Desktop: improve enable kubernetes section (#14593)

* desktop: no need to mention "in a docker container" for k8s

It's an implementation detail.

Signed-off-by: David Scott <dave.scott@docker.com>

* desktop: `docker ps` rather than `docker service ls`

`docker service ls` is a Swarm API. We could use `docker container ls`
but to be honest everyone prefers `docker ps` since it's shorter.

Signed-off-by: David Scott <dave.scott@docker.com>

* desktop: move the option that no-one needs after the screenshot

We want to emphasize how easy it is to enable and avoid telling people
about advanced features which they don't need up front.

Signed-off-by: David Scott <dave.scott@docker.com>

* desktop: the section on kubectl is not a pre-req

It's not possible to use the docker-desktop kubernetes context because
it hasn't been created yet.

Signed-off-by: David Scott <dave.scott@docker.com>

* desktop: merge the kubectl sections

Signed-off-by: David Scott <dave.scott@docker.com>
This commit is contained in:
David Scott 2022-04-22 17:54:01 +01:00 committed by GitHub
parent ab445f493e
commit 6a45693de1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 19 deletions

View File

@ -15,32 +15,16 @@ is only for local testing. Enabling Kubernetes allows you to deploy
your workloads in parallel, on Kubernetes, Swarm, and as standalone containers. Enabling or disabling the Kubernetes server does not affect your other
workloads.
## Prerequisites
The Kubernetes client command `kubectl` is included and configured to connect
to the local Kubernetes server. If you have already installed `kubectl` and
pointing to some other environment, such as `minikube` or a GKE cluster, ensure you change the context so that `kubectl` is pointing to `docker-desktop`:
```console
$ kubectl config get-contexts
$ kubectl config use-context docker-desktop
```
If you installed `kubectl` using Homebrew, or by some other method, and
experience conflicts, remove `/usr/local/bin/kubectl`.
## Enable Kubernetes
To enable Kubernetes support and install a standalone instance of Kubernetes
running as a Docker container, go to **Preferences** > **Kubernetes** and then click **Enable Kubernetes**.
By default, Kubernetes containers are hidden from commands like `docker
service ls`, because managing them manually is not supported. To see these internal containers, select **Show system containers (advanced)**. Most users do not need this option.
To enable Kubernetes in Docker Desktop, go to **Preferences** > **Kubernetes** and then click **Enable Kubernetes**.
Click **Apply & Restart** to save the settings and then click **Install** to confirm. This instantiates images required to run the Kubernetes server as containers, and installs the `/usr/local/bin/kubectl` command on your machine.
![Enable Kubernetes](images/kube-enable.png){:width="750px"}
By default, Kubernetes containers are hidden from commands like `docker ps`, because managing them manually is not supported. To see these internal containers, select **Show system containers (advanced)**. Most users do not need this option.
When Kubernetes is enabled and running, an additional status bar item displays
at the bottom right of the Docker Desktop Settings dialog.
@ -60,6 +44,17 @@ at `/usr/local/bin/kubectl` on Mac and at `C:\>Program Files\Docker\Docker\Resou
variable, so you may need to type the full path of the command or add it to
the `PATH`.
If you have already installed `kubectl` and
pointing to some other environment, such as `minikube` or a GKE cluster, ensure you change the context so that `kubectl` is pointing to `docker-desktop`:
```console
$ kubectl config get-contexts
$ kubectl config use-context docker-desktop
```
If you installed `kubectl` using Homebrew, or by some other method, and
experience conflicts, remove `/usr/local/bin/kubectl`.
You can test the command by listing the available nodes:
```console