Skip to content

Commit 606afb7

Browse files
authored
docs(website): updated documenation for hyper-v support on windows (podman-desktop#11309)
* docs(website): updated documenation for hyper-v support on windows Signed-off-by: Shipra Singh <[email protected]> * docs(website): minor edits Signed-off-by: Shipra Singh <[email protected]> * docs(website): fixed a suggestion Signed-off-by: Shipra Singh <[email protected]> --------- Signed-off-by: Shipra Singh <[email protected]>
1 parent 71edca9 commit 606afb7

File tree

3 files changed

+11
-41
lines changed

3 files changed

+11
-41
lines changed
Loading

website/docs/installation/windows-install/index.md

+6-39
Original file line numberDiff line numberDiff line change
@@ -129,52 +129,19 @@ To verify that Podman is set up:
129129

130130
### Use Hyper-V as machine provider
131131

132-
Before creating a Podman machine, you can use one of the following ways to enable it to use Hyper-V:
132+
As an administrator, you can set up a Podman machine using Hyper-V as the machine provider type. To do so, select `hyperv` from the **Provider Type** dropdown list when [creating a Podman machine](/docs/podman/creating-a-podman-machine).
133133

134-
**_Configuring an environment variable_**
134+
:::note
135135

136-
1. Perform one of the following steps:
136+
If you already have a running Podman machine with the WSL provider type, you will be prompted to set the Hyper-V machine as the default machine to avoid CLI errors.
137137

138-
- As a normal user, set the following variable at session level:
139-
140-
```shell-session
141-
> $env:CONTAINERS_MACHINE_PROVIDER = 'hyperv'
142-
```
143-
144-
- As an admin user, set the following variable at system level:
145-
146-
```shell-session
147-
# [System.Environment]::SetEnvironmentVariable('CONTAINERS_MACHINE_PROVIDER','hyperv')
148-
```
149-
150-
1. [Create and start a Podman machine](/docs/podman/creating-a-podman-machine) using the UI.
151-
152-
**_Configuring the `containers.conf` file_**
153-
154-
1. Open the `containers.conf` file on your machine. The file is usually placed at `C:\Users\myuser\AppData\Roaming\containers\`.
155-
1. Add the `provider` attribute and set its value to `hyperv` in the file.
156-
157-
```vim
158-
...
159-
[machine]
160-
161-
provider = "hyperv"
162-
...
163-
```
164-
165-
1. [Create and start a Podman machine](/docs/podman/creating-a-podman-machine) using the UI.
138+
:::
166139

167140
#### Verification
168141

169-
After configuration, you can confirm whether you are using a Podman machine with Hyper-V virtualization provider.
170-
171142
1. Go to **Settings > Resources**.
172-
1. Click the **Podman details** icon in the Podman tile.
173-
1. Select the **Logs** tab to view the following notification message:
174-
175-
```text
176-
time="2023-05-09T21:16:08+03:00" level=debug msg="Using Podman machine with `hyperv` virtualization provider"
177-
```
143+
1. View the created machine in the Podman tile.
144+
![Podman machine with the hyperv provide type](img/podman-machine-hyperv.png)
178145

179146
#### Next steps
180147

website/docs/podman/creating-a-podman-machine.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,11 @@ Consider creating a custom Podman machine to:
4444
Enable to use the rootful connection by default.
4545
Required to use Kind on Windows.
4646
1. Additional settings based on your operating system:
47-
- (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.
48-
- (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.
47+
- (On Windows)
48+
- **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.
49+
- **Provider Type**: The setting is visible only to administrators, and its default value is `wsl`.
50+
- (On macOS)
51+
- **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.
4952
1. Click **Create**.
5053

5154
![Create a Podman machine](img/create-a-podman-machine.png)

0 commit comments

Comments
 (0)