Restore most of the README.md text
The previous change may have been a little too drastic.pull/5071/head
parent
d384aa3150
commit
1d80585fed
52
README.md
52
README.md
|
@ -11,10 +11,54 @@
|
|||
|
||||
<img src="https://github.com/kubernetes/minikube/raw/master/images/logo/logo.png" width="100">
|
||||
|
||||
## What is minikube?
|
||||
|
||||
minikube implements a local Kubernetes cluster on macOS, Linux, and Windows.
|
||||
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.
|
||||
|
||||

|
||||
|
||||
For more information and documentation, see https://minikube.sigs.k8s.io
|
||||
## Features
|
||||
|
||||
minikube runs the latest stable release of Kubernetes, with support for standard Kubernetes features like:
|
||||
|
||||
* [LoadBalancer](https://minikube.sigs.k8s.io/docs/tasks/loadbalancer/) - using `minikube tunnel`
|
||||
* Multi-cluster - using `minikube start -p <name>`
|
||||
* NodePorts - using `minikube service`
|
||||
* [Persistent Volumes](https://minikube.sigs.k8s.io/docs/reference/persistent_volumes/)
|
||||
* Ingress
|
||||
* [Dashboard](https://minikube.sigs.k8s.io/docs/tasks/dashboard/) - `minikube dashboard`
|
||||
* [Container runtimes](https://minikube.sigs.k8s.io/docs/reference/runtimes/) - `start --container-runtime`
|
||||
* [Configure apiserver and kubelet options](https://minikube.sigs.k8s.io/docs/reference/configuration/kubernetes/) via command-line flags
|
||||
|
||||
As well as developer-friendly features:
|
||||
|
||||
* [Addons](https://minikube.sigs.k8s.io/docs/tasks/addons/) - a marketplace for developers to share configurations for running services on minikube
|
||||
* [NVIDIA GPU support](https://minikube.sigs.k8s.io/docs/tutorials/nvidia_gpu/) - for machine learning
|
||||
* [Filesystem mounts](https://minikube.sigs.k8s.io/docs/tasks/mount/)
|
||||
|
||||
**For more information, see the official [minikube website](https://minikube.sigs.k8s.io)**
|
||||
|
||||
## Installation
|
||||
|
||||
Installation methods can be found in the [Getting Started Guide](https://minikube.sigs.k8s.io/docs/start/)
|
||||
|
||||
## Documentation
|
||||
|
||||
See https://minikube.sigs.k8s.io/docs/
|
||||
|
||||
## More Examples
|
||||
|
||||
See our [examples page](https://minikube.sigs.k8s.io/docs/examples/)
|
||||
|
||||
## 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!
|
||||
* [minikube-users mailing list](https://groups.google.com/forum/#!forum/minikube-users)
|
||||
* [minikube-dev mailing list](https://groups.google.com/forum/#!forum/minikube-dev)
|
||||
* [Bi-weekly office hours, Mondays @ 10am PST](https://tinyurl.com/minikube-oh)
|
||||
|
||||
* [Contributing](https://minikube.sigs.k8s.io/docs/contributing/)
|
||||
* [Development Roadmap](https://minikube.sigs.k8s.io/docs/contributing/roadmap/)
|
||||
|
||||
|
|
Loading…
Reference in New Issue