diff --git a/README.md b/README.md index 3f002b3713..02308a05e2 100644 --- a/README.md +++ b/README.md @@ -23,20 +23,20 @@ minikube implements a local Kubernetes cluster on macOS, Linux, and Windows. min 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` +* [LoadBalancer](https://minikube.sigs.k8s.io/docs/handbook/accessing/#loadbalancer-access) - using `minikube tunnel` * Multi-cluster - using `minikube start -p ` * NodePorts - using `minikube service` -* [Persistent Volumes](https://minikube.sigs.k8s.io/docs/reference/persistent_volumes/) +* [Persistent Volumes](https://minikube.sigs.k8s.io/docs/handbook/persistent_volumes/) * [Ingress](https://kubernetes.io/docs/tasks/access-application-cluster/ingress-minikube/) -* [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 +* [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 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 +* [Addons](https://minikube.sigs.k8s.io/docs/handbook/deploying/#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/) +* [Filesystem mounts](https://minikube.sigs.k8s.io/docs/handbook/mount/) **For more information, see the official [minikube website](https://minikube.sigs.k8s.io)** diff --git a/site/content/en/docs/_index.md b/site/content/en/docs/_index.md index 1a552191eb..9cb97620e9 100755 --- a/site/content/en/docs/_index.md +++ b/site/content/en/docs/_index.md @@ -17,9 +17,9 @@ minikube quickly sets up a local Kubernetes cluster on macOS, Linux, and Windows * Cross-platform (Linux, macOS, Windows) * Deploy as a VM, a container, or on bare-metal * Multiple container runtimes (CRI-O, containerd, docker) -* Docker API endpoint for blazing fast [image pushes](https://minikube.sigs.k8s.io/docs/handbook/pushing/#pushing-directly-to-the-in-cluster-docker-daemon) -* Advanced features such as [LoadBalancer](https://minikube.sigs.k8s.io/Handbook/loadbalancer/), filesystem mounts, and FeatureGates -* [Addons](https://minikube.sigs.k8s.io/Handbook/addons/) for easily installed Kubernetes applications +* Docker API endpoint for blazing fast [image pushes]({{< ref "/docs/handbook/pushing.md#pushing-directly-to-the-in-cluster-docker-daemon" >}}) +* Advanced features such as [LoadBalancer]({{< ref "/docs/handbook/accessing.md#loadbalancer-access" >}}), filesystem mounts, and FeatureGates +* [Addons]({{< ref "/docs/handbook/deploying.md#addons" >}}) for easily installed Kubernetes applications ## Survey diff --git a/site/content/en/docs/faq/_index.md b/site/content/en/docs/faq/_index.md index 321bff9bae..c077acab96 100644 --- a/site/content/en/docs/faq/_index.md +++ b/site/content/en/docs/faq/_index.md @@ -14,6 +14,6 @@ description: > The easiest approach is to use the `docker` driver, as the backend service always runs as `root`. -`none` users may want to try `CHANGE_MINIKUBE_NONE_USER=true`, where kubectl and such will still work: [see environment variables](https://minikube.sigs.k8s.io/reference/environment_variables/) +`none` users may want to try `CHANGE_MINIKUBE_NONE_USER=true`, where kubectl and such will still work: [see environment variables]({{< ref "/docs/handbook/config.md#environment-variables" >}}) Alternatively, configure `sudo` to never prompt for the commands issued by minikube. diff --git a/site/content/en/docs/handbook/accessing.md b/site/content/en/docs/handbook/accessing.md index 3b79ecfd2b..9b0aedae17 100644 --- a/site/content/en/docs/handbook/accessing.md +++ b/site/content/en/docs/handbook/accessing.md @@ -5,6 +5,7 @@ description: > How to access applications running within minikube aliases: - /docs/tasks/loadbalancer + - /Handbook/loadbalancer/ - /docs/tasks/nodeport --- diff --git a/site/content/en/docs/handbook/config.md b/site/content/en/docs/handbook/config.md index 9479c3c691..3578b27ab2 100644 --- a/site/content/en/docs/handbook/config.md +++ b/site/content/en/docs/handbook/config.md @@ -3,6 +3,10 @@ title: "Configuration" weight: 4 description: > Configuring your cluster +aliases: + - /docs/reference/environment_variables/ + - /docs/reference/configuration/kubernetes/ + - /docs/reference/runtimes --- ## Basic Configuration diff --git a/site/content/en/docs/handbook/deploying.md b/site/content/en/docs/handbook/deploying.md index 209d12b1a9..0c727afb0a 100644 --- a/site/content/en/docs/handbook/deploying.md +++ b/site/content/en/docs/handbook/deploying.md @@ -5,6 +5,7 @@ description: > How to deploy an application to minikube aliases: - /docs/tasks/addons + - /Handbook/addons --- ## kubectl diff --git a/site/content/en/docs/handbook/filesync.md b/site/content/en/docs/handbook/filesync.md index bfa1551349..9b83831f48 100644 --- a/site/content/en/docs/handbook/filesync.md +++ b/site/content/en/docs/handbook/filesync.md @@ -5,6 +5,7 @@ description: > How to sync files into minikube aliases: - /docs/tasks/sync/ + - /Handbook/sync/ --- ## Built-in sync diff --git a/site/content/en/docs/handbook/persistent_volumes.md b/site/content/en/docs/handbook/persistent_volumes.md index 0da5465b7b..bb05a7944b 100644 --- a/site/content/en/docs/handbook/persistent_volumes.md +++ b/site/content/en/docs/handbook/persistent_volumes.md @@ -5,6 +5,8 @@ weight: 10 date: 2019-08-01 description: > About persistent volumes (hostPath) +aliases: + - /docs/reference/persistent_volumes --- minikube supports [PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) of type `hostPath` out of the box. These PersistentVolumes are mapped to a directory inside the running minikube instance (usually a VM, unless you use `--driver=none`, `--driver=docker`, or `--driver=podman`). For more information on how this works, read the Dynamic Provisioning section below. diff --git a/site/content/en/docs/tutorials/audit-policy.md b/site/content/en/docs/tutorials/audit-policy.md index 973986f0bb..74e87738e6 100644 --- a/site/content/en/docs/tutorials/audit-policy.md +++ b/site/content/en/docs/tutorials/audit-policy.md @@ -34,6 +34,6 @@ minikube start \ kubectl logs kube-apiserver-minikube -n kube-system | grep audit.k8s.io/v1 ``` -The [Audit Policy](https://kubernetes.io/docs/Handbook/debug-application-cluster/audit/#audit-policy) used in this tutorial is very minimal and quite verbose. As a next step you might want to finetune the `audit-policy.yaml` file. To get the changes applied you need to stop and start minikube. Restarting minikube triggers the [file sync mechanism](https://minikube.sigs.k8s.io/Handbook/sync/) that copies the yaml file onto the minikube node and causes the API server to read the changed policy file. +The [Audit Policy](https://kubernetes.io/docs/Handbook/debug-application-cluster/audit/#audit-policy) used in this tutorial is very minimal and quite verbose. As a next step you might want to finetune the `audit-policy.yaml` file. To get the changes applied you need to stop and start minikube. Restarting minikube triggers the [file sync mechanism]({{< ref "/docs/handbook/filesync.md" >}}) that copies the yaml file onto the minikube node and causes the API server to read the changed policy file. -Note: Currently there is no dedicated directory to store the `audit-policy.yaml` file in `~/.minikube/`. Using the `~/.minikube/files/etc/ssl/certs` directory is a workaround! This workaround works like this: By putting the file into a sub-directory of `~/.minikube/files/`, the [file sync mechanism](https://minikube.sigs.k8s.io/Handbook/sync/) gets triggered and copies the `audit-policy.yaml` file from the host onto the minikube node. When the API server container gets started by `kubeadm` I'll mount the `/etc/ssl/certs` directory from the minikube node into the container. This is the reason why the `audit-policy.yaml` file has to be stored in the ssl certs directory: It's one of the directories that get mounted from the minikube node into the container. +Note: Currently there is no dedicated directory to store the `audit-policy.yaml` file in `~/.minikube/`. Using the `~/.minikube/files/etc/ssl/certs` directory is a workaround! This workaround works like this: By putting the file into a sub-directory of `~/.minikube/files/`, the [file sync mechanism]({{< ref "/docs/handbook/filesync.md" >}}) gets triggered and copies the `audit-policy.yaml` file from the host onto the minikube node. When the API server container gets started by `kubeadm` I'll mount the `/etc/ssl/certs` directory from the minikube node into the container. This is the reason why the `audit-policy.yaml` file has to be stored in the ssl certs directory: It's one of the directories that get mounted from the minikube node into the container. diff --git a/site/content/en/docs/tutorials/openid_connect_auth.md b/site/content/en/docs/tutorials/openid_connect_auth.md index 769155c296..fefecd815e 100644 --- a/site/content/en/docs/tutorials/openid_connect_auth.md +++ b/site/content/en/docs/tutorials/openid_connect_auth.md @@ -13,7 +13,7 @@ Read more about OpenID Connect Authentication for Kubernetes here: }}) for more details. The following example configures your Minikube cluster to support RBAC and OIDC: