From 7d17554efd13b7eb2c932ff4eb45fbf592b85f8a Mon Sep 17 00:00:00 2001 From: RobinDeBock Date: Sun, 12 Jun 2022 15:52:17 +0200 Subject: [PATCH] Docs: more generic message in warning and in additional notes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Removed mentions of Windows as the fix isn't tested Update docs/book/src/clusterctl/developers.md Co-authored-by: Stefan Büringer <4662360+sbueringer@users.noreply.github.com> Update docs/book/src/clusterctl/developers.md Co-authored-by: Stefan Büringer <4662360+sbueringer@users.noreply.github.com> Update docs/book/src/user/quick-start.md Co-authored-by: Stefan Büringer <4662360+sbueringer@users.noreply.github.com> --- docs/book/src/clusterctl/developers.md | 5 ++--- docs/book/src/user/quick-start.md | 4 +--- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/book/src/clusterctl/developers.md b/docs/book/src/clusterctl/developers.md index 99bd65ee95c2..bac2f31d224b 100644 --- a/docs/book/src/clusterctl/developers.md +++ b/docs/book/src/clusterctl/developers.md @@ -189,10 +189,9 @@ The command for getting the kubeconfig file for connecting to a workload cluster clusterctl get kubeconfig capi-quickstart > capi-quickstart.kubeconfig ``` -### Fix kubeconfig (when using docker on macOS) +### Fix kubeconfig when using Docker Desktop -When using docker on macOS, you will need to do a couple of additional -steps to get the correct kubeconfig for a workload cluster created with the Docker provider: +When using using Docker Desktop on macOS or Docker Desktop (Docker Engine works fine) on Linux, you'll need to take a few extra steps to get the kubeconfig for a workload cluster created with the Docker provider. ```bash # Point the kubeconfig to the exposed port of the load balancer, rather than the inaccessible container IP. diff --git a/docs/book/src/user/quick-start.md b/docs/book/src/user/quick-start.md index 115a91dcf4fd..b314ec36f576 100644 --- a/docs/book/src/user/quick-start.md +++ b/docs/book/src/user/quick-start.md @@ -975,9 +975,7 @@ clusterctl get kubeconfig capi-quickstart > capi-quickstart.kubeconfig

Warning

-If you are using Docker on MacOS, you will need to do a couple of additional -steps to get the correct kubeconfig for a workload cluster created with the Docker provider. -See [Additional Notes for the Docker Provider](../clusterctl/developers.md#additional-notes-for-the-docker-provider). +If you're using Docker Desktop on macOS, or Docker Desktop (Docker Engine works fine) on Linux, you'll need to take a few extra steps to get the kubeconfig for a workload cluster created with the Docker provider. See [Additional Notes for the Docker provider](../clusterctl/developers.md#additional-notes-for-the-docker-provider).