diff --git a/website/docs/kubernetes/configuring-access-to-a-kubernetes-cluster.md b/website/docs/kubernetes/configuring-access-to-a-kubernetes-cluster.md new file mode 100644 index 00000000000..396f1caf672 --- /dev/null +++ b/website/docs/kubernetes/configuring-access-to-a-kubernetes-cluster.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 1 +title: Configuring access +description: Configuring access to a Kubernetes cluster +keywords: [podman desktop, podman, containers, pods, migrating, kubernetes] +tags: [migrating-to-kubernetes] +--- + +# Configuring access to a Kubernetes cluster + +Podman Desktop configures the access to Kubernetes clusters automatically when: + +- [Creating a Kind-powered local Kubernetes cluster](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). + +You can also use the Kubernetes CLI to configure access to your Kubernetes cluster: + +#### Prerequisites + +- You have credentials for your Kubernetes cluster. + +#### Procedure + +1. (Optionally) Go to ** Settings > Preferences > Path to the kubeconfig file** to adapt your kubeconfig file location, when different from the default `$HOME/.kube/config`. +1. Register your _``_ Kubernetes cluster: + + ```shell-session + $ kubectl config set-cluster --server= + ``` + +#### Verification + +- You can [view and select the Kubernetes cluster in Podman Desktop](viewing-and-selecting-current-kubernete-context) + +#### Additional resopurces + +- [Kubernetes documentation: Configure access to multiple clusters](https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/) diff --git a/website/docs/kubernetes/kind/index.md b/website/docs/kubernetes/kind/index.md index ad218994110..a2fabb74141 100644 --- a/website/docs/kubernetes/kind/index.md +++ b/website/docs/kubernetes/kind/index.md @@ -1,6 +1,6 @@ --- -sidebar_position: 1 -title: Kind +sidebar_position: 10 +title: Working with 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] diff --git a/website/docs/kubernetes/kind/installing-kind.md b/website/docs/kubernetes/kind/installing-kind.md index 6f60222ad2f..854e10b37b1 100644 --- a/website/docs/kubernetes/kind/installing-kind.md +++ b/website/docs/kubernetes/kind/installing-kind.md @@ -15,7 +15,7 @@ tags: [migrating-to-kubernetes, kind] #### Verification -1. The status bar doesn't display **Kind**. +1. The status bar does not display **Kind**. 1. ** Settings > Resources** contain a **Kind** tile. ![Kind resource tile](img/kind-resource.png) 1. You can run the `kind` CLI: diff --git a/website/docs/kubernetes/openshift/configuring-access-to-a-developer-sandbox.md b/website/docs/kubernetes/openshift/configuring-access-to-a-developer-sandbox.md new file mode 100644 index 00000000000..2574ef77bcb --- /dev/null +++ b/website/docs/kubernetes/openshift/configuring-access-to-a-developer-sandbox.md @@ -0,0 +1,49 @@ +--- +sidebar_position: 1 +title: Developer Sandbox +description: Configuring access to a Developer Sandbox +keywords: [podman desktop, podman, containers, pods, migrating, kubernetes, openshift] +tags: [migrating-to-kubernetes, openshift] +--- + +# Configuring access to a Developer Sandbox + +The [Developer Sandbox](https://developers.redhat.com/developer-sandbox) is a free, private OpenShift environment including one project and a resource quota of 14 GB RAM, and 40 GB storage. +It lasts 30 days. + +With Podman Desktop, you can configure access to your Developer Sandbox instances. + +#### Prerequisites + +- [Register a Red Hat account](https://developers.redhat.com/register). + +#### Procedure + +1. Install the _Developer Sandbox_ extension: go to **Dashboard**, and click **Developer Sandbox **. +1. Go to ** Settings > Resources**. +1. In the **Developer Sandbox** tile, click **Create new**. +1. In the **Create a Developer Sandbox** screen, click **Log into Developer Sandbox**. +1. In the **Open external website** dialog, click **Yes**. +1. In the [Developer Sandbox website](https://developers.redhat.com/developer-sandbox): + 1. Click **Start your sandbox for free** + 1. If you never used this service, you might get through a verification workflow. + 1. In the **Login with...** screen, click **DevSandbox**. + 1. In your Developer Sandbox Console, click on **your login name > Copy login command** from the menu. + 1. In the **Login with...** screen, click **DevSandbox**. + 1. Click **Display Token**. + 1. Copy the **Log in with this token** full login command, similar to: `oc login --token=sha256~ --server=https://api.sandbox-m2..openshiftapps.com:6443`. +1. Get back to Podman Desktop **Create a Developer Sandbox** screen. + 1. **Context name**: Enter a name such as `Developer Sandbox`. + 2. **Login command**: Paste the `oc login` command that you copied previously. +1. The **Creation** screen displays _Successful operation_. Click **Go back to Resources**. + +#### Verification + +1. On the ** Settings > Resources** screen, your Developer Sandbox is running. + + ![Developer Sandbox is running](img/resources-developer-sandbox-running.png) + +1. [Select your Developer Sandbox in the Podman Desktop tray](../viewing-and-selecting-current-kubernete-context) +1. Run basic tasks such as: + - [Deploying a container](../deploying-a-container-to-kubernetes) + - [Deploying a pod](../deploying-a-pod-to-kubernetes) diff --git a/website/docs/kubernetes/openshift/creating-an-openshift-local-cluster.md b/website/docs/kubernetes/openshift/creating-an-openshift-local-cluster.md new file mode 100644 index 00000000000..1079d5dd158 --- /dev/null +++ b/website/docs/kubernetes/openshift/creating-an-openshift-local-cluster.md @@ -0,0 +1,91 @@ +--- +sidebar_position: 1 +title: OpenShift Local +description: Creating an OpenShift Local instance +keywords: [podman desktop, podman, containers, pods, migrating, kubernetes, openshift] +tags: [migrating-to-kubernetes, openshift] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Creating an OpenShift Local instance + +[Red Hat OpenShift Local](https://developers.redhat.com/products/openshift-local/overview) manages a minimal OpenShift or MicroShift cluster on your workstation for local development and testing. + +With Podman Desktop and the OpenShift Local extension, you can manage your OpenShift Local instances. + +#### Prerequisites + +- [Register a Red Hat account](https://developers.redhat.com/register). + +#### Procedure + +1. Install the _OpenShift Local_ extension: on to **Dashboard**, click **OpenShift Local **. +1. Install the OpenShift Local binaries, when on the **Dashboard**, you see _Podman Desktop was not able to find an installation of OpenShift Local_. + + + + + 1. In the **OpenShift Local** tile, click ** Install**. + 1. When prerequisites are missing, follow the instructions. + 1. In the **Red Hat OpenShift Local** screen, click **Yes** to start the installation. + 1. Follow the installation program instructions. + 1. Reboot to finalize system changes. + + + + + 1. In the **OpenShift Local** tile, click ** Install**. + 1. When prerequisites are missing, follow the instructions. + 1. In the **Red Hat OpenShift Local** screen, click **Yes** to start the installation. + 1. Follow the installation program instructions. + 1. Reboot to finalize system changes. + + + + + 1. Go to the [Red Hat OpenShift local download page](https://console.redhat.com/openshift/create/local). + 1. Select your platform. + 1. Click **Download OpenShift Local**. + 1. Extract the archive. + 1. Copy the `crc` binary to a directory in your`$PATH`, such as `/usr/local/bin`. + 1. To configure your system, run the command: + + ```shell-session + $ crc setup + ``` + + 1. Exit and restart Podman Desktop. + + + + +1. (Optionally) Review the extension settings in ** Settings > Preferences > Extension: Red Hat OpenShift Local**. +1. On the **Dashboard**, click **Initialize and start**. + + 1. Select your OpenShift Local Virtual machine preset, if not set in ** Settings > Preferences > Extension: Red Hat OpenShift Local > Preset**. + - _MicroShift_ (experimental): provides a lightweight and optimized environment with a limited set of services. + - _OpenShift_: provides a single node OpenShift cluster with a fuller set of services, including a web console (requires more resources). + 2. Provide a pull secret, required to pull container images from the registry: + + 1. Open the [Red Hat OpenShift Local download page](https://cloud.redhat.com/openshift/create/local). + 1. Click **Copy pull secret**. + 1. Get back to Podman Desktop. + 1. Paste the pull secret, and press `Enter`. + +#### Verification + +1. On the **Dashboard** screen, _OpenShift Local is running_. +1. On the **Settings > Resources** screen, your OpenShift Local instance is running. + + ![Developer Sandbox is running](img/resources-openshift-local-running.png) + +1. [Select your OpenShift Local instance the Podman Desktop tray](../viewing-and-selecting-current-kubernete-context). +1. Run basic tasks such as: + - [Deploying a container](../deploying-a-container-to-kubernetes) + - [Deploying a pod](../deploying-a-pod-to-kubernetes) + +#### Additional resources + +- [Red Hat OpenShift Local extension repository](https://github.com/crc-org/crc-extension) diff --git a/website/docs/kubernetes/openshift/img/resources-developer-sandbox-running.png b/website/docs/kubernetes/openshift/img/resources-developer-sandbox-running.png new file mode 100644 index 00000000000..c06195272bf Binary files /dev/null and b/website/docs/kubernetes/openshift/img/resources-developer-sandbox-running.png differ diff --git a/website/docs/kubernetes/openshift/img/resources-openshift-local-running.png b/website/docs/kubernetes/openshift/img/resources-openshift-local-running.png new file mode 100644 index 00000000000..12dba312630 Binary files /dev/null and b/website/docs/kubernetes/openshift/img/resources-openshift-local-running.png differ diff --git a/website/docs/kubernetes/openshift/index.md b/website/docs/kubernetes/openshift/index.md new file mode 100644 index 00000000000..f5b9371876f --- /dev/null +++ b/website/docs/kubernetes/openshift/index.md @@ -0,0 +1,16 @@ +--- +sidebar_position: 10 +title: Working with OpenShift +description: Working with OpenShift +keywords: [podman desktop, podman, containers, migrating, kubernetes, openshift] +tags: [migrating-to-kubernetes, openshift] +--- + +# Working with OpenShift + +With Podman Desktop, you can work on [OpenShift-powered](https://openshift.com/) Kubernetes clusters. + +To get started, configure access to an OpenShift cluster, and optionally, create the 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/viewing-and-selecting-current-kubernete-context.md b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md index 785f7674f98..eea276d7eb5 100644 --- a/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md +++ b/website/docs/kubernetes/viewing-and-selecting-current-kubernete-context.md @@ -1,6 +1,6 @@ --- -sidebar_position: 10 -title: Kubernetes context +sidebar_position: 2 +title: Selecting a context description: Viewing and selecting the current Kubernetes context keywords: [podman desktop, podman, containers, pods, migrating, kubernetes] tags: [migrating-to-kubernetes]