Go to file
Anders F Björklund 3cc4376298 Upgrade crio to 1.14.0 2019-05-04 16:17:12 +02:00
.github Minor edit to the comment text for clarity 2019-05-03 11:21:18 -07:00
cmd Merge pull request #4199 from sharifelgamal/jibber-jabber 2019-05-03 15:03:05 -07:00
deploy Upgrade crio to 1.14.0 2019-05-04 16:17:12 +02:00
docs Update configuring_kubernetes.md 2019-05-01 10:45:02 -07:00
hack Add script to update kubernetes version 2019-05-01 15:06:21 -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 Merge pull request #4199 from sharifelgamal/jibber-jabber 2019-05-03 15:03:05 -07:00
test/integration fix tunnel integration tests for driver None (#4105) 2019-04-25 08:49:24 -07:00
third_party/go9p Run go vet on all code, not just pkg and cmd 2019-03-10 14:33:24 +01:00
vendor Add automatic locale detection 2019-05-02 19:03:52 -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 adding multi-arch support 2019-04-17 08:43:37 -04: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 Fix date of v1.0.1 2019-04-30 09:42:52 -07:00
CONTRIBUTING.md Update CLA link 2018-01-02 08:19:46 -08:00
Gopkg.lock Add automatic locale detection 2019-05-02 19:03:52 -07:00
Gopkg.toml Add automatic locale detection 2019-05-02 19:03:52 -07:00
LICENSE Update License file 2016-04-15 15:44:00 -07:00
MAINTAINERS Update MAINTAINERS 2019-04-25 14:16:43 -07:00
Makefile Fix the deploy targets, restore default target 2019-05-02 21:01:46 +02:00
OWNERS s/priya/selgamal 2019-04-25 14:24:27 -07:00
README.md Clarify goal statemement. 2019-04-30 09:47:55 -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

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

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

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