README.md 3.6 KB
Newer Older
T
Thomas Strömberg 已提交
1
# minikube
R
r2d4 已提交
2

M
Medya Gh 已提交
3
[![Actions Status](https://github.com/kubernetes/minikube/workflows/build/badge.svg)](https://github.com/kubernetes/minikube/actions)
M
Mohammad Asif Siddiqui 已提交
4
[![GoReport Widget]][GoReport Status]
5 6 7
[![Github All Releases](https://img.shields.io/github/downloads/kubernetes/minikube/total.svg)](https://github.com/kubernetes/minikube/releases/latest)
[![Latest Release](https://img.shields.io/github/v/release/kubernetes/minikube?include_prereleases)](https://github.com/kubernetes/minikube/releases/latest)
 
M
Mohammad Asif Siddiqui 已提交
8 9 10 11

[GoReport Status]: https://goreportcard.com/report/github.com/kubernetes/minikube
[GoReport Widget]: https://goreportcard.com/badge/github.com/kubernetes/minikube

12
<img src="https://github.com/kubernetes/minikube/raw/master/images/logo/logo.png" width="100" alt="minikube logo">
R
r2d4 已提交
13

14
minikube implements a local Kubernetes cluster on macOS, Linux, and Windows. minikube's [primary goals](https://minikube.sigs.k8s.io/docs/concepts/principles/) are to be the best tool for local Kubernetes application development and to support all Kubernetes features that fit. 
R
r2d4 已提交
15

T
Thomas Strömberg 已提交
16
<img src="https://raw.githubusercontent.com/kubernetes/minikube/master/site/static/images/screenshot.png" width="575" height="322" alt="screenshot">
17

18 19 20 21
## Features

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

22
* [LoadBalancer](https://minikube.sigs.k8s.io/docs/handbook/accessing/#loadbalancer-access) - using `minikube tunnel`
23 24
* Multi-cluster - using `minikube start -p <name>`
* NodePorts - using `minikube service`
25
* [Persistent Volumes](https://minikube.sigs.k8s.io/docs/handbook/persistent_volumes/)
26
* [Ingress](https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/)
27 28 29
* [Dashboard](https://minikube.sigs.k8s.io/docs/handbook/dashboard/) - `minikube dashboard`
* [Container runtimes](https://minikube.sigs.k8s.io/docs/handbook/config/#runtime-configuration) - `start --container-runtime`
* [Configure apiserver and kubelet options](https://minikube.sigs.k8s.io/docs/handbook/config/#modifying-kubernetes-defaults) via command-line flags
30 31 32

As well as developer-friendly features:

33
* [Addons](https://minikube.sigs.k8s.io/docs/handbook/deploying/#addons) - a marketplace for developers to share configurations for running services on minikube
34
* [NVIDIA GPU support](https://minikube.sigs.k8s.io/docs/tutorials/nvidia_gpu/) - for machine learning
35
* [Filesystem mounts](https://minikube.sigs.k8s.io/docs/handbook/mount/)
36 37 38 39 40

**For more information, see the official [minikube website](https://minikube.sigs.k8s.io)**

## Installation

T
Thomas Strömberg 已提交
41 42 43
See the [Getting Started Guide](https://minikube.sigs.k8s.io/docs/start/)

:mega: **Please fill out our [fast 5-question survey](https://forms.gle/Gg3hG5ZySw8c1C24A)** so that we can learn how & why you use minikube, and what improvements we should make. Thank you! :dancers:
44 45 46 47 48

## Documentation

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

49
## More Examples
50

P
Prasad Katti 已提交
51
See minikube in action [here](https://minikube.sigs.k8s.io/docs/handbook/controls/)
52 53 54 55 56 57

## Community

minikube is a Kubernetes [#sig-cluster-lifecycle](https://github.com/kubernetes/community/tree/master/sig-cluster-lifecycle)  project.

* [**#minikube on Kubernetes Slack**](https://kubernetes.slack.com) - Live chat with minikube developers!
W
wangxy518 已提交
58 59
* [minikube-users mailing list](https://groups.google.com/g/minikube-users)
* [minikube-dev mailing list](https://groups.google.com/g/minikube-dev)
60

G
gorbondiga 已提交
61 62
* [Contributing](https://minikube.sigs.k8s.io/docs/contrib/)
* [Development Roadmap](https://minikube.sigs.k8s.io/docs/contrib/roadmap/)
63

64 65
Join our meetings:
* [Bi-weekly office hours, Mondays @ 11am PST](https://tinyurl.com/minikube-oh)
T
Thomas Strömberg 已提交
66
* [Triage Party](https://minikube.sigs.k8s.io/docs/contrib/triage/)