minikube README

The project's README from github.com/kubernetes/minikube. As one markdown file: README.md.

minikube

Actions Status GoReport Widget GitHub All Releases Latest Release Try minikube in the browser (needs github login)

minikube logo

minikube implements a local Kubernetes cluster on macOS, Linux, and Windows. minikube's primary goals are to be the best tool for local Kubernetes application development and to support all Kubernetes features that fit.

screenshot

Features

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

As well as developer-friendly features:

For more information, see the official minikube website

Installation

See the Getting Started Guide

:mega: 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! :dancers:

GitHub Codespace

You can run minikube in a GitHub Codespace by clicking here: Open in GitHub Codespaces

This will launch a Github Codespace. You can then run minikube start and minikube dashboard - You can then open Minikube Dashboard by clicking opening the link displayed in the terminal.

You can also run Minikube in a Dev Container locally using your favorite IDE, for more information see Dev Containers https://code.visualstudio.com/docs/devcontainers/containers

Documentation

See https://minikube.sigs.k8s.io/docs/

More Examples

See minikube in action in the controls handbook

Governance

Kubernetes project is governed by a framework of principles, values, policies and processes to help our community and constituents towards our shared goals.

The Kubernetes Community is the launching point for learning about how we organize ourselves.

The Kubernetes Steering community repo is used by the Kubernetes Steering Committee, which oversees governance of the Kubernetes project.

Community

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

Join our community meetings:

minikube (kubernetes/minikube)

Searching Database…

32.2K ·GitHub
What is this?Minikube runs a local Kubernetes cluster on macOS, Linux, or Windows so developers can build and test Kubernetes applications on their own machine.
Is this a full Kubernetes distribution or just a dev sandbox?It is a CLI tool that spins up a single- or multi-node local Kubernetes cluster with support for standard features like LoadBalancer, NodePorts, and Persistent Volumes, aimed specifically at local development rather than production.
How do I get it running?Install minikube via the Getting Started Guide, then run 'minikube start' to launch the cluster and 'minikube dashboard' to open the web UI.
Do I need a container runtime or hypervisor installed first?You need a driver backend (container or VM runtime) on your machine; you can pick it with the '--container-runtime' flag when starting minikube, and GPU support (NVIDIA/AMD) requires the corresponding drivers for ML workloads.
Is this just for solo testing or does it support multi-cluster setups too?It supports running multiple clusters at once using profiles via 'minikube start -p', so you can test multi-cluster scenarios locally.
Does it work the same on all three major OSes?Yes, minikube explicitly supports macOS, Linux, and Windows.
Can I expose services externally for testing LoadBalancer configs?Yes, minikube provides 'minikube tunnel' to support LoadBalancer services locally.
Does minikube support GPU workloads?Yes, it has both NVIDIA and AMD GPU support for machine learning use cases.
Can I try minikube without installing anything locally?Yes, you can launch minikube in a GitHub Codespace or a local Dev Container, which boots a ready-to-use environment.
How do I add extra functionality like monitoring or ingress?Minikube has an addons marketplace where developers share configurations for running extra services on top of a minikube cluster.
What are similar projects?containerd, k9s, ingress-nginx, kops, k3s, helm, dokku, compose
Creator
kubernetes
Size
297.1 MB
Stars
32.2K
Age
10y
Commits · 90 Days