Go to file
Priya Wadhwa a294bdb29a gvisor-addon depends on generated files 2019-08-08 13:16:30 -07:00
.github/ISSUE_TEMPLATE making issue template less complex 2019-07-08 10:19:03 -07:00
cmd Fixed the template for dashboard output 2019-08-07 11:16:39 +05:30
deploy Merge branch 'master' of https://github.com/kubernetes/minikube into gvisor-image 2019-08-08 13:10:04 -07:00
docs 2->3 2019-08-06 20:10:07 -07:00
hack Merge branch 'master' of https://github.com/kubernetes/minikube into gvisor-image 2019-08-08 13:10:04 -07:00
images Update start.jpg to v1.2 2019-06-24 16:21:38 +08:00
installers Change deb maintainer, lower case minikube 2019-07-14 09:32:19 +02:00
pkg Merge branch 'master' of https://github.com/kubernetes/minikube into gvisor-image 2019-08-08 13:10:04 -07:00
site Update to v1.3.0 2019-08-06 10:17:12 -07:00
test/integration No longer need to build out/gvisor-addon since it's built in the docker image 2019-08-08 11:28:40 -07:00
third_party/go9p Better comment syntax 2019-07-05 11:17:10 +08:00
translations Console output cleanup (#4825) 2019-07-19 17:00:51 -07: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 add latest binary to gitignore 2019-07-30 10:45:05 -07:00
.gitmodules Switch hugo themes from whisper to docsy 2019-07-19 19:04:51 -07:00
.markdownlint.json Run markdownlint on all the md files in docs 2019-03-10 20:06:04 +01:00
.travis.yml pinning go version in travis 2019-07-22 16:20:55 -07:00
CHANGELOG.md Late-breaking v1.3.0 changes 2019-08-05 18:46:48 -07:00
CONTRIBUTING.md Update CLA link 2018-01-02 08:19:46 -08:00
LICENSE Update License file 2016-04-15 15:44:00 -07:00
MAINTAINERS Update security contacts 2019-07-10 10:48:31 -07:00
Makefile gvisor-addon depends on generated files 2019-08-08 13:16:30 -07:00
OWNERS Update security contacts 2019-07-10 10:48:31 -07:00
README.md Mention v1.3.0 2019-08-05 19:04:16 -07:00
SECURITY_CONTACTS Update security contacts 2019-07-10 10:48:31 -07:00
code-of-conduct.md Update code-of-conduct.md 2017-12-20 13:39:35 -05:00
go.mod Merge branch 'master' of https://github.com/kubernetes/minikube into gvisor-image 2019-08-08 13:10:04 -07:00
go.sum Merge branch 'master' of https://github.com/kubernetes/minikube into gvisor-image 2019-08-08 13:10:04 -07:00
netlify.toml Switch hugo themes from whisper to docsy 2019-07-19 19:04:51 -07:00
test.sh Merge pull request #4674 from kubernetes/docsy2 2019-07-29 11:51:48 -07:00

README.md

minikube

BuildStatus Widget GoReport Widget

What is minikube?

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

screenshot

minikube's primary goals 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

📣 Please fill out our fast 5-question survey so that we can learn how & why you use minikube, and what improvements we should make. Thank you! 👯

Features

minikube runs the latest 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

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