Go to file
Thomas Strömberg 9a2f9cfae1
Fix start image width
2019-02-15 16:40:03 -08:00
.github Update ISSUE_TEMPLATE 2018-10-01 18:43:50 -07:00
cmd Merge from HEAD 2019-02-15 09:24:35 -08:00
deploy Update releases.json to include v0.34.0 2019-02-15 21:42:33 +00:00
docs Merge pull request #3690 from joerg84/unified-instructions 2019-02-15 16:03:07 -08:00
hack none tests: Cleanup /var/lib/minikube 2019-02-14 20:20:49 -08:00
images Make images subdirectory, add start image 2019-02-15 16:36:36 -08:00
installers Use lowercase 'minikube' as a name. 2019-02-15 15:43:59 -08:00
pkg Merge pull request #3680 from tstromberg/better-none 2019-02-15 10:38:07 -08:00
test/integration Fix TestStartStop so that none tests are executed 2019-02-14 20:26:24 -08:00
third_party/go9p go fmt 2018-10-31 11:18:03 +01:00
vendor Add vendored cmpopts 2019-02-14 16:13:50 -08:00
.codecov.yml Disable codecov comment bot 2017-08-04 14:46:44 -07:00
.dockerignore Add a .dockerignore to make image builds faster. 2017-11-06 13:01:01 -08:00
.gitignore Added .vscode to .gitignore 2017-04-07 16:02:37 -07:00
.travis.yml Let Travis track the latest stable Go 1.x release. 2018-10-04 13:35:19 -07:00
CHANGELOG.md Update CHANGELOG.md 2019-02-15 14:11:29 -08:00
CONTRIBUTING.md Update CLA link 2018-01-02 08:19:46 -08:00
Gopkg.lock ListContainers should return empty list when no containers match 2019-02-14 16:10:33 -08:00
Gopkg.toml Merge from hell #2: refactor start.go because it's terrible 2019-02-08 13:37:29 -08:00
LICENSE Update License file 2016-04-15 15:44:00 -07:00
MAINTAINERS Add afbjorklund to maintainers 2019-01-20 20:20:41 +01:00
Makefile v0.34.0 2019-02-15 13:26:08 -08:00
OWNERS Updated OWNERS file to include link to docs 2019-02-04 18:48:23 +01:00
README.md Fix start image width 2019-02-15 16:40:03 -08:00
SECURITY_CONTACTS Add security contacts. 2018-05-25 07:35:57 -07:00
code-of-conduct.md Update code-of-conduct.md 2017-12-20 13:39:35 -05:00
makedepend.sh Avoid out directory, when listing test files 2018-10-06 21:04:44 +02:00
test.sh Merge pull request #3229 from afbjorklund/makedepend-buildroot 2019-01-16 11:15:34 -08:00

README.md

minikube

BuildStatus Widget GoReport Widget

What is minikube?

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

Our goal is to enable fast local development and to support all Kubernetes features that fit. We hope you enjoy it!

News

Features

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

minikube also supports features for developer convenience:

  • Addons - a marketplace for developers to share configurations for running services on minikube
  • GPU support - for machine learning
  • Filesystem mounts
  • Automatic failure analysis

Community & Documentation

Requirements

  • 4GB of memory (VM reserves 2GB by default), 32GB of disk space
  • An internet connection - preferably one that does not require a VPN or SSL proxy to access the internet
  • macOS 10.12 (Sierra) or higher
    • Requires a hypervisor, such as:
      • hyperkit (recommended)
      • VirtualBox
  • Linux
    • libvirt for the KVM driver, or VirtualBox
    • VT-x/AMD-v virtualization must be enabled in BIOS
  • 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

  • macOS: curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-amd64 && sudo install minikube-darwin-amd64 /usr/local/bin/minikube

  • Windows with Chocolatey choco install minikube

  • Windows without Choco - Download and run the installer

  • Linux curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && sudo install minikube-linux-amd64 /usr/local/bin/minikube

For full installation instructions, please see https://kubernetes.io/docs/tasks/tools/install-minikube/

Supported Hypervisors

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

  • KVM2 - Recommended Linux driver
  • hyperkit - Recommended macOS driver
  • virtualbox - Recommended Windows driver
  • none - 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:

Quick Start

Start a cluster:

minikube start

Interact with it using kubectl, just like any other kubernetes cluster:

$ kubectl run hello-minikube --image=k8s.gcr.io/echoserver:1.4 --port=8080
deployment "hello-minikube" created

$ kubectl expose deployment hello-minikube --type=NodePort
service "hello-minikube" exposed

Open the 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