Go to file
Sharif Elgamal 2c2e7c1271
Reroute logs printed to stdout
2019-04-18 17:19:20 -07:00
.github Update ISSUE_TEMPLATE 2019-03-11 12:15:42 -07:00
cmd Another complex function 2019-04-12 20:47:29 +02:00
deploy Added REGISTRY_STORAGE_DELETE_ENABLED environment variable for Registry addon 2019-04-11 16:14:36 -07:00
docs Merge pull request #4052 from marcosdiez/more-vmdriver-none-documentation 2019-04-11 11:47:59 -07:00
hack fix boilerplate 2019-04-03 11:12:08 -07:00
images Make the help wanted image smaller 2019-03-27 09:21:09 -07:00
installers Merge pull request #3701 from afbjorklund/kvm-image 2019-03-20 19:27:11 -07:00
pkg Reroute logs printed to stdout 2019-04-18 17:19:20 -07:00
test/integration Merge branch 'master' into cyclo 2019-04-12 20:03:20 +02:00
third_party/go9p Run go vet on all code, not just pkg and cmd 2019-03-10 14:33:24 +01:00
vendor Merge pull request #3899 from afbjorklund/reference 2019-04-12 19:56:05 +02: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
.markdownlint.json Run markdownlint on all the md files in docs 2019-03-10 20:06:04 +01:00
.travis.yml Let Travis track the latest stable Go 1.x release. 2018-10-04 13:35:19 -07:00
CHANGELOG.md Mention kubectl update recommendation. 2019-03-27 07:32:40 -07:00
CONTRIBUTING.md Update CLA link 2018-01-02 08:19:46 -08:00
Gopkg.lock Merge pull request #3899 from afbjorklund/reference 2019-04-12 19:56:05 +02: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 Update Makefile version to v1.0.0 2019-03-26 21:53:29 -07:00
OWNERS Updated OWNERS file to include link to docs 2019-02-04 18:48:23 +01:00
README.md Remove older news 2019-04-10 10:56:20 -07:00
SECURITY_CONTACTS Update embargo doc link in SECURITY_OWNERS and changes PST to PSC 2019-03-08 10:23:48 -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 Adding test to make sure HEAD can run on VM created by latest release 2019-03-21 17:36:13 -07:00

README.md

minikube

BuildStatus Widget GoReport Widget

What is minikube?

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

screenshot

Our project goals are 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:

As well as developer-friendly features:

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

Documentation

Community

Help Wanted!

minikube is a Kubernetes #sig-cluster-lifecycle project.

Installation

See the installation guide. For the impatient, here is the TL;DR:

  • macOS 10.12 (Sierra)

    • Requires installing a hypervisor, such as hyperkit (recommended) or VirtualBox
    • using brew: 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 choco install minikube
    • manually: Download and run the installer
  • Linux

    • Requires either the 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 - 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 by running:

minikube start

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