docs: updated content to show libkrun as the default machine provider on macOS (#12856)

* docs: updated content to show libkrun as the default machine provide on macOS

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: minor edits

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: corrected a link

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: added a note

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: minor edits

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: incorporated SME feedback

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: minor edits

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: removed the section using libkrun as default provider

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: minor edits

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: fixed formatting

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: corrected formattingusing prettier

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: fixed formatting

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: minor edits

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: added screenshots

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: updated screenshots

Signed-off-by: Shipra Singh <shipsing@redhat.com>

* docs: updates to screenshots

Signed-off-by: Shipra Singh <shipsing@redhat.com>

---------

Signed-off-by: Shipra Singh <shipsing@redhat.com>
This commit is contained in:
Shipra Singh 2025-07-22 12:37:41 +05:30 committed by GitHub
parent ac41ba41b4
commit bd7d643e4d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 21 additions and 42 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 101 KiB

After

Width:  |  Height:  |  Size: 184 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 179 KiB

After

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 266 KiB

After

Width:  |  Height:  |  Size: 279 KiB

View file

@ -1,21 +1,25 @@
---
sidebar_position: 3
title: macOS
description: How to install Podman Desktop and Podman on macOS.
tags: [podman-desktop, installing, macOS]
keywords: [podman desktop, containers, podman, installing, installation, macOS]
---
# MacOS
This page contains information regarding installation of Podman Desktop on MacOS.
You can install Podman Desktop on Mac:
You can install Podman Desktop on macOS:
1. Using the .dmg file
2. Using Brew
2. Using Homebrew
:::info[Prerequisite]
Podman Desktop requires [Podman Engine](https://docs.podman.io/en/latest/index.html). If you don't have Podman Engine installed, Podman Desktop will prompt you to do so at a later stage.
:::
## Installing Podman Desktop on MacOS using .dmg file
## Installing Podman Desktop on macOS using .dmg file
1. Download the `.dmg` file from the [Downloads](/downloads/macos) section of this website.
@ -46,7 +50,7 @@ Podman Desktop requires [Podman Engine](https://docs.podman.io/en/latest/index.h
1. After the installation is complete, close the installation program. Podman Engine has been installed and you are now ready to use Podman Desktop.
## Installing Podman Desktop on MacOS using [brew](https://brew.sh/)
## Installing Podman Desktop on macOS using Homebrew
:::info[Prerequisite]
@ -63,42 +67,9 @@ Podman Desktop requires [Podman Engine](https://docs.podman.io/en/latest/index.h
brew install podman-desktop
```
Brew will also install the Podman Engine along with the Podman Desktop application, in case you don't have it installed yet.
Homebrew will also install the Podman Engine along with the Podman Desktop application, in case you don't have it installed yet.
After the command is executed, you can find the Podman Desktop Application within the `Applications` directory of the MacOS.
## Using `libkrun` as machine provider
By default, Podman uses the `Apple HyperVisor` provider type. If you are already running an `Apple HyperVisor` Podman machine and want to create a `GPU enabled (LibKrun)` machine, reset the Podman machine to avoid any port conflicts:
- Using the UI: Click the **Troubleshooting** icon in the status bar and then **Cleanup / Purge data**.
- Using the CLI: Run the `podman machine reset` command.
To use `podman machine` CLI commands with the `libkrun` provider type, configure the machine provider manually using one of the following ways:
**_Configuring an environment variable_**
1. Set the following variable:
```shell-session
export CONTAINERS_MACHINE_PROVIDER=libkrun
```
1. [Create and start a Podman machine](/docs/podman/creating-a-podman-machine) using the UI.
**_Configuring the `containers.conf` file_**
1. Open the `containers.conf` file, which is placed in the `$HOME/.config/containers` directory.
1. Add the `provider` attribute and set its value to `libkrun` in the file.
```vim
...
[machine]
provider = "libkrun"
...
```
1. [Create and start a Podman machine](/docs/podman/creating-a-podman-machine) using the UI.
After the command is executed, you can find the Podman Desktop application in the `Applications` directory of macOS.
## Getting Started

View file

@ -23,6 +23,12 @@ Consider creating a custom Podman machine to:
- The Podman executable is installed.
:::note
On the macOS ARM64 platform, you might get a warning that the `krunkit` binary is unavailable on the _Create Podman machine_ page. To resolve the warning, [install `krunkit` manually](https://github.com/containers/krunkit?tab=readme-ov-file#installation) or [install Podman using the GitHub installer](https://github.com/containers/podman/releases).
:::
#### Procedure
1. Go to **Settings > Resources**.
@ -46,8 +52,10 @@ Consider creating a custom Podman machine to:
- (On Windows)
- **User mode networking (traffic relayed by a user process)**: Enable to route the traffic through the network connection from your Windows session. This setting is required to access resources behind your VPN connection.
- **Provider Type**: The setting is visible only to administrators, and its default value is `wsl`.
- (On macOS)
- **Provider Type**: The default value is `Apple HyperVisor`. Before switching to `GPU enabled (LibKrun)`, ensure that you have [configured the machine provider](/docs/installation/macos-install#using-libkrun-as-machine-provider) manually.
- (On macOS) **Provider Type**:
- For the macOS ARM64 platform, the default value is `GPU enabled (LibKrun)`. However, you can switch to `Apple HyperVisor` when needed.
- For the macOS AMD64 platform, the default value is `Apple HyperVisor`, and you cannot use the `GPU enabled (LibKrun)` provider.
1. Click **Create**.
![Create a Podman machine](img/create-a-podman-machine.png)
![Create a Podman machine](img/create-a-podman-machine.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 213 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 144 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 141 KiB

After

Width:  |  Height:  |  Size: 160 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 90 KiB