From 06dcd1cb3365a62a6cf7b73b6f22acc104b3db80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Str=C3=B6mberg?= Date: Fri, 9 Aug 2019 18:38:28 -0700 Subject: [PATCH] Begin steering users to the docsy site --- README.md | 93 +++++++++---------------------------------------------- 1 file changed, 15 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 9f259f2ad..af51a25fb 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ minikube implements a local Kubernetes cluster on macOS, Linux, and Windows. ![screenshot](/images/start.jpg) -minikube's [primary goals](https://github.com/kubernetes/minikube/blob/master/docs/contributors/principles.md) are to be the best tool for local Kubernetes application development and to support all Kubernetes features that fit. We hope you enjoy it! +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. We hope you enjoy it! ## News @@ -29,28 +29,26 @@ minikube's [primary goals](https://github.com/kubernetes/minikube/blob/master/do minikube runs the latest stable release of Kubernetes, with support for standard Kubernetes features like: -* [LoadBalancer](https://github.com/kubernetes/minikube/blob/master/docs/tunnel.md) - using `minikube tunnel` +* [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://github.com/kubernetes/minikube/blob/master/docs/persistent_volumes.md) +* [Persistent Volumes](https://minikube.sigs.k8s.io/docs/reference/persistent_volumes/) * Ingress * RBAC -* [Dashboard](https://github.com/kubernetes/minikube/blob/master/docs/dashboard.md) - `minikube dashboard` -* [Container runtimes](https://github.com/kubernetes/minikube/blob/master/docs/alternative_runtimes.md) - `start --container-runtime` -* [Configure apiserver and kubelet options](https://github.com/kubernetes/minikube/blob/master/docs/configuring_kubernetes.md) via command-line flags +* [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://github.com/kubernetes/minikube/blob/master/docs/addons.md) - a marketplace for developers to share configurations for running services on minikube -* [GPU support](https://github.com/kubernetes/minikube/blob/master/docs/gpu.md) - for machine learning -* [Filesystem mounts](https://github.com/kubernetes/minikube/blob/master/docs/host_folder_mount.md) +* [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/) * Automatic failure analysis ## Documentation -* [**Installation**](https://kubernetes.io/docs/tasks/tools/install-minikube/) -* [Advanced Topics and Tutorials](https://github.com/kubernetes/minikube/blob/master/docs/README.md) -* [Contributors Guide](https://github.com/kubernetes/minikube/blob/master/docs/contributors/README.md) +See https://minikube.sigs.k8s.io/docs/ ## Community @@ -63,74 +61,13 @@ minikube is a Kubernetes [#sig-cluster-lifecycle](https://github.com/kubernetes/ * [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://github.com/kubernetes/minikube/blob/master/CONTRIBUTING.md) -* [Development Roadmap](https://github.com/kubernetes/minikube/blob/master/docs/contributors/roadmap.md) +* [Contributing](https://minikube.sigs.k8s.io/docs/contributing/) +* [Development Roadmap](https://minikube.sigs.k8s.io/docs/contributing/roadmap/) ## Installation -See the [installation guide](https://kubernetes.io/docs/tasks/tools/install-minikube/). For the impatient, here is the TL;DR: +See [getting started](https://minikube.sigs.k8s.io/docs/getting-started/) -* *macOS 10.12 (Sierra)* - * Requires installing a hypervisor, such as [hyperkit](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver) (recommended) or VirtualBox - * using [brew](https://brew.sh/): `brew cask install minikube` - * manually: `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-darwin-amd64 && sudo install minikube-darwin-amd64 /usr/local/bin/minikube` +## Examples -* *Windows 10* - * Requires a hypervisor, such as VirtualBox (recommended) or HyperV - * VT-x/AMD-v virtualization must be enabled in BIOS - * using [chocolatey](https://chocolatey.org/) `choco install minikube` - * manually: Download and run the [installer](https://storage.googleapis.com/minikube/releases/latest/minikube-installer.exe) - -* *Linux* - * Requires either the [kvm2 driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver) (recommended), or VirtualBox - * VT-x/AMD-v virtualization must be enabled in BIOS - * manually: `curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && sudo install minikube-linux-amd64 /usr/local/bin/minikube` - -### Supported Hypervisors - -`minikube start` defaults to virtualbox, but supports other drivers using the `--vm-driver` argument: - -* [KVM2](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#kvm2-driver) - Recommended Linux driver -* [hyperkit](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperkit-driver) - Recommended macOS driver -* virtualbox - Recommended Windows driver -* [none](https://github.com/kubernetes/minikube/blob/master/docs/vmdriver-none.md) - 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](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#hyperV-driver) -* [vmware](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#vmware-unified-driver) -* [parallels](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#parallels-driver) - -## Quick Start - -Start a cluster by running: - -`minikube start` - -Access Kubernetes Dashboard within Minikube: - -`minikube dashboard` - -Once started, you can interact with your cluster using `kubectl`, just like any other Kubernetes cluster. For instance, starting a server: - -`kubectl run hello-minikube --image=k8s.gcr.io/echoserver:1.4 --port=8080` - -Exposing a service as a NodePort - -`kubectl expose deployment hello-minikube --type=NodePort` - -minikube makes it easy to open this exposed 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` +See [examples](https://minikube.sigs.k8s.io/docs/examples/) -- GitLab