More doc cleanup
Thomas Strömberg
GitHub
parent
ec5ac30cfd
commit
5bc44487fb
70
README.md
70
README.md
|
|
@ -1,4 +1,4 @@
|
|||
# Minikube
|
||||
# minikube
|
||||
|
||||
[![BuildStatus Widget]][BuildStatus Result]
|
||||
[![GoReport Widget]][GoReport Status]
|
||||
|
|
@ -13,37 +13,44 @@
|
|||
|
||||
## What is minikube?
|
||||
|
||||
minikube makes running a local Kubernetes cluster fast and easy, supporting macOS, Linux, and Windows. Our design goals are fast local development, single command setup and teardown, and support for all Kubernetes features that fit.
|
||||
A local Kubernetes cluster.
|
||||
|
||||
## Kubernetes features
|
||||
|
||||
minikube runs the most recent stable release of Kubernetes, using the official release binaries. We explicitly support the following features:
|
||||
|
||||
* NodePorts - access via `minikube service`
|
||||
* Ingress
|
||||
* LoadBalancer - access via `minikube tunnel`
|
||||
* DNS
|
||||
* Persistent Volumes
|
||||
* ConfigMaps
|
||||
* RBAC
|
||||
* Secrets
|
||||
* Dashboard - access via `minikube dashboard`
|
||||
* Container runtimes - Docker, CRI-O, containerd
|
||||
minikube makes running a local Kubernetes cluster fast and easy, supporting macOS, Linux, and Windows. Our goals are to enable fast local development, single command setup and teardown, and support for all Kubernetes features that fit.
|
||||
|
||||
## News
|
||||
|
||||
* 2019-02-15 - minikube v0.34.0 was released! See the [releases](https://github.com/kubernetes/minikube/releases) page for more.
|
||||
|
||||
## Kubernetes features
|
||||
|
||||
minikube runs the official stable release of Kubernetes, with support for features such as:
|
||||
|
||||
* NodePorts - access via `minikube service`
|
||||
* Ingress
|
||||
* LoadBalancer - access via `minikube tunnel` [docs](https://github.com/kubernetes/minikube/blob/master/docs/tunnel.md)
|
||||
* Persistent Volumes [docs](https://github.com/kubernetes/minikube/blob/master/docs/persistent_volumes.md)
|
||||
* ConfigMaps
|
||||
* RBAC
|
||||
* Secrets
|
||||
* Dashboard - access via `minikube dashboard`
|
||||
* Container runtimes - Docker, CRI-O, containerd
|
||||
|
||||
## Developer Features
|
||||
|
||||
* [Addons](https://github.com/kubernetes/minikube/blob/master/docs/addons.md) - a marketplace for developers to share configurations for running services on minikube
|
||||
* [GPU support](https://github.com/kubernetes/minikube/blob/master/docs/gpu.md) - for machine learning
|
||||
* Automatic failure analysis - so you know why your deployment failed
|
||||
* [Filesystem mounts](https://github.com/kubernetes/minikube/blob/master/docs/host_folder_mount.md)
|
||||
|
||||
## Community & Documentation
|
||||
|
||||
* [**#minikube on Kubernetes Slack**](https://kubernetes.slack.com) - Live chat with minikube developers!
|
||||
* [**minikube-users mailing list](https://groups.google.com/forum/#!forum/minikube-users)
|
||||
* [**minikube-dev mailing list](https://groups.google.com/forum/#!forum/minikube-dev)
|
||||
* [minikube-users mailing list](https://groups.google.com/forum/#!forum/minikube-users)
|
||||
* [minikube-dev mailing list](https://groups.google.com/forum/#!forum/minikube-dev)
|
||||
|
||||
* [**Advanced Topics and Tutorials**](https://github.com/kubernetes/minikube/blob/master/docs/README.md)
|
||||
* [**Contributing**](https://github.com/kubernetes/minikube/blob/master/CONTRIBUTING.md)
|
||||
* [**Development Guide**](https://github.com/kubernetes/minikube/blob/master/docs/contributors/README.md)
|
||||
|
||||
* [Contributing](https://github.com/kubernetes/minikube/blob/master/CONTRIBUTING.md)
|
||||
* [Development Guide](https://github.com/kubernetes/minikube/blob/master/docs/contributors/README.md)
|
||||
|
||||
## Requirements
|
||||
|
||||
|
|
@ -54,23 +61,21 @@ minikube runs the most recent stable release of Kubernetes, using the official r
|
|||
* hyperkit (recommended)
|
||||
* VirtualBox
|
||||
* Linux
|
||||
* VT-x/AMD-v virtualization must be enabled in BIOS
|
||||
* libvirt for the KVM driver, or VirtualBox
|
||||
* Windows 10
|
||||
* VT-x/AMD-v virtualization must be enabled in BIOS
|
||||
* HyperV (Pro) or a 3rd party hypervisor, such as VirtualBox.
|
||||
* Windows 10
|
||||
* HyperV (Windows 10 Pro) or a 3rd party hypervisor, such as VirtualBox.
|
||||
* VT-x/AMD-v virtualization must be enabled in BIOS
|
||||
|
||||
## Installation
|
||||
|
||||
* *macOS* with brew: `brew cask install minikube` (if [Homebrew](https://brew.sh/ is installed)
|
||||
* *macOS*: `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-amd64 \
|
||||
&& sudo install minikube-darwin-amd64 /usr/local/bin/minikube`
|
||||
* *macOS* with [brew](https://brew.sh/): `brew cask install minikube`
|
||||
* *macOS*: `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-amd64 && sudo install minikube-darwin-amd64 /usr/local/bin/minikube`
|
||||
|
||||
* *Windows 10 with Choco* `choco install minikube` (if [Chocolatey](https://chocolatey.org/ is installed)
|
||||
* *Windows 10 without Choco* - Download [minikube-windows-amd64.exe](https://storage.googleapis.com/minikube/releases/latest/minikube-windows-amd64.exe) file, rename it to `minikube.exe`, and add it to your path.
|
||||
|
||||
* *Generic Linux* `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 \
|
||||
&& sudo install minikube-linux-amd64 /usr/local/bin/minikube`
|
||||
* *Generic Linux* `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && sudo install minikube-linux-amd64 /usr/local/bin/minikube`
|
||||
* [Arch Linux AUR](https://aur.archlinux.org/packages/minikube/)
|
||||
* [Fedora/CentOS/Red Hat COPR](https://copr.fedorainfracloud.org/coprs/antonpatsev/minikube-rpm/)
|
||||
* [Void Linux](https://github.com/void-linux/void-packages/tree/master/srcpkgs/minikube/template)
|
||||
|
|
@ -85,9 +90,12 @@ For full installation instructions, please see https://kubernetes.io/docs/tasks/
|
|||
* [KVM2](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver) - Recommended Linux driver
|
||||
* [hyperkit](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver) - Recommended macOS driver
|
||||
* virtualbox - Recommended Windows driver
|
||||
* [none](https://github.com/kubernetes/minikube/blob/master/docs/vmdriver-none.md) - bare-metal execution on Linux, at the expense of system security and reliability
|
||||
|
||||
Other drivers which are supported but not part of our continuous integration system are:
|
||||
|
||||
* [hyperv](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperV-driver)
|
||||
* vmwarefusion
|
||||
* none (**Linux-only**) - run without a hypervisor, at the expense of system security or reliability.
|
||||
* [vmware](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#vmware-unified-driver)
|
||||
|
||||
## Quick Start
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue