diff --git a/site/content/en/docs/Commands/_index.md b/site/content/en/docs/Commands/_index.md index 889734bd1f..a2accbac1b 100644 --- a/site/content/en/docs/Commands/_index.md +++ b/site/content/en/docs/Commands/_index.md @@ -1,7 +1,7 @@ --- title: "Commands" linkTitle: "Commands" -weight: 1 +weight: 2 date: 2019-08-01 description: > minikube command reference diff --git a/site/content/en/docs/FAQ/_index.md b/site/content/en/docs/FAQ/_index.md index 4c22c42c78..94c90fcc46 100644 --- a/site/content/en/docs/FAQ/_index.md +++ b/site/content/en/docs/FAQ/_index.md @@ -6,3 +6,14 @@ description: > Questions that come up regularly --- +## Operating-systems + +## Linux + +### Preventing password prompts + +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/docs/reference/environment_variables/) + +Alternatively, configure `sudo` to never prompt for the commands issued by minikube. diff --git a/site/content/en/docs/FAQ/sudo_prompts.md b/site/content/en/docs/FAQ/sudo_prompts.md deleted file mode 100644 index a78b9d141d..0000000000 --- a/site/content/en/docs/FAQ/sudo_prompts.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Sudo prompts" -linkTitle: "Sudo prompts" -weight: 1 -date: 2020-03-26 -description: > - Disabling sudo prompts when using minikude start/stop/status, kubectl cluster-info, ... ---- - -## Use the `docker` driver - -Use the `docker` driver rather than the `none` driver. `docker` driver should be used unless it does not meet requirements for some reason. - -## For `none` users - -For `none` users, `CHANGE_MINIKUBE_NONE_USER=true`, kubectl and such will still work: [see environment variables](https://minikube.sigs.k8s.io/docs/reference/environment_variables/) - -## Otherwise deal with `sudo` - -Configure `sudo` to never prompt for the commands issued by minikube. diff --git a/site/content/en/docs/Handbook/config.md b/site/content/en/docs/Handbook/config.md index 78b18a5dde..9c99762c53 100644 --- a/site/content/en/docs/Handbook/config.md +++ b/site/content/en/docs/Handbook/config.md @@ -1,5 +1,5 @@ --- -title: "Configuration & Tuning" +title: "Configuration" weight: 4 description: > Configuring your cluster diff --git a/site/content/en/docs/Handbook/controls.md b/site/content/en/docs/Handbook/controls.md index c8a21a302c..638926dd74 100755 --- a/site/content/en/docs/Handbook/controls.md +++ b/site/content/en/docs/Handbook/controls.md @@ -1,7 +1,6 @@ --- title: "Basic controls" -linkTitle: "Basic controls" weight: 1 description: > See minikube in action! diff --git a/site/content/en/docs/Handbook/dashboard.md b/site/content/en/docs/Handbook/dashboard.md index 2f8aae6c13..7252f2d8e5 100644 --- a/site/content/en/docs/Handbook/dashboard.md +++ b/site/content/en/docs/Handbook/dashboard.md @@ -1,6 +1,6 @@ --- title: "Dashboard" -weight: 3 +weight: 4 description: > Dashboard --- diff --git a/site/content/en/docs/Handbook/deploying.md b/site/content/en/docs/Handbook/deploying.md index a0a9bebc4f..d96b30cb87 100644 --- a/site/content/en/docs/Handbook/deploying.md +++ b/site/content/en/docs/Handbook/deploying.md @@ -1,6 +1,5 @@ --- title: "Deploying apps" -linkTitle: "Deploying apps" weight: 2 description: > How to deploy an application to minikube diff --git a/site/content/en/docs/Handbook/filesync.md b/site/content/en/docs/Handbook/filesync.md index c7f415c2d5..e88ad0c66c 100644 --- a/site/content/en/docs/Handbook/filesync.md +++ b/site/content/en/docs/Handbook/filesync.md @@ -1,8 +1,6 @@ --- title: "File Sync" -linkTitle: "File Sync" -weight: 15 -date: 2019-08-01 +weight: 12 description: > How to sync files into minikube --- diff --git a/site/content/en/docs/Handbook/accessing-host-resources.md b/site/content/en/docs/Handbook/host-access.md similarity index 98% rename from site/content/en/docs/Handbook/accessing-host-resources.md rename to site/content/en/docs/Handbook/host-access.md index 048fd69dc9..596477a1ee 100644 --- a/site/content/en/docs/Handbook/accessing-host-resources.md +++ b/site/content/en/docs/Handbook/host-access.md @@ -1,7 +1,7 @@ --- title: "Host access" date: 2017-01-05 -weight: 10 +weight: 9 description: > How to access host resources from a pod --- diff --git a/site/content/en/docs/Handbook/mount.md b/site/content/en/docs/Handbook/mount.md index a145aef97d..c4000894b0 100644 --- a/site/content/en/docs/Handbook/mount.md +++ b/site/content/en/docs/Handbook/mount.md @@ -1,6 +1,7 @@ --- title: "Mounting filesystems" date: 2017-01-05 +weight: 11 description: > How to mount a host directory into the VM --- diff --git a/site/content/en/docs/Handbook/persistent_volumes.md b/site/content/en/docs/Handbook/persistent_volumes.md index 6c483a5c41..0da5465b7b 100644 --- a/site/content/en/docs/Handbook/persistent_volumes.md +++ b/site/content/en/docs/Handbook/persistent_volumes.md @@ -1,7 +1,7 @@ --- title: "Persistent Volumes" linkTitle: "Persistent Volumes" -weight: 12 +weight: 10 date: 2019-08-01 description: > About persistent volumes (hostPath) diff --git a/site/content/en/docs/Handbook/pushing.md b/site/content/en/docs/Handbook/pushing.md index c695ae670d..f8cbb5e75f 100644 --- a/site/content/en/docs/Handbook/pushing.md +++ b/site/content/en/docs/Handbook/pushing.md @@ -1,7 +1,6 @@ --- title: "Pushing images" -date: 2019-08-05 -weight: 4 +weight: 5 description: > There are many ways to push images into minikube. --- diff --git a/site/content/en/docs/Handbook/uninstalling_minikube.md b/site/content/en/docs/Handbook/uninstalling_minikube.md index 7971e5ec98..b01809f513 100644 --- a/site/content/en/docs/Handbook/uninstalling_minikube.md +++ b/site/content/en/docs/Handbook/uninstalling_minikube.md @@ -1,72 +1,45 @@ --- -title: "Uninstall minikube" -linkTitle: "Uninstall minikube" -weight: 6 +title: "Uninstall" +linkTitle: "Uninstall" +weight: 99 +draft: true date: 2019-08-18 description: > - Reference on uninstalling minikube from your system completely. + Reference on uninstalling minikube --- -# Uninstall minikube on Windows -Following are the ways you can install minikube on Windows. Depending on how you installed minikube, please follow the guide appropriately. +NOTE: To be moved to the FAQ ## Chocolatey -If you have installed minikube using Chocolatey package manager, follow the below steps to completely uninstall minikube from your system - + - Open a command prompt with Administrator privileges. -- We need to delete the cluster which was created by minikube - `minikube delete` +- Run `minikube delete --purge --all` - Run, `choco uninstall minikube` to remove the minikube package from your system. -- Now, navigate to your User Folder - `C:\Users\YOUR_USER_NAME` (You can also find the path by expanding the environment variable `%USERPROFILE%`) -- In this folder, delete the `.minikube` folder. ## Windows Installer -If you have downloaded and installed minikube using the Windows Installer provided in our Releases, kindly follow the below steps - + - Open a command prompt with Administrator privileges. -- We need to delete the cluster which was created by minikube - `minikube delete` -- Now, open the Run dialog box (**Win+R**), type in `appwiz.cpl` and hit **Enter** key. +- Run `minikube delete --purge --all` +- Open the Run dialog box (**Win+R**), type in `appwiz.cpl` and hit **Enter** key. - In there, find an entry for the Minikube installer, right click on it & click on **Uninstall**. -- Follow the onscreen prompts to uninstall minikube from your system. -- Now, navigate to your User Folder - `C:\Users\YOUR_USER_NAME` (You can also find the path by expanding the environment variable `%USERPROFILE%`) -- In this folder, delete the `.minikube` folder. ## Binary/Direct -If you have downloaded just the binary and are using it to run minikube, please follow the below steps - + - Open a command prompt with Administrator privileges. -- We need to delete the cluster which was created by minikube - `minikube delete` +- Run `minikube delete --purge --all` - Delete the minikube binary. -- Now, navigate to your User Folder - `C:\Users\YOUR_USER_NAME` (You can also find the path by expanding the environment variable `%USERPROFILE%`) -- In this folder, delete the `.minikube` folder. - - -# Uninstall minikube on Linux -## Binary/Direct -If you have installed minikube using the direct download method, follow the below steps to uninstall minikube completely from your system - -- In the shell, type in `minikube delete` to delete the minikube cluster. -- Remove the binary using `rm /usr/local/bin/minikube` -- Remove the directory containing the minikube configuration `rm -rf ~/.minikube` ## Debian/Ubuntu (Deb) -If you have installed minikube using the (deb) file, follow the below instructions - -- In the shell, type in `minikube delete` to delete the minikube cluster. -- Uninstall the minikube package completely - `sudo dpkg -P minikube` -- Remove the minikube configuration directory - `rm -rf ~/.minikube` + +- Run `minikube delete --purge --all` +- Run `sudo dpkg -P minikube` ## Fedora/Red Hat (RPM) -If you have installed minikube using RPM, follow the below steps - -- In the shell, type in `minikube delete` to delete the minikube cluster. -- Uninstall the minikube package - `sudo rpm -e minikube` -- Remove the minikube configuration directory - `rm -rf ~/.minikube` - - -# Uninstall minikube on MacOS -## Binary/Direct -If you have installed minikube using the direct download method, follow the below steps to uninstall minikube completely from your system - -- In the shell, type in `minikube delete` to delete the minikube cluster. -- Remove the binary using `rm /usr/local/bin/minikube` -- Remove the directory containing the minikube configuration `rm -rf ~/.minikube` +- Run `minikube delete --purge --all` +- Run `sudo rpm -e minikube` ## Brew -If you have installed minikube using the direct download method, follow the below steps to uninstall minikube completely from your system - -- In the shell, type in `minikube delete` to delete the minikube cluster. -- Uninstall the minikube package using `brew uninstall minikube` -- Remove the directory containing the minikube configuration `rm -rf ~/.minikube` + +- Run `minikube delete --purge --all` +- Run `brew uninstall minikube` diff --git a/site/content/en/docs/Handbook/untrusted_certs.md b/site/content/en/docs/Handbook/untrusted_certs.md new file mode 100644 index 0000000000..049f9075d7 --- /dev/null +++ b/site/content/en/docs/Handbook/untrusted_certs.md @@ -0,0 +1,35 @@ +--- +title: "Certificates" +weight: 7 +date: 2019-08-15 +description: > + All about TLS certificates +--- + +## Untrusted Root Certificates + +Many organizations deploy their own Root Certificate and CA service inside the corporate networks. +Internal websites, image repositories and other resources may install SSL server certificates issued by this CA service for security and privacy concerns. + +You may install the Root Certificate into the minikube cluster to access these corporate resources within the cluster. + +### Tutorial + +You will need a corporate X.509 Root Certificate in PEM format. If it's in DER format, convert it: + +``` +openssl x509 -inform der -in my_company.cer -out my_company.pem +``` + +Copy the certificate into the certs directory: + +```shell +mkdir -p $HOME/.minikube/certs +cp my_company.pem $HOME/.minikube/certs/my_company.pem +``` + +Then restart minikube to sync the certificates: + +```shell +minikube start +``` diff --git a/site/content/en/docs/Tutorials/continuous_integration.md b/site/content/en/docs/Tutorials/continuous_integration.md index f8392a4c0c..c4ced226c3 100644 --- a/site/content/en/docs/Tutorials/continuous_integration.md +++ b/site/content/en/docs/Tutorials/continuous_integration.md @@ -1,45 +1,30 @@ --- title: "Continuous Integration" -linkTitle: "Continuous Integration" weight: 1 -date: 2018-01-02 description: > Using minikube for Continuous Integration --- ## Overview -Most continuous integration environments are already running inside a VM, and may not support nested virtualization. The `none` driver was designed for this use case. or you could alternatively use the [Docker](https://minikube.sigs.k8s.io/docs/Drivers/docker). +Most continuous integration environments are already running inside a VM, and may not support nested virtualization. -## Prerequisites +The `docker` driver was designed for this use case, as well as the older `none` driver. -- VM running a systemd based Linux distribution - -## using none driver +## Example Here is an example, that runs minikube from a non-root user, and ensures that the latest stable kubectl is installed: ```shell -curl -Lo minikube \ +curl -LO \ https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 \ - && sudo install minikube /usr/local/bin/ - + && install minikube-linux-amd64 /tmp/ + kv=$(curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt) -curl -Lo kubectl \ +curl -LO \ https://storage.googleapis.com/kubernetes-release/release/$kv/bin/linux/amd64/kubectl \ - && sudo install kubectl /usr/local/bin/ + && install kubectl /tmp/ export MINIKUBE_WANTUPDATENOTIFICATION=false -export MINIKUBE_HOME=$HOME -export CHANGE_MINIKUBE_NONE_USER=true -export KUBECONFIG=$HOME/.kube/config - -mkdir -p $HOME/.kube $HOME/.minikube -touch $KUBECONFIG - -sudo -E minikube start --driver=none +/tmp/minikube-linux-amd64 start --driver=docker ``` - -## Alternative ways - -you could alternatively use minikube's container drivers such as [Docker](https://minikube.sigs.k8s.io/docs/Drivers/docker) or [Podman](https://minikube.sigs.k8s.io/docs/Drivers/podman). \ No newline at end of file diff --git a/site/content/en/docs/Tutorials/nginx_tcp_udp_ingress.md b/site/content/en/docs/Tutorials/nginx_tcp_udp_ingress.md index bb05c52652..97eabbbabe 100644 --- a/site/content/en/docs/Tutorials/nginx_tcp_udp_ingress.md +++ b/site/content/en/docs/Tutorials/nginx_tcp_udp_ingress.md @@ -23,9 +23,9 @@ is only configured to listen on ports 80 and 443. TCP and UDP services listening ## Configuring TCP and UDP services with the nginx ingress controller -### Enable the ingress addon +### Enable the ingress addon -Enable the minikube ingress addon with the following command: +Enable the minikube ingress addon with the following command: ```shell minikube addons enable ingress diff --git a/site/content/en/docs/Tutorials/untrusted_root_certificate.md b/site/content/en/docs/Tutorials/untrusted_root_certificate.md deleted file mode 100644 index d1b857aa73..0000000000 --- a/site/content/en/docs/Tutorials/untrusted_root_certificate.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "Untrusted Root Certificate" -linkTitle: "Untrusted Root Certificate" -weight: 1 -date: 2019-08-15 -description: > - Using minikube with Untrusted Root Certificate ---- - -## Overview - -Most organizations deploy their own Root Certificate and CA service inside the corporate networks. -Internal websites, image repositories and other resources may install SSL server certificates issued by this CA service for security and privacy concerns. -You may install the Root Certificate into the minikube cluster to access these corporate resources within the cluster. - -## Prerequisites - -- Corporate X.509 Root Certificate -- Latest minikube binary and ISO - -## Tutorial - -* The certificate must be in PEM format. You may use `openssl` to convert from DER format. - -``` -openssl x509 -inform der -in my_company.cer -out my_company.pem -``` - -* You may need to delete existing minikube cluster - -```shell -minikube delete -``` - -* Copy the certificate before creating the minikube cluster - -```shell -mkdir -p $HOME/.minikube/certs -cp my_company.pem $HOME/.minikube/certs/my_company.pem - -minikube start -```