From 7ae63dd4da918a81725df56f16d70b46b41fb0fb Mon Sep 17 00:00:00 2001 From: Thomas Stromberg Date: Fri, 9 Aug 2019 17:46:01 -0700 Subject: [PATCH] Address review comments --- docs/reusing_the_docker_daemon.md | 8 ++------ .../en/docs/Reference/Drivers/hyperkit.md | 10 +++++----- .../en/docs/Reference/Drivers/hyperv.md | 2 +- .../Reference/Drivers/includes/hyperv_usage.md | 18 +++++++++++++----- .../Drivers/includes/virtualbox_usage.md | 2 +- site/content/en/docs/Reference/Drivers/kvm2.md | 8 ++++---- .../en/docs/Reference/Drivers/virtualbox.md | 4 ++-- site/content/en/docs/Tasks/loadbalancer.md | 18 +++++++++--------- .../docs/Tutorials/continuous_integration.md | 1 - 9 files changed, 37 insertions(+), 34 deletions(-) diff --git a/docs/reusing_the_docker_daemon.md b/docs/reusing_the_docker_daemon.md index 7060bb3f8..28e6511f4 100644 --- a/docs/reusing_the_docker_daemon.md +++ b/docs/reusing_the_docker_daemon.md @@ -16,13 +16,9 @@ You should now be able to use docker on the command line on your host mac/linux docker ps ``` -Docker may report following forbidden error if you are using http proxy and the `$(minikube ip)` is not added to `no_proxy`/`NO_PROXY`: +### Troubleshooting -```shell -error during connect: Get https://192.168.39.98:2376/v1.39/containers/json: Forbidden -``` - -On Centos 7, docker may report the following error: +On CentOS 7, Docker may report the following error: ```shell Could not read CA certificate "/etc/docker/ca.pem": open /etc/docker/ca.pem: no such file or directory diff --git a/site/content/en/docs/Reference/Drivers/hyperkit.md b/site/content/en/docs/Reference/Drivers/hyperkit.md index 22581e7d2..05cffe90f 100644 --- a/site/content/en/docs/Reference/Drivers/hyperkit.md +++ b/site/content/en/docs/Reference/Drivers/hyperkit.md @@ -18,11 +18,11 @@ description: > minikube start supports additional hyperkit specific flags: -* **\--hyperkit-vpnkit-sock**: Location of the VPNKit socket used for networking. If empty, disables Hyperkit VPNKitSock, if 'auto' uses Docker for Mac VPNKit connection, otherwise uses the specified VSoc -* **\--hyperkit-vsock-ports**: List of guest VSock ports that should be exposed as sockets on the host -* **\--nfs-share**: Local folders to share with Guest via NFS mounts -* **\--nfs-shares-root**: Where to root the NFS Shares (default "/nfsshares") -* **\--uuid**: Provide VM UUID to restore MAC address +* **`--hyperkit-vpnkit-sock`**: Location of the VPNKit socket used for networking. If empty, disables Hyperkit VPNKitSock, if 'auto' uses Docker for Mac VPNKit connection, otherwise uses the specified VSoc +* **`--hyperkit-vsock-ports`**: List of guest VSock ports that should be exposed as sockets on the host +* **`--nfs-share`**: Local folders to share with Guest via NFS mounts +* **`--nfs-shares-root`**: Where to root the NFS Shares (default "/nfsshares") +* **`--uuid`**: Provide VM UUID to restore MAC address ## Issues diff --git a/site/content/en/docs/Reference/Drivers/hyperv.md b/site/content/en/docs/Reference/Drivers/hyperv.md index edfa78c9c..ff14868f8 100644 --- a/site/content/en/docs/Reference/Drivers/hyperv.md +++ b/site/content/en/docs/Reference/Drivers/hyperv.md @@ -18,7 +18,7 @@ Hyper-V is a native hypervisor built in to modern versions of Microsoft Windows. The `minikube start` command supports additional hyperv specific flags: -* **\--hyperv-virtual-switch**: The hyperv virtual switch name. Defaults to first found +* **`--hyperv-virtual-switch`**: The hyperv virtual switch name. Defaults to first found ## Issues diff --git a/site/content/en/docs/Reference/Drivers/includes/hyperv_usage.md b/site/content/en/docs/Reference/Drivers/includes/hyperv_usage.md index a90c6c964..96ffa5414 100644 --- a/site/content/en/docs/Reference/Drivers/includes/hyperv_usage.md +++ b/site/content/en/docs/Reference/Drivers/includes/hyperv_usage.md @@ -2,9 +2,9 @@ * Windows 10 Pro * Hyper-V enabled -* A Hyper-V switch created +* An active Hyper-V switch -## Configuring Hyper-V +## Enabling Hyper-V Open a PowerShell console as Administrator, and run the following command: @@ -12,13 +12,21 @@ Open a PowerShell console as Administrator, and run the following command: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All ``` -Reboot, and create a new external network switch: +If Hyper-V was not previously active, you will need to reboot. + +## Network Configuration + +Create a Hyper-V external network switch + +{{% alert title="Untested" color="warning" %}} +This command is speculative, and may not work in all environments. You may need to use the Hyper-V Administrator UI for wireless interfaces. +{{% /alert %}} ```powershell -New-VMSwitch -name ExternalSwitch -NetAdapterName Ethernet -AllowManagementOS $true +New-VMSwitch -name ExternalSwitch -NetAdapterName Ethernet -AllowManagementOS $true ``` -Set this network switch as the minikube default: +Set this switch as the minikube default: ```shell minikube config set hyperv-virtual-switch ExternalSwitch diff --git a/site/content/en/docs/Reference/Drivers/includes/virtualbox_usage.md b/site/content/en/docs/Reference/Drivers/includes/virtualbox_usage.md index 148dc7b74..bb67f88d2 100644 --- a/site/content/en/docs/Reference/Drivers/includes/virtualbox_usage.md +++ b/site/content/en/docs/Reference/Drivers/includes/virtualbox_usage.md @@ -1,6 +1,6 @@ ## Requirements -- [https://www.virtualbox.org/wiki/Downloads](VirtualBox) 5.2 or higher +- [VirtualBox](https://www.virtualbox.org/wiki/Downloads) 5.2 or higher ## Usage diff --git a/site/content/en/docs/Reference/Drivers/kvm2.md b/site/content/en/docs/Reference/Drivers/kvm2.md index e5da5b34f..2b933b91a 100644 --- a/site/content/en/docs/Reference/Drivers/kvm2.md +++ b/site/content/en/docs/Reference/Drivers/kvm2.md @@ -18,13 +18,13 @@ description: > The `minikube start` command supports 3 additional kvm specific flags: -* **\--gpu**: Enable experimental NVIDIA GPU support in minikube -* **\--hidden**: Hide the hypervisor signature from the guest in minikube -* **\--kvm-network**: The KVM network name +* **`--gpu`**: Enable experimental NVIDIA GPU support in minikube +* **`--hidden`**: Hide the hypervisor signature from the guest in minikube +* **`--kvm-network`**: The KVM network name ## Issues -* `minikube` will repeatedly for root password if user is not in the correct `libvirt` group [#3467](https://github.com/kubernetes/minikube/issues/3467) +* `minikube` will repeatedly for the root password if user is not in the correct `libvirt` group [#3467](https://github.com/kubernetes/minikube/issues/3467) * `Machine didn't return an IP after 120 seconds` when firewall prevents VM network access [#3566](https://github.com/kubernetes/minikube/issues/3566) * `unable to set user and group to '65534:992` when `dynamic ownership = 1` in `qemu.conf` [#4467](https://github.com/kubernetes/minikube/issues/4467) * KVM VM's cannot be used simultaneously with VirtualBox [#4913](https://github.com/kubernetes/minikube/issues/4913) diff --git a/site/content/en/docs/Reference/Drivers/virtualbox.md b/site/content/en/docs/Reference/Drivers/virtualbox.md index 4303387eb..fa0a0350a 100644 --- a/site/content/en/docs/Reference/Drivers/virtualbox.md +++ b/site/content/en/docs/Reference/Drivers/virtualbox.md @@ -17,8 +17,8 @@ VirtualBox is the oldest and most stable VM driver for minikube. minikube start supports some VirtualBox specific flags: -* **\--host-only-cidr**: The CIDR to be used for the minikube VM (default "192.168.99.1/24") -* **\--no-vtx-check**: Disable checking for the availability of hardware virtualization +* **`--host-only-cidr`**: The CIDR to be used for the minikube VM (default "192.168.99.1/24") +* **`--no-vtx-check`**: Disable checking for the availability of hardware virtualization ## Issues diff --git a/site/content/en/docs/Tasks/loadbalancer.md b/site/content/en/docs/Tasks/loadbalancer.md index 38c70c991..2c1806386 100644 --- a/site/content/en/docs/Tasks/loadbalancer.md +++ b/site/content/en/docs/Tasks/loadbalancer.md @@ -7,8 +7,11 @@ description: > How to access a LoadBalancer service in minikube --- +## Overview + A LoadBalancer service is the standard way to expose a service to the internet. With this method, each service gets it's own IP address. + ## Using `minikube tunnel` Services of type `LoadBalancer` can be exposed via the `minikube tunnel` command. It will run until Ctrl-C is hit. @@ -33,26 +36,23 @@ Status: loadbalancer emulator: no errors ``` -Tunnel might ask you for password for creating and deleting network routes. -### DNS resolution +`minikube tunnel` runs as a separate daemon, creating a network route on the host to the service CIDR of the cluster using the cluster's IP address as a gateway. The tunnel command exposes the external IP directly to any program running on the host operating system. + +### DNS resolution (experimental) If you are on macOS, the tunnel command also allows DNS resolution for Kubernetes services from the host. ### Cleaning up orphaned routes -If the `minikube tunnel` shuts down in an unclean way, it might leave a network route around. -This case the ~/.minikube/tunnels.json file will contain an entry for that tunnel. -To cleanup orphaned routes, run: +If the `minikube tunnel` shuts down in an abrupt manner, it may leave orphaned network routes on your system. If this happens, the ~/.minikube/tunnels.json file will contain an entry for that tunnel. To remove orphaned routes, run: ````shell minikube tunnel --cleanup ```` -### Avoid entering password multiple times - -`minikube tunnel` runs as a separate daemon, creates a network route on the host to the service CIDR of the cluster using the cluster's IP address as a gateway. Adding a route requires root privileges for the user, and thus there are differences in how to run `minikube tunnel` depending on the OS. +### Avoiding password prompts -If you want to avoid entering the root password, consider setting NOPASSWD for "ip" and "route" commands: +Adding a route requires root privileges for the user, and thus there are differences in how to run `minikube tunnel` depending on the OS. If you want to avoid entering the root password, consider setting NOPASSWD for "ip" and "route" commands: diff --git a/site/content/en/docs/Tutorials/continuous_integration.md b/site/content/en/docs/Tutorials/continuous_integration.md index 41ede8471..eaf357a96 100644 --- a/site/content/en/docs/Tutorials/continuous_integration.md +++ b/site/content/en/docs/Tutorials/continuous_integration.md @@ -41,4 +41,3 @@ touch $KUBECONFIG sudo -E minikube start --vm-driver=none ``` -## Troubleshooting -- GitLab