From 1d80585fed209c5f9217240d83d69f7164e3cf3e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Str=C3=B6mberg?= Date: Tue, 13 Aug 2019 17:12:27 -0700 Subject: [PATCH] Restore most of the README.md text The previous change may have been a little too drastic. --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 48 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3fb90ff5b8..20a7942d5a 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,54 @@ -## 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. ![screenshot](/images/start.jpg) -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 ` +* 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 + +![Help Wanted!](/images/help_wanted.jpg) + +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/) +