From 3dbff4e2f19f7743b54d3a55b939c18de7667ad9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Wed, 20 Sep 2023 18:21:49 +0200 Subject: [PATCH] docs: moved Kind onboarding procedures to the onboarding section (#3991) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- ...figuring-access-to-a-kubernetes-cluster.md | 2 +- .../deploying-a-container-to-kubernetes.md | 2 +- .../deploying-a-pod-to-kubernetes.md | 2 +- ...uilding-an-image-and-testing-it-in-kind.md | 6 ++--- website/docs/kubernetes/kind/index.md | 10 ++++++++ .../kind/pushing-an-image-to-kind.md | 4 +++- .../working-with-your-local-kind-cluster.md | 5 ++++ ...ent-kubernete-context-in-the-status-bar.md | 2 +- ...and-selecting-current-kubernete-context.md | 2 +- website/docs/onboarding/kubernetes/index.md | 2 +- .../configuring-podman-for-kind-on-windows.md | 0 .../kind/creating-a-kind-cluster.md | 4 ++-- .../kind/deleting-your-kind-cluster.md | 2 +- .../docs/onboarding/kubernetes/kind/index.md | 23 +++++++++++++++++++ .../kubernetes/kind/installing-kind.md | 4 ++-- .../kind/restarting-your-kind-cluster.md | 4 ++-- website/docusaurus.config.js | 20 ++++++++++++++++ 17 files changed, 77 insertions(+), 17 deletions(-) rename website/docs/{ => onboarding}/kubernetes/kind/configuring-podman-for-kind-on-windows.md (100%) rename website/docs/{ => onboarding}/kubernetes/kind/creating-a-kind-cluster.md (90%) rename website/docs/{ => onboarding}/kubernetes/kind/deleting-your-kind-cluster.md (93%) create mode 100644 website/docs/onboarding/kubernetes/kind/index.md rename website/docs/{ => onboarding}/kubernetes/kind/installing-kind.md (79%) rename website/docs/{ => onboarding}/kubernetes/kind/restarting-your-kind-cluster.md (88%) diff --git a/website/docs/kubernetes/configuring-access-to-a-kubernetes-cluster.md b/website/docs/kubernetes/configuring-access-to-a-kubernetes-cluster.md index 396f1caf672..7ad0db1ffe4 100644 --- a/website/docs/kubernetes/configuring-access-to-a-kubernetes-cluster.md +++ b/website/docs/kubernetes/configuring-access-to-a-kubernetes-cluster.md @@ -10,7 +10,7 @@ tags: [migrating-to-kubernetes] Podman Desktop configures the access to Kubernetes clusters automatically when: -- [Creating a Kind-powered local Kubernetes cluster](kind/creating-a-kind-cluster). +- [Creating a Kind-powered local Kubernetes cluster](../onboarding/kubernetes/kind/creating-a-kind-cluster). - [Creating an OpenShift Local cluster](openshift/creating-an-openshift-local-cluster). - [Configuring access to a Developer Sandbox](openshift/configuring-access-to-a-developer-sandbox). diff --git a/website/docs/kubernetes/deploying-a-container-to-kubernetes.md b/website/docs/kubernetes/deploying-a-container-to-kubernetes.md index e13120fb795..5846f55e7e0 100644 --- a/website/docs/kubernetes/deploying-a-container-to-kubernetes.md +++ b/website/docs/kubernetes/deploying-a-container-to-kubernetes.md @@ -14,7 +14,7 @@ With Podman Desktop, you can deploy a container to your Kubernetes cluster. - Your are using the Podman container engine. - Your container, running or stopped, is available on the **Containers** page: __. -- You registered the Kubernetes cluster in your kubeconfig file: __. For example, [Creating a kind cluster](kind/creating-a-kind-cluster.md). +- You registered the Kubernetes cluster in your kubeconfig file: __. For example, [Creating a kind cluster](../onboarding/kubernetes/kind/creating-a-kind-cluster). - The Kubernetes namespace to deploy to already exists. #### Procedure diff --git a/website/docs/kubernetes/deploying-a-pod-to-kubernetes.md b/website/docs/kubernetes/deploying-a-pod-to-kubernetes.md index 1a6c8e7c671..d565216462e 100644 --- a/website/docs/kubernetes/deploying-a-pod-to-kubernetes.md +++ b/website/docs/kubernetes/deploying-a-pod-to-kubernetes.md @@ -14,7 +14,7 @@ With Podman Desktop, you can deploy a pod to your Kubernetes cluster. - Your are using the Podman container engine. - Your pod, running or stopped, is available on the **Pods** page: __. -- You registered the Kubernetes cluster in your kubeconfig file: __. For example, [Creating a kind cluster](kind/creating-a-kind-cluster.md). +- You registered the Kubernetes cluster in your kubeconfig file: __. For example, [Creating a kind cluster](../onboarding/kubernetes/kind/creating-a-kind-cluster). - The Kubernetes namespace to deploy to already exists. #### Procedure diff --git a/website/docs/kubernetes/kind/building-an-image-and-testing-it-in-kind.md b/website/docs/kubernetes/kind/building-an-image-and-testing-it-in-kind.md index 0391d32df07..a5cb3c2b77f 100644 --- a/website/docs/kubernetes/kind/building-an-image-and-testing-it-in-kind.md +++ b/website/docs/kubernetes/kind/building-an-image-and-testing-it-in-kind.md @@ -12,9 +12,9 @@ With Podman Desktop, you can build an image with your container engine, and test #### Prerequisites -- Podman Desktop has access to: - - A running container engine. - - A running Kind cluster. +- [You onboarded a container engine](/docs/onboarding/containers). +- [You onboarded a Kind cluster](/docs/onboarding/kubernetes/kind). +- [You have set your Kubernetes context to your local Kind-powered Kubernetes cluster](/docs/kubernetes/kind/working-with-your-local-kind-cluster). - A container definition file: `Containerfile` or `Dockerfile`. #### Procedure diff --git a/website/docs/kubernetes/kind/index.md b/website/docs/kubernetes/kind/index.md index a2fabb74141..c7171c3a56e 100644 --- a/website/docs/kubernetes/kind/index.md +++ b/website/docs/kubernetes/kind/index.md @@ -9,3 +9,13 @@ tags: [migrating-to-kubernetes, kind] # Running Kubernetes on your workstation with Kind and Podman Podman Desktop can help you run [Kind-powered](https://kind.sigs.k8s.io/) local Kubernetes clusters on a container engine, such as Podman. + +#### Prerequisites + +- [You onboarded a Kind cluster](/docs/onboarding/kubernetes/kind). + +#### Procedure + +1. [Set your Kubernetes context to your local Kind-powered Kubernetes cluster](/docs/kubernetes/kind/working-with-your-local-kind-cluster). +1. [Build an image and test it in Kind](/docs/kubernetes/kind/building-an-image-and-testing-it-in-kind). +1. [Push an image to Kind](/docs/kubernetes/kind/pushing-an-image-to-kind). diff --git a/website/docs/kubernetes/kind/pushing-an-image-to-kind.md b/website/docs/kubernetes/kind/pushing-an-image-to-kind.md index aa0bfcd95b6..411f76bb59c 100644 --- a/website/docs/kubernetes/kind/pushing-an-image-to-kind.md +++ b/website/docs/kubernetes/kind/pushing-an-image-to-kind.md @@ -12,8 +12,10 @@ With Podman Desktop, you can push an image to your local Kind-powered Kubernetes #### Prerequisites +- [You onboarded a container engine](/docs/onboarding/containers). +- [You onboarded a Kind cluster](/docs/onboarding/kubernetes/kind). +- [You have set your Kubernetes context to your local Kind-powered Kubernetes cluster](/docs/kubernetes/kind/working-with-your-local-kind-cluster). - Your image is available on the **Images** page: `:`. -- [You created a Kind cluster](creating-a-kind-cluster). #### Procedure diff --git a/website/docs/kubernetes/kind/working-with-your-local-kind-cluster.md b/website/docs/kubernetes/kind/working-with-your-local-kind-cluster.md index 04e045d91a8..38485848409 100644 --- a/website/docs/kubernetes/kind/working-with-your-local-kind-cluster.md +++ b/website/docs/kubernetes/kind/working-with-your-local-kind-cluster.md @@ -10,6 +10,11 @@ tags: [migrating-to-kubernetes, kind] Set your Kubernetes context to your local Kind-powered Kubernetes cluster. +#### Prerequisites + +- [You onboarded a Kind cluster](/docs/onboarding/kubernetes/kind). +- [You have set your Kubernetes context to your local Kind-powered Kubernetes cluster](/docs/kubernetes/kind/working-with-your-local-kind-cluster). + #### Procedure 1. Open the Podman Desktop tray. diff --git a/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.md b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.md index c1802635c30..8564410872b 100644 --- a/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.md +++ b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context-in-the-status-bar.md @@ -13,7 +13,7 @@ With Podman Desktop, you can view and select your current Kubernetes context in #### Prerequisites - You have a Kubernetes context in your kubeconfig file: __. - For example, [Creating a kind cluster](kind/creating-a-kind-cluster). + For example, [Creating a kind cluster](../onboarding/kubernetes/kind/creating-a-kind-cluster). #### Procedure diff --git a/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md index eea276d7eb5..a31fab47634 100644 --- a/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md +++ b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md @@ -16,7 +16,7 @@ With Podman Desktop, you can view and select your current Kubernetes context. #### Prerequisites - You have a Kubernetes context in your kubeconfig file: __. - For example, [Creating a kind cluster](kind/creating-a-kind-cluster). + For example, [Creating a kind cluster](../onboarding/kubernetes/kind/creating-a-kind-cluster). #### Procedure diff --git a/website/docs/onboarding/kubernetes/index.md b/website/docs/onboarding/kubernetes/index.md index 5f63730c8e5..8f085db81cc 100644 --- a/website/docs/onboarding/kubernetes/index.md +++ b/website/docs/onboarding/kubernetes/index.md @@ -22,7 +22,7 @@ To connect to a remote Kubernetes, you can: To setup Kubernetes on your workstation, you can: -- [Setup Kind on your container engine](/docs/kubernetes/kind). +- [Setup Kind on your container engine](/docs/onboarding/kubernetes/kind). - [Setup Minikube on your container engine](/docs/kubernetes/minikube). - [Setup a Lima machine with Kubernetes](/docs/onboarding/containers/creating-a-lima-instance-with-podman-desktop). - [Setup Red Hat OpenShift Local with MicroShift or OpenShift](/docs/kubernetes/openshift/creating-an-openshift-local-cluster). diff --git a/website/docs/kubernetes/kind/configuring-podman-for-kind-on-windows.md b/website/docs/onboarding/kubernetes/kind/configuring-podman-for-kind-on-windows.md similarity index 100% rename from website/docs/kubernetes/kind/configuring-podman-for-kind-on-windows.md rename to website/docs/onboarding/kubernetes/kind/configuring-podman-for-kind-on-windows.md diff --git a/website/docs/kubernetes/kind/creating-a-kind-cluster.md b/website/docs/onboarding/kubernetes/kind/creating-a-kind-cluster.md similarity index 90% rename from website/docs/kubernetes/kind/creating-a-kind-cluster.md rename to website/docs/onboarding/kubernetes/kind/creating-a-kind-cluster.md index 187a1ff2509..9805e5f1798 100644 --- a/website/docs/kubernetes/kind/creating-a-kind-cluster.md +++ b/website/docs/onboarding/kubernetes/kind/creating-a-kind-cluster.md @@ -12,8 +12,8 @@ You can create multiple local Kind-powered Kubernetes clusters. #### Prerequisites -- [You installed Kind](installing-kind). -- [On Windows, you configured Podman](configuring-podman-for-kind-on-windows). +- [You installed Kind](./installing-kind). +- [On Windows, you configured Podman](./configuring-podman-for-kind-on-windows). #### Procedure diff --git a/website/docs/kubernetes/kind/deleting-your-kind-cluster.md b/website/docs/onboarding/kubernetes/kind/deleting-your-kind-cluster.md similarity index 93% rename from website/docs/kubernetes/kind/deleting-your-kind-cluster.md rename to website/docs/onboarding/kubernetes/kind/deleting-your-kind-cluster.md index 64b93779b6a..df1534e7d3c 100644 --- a/website/docs/kubernetes/kind/deleting-your-kind-cluster.md +++ b/website/docs/onboarding/kubernetes/kind/deleting-your-kind-cluster.md @@ -10,7 +10,7 @@ tags: [migrating-to-kubernetes, kind] #### Prerequisites -- [You configured Podman](creating-a-kind-cluster.md). +- [You configured Podman](./creating-a-kind-cluster). - [You installed Kind](https://kind.sigs.k8s.io/). #### Procedure diff --git a/website/docs/onboarding/kubernetes/kind/index.md b/website/docs/onboarding/kubernetes/kind/index.md new file mode 100644 index 00000000000..a43bacad826 --- /dev/null +++ b/website/docs/onboarding/kubernetes/kind/index.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 10 +title: Onboarding Kind +description: Kind is one way to get Kubernetes running on your workstation. +keywords: [podman desktop, podman, containers, migrating, kubernetes, kind] +tags: [migrating-to-kubernetes, kind] +--- + +# Onboarding Kubernetes on your workstation with Kind and Podman + +Podman Desktop can help you run [Kind-powered](https://kind.sigs.k8s.io/) local Kubernetes clusters on a container engine, such as Podman. + +#### Procedure + +1. [Install the `kind` CLI](/docs/onboarding/kubernetes/kind/installing-kind). +2. [On Windows, configure Podman in rootful mode](/docs/onboarding/kubernetes/kind/configuring-podman-for-kind-on-windows). +3. [Create a Kind cluster](/docs/onboarding/kubernetes/kind/creating-a-kind-cluster). + +#### Next steps + +1. [Work with your Kind cluster](/docs/kubernetes/kind). +1. [Restart your Kind cluster](/docs/onboarding/kubernetes/kind/restarting-your-kind-cluster). +1. [Delete your Kind cluster](/docs/onboarding/kubernetes/kind/deleting-your-kind-cluster). diff --git a/website/docs/kubernetes/kind/installing-kind.md b/website/docs/onboarding/kubernetes/kind/installing-kind.md similarity index 79% rename from website/docs/kubernetes/kind/installing-kind.md rename to website/docs/onboarding/kubernetes/kind/installing-kind.md index 854e10b37b1..11f8d3625f2 100644 --- a/website/docs/kubernetes/kind/installing-kind.md +++ b/website/docs/onboarding/kubernetes/kind/installing-kind.md @@ -11,13 +11,13 @@ tags: [migrating-to-kubernetes, kind] #### Procedure - In the status bar, click on **Kind**, and follow the prompts. - ![Kind in the status bar](img/kind-status-bar.png) + ![Kind in the status bar](../../../kubernetes/kind/img/kind-status-bar.png) #### Verification 1. The status bar does not display **Kind**. 1. ** Settings > Resources** contain a **Kind** tile. - ![Kind resource tile](img/kind-resource.png) + ![Kind resource tile](../../../kubernetes/kind/img/kind-resource.png) 1. You can run the `kind` CLI: ```shell-session diff --git a/website/docs/kubernetes/kind/restarting-your-kind-cluster.md b/website/docs/onboarding/kubernetes/kind/restarting-your-kind-cluster.md similarity index 88% rename from website/docs/kubernetes/kind/restarting-your-kind-cluster.md rename to website/docs/onboarding/kubernetes/kind/restarting-your-kind-cluster.md index 0138663f537..b5fa6264741 100644 --- a/website/docs/kubernetes/kind/restarting-your-kind-cluster.md +++ b/website/docs/onboarding/kubernetes/kind/restarting-your-kind-cluster.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 5 title: Restarting your Kind cluster description: Restarting your local Kind-powered Kubernetes cluster. keywords: [podman desktop, podman, containers, migrating, kubernetes, kind] @@ -32,4 +32,4 @@ The Kind cluster might not restart successfully. In that case: - Consider replacing Kind with a local Kubernetes cluster that you can restart, such as [OpenShift Local](https://developers.redhat.com/products/openshift-local/). -- Consider [deleting your Kind cluster](deleting-your-kind-cluster), and [creating a Kind cluster](creating-a-kind-cluster). +- Consider [deleting your Kind cluster](./deleting-your-kind-cluster), and [creating a Kind cluster](./creating-a-kind-cluster). diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index c09cb587998..9048a43a53a 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -60,6 +60,26 @@ const config = { to: '/docs/onboarding/containers/creating-a-podman-machine-with-podman-desktop', from: ['/docs/Installation/creating-a-podman-machine-with-podman-desktop'], }, + { + to: '/docs/onboarding/kubernetes/kind/installing-kind', + from: '/docs/kubernetes/kind/installing-kind', + }, + { + to: '/docs/onboarding/kubernetes/kind/configuring-podman-for-kind-on-windows', + from: '/docs/kubernetes/kind/configuring-podman-for-kind-on-windows', + }, + { + to: '/docs/onboarding/kubernetes/kind/creating-a-kind-cluster', + from: '/docs/kubernetes/kind/creating-a-kind-cluster', + }, + { + to: '/docs/onboarding/kubernetes/kind/restarting-your-kind-cluster', + from: '/docs/kubernetes/kind/restarting-your-kind-cluster', + }, + { + to: '/docs/onboarding/kubernetes/kind/deleting-your-kind-cluster', + from: '/docs/kubernetes/kind/deleting-your-kind-cluster', + }, { to: '/docs/working-with-containers', from: ['/docs/getting-started/getting-started', '/docs/getting-started'],