minikube/README.md

# minikube

[![BuildStatus Widget]][BuildStatus Result]
[![GoReport Widget]][GoReport Status]

[BuildStatus Result]: https://travis-ci.org/kubernetes/minikube
[BuildStatus Widget]: https://travis-ci.org/kubernetes/minikube.svg?branch=master

[GoReport Status]: https://goreportcard.com/report/github.com/kubernetes/minikube
[GoReport Widget]: https://goreportcard.com/badge/github.com/kubernetes/minikube

<img src="https://github.com/kubernetes/minikube/raw/master/images/logo/logo.png" width="100">

## What is minikube?

minikube implements a local Kubernetes cluster on macOS, Linux, and Windows.

![screenshot](/images/start.jpg)

minikube's [primary goals](https://github.com/kubernetes/minikube/blob/master/docs/contributors/principles.md) are to be the best tool for local Kubernetes application development and to support all Kubernetes features that fit. We hope you enjoy it!

## News

:mega: **Please fill out our [fast 5-question survey](https://forms.gle/Gg3hG5ZySw8c1C24A)** so that we can learn how & why you use minikube, and what improvements we should make. Thank you! :dancers:

* 2019-06-24 - v1.2.0 released! [[download](https://github.com/kubernetes/minikube/releases/tag/v1.2.0)] [[release notes](https://github.com/kubernetes/minikube/blob/master/CHANGELOG.md#version-120---2019-06-24)]
* 2019-06-07 - v1.1.1 released! [[download](https://github.com/kubernetes/minikube/releases/tag/v1.1.1)] [[release notes](https://github.com/kubernetes/minikube/blob/master/CHANGELOG.md#version-111---2019-06-07)]
* 2019-05-21 - v1.1.0 released! [[download](https://github.com/kubernetes/minikube/releases/tag/v1.1.0)] [[release notes](https://github.com/kubernetes/minikube/blob/master/CHANGELOG.md#version-110---2019-05-21)]

## Features

minikube runs the latest stable release of Kubernetes, with support for standard Kubernetes features like:

* [LoadBalancer](https://github.com/kubernetes/minikube/blob/master/docs/tunnel.md) - using `minikube tunnel`
* Multi-cluster - using `minikube start -p <name>`
* NodePorts - using `minikube service`
* [Persistent Volumes](https://github.com/kubernetes/minikube/blob/master/docs/persistent_volumes.md)
* Ingress
* RBAC
* [Dashboard](https://github.com/kubernetes/minikube/blob/master/docs/dashboard.md) - `minikube dashboard`
* [Container runtimes](https://github.com/kubernetes/minikube/blob/master/docs/alternative_runtimes.md) - `start --container-runtime`
* [Configure apiserver and kubelet options](https://github.com/kubernetes/minikube/blob/master/docs/configuring_kubernetes.md) via command-line flags

As well as developer-friendly 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
* [Filesystem mounts](https://github.com/kubernetes/minikube/blob/master/docs/host_folder_mount.md)
* Automatic failure analysis

## Documentation

* [**Installation**](https://kubernetes.io/docs/tasks/tools/install-minikube/)
* [Advanced Topics and Tutorials](https://github.com/kubernetes/minikube/blob/master/docs/README.md)
* [Contributors Guide](https://github.com/kubernetes/minikube/blob/master/docs/contributors/README.md)

## Community

![Help Wanted!](/images/help_wanted.jpg)

minikube is a Kubernetes [#sig-cluster-lifecycle](https://github.com/kubernetes/community/tree/master/sig-cluster-lifecycle)  project.

* [**#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)
* [Bi-weekly office hours, Mondays @ 10am PST](https://tinyurl.com/minikube-oh)

* [Contributing](https://github.com/kubernetes/minikube/blob/master/CONTRIBUTING.md)
* [Development Roadmap](https://github.com/kubernetes/minikube/blob/master/docs/contributors/roadmap.md)

## Installation

See the [installation guide](https://kubernetes.io/docs/tasks/tools/install-minikube/). For the impatient, here is the TL;DR:

* *macOS 10.12 (Sierra)*
  * Requires installing a hypervisor, such as [hyperkit](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver) (recommended) or VirtualBox
  * using [brew](https://brew.sh/): `brew cask install minikube`
  * manually: `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-amd64 && sudo install minikube-darwin-amd64 /usr/local/bin/minikube`

* *Windows 10*
  * Requires a hypervisor, such as VirtualBox (recommended) or HyperV
  * VT-x/AMD-v virtualization must be enabled in BIOS
  * using [chocolatey](https://chocolatey.org/) `choco install minikube`
  * manually: Download and run the [installer](https://storage.googleapis.com/minikube/releases/latest/minikube-installer.exe)

* *Linux*
  * Requires either the [kvm2 driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver) (recommended), or VirtualBox
  * VT-x/AMD-v virtualization must be enabled in BIOS
  * manually:  `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && sudo install minikube-linux-amd64 /usr/local/bin/minikube`

### Supported Hypervisors

`minikube start` defaults to virtualbox, but supports other drivers using the `--vm-driver` argument:

* [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 not yet part of our continuous integration system are:

* [hyperv](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperV-driver)
* [vmware](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#vmware-unified-driver)

## Quick Start

Start a cluster by running:

`minikube start`

Access Kubernetes Dashboard within Minikube:

`minikube dashboard`

Once started, you can interact with your cluster using `kubectl`, just like any other Kubernetes cluster. For instance, starting a server:

`kubectl run hello-minikube --image=k8s.gcr.io/echoserver:1.4 --port=8080`

Exposing a service as a NodePort

`kubectl expose deployment hello-minikube --type=NodePort`

minikube makes it easy to open this exposed endpoint in your browser:

`minikube service hello-minikube`

Start a second local cluster:

`minikube start -p cluster2`

Stop your local cluster:

`minikube stop`

Delete your local cluster:

`minikube delete`
More doc cleanup 2019-02-15 23:07:44 +00:00			`# minikube`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2017-08-09 02:07:56 +00:00			`[![BuildStatus Widget]][BuildStatus Result]`
			`[![GoReport Widget]][GoReport Status]`

			`[BuildStatus Result]: https://travis-ci.org/kubernetes/minikube`
			`[BuildStatus Widget]: https://travis-ci.org/kubernetes/minikube.svg?branch=master`

			`[GoReport Status]: https://goreportcard.com/report/github.com/kubernetes/minikube`
			`[GoReport Widget]: https://goreportcard.com/badge/github.com/kubernetes/minikube`

Make images subdirectory, add start image 2019-02-16 00:36:36 +00:00			`<img src="https://github.com/kubernetes/minikube/raw/master/images/logo/logo.png" width="100">`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`## What is minikube?`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Add markdownlint config file, address some issues Mostly related to whitespace (newlines / trailing), lots of issues remaining to fix in the docs directory. As usual linting takes most effort when you start, but from there it is easier to keep code and docs clean. 2019-03-10 11:11:44 +00:00			`minikube implements a local Kubernetes cluster on macOS, Linux, and Windows.`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Add help wanted image 2019-03-27 16:23:42 +00:00			`![screenshot](/images/start.jpg)`
Make images subdirectory, add start image 2019-02-16 00:36:36 +00:00
Clarify goal statemement. 2019-04-30 16:47:55 +00:00			`minikube's [primary goals](https://github.com/kubernetes/minikube/blob/master/docs/contributors/principles.md) are to be the best tool for local Kubernetes application development and to support all Kubernetes features that fit. We hope you enjoy it!`
Make images subdirectory, add start image 2019-02-16 00:36:36 +00:00
More doc cleanup 2019-02-15 23:07:44 +00:00			`## News`
Mention CVE on frontpage. 2018-10-09 23:26:03 +00:00
Fix emoji. 2019-05-30 22:58:21 +00:00			`:mega: Please fill out our [fast 5-question survey](https://forms.gle/Gg3hG5ZySw8c1C24A) so that we can learn how & why you use minikube, and what improvements we should make. Thank you! :dancers:`
Add survey link 2019-05-30 22:54:22 +00:00
Mention v1.2.0 release 2019-06-24 09:07:10 +00:00			`* 2019-06-24 - v1.2.0 released! [[download](https://github.com/kubernetes/minikube/releases/tag/v1.2.0)] [[release notes](https://github.com/kubernetes/minikube/blob/master/CHANGELOG.md#version-120---2019-06-24)]`
Fix the release date of minikube v1.1.1 2019-06-18 16:16:50 +00:00			`* 2019-06-07 - v1.1.1 released! [[download](https://github.com/kubernetes/minikube/releases/tag/v1.1.1)] [[release notes](https://github.com/kubernetes/minikube/blob/master/CHANGELOG.md#version-111---2019-06-07)]`
Mention v1.1.0 2019-05-22 00:27:35 +00:00			`* 2019-05-21 - v1.1.0 released! [[download](https://github.com/kubernetes/minikube/releases/tag/v1.1.0)] [[release notes](https://github.com/kubernetes/minikube/blob/master/CHANGELOG.md#version-110---2019-05-21)]`
Mention CVE on frontpage. 2018-10-09 23:26:03 +00:00
Simplify Linux instructions 2019-02-15 23:28:35 +00:00			`## Features`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Add survey link 2019-05-30 22:54:22 +00:00			`minikube runs the latest stable release of Kubernetes, with support for standard Kubernetes features like:`
Simplifies Linux installation instructions by using install(1) Makes documentation easier to read on narrower screens, and makes the command-line less scary looking. Leaves deletion of the downloaded file as an exercise for the reader. It's typically not done in installation instructions. Instructions still assume x86-64 architecture, which is the common case, but less than ideal. 2018-09-05 18:48:57 +00:00
Add markdownlint config file, address some issues Mostly related to whitespace (newlines / trailing), lots of issues remaining to fix in the docs directory. As usual linting takes most effort when you start, but from there it is easier to keep code and docs clean. 2019-03-10 11:11:44 +00:00			* [LoadBalancer](https://github.com/kubernetes/minikube/blob/master/docs/tunnel.md) - using `minikube tunnel`
Combine requirements & installation, simplify other bits 2019-02-16 04:35:16 +00:00			* Multi-cluster - using `minikube start -p <name>`
			* NodePorts - using `minikube service`
Simplify Linux instructions 2019-02-15 23:28:35 +00:00			`* [Persistent Volumes](https://github.com/kubernetes/minikube/blob/master/docs/persistent_volumes.md)`
Combine requirements & installation, simplify other bits 2019-02-16 04:35:16 +00:00			`* Ingress`
Update README.md 2019-02-15 22:56:28 +00:00			`* RBAC`
Add some documentation about the dashboard 2019-06-17 19:01:07 +00:00			* [Dashboard](https://github.com/kubernetes/minikube/blob/master/docs/dashboard.md) - `minikube dashboard`
Combine requirements & installation, simplify other bits 2019-02-16 04:35:16 +00:00			* [Container runtimes](https://github.com/kubernetes/minikube/blob/master/docs/alternative_runtimes.md) - `start --container-runtime`
readme: typo 2019-02-19 10:16:32 +00:00			`* [Configure apiserver and kubelet options](https://github.com/kubernetes/minikube/blob/master/docs/configuring_kubernetes.md) via command-line flags`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Combine requirements & installation, simplify other bits 2019-02-16 04:35:16 +00:00			`As well as developer-friendly features:`
Keep both sets of instructions Link to https://chocolatey.org/ and include manual instructions. 2018-07-11 19:05:17 +00:00
More doc cleanup 2019-02-15 23:07:44 +00:00			`* [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`
			`* [Filesystem mounts](https://github.com/kubernetes/minikube/blob/master/docs/host_folder_mount.md)`
More readability improvements. Add download links. 2019-02-15 23:24:00 +00:00			`* Automatic failure analysis`
updated readme for Windows installation 2018-08-17 15:10:00 +00:00
Combine requirements & installation, simplify other bits 2019-02-16 04:35:16 +00:00			`## Documentation`

			`* [Installation](https://kubernetes.io/docs/tasks/tools/install-minikube/)`
			`* [Advanced Topics and Tutorials](https://github.com/kubernetes/minikube/blob/master/docs/README.md)`
			`* [Contributors Guide](https://github.com/kubernetes/minikube/blob/master/docs/contributors/README.md)`

			`## Community`
updated readme for Windows installation 2018-08-17 15:10:00 +00:00
Add help wanted image 2019-03-27 16:23:42 +00:00			`![Help Wanted!](/images/help_wanted.jpg)`

Add markdownlint config file, address some issues Mostly related to whitespace (newlines / trailing), lots of issues remaining to fix in the docs directory. As usual linting takes most effort when you start, but from there it is easier to keep code and docs clean. 2019-03-10 11:11:44 +00:00			`minikube is a Kubernetes [#sig-cluster-lifecycle](https://github.com/kubernetes/community/tree/master/sig-cluster-lifecycle) project.`
Mention office hours, minor formatting fixes 2019-02-18 14:36:00 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`* [#minikube on Kubernetes Slack](https://kubernetes.slack.com) - Live chat with minikube developers!`
More doc cleanup 2019-02-15 23:07:44 +00:00			`* [minikube-users mailing list](https://groups.google.com/forum/#!forum/minikube-users)`
			`* [minikube-dev mailing list](https://groups.google.com/forum/#!forum/minikube-dev)`
Mention office hours, minor formatting fixes 2019-02-18 14:36:00 +00:00			`* [Bi-weekly office hours, Mondays @ 10am PST](https://tinyurl.com/minikube-oh)`

More doc cleanup 2019-02-15 23:07:44 +00:00			`* [Contributing](https://github.com/kubernetes/minikube/blob/master/CONTRIBUTING.md)`
More readability improvements. Add download links. 2019-02-15 23:24:00 +00:00			`* [Development Roadmap](https://github.com/kubernetes/minikube/blob/master/docs/contributors/roadmap.md)`
Mention asdf Version Manager 2017-10-12 18:20:39 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`## Installation`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Mention office hours, minor formatting fixes 2019-02-18 14:36:00 +00:00			`See the [installation guide](https://kubernetes.io/docs/tasks/tools/install-minikube/). For the impatient, here is the TL;DR:`
Mention asdf Version Manager 2017-10-12 18:20:39 +00:00
Mention office hours, minor formatting fixes 2019-02-18 14:36:00 +00:00			`* macOS 10.12 (Sierra)`
Add hyperkit link 2019-02-18 14:37:39 +00:00			`* Requires installing a hypervisor, such as [hyperkit](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver) (recommended) or VirtualBox`
Combine requirements & installation, simplify other bits 2019-02-16 04:35:16 +00:00			* using [brew](https://brew.sh/): `brew cask install minikube`
			* manually: `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-amd64 && sudo install minikube-darwin-amd64 /usr/local/bin/minikube`
Mention asdf Version Manager 2017-10-12 18:20:39 +00:00
Mention office hours, minor formatting fixes 2019-02-18 14:36:00 +00:00			`* Windows 10`
Combine requirements & installation, simplify other bits 2019-02-16 04:35:16 +00:00			`* Requires a hypervisor, such as VirtualBox (recommended) or HyperV`
			`* VT-x/AMD-v virtualization must be enabled in BIOS`
Mention office hours, minor formatting fixes 2019-02-18 14:36:00 +00:00			* using [chocolatey](https://chocolatey.org/) `choco install minikube`
Combine requirements & installation, simplify other bits 2019-02-16 04:35:16 +00:00			`* manually: Download and run the [installer](https://storage.googleapis.com/minikube/releases/latest/minikube-installer.exe)`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Add markdownlint config file, address some issues Mostly related to whitespace (newlines / trailing), lots of issues remaining to fix in the docs directory. As usual linting takes most effort when you start, but from there it is easier to keep code and docs clean. 2019-03-10 11:11:44 +00:00			`* Linux`
Combine requirements & installation, simplify other bits 2019-02-16 04:35:16 +00:00			`* Requires either the [kvm2 driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver) (recommended), or VirtualBox`
			`* VT-x/AMD-v virtualization must be enabled in BIOS`
Fix code block highlight in README 2019-02-19 09:26:35 +00:00			* manually: `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && sudo install minikube-linux-amd64 /usr/local/bin/minikube`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`### Supported Hypervisors`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`minikube start` defaults to virtualbox, but supports other drivers using the `--vm-driver` argument:
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`* [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`
More doc cleanup 2019-02-15 23:07:44 +00:00			`* [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`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
More readability improvements. Add download links. 2019-02-15 23:24:00 +00:00			`Other drivers which are not yet part of our continuous integration system are:`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`* [hyperv](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperV-driver)`
More doc cleanup 2019-02-15 23:07:44 +00:00			`* [vmware](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#vmware-unified-driver)`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`## Quick Start`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Simplify QuickStart text 2019-02-16 04:38:12 +00:00			`Start a cluster by running:`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
More readability improvements. Add download links. 2019-02-15 23:24:00 +00:00			`minikube start`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md Changes addressed 2019-04-18 11:45:16 +00:00			`Access Kubernetes Dashboard within Minikube:`
Accessing minikube Dashboard UI 2019-03-27 18:54:00 +00:00
			`minikube dashboard`

Simplify QuickStart text 2019-02-16 04:38:12 +00:00			Once started, you can interact with your cluster using `kubectl`, just like any other Kubernetes cluster. For instance, starting a server:
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Simplify QuickStart text 2019-02-16 04:38:12 +00:00			`kubectl run hello-minikube --image=k8s.gcr.io/echoserver:1.4 --port=8080`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Simplify QuickStart text 2019-02-16 04:38:12 +00:00			`Exposing a service as a NodePort`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Simplify QuickStart text 2019-02-16 04:38:12 +00:00			`kubectl expose deployment hello-minikube --type=NodePort`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Simplify QuickStart text 2019-02-16 04:38:12 +00:00			`minikube makes it easy to open this exposed endpoint in your browser:`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 23:32:57 +00:00			`minikube service hello-minikube`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`Start a second local cluster:`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`minikube start -p cluster2`
Update README.md 2017-10-04 22:01:18 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`Stop your local cluster:`

			`minikube stop`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`Delete your local cluster:`
Normalize all the line endings 2017-03-21 04:57:11 +00:00
Update README.md 2019-02-15 22:56:28 +00:00			`minikube delete`