mirror of
https://github.com/podman-desktop/podman-desktop
synced 2026-05-24 10:18:53 +00:00
docs: new _Onboarding_ section (#3888)
This commit is contained in:
Fabrice Flore-Thébault
GitHub
parent
2ad5590a3e
commit
d12ed6ba2e
17 changed files with 148 additions and 77 deletions
|
|
@ -2,8 +2,8 @@
|
|||
sidebar_position: 2
|
||||
title: Installing Podman Desktop
|
||||
description: You can install Podman Desktop on Windows, macOS, and Linux.
|
||||
tags: [podman-desktop, installing, windows, macos, linux]
|
||||
keywords: [podman desktop, containers, podman, installing, installation, windows, macos, linux]
|
||||
tags: [podman-desktop, installing]
|
||||
keywords: [podman desktop, containers, podman, installing, installation]
|
||||
---
|
||||
|
||||
# Installing Podman Desktop
|
||||
|
|
@ -14,23 +14,6 @@ You can install Podman Desktop on:
|
|||
- [macOS](./installation/macos-install)
|
||||
- [Linux](./installation/linux-install)
|
||||
|
||||
Podman Desktop requires you to install at least one container engine.
|
||||
#### Next steps
|
||||
|
||||
Podman Desktop does not install any container engine automatically.
|
||||
|
||||
Podman Desktop can use different virtual machines, such as:
|
||||
|
||||
- Lima
|
||||
- Podman Machine
|
||||
|
||||
Podman Desktop can control various container engines, such as:
|
||||
|
||||
- Docker
|
||||
- Podman
|
||||
|
||||
Consider installing the Podman container engine for:
|
||||
|
||||
- Added security
|
||||
- No daemon
|
||||
- Open source
|
||||
- Rootless
|
||||
- [Onboarding](/docs/onboarding)
|
||||
|
|
|
|||
|
|
@ -24,5 +24,4 @@ Consider using this installation method if you don't require another method such
|
|||
|
||||
#### Next steps
|
||||
|
||||
- [Installing Podman](windows-install/installing-podman-with-podman-desktop)
|
||||
- [Getting Started with Podman Desktop](/docs/getting-started)
|
||||
- [Onboarding](/docs/onboarding)
|
||||
|
|
|
|||
|
|
@ -42,4 +42,4 @@ The Windows installer for restricted environments:
|
|||
|
||||
#### Next steps
|
||||
|
||||
- [Getting Started with Podman Desktop](/docs/getting-started).
|
||||
- [Onboarding](/docs/onboarding)
|
||||
|
|
|
|||
|
|
@ -21,5 +21,4 @@ Consider using this method to install the Podman Desktop Windows installer witho
|
|||
|
||||
#### Next steps
|
||||
|
||||
- [Installing Podman](installing-podman-with-podman-desktop)
|
||||
- [Getting Started with Podman Desktop](/docs/getting-started)
|
||||
- [Onboarding](/docs/onboarding)
|
||||
|
|
|
|||
|
|
@ -26,5 +26,4 @@ keywords: [podman desktop, containers, podman, installing, installation, windows
|
|||
|
||||
#### Next steps
|
||||
|
||||
- [Installing Podman](installing-podman-with-podman-desktop)
|
||||
- [Getting Started with Podman Desktop](/docs/getting-started)
|
||||
- [Onboarding](/docs/onboarding)
|
||||
|
|
|
|||
|
|
@ -27,5 +27,4 @@ keywords: [podman desktop, containers, podman, installing, installation, windows
|
|||
|
||||
#### Next steps
|
||||
|
||||
- [Installing Podman](installing-podman-with-podman-desktop)
|
||||
- [Getting Started with Podman Desktop](/docs/getting-started)
|
||||
- [Onboarding](/docs/onboarding)
|
||||
|
|
|
|||
|
|
@ -26,5 +26,4 @@ keywords: [podman desktop, containers, podman, installing, installation, windows
|
|||
|
||||
#### Next steps
|
||||
|
||||
- [Installing Podman](installing-podman-with-podman-desktop)
|
||||
- [Getting Started with Podman Desktop](/docs/getting-started)
|
||||
- [Onboarding](/docs/onboarding)
|
||||
|
|
|
|||
|
|
@ -4,37 +4,11 @@ sidebar_position: 1
|
|||
|
||||
# Introduction
|
||||
|
||||
Let's discover **Podman Desktop in less than 5 minutes**.
|
||||
Podman Desktop is an open source graphical tool enabling you to seamlessly work with containers and Kubernetes from your local environment.
|
||||
|
||||
## Getting Started
|
||||
With Podman Desktop, you can:
|
||||
|
||||
Get started by **[Downloading](/downloads) the product** for your operating system.
|
||||
|
||||
### What you'll need
|
||||
|
||||
- Podman 4.x
|
||||
- Check there is a Podman machine running
|
||||
|
||||
### Check Podman CLI is working
|
||||
|
||||
Run the development server:
|
||||
|
||||
```sh
|
||||
$ podman run quay.io/podman/hello
|
||||
!... Hello Podman World ...!
|
||||
|
||||
.--"--.
|
||||
/ - - \
|
||||
/ (O) (O) \
|
||||
~~~| -=(,Y,)=- |
|
||||
.---. /` \ |~~
|
||||
~/ o o \~~~~.----. ~~
|
||||
| =(X)= |~ / (O (O) \
|
||||
~~~~~~~ ~| =(Y_)=- |
|
||||
~~~~ ~~~| U |~~
|
||||
|
||||
Project: https://github.com/containers/podman
|
||||
Website: https://podman.io
|
||||
Documents: https://docs.podman.io
|
||||
Twitter: @Podman_io
|
||||
```
|
||||
- [Onboard for container workloads](/docs/onboarding/containers).
|
||||
- [Onboard for Kubernetes workloads](/docs/onboarding/kubernetes).
|
||||
- [Work with containers](/docs/getting-started).
|
||||
- [Work with Kubernetes](/docs/kubernetes).
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
sidebar_position: 10
|
||||
sidebar_position: 30
|
||||
title: Custom Lima instance
|
||||
description: Podman Desktop can assist you to create custom Lima instance on Linux and macOS.
|
||||
tags: [podman-desktop, podman, installing, linux, macOS]
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
sidebar_position: 11
|
||||
sidebar_position: 20
|
||||
title: Custom Podman machine
|
||||
description: Podman Desktop can assist you to create custom Podman machine on Windows and macOS.
|
||||
tags: [podman-desktop, podman, installing, windows, macOS]
|
||||
|
|
@ -47,4 +47,4 @@ Consider creating a custom Podman machine to:
|
|||
Required to access resources behind your VPN connection.
|
||||
1. Click **Create**
|
||||
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 213 KiB After Width: | Height: | Size: 213 KiB |
57
website/docs/onboarding/containers/index.md
Normal file
57
website/docs/onboarding/containers/index.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
title: Containers
|
||||
description: To run container workloads with Podman Desktop, set up at least one container engine.
|
||||
tags: [podman-desktop, onboarding]
|
||||
keywords: [podman desktop, containers, podman, onboarding]
|
||||
---
|
||||
|
||||
# Onboarding for container workloads
|
||||
|
||||
To run container workloads, set up at least one container engine.
|
||||
|
||||
Podman Desktop does not automatically set up container engine resources that you might not need.
|
||||
|
||||
#### Procedure
|
||||
|
||||
1. Select a container engine supporting your workload.
|
||||
|
||||
| Workload | Podman | Native Docker | Docker Desktop |
|
||||
| :------------------ | :----: | :-----------: | :------------: |
|
||||
| Rootless containers | ✅ yes | ✅ yes | ❌ no |
|
||||
| Rootful containers | ✅ yes | ✅ yes | ✅ yes |
|
||||
| Compose | ✅ yes | ✅ yes | ✅ yes |
|
||||
| Pods | ✅ yes | ❌ no | ❌ no |
|
||||
|
||||
Podman supports rootless container and pods, in addition to rootful containers and Compose.
|
||||
|
||||
2. Select an execution environment supporting your container engine and your operating system.
|
||||
|
||||
- Select a Podman execution environment:
|
||||
|
||||
| Host operating system | Native containers | Podman machine | Lima machine |
|
||||
| :-------------------- | :---------------: | :---------------------------: | :-------------: |
|
||||
| Windows | ❌ no | ✅ yes | ❌ experimental |
|
||||
| macOS | ❌ no | ✅ yes | ✅ yes |
|
||||
| Linux | ✅ yes | ❌ disabled in Podman Desktop | ✅ yes |
|
||||
|
||||
- Select a Docker execution environment:
|
||||
|
||||
| Host operating system | Native containers | Lima machine | Docker Desktop |
|
||||
| :-------------------- | :---------------: | :----------: | :------------: |
|
||||
| Windows | ❌ no | ❌ no | ✅ yes |
|
||||
| macOS | ❌ no | ✅ yes | ✅ yes |
|
||||
| Linux | ✅ yes | ❌ no | ✅ yes |
|
||||
|
||||
3. Setup your container engine.
|
||||
|
||||
- Podman Desktop assists you to set up Podman and Podman machines on Windows and macOS.
|
||||
|
||||
- [Installing Podman on Windows](/docs/onboarding/containers/installing-podman-with-podman-desktop-on-windows).
|
||||
- [Installing Podman with OpenShift Local on Windows](/docs/onboarding/containers/installing-podman-with-openshift-local-on-windows).
|
||||
- [Creating a Podman machine with Podman Desktop](/docs/onboarding/containers/creating-a-podman-machine-with-podman-desktop).
|
||||
|
||||
- Podman Desktop consumes your native containers, Lima machine or Docker setup.
|
||||
|
||||
- [Creating a Lima machine](/docs/onboarding/containers/creating-a-lima-instance-with-podman-desktop).
|
||||
- [Installing Podman on Linux](https://podman.io/docs/installation#installing-on-linux).
|
||||
|
|
@ -1,16 +1,16 @@
|
|||
---
|
||||
sidebar_position: 12
|
||||
sidebar_position: 11
|
||||
title: Installing Podman with OpenShift Local
|
||||
description: OpenShift Local can assist you to install Podman on Windows.
|
||||
tags: [openshift-local, podman, installing, windows]
|
||||
keywords: [podman desktop, containers, podman, installing, installation, windows]
|
||||
---
|
||||
|
||||
# Installing the Podman Preset with OpenShift Local
|
||||
# Installing the Podman Preset with OpenShift Local on Windows
|
||||
|
||||
On Windows, running the Podman container engine requires running a Linux distribution on a virtual machine.
|
||||
|
||||
Consider installing the Podman Preset in OpenShift Local rather than [installing Podman with Podman Desktop](installing-podman-with-podman-desktop) when you require one of following:
|
||||
Consider installing the Podman Preset in OpenShift Local rather than [installing Podman with Podman Desktop](/docs/onboarding/containers/installing-podman-with-podman-desktop-on-windows) when you require one of following:
|
||||
|
||||
- No WSL 2
|
||||
- Full control on the HyperV virtual machine
|
||||
|
|
@ -25,21 +25,23 @@ Consider installing the Podman Preset in OpenShift Local rather than [installing
|
|||
|
||||
#### Procedure
|
||||
|
||||
1. [Install OpenShift Local](https://console.redhat.com/openshift/create/local)
|
||||
1. Install the OpenShift Local extension.
|
||||
|
||||
2. Select the Podman container runtime preset:
|
||||
1. Install OpenShift Local.
|
||||
|
||||
1. Select the Podman container runtime preset:
|
||||
|
||||
```shell-session
|
||||
$ crc config set preset podman
|
||||
```
|
||||
|
||||
3. Set up your host machine for Red Hat OpenShift Local:
|
||||
1. Set up your host machine for Red Hat OpenShift Local:
|
||||
|
||||
```shell-session
|
||||
$ crc setup
|
||||
```
|
||||
|
||||
4. Start the Red Hat OpenShift instance:
|
||||
1. Start the Red Hat OpenShift instance:
|
||||
|
||||
```shell-session
|
||||
$ crc start
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
sidebar_position: 11
|
||||
sidebar_position: 10
|
||||
title: Installing Podman on Windows
|
||||
description: Podman Desktop can assist you to install Podman on Windows.
|
||||
tags: [podman-desktop, podman, installing, windows]
|
||||
|
|
@ -16,7 +16,7 @@ Main benefits are:
|
|||
- Ease of use
|
||||
- Windows native virtualization performance
|
||||
|
||||
Consider rather [installing Podman with OpenShift Local](installing-podman-with-openshift-local) if:
|
||||
Consider rather [installing Podman with OpenShift Local](./installing-podman-with-openshift-local-on-windows) if:
|
||||
|
||||
- You prefer working with a RHEL distribution of Linux
|
||||
- Your environment doesn't allow you to meet the prerequisites
|
||||
|
|
@ -43,7 +43,7 @@ Consider rather [installing Podman with OpenShift Local](installing-podman-with-
|
|||
|
||||
2. The **Home** screen displays _Podman Desktop was not able to find an installation of Podman_. Click on **Install**.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Podman Desktop checks the prerequites to install Podman Engine. When necessary, follow the instructions to install prerequisites.
|
||||
|
||||
16
website/docs/onboarding/index.md
Normal file
16
website/docs/onboarding/index.md
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
title: Onboarding
|
||||
description: You can install Podman Desktop on Windows, macOS, and Linux.
|
||||
tags: [podman-desktop, onboarding]
|
||||
keywords: [podman desktop, containers, podman, kubernetes, onboarding]
|
||||
---
|
||||
|
||||
# Onboarding for your container and Kubernetes workloads
|
||||
|
||||
Set up the resources that your container and Kubernetes workloads require.
|
||||
|
||||
Podman Desktop does not automatically set up resources that you might not need.
|
||||
|
||||
- [Onboarding for container workloads](/docs/onboarding/containers).
|
||||
- [Onboarding for Kubernetes workloads](/docs/onboarding/kubernetes).
|
||||
28
website/docs/onboarding/kubernetes/index.md
Normal file
28
website/docs/onboarding/kubernetes/index.md
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
title: Onboarding for Kubernetes
|
||||
description: To run Kubernetes workloads with Kubernetes, set up at least one Kubernetes context.
|
||||
tags: [podman-desktop, onboarding]
|
||||
keywords: [podman desktop, kubernetes, onboarding]
|
||||
---
|
||||
|
||||
# Onboarding for Kubernetes workloads
|
||||
|
||||
To run Kubernetes workloads, set up at least one Kubernetes context.
|
||||
|
||||
Podman Desktop does not automatically set up Kubernetes resources that you might not need.
|
||||
|
||||
#### Procedure
|
||||
|
||||
To connect to a remote Kubernetes, you can:
|
||||
|
||||
- [Select the current Kubernetes context based on your Kube config](/docs/kubernetes/viewing-and-selecting-current-kubernete-context).
|
||||
- [Setup access to a Red Hat OpenShift Sandbox](/docs/kubernetes/openshift/configuring-access-to-a-developer-sandbox).
|
||||
- [Setup access to a Kubernetes cluster](/docs/kubernetes/configuring-access-to-a-kubernetes-cluster).
|
||||
|
||||
To setup Kubernetes on your workstation, you can:
|
||||
|
||||
- [Setup Kind on your container engine](/docs/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).
|
||||
|
|
@ -44,6 +44,22 @@ const config = {
|
|||
to: '/docs/compose',
|
||||
from: ['/docs/compose/compose-spec', '/docs/compose/podman-compose'],
|
||||
},
|
||||
{
|
||||
to: '/docs/onboarding/containers/installing-podman-with-podman-desktop-on-windows',
|
||||
from: '/docs/Installation/windows-install/installing-podman-with-podman-desktop',
|
||||
},
|
||||
{
|
||||
to: '/docs/onboarding/containers/installing-podman-with-openshift-local-on-windows',
|
||||
from: '/docs/Installation/windows-install/installing-podman-with-openshift-local',
|
||||
},
|
||||
{
|
||||
to: '/docs/onboarding/containers/creating-a-lima-instance-with-podman-desktop',
|
||||
from: '/docs/Installation/creating-a-lima-instance-with-podman-desktop',
|
||||
},
|
||||
{
|
||||
to: '/docs/onboarding/containers/creating-a-podman-machine-with-podman-desktop',
|
||||
from: ['/docs/Installation/creating-a-podman-machine-with-podman-desktop'],
|
||||
},
|
||||
{
|
||||
to: '/docs/working-with-containers',
|
||||
from: ['/docs/getting-started/getting-started', '/docs/getting-started'],
|
||||
|
|
|
|||
Loading…
Reference in a new issue