diff --git a/website/docs/installation/macos-install.md b/website/docs/installation/macos-install.md index f098f44ad..345a29352 100644 --- a/website/docs/installation/macos-install.md +++ b/website/docs/installation/macos-install.md @@ -67,6 +67,38 @@ Podman Desktop requires [Podman Engine](https://docs.podman.io/en/latest/index.h 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. + ## Getting Started Learn more on how to get started with Podman Desktop by clicking [here](/docs/containers). diff --git a/website/docs/installation/windows-install/index.md b/website/docs/installation/windows-install/index.md index 5393a9725..5029cb6f6 100644 --- a/website/docs/installation/windows-install/index.md +++ b/website/docs/installation/windows-install/index.md @@ -144,7 +144,7 @@ Before creating a Podman machine, you can use one of the following ways to enabl # [System.Environment]::SetEnvironmentVariable('CONTAINERS_MACHINE_PROVIDER','hyperv') ``` -1. [Create and start a Podman machine](/docs/podman/creating-a-podman-machine) using UI. +1. [Create and start a Podman machine](/docs/podman/creating-a-podman-machine) using the UI. **_Configuring the `containers.conf` file_** @@ -159,7 +159,7 @@ Before creating a Podman machine, you can use one of the following ways to enabl ... ``` -1. [Create and start a Podman machine](/docs/podman/creating-a-podman-machine) using UI. +1. [Create and start a Podman machine](/docs/podman/creating-a-podman-machine) using the UI. #### Verification After configuration, you can confirm whether you are using a Podman machine with Hyper-V virtualization provider. diff --git a/website/docs/podman/creating-a-podman-machine.md b/website/docs/podman/creating-a-podman-machine.md index ab873fbfa..606c41ba2 100644 --- a/website/docs/podman/creating-a-podman-machine.md +++ b/website/docs/podman/creating-a-podman-machine.md @@ -43,9 +43,9 @@ Consider creating a custom Podman machine to: 1. **Machine with root privileges**: Enable to use the rootful connection by default. Required to use Kind on Windows. - 1. (On Windows) **User mode networking (traffic relayed by a user process)**: - Enable to route the traffic through the network connection from your Windows session. - Required to access resources behind your VPN connection. + 1. Additional settings based on your operating system: + - (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. + - (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. 1. Click **Create**. ![Create a Podman machine](img/create-a-podman-machine.png) diff --git a/website/docs/troubleshooting/troubleshooting-podman-on-macos.md b/website/docs/troubleshooting/troubleshooting-podman-on-macos.md index f73007241..99310a078 100644 --- a/website/docs/troubleshooting/troubleshooting-podman-on-macos.md +++ b/website/docs/troubleshooting/troubleshooting-podman-on-macos.md @@ -243,3 +243,29 @@ For M3 processors: #### Additional resources - [Issue #20776](https://github.com/containers/podman/issues/20776) + +## `podman machine` CLI commands do not work with `libkrun` provider type without manual configuration + +When you create a Podman machine with the `GPU enabled (LibKrun)` provider type, all the `podman machine` CLI commands stop working. + +**_Podman machine is not listed_** +```shell-session +$ podman machine list +NAME VM TYPE CREATED LAST UP CPUS MEMORY DISK SIZE +``` + +**_Error: interacting with the default Podman machine_** +```shell-session +$ podman machine ssh +Error: vm podman-machine-default not found: podman-machine-default: VM does not exist +``` + +#### Workaround + +- Prefix each `podman machine` command with +`CONTAINERS_MACHINE_PROVIDER=libkrun`. For example, `CONTAINERS_MACHINE_PROVIDER=libkrun podman machine ls`. +- Manually configure the `containers.conf` file or the `CONTAINERS_MACHINE_PROVIDER` environment variable. See [Using `libkrun` as machine provider](/docs/installation/macos-install#using-libkrun-as-machine-provider). + +#### Additional resources + +- [Issue #9860](https://github.com/podman-desktop/podman-desktop/issues/9860) \ No newline at end of file diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 57adccb36..fc58e25de 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -104,6 +104,10 @@ const config = { to: '/docs/kubernetes', from: '/docs/onboarding-for-kubernetes', }, + { + to: '/docs/kubernetes/deploying-a-pod-to-kubernetes', + from: '/docs/kubernetes/deploying-a-container-to-kubernetes', + }, { to: '/docs/containers/onboarding', from: ['/docs/onboarding-for-containers', '/docs/onboarding', '/docs/onboarding/containers'],