minikube/README.md

minikube

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

• 2019-02-15 - v0.34.0 released! [download] [release notes]
• 2019-01-18 - v0.33.1 released to address CVE-2019-5736 [download] [release notes]
• 2019-01-17 - v0.33.0 released! [download] [release notes]

Features

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

• NodePorts - minikube service
• Ingress
• LoadBalancer - minikube tunnel
• Persistent Volumes
• ConfigMaps
• RBAC
• Secrets
• Dashboard - minikube dashboard
• Multiple container runtimes - start --container-runtime

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

• #minikube on Kubernetes Slack - Live chat with minikube developers!

• minikube-users mailing list

• minikube-dev mailing list

• Advanced Topics and Tutorials

• Contributing

• Development Guide

• Development Roadmap

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:

• hyperv
• vmware

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