mirror of
https://github.com/podman-desktop/podman-desktop
synced 2026-05-24 02:08:24 +00:00
docs: configuring access to Kubernetes and OpenShift clusters (#2486)
This commit is contained in:
Fabrice Flore-Thébault
GitHub
parent
0f5bf12e82
commit
22a2e2c18d
9 changed files with 199 additions and 5 deletions
|
|
@ -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 **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Preferences > Path to the kubeconfig file** to adapt your kubeconfig file location, when different from the default `$HOME/.kube/config`.
|
||||
1. Register your _`<my_kubernetes>`_ Kubernetes cluster:
|
||||
|
||||
```shell-session
|
||||
$ kubectl config set-cluster <my_kubernetes> --server=<my_kubernetes_url>
|
||||
```
|
||||
|
||||
#### 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/)
|
||||
|
|
@ -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]
|
||||
|
|
|
|||
|
|
@ -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. **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Resources** contain a **Kind** tile.
|
||||
|
||||
1. You can run the `kind` CLI:
|
||||
|
|
|
|||
|
|
@ -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 <icon icon="fa-solid fa-download" size="lg" />**.
|
||||
1. Go to **<icon icon="fa-solid fa-cog" size="lg" /> 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~<token> --server=https://api.sandbox-m2.<sandbox_id>.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 **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Resources** screen, your Developer Sandbox is running.
|
||||
|
||||
|
||||
|
||||
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)
|
||||
|
|
@ -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 <icon icon="fa-solid fa-download" size="lg" />**.
|
||||
1. Install the OpenShift Local binaries, when on the **Dashboard**, you see _Podman Desktop was not able to find an installation of OpenShift Local_.
|
||||
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">
|
||||
|
||||
1. In the **OpenShift Local** tile, click **<icon icon="fa-solid fa-rocket" size="lg" /> 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.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="mac" label="macOS">
|
||||
|
||||
1. In the **OpenShift Local** tile, click **<icon icon="fa-solid fa-rocket" size="lg" /> 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.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="linux" label="Linux">
|
||||
|
||||
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.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
1. (Optionally) Review the extension settings in **<icon icon="fa-solid fa-cog" size="lg" /> 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 **<icon icon="fa-solid fa-cog" size="lg" /> 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 **<icon icon="fa-solid fa-cog" size="lg" />Settings > Resources** screen, your OpenShift Local instance is running.
|
||||
|
||||
|
||||
|
||||
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)
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
16
website/docs/kubernetes/openshift/index.md
Normal file
16
website/docs/kubernetes/openshift/index.md
Normal file
|
|
@ -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).
|
||||
|
|
@ -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]
|
||||
|
|
|
|||
Loading…
Reference in a new issue