Skip to content

Commit fd0f4d6

Browse files
committed
ENGDOCS-2515c
1 parent fa6e23b commit fd0f4d6

File tree

11 files changed

+63
-57
lines changed

11 files changed

+63
-57
lines changed

content/manuals/desktop/features/containerd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: containerd image store
3-
weight: 10
3+
weight: 60
44
description: How to activate the containerd integration feature in Docker Desktop
55
keywords: Docker, containerd, engine, image store, lazy-pull
66
toc_max: 3

content/manuals/desktop/features/desktop-cli.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
---
2-
title: Using the Docker Desktop CLI
2+
title: Use the Docker Desktop CLI
33
linkTitle: Docker Desktop CLI
4-
weight: 120
4+
weight: 90
55
description: How to use the Docker Desktop CLI
66
keywords: cli, docker desktop, macos, windows, linux
7-
params:
8-
sidebar:
9-
badge:
10-
color: green
11-
text: New
127
---
138

149
{{< summary-bar feature_name="Docker Desktop CLI" >}}

content/manuals/desktop/features/dev-environments/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ description: Dev Environments
33
keywords: Dev Environments, share, local, Compose
44
title: Overview of Dev Environments
55
linkTitle: Dev Environments
6-
weight: 40
6+
weight: 120
77
aliases:
88
- /desktop/dev-environments/
99
params:

content/manuals/desktop/features/gpu.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: GPU support in Docker Desktop
2+
title: GPU support in Docker Desktop for Windows
33
linkTitle: GPU support
4-
weight: 80
4+
weight: 40
55
description: How to use GPU in Docker Desktop
66
keywords: gpu, gpu support, nvidia, wsl2, docker desktop, windows
77
toc_max: 3
@@ -13,22 +13,27 @@ aliases:
1313
>
1414
> Currently GPU support in Docker Desktop is only available on Windows with the WSL2 backend.
1515
16-
## Using NVIDIA GPUs with WSL2
16+
Docker Desktop for Windows supports NVIDIA GPU Paravirtualization (GPU-PV) on NVIDIA GPUs, allowing containers to access GPU resources for compute-intensive workloads like AI, machine learning, or video processing.
1717

18-
Docker Desktop for Windows supports WSL 2 GPU Paravirtualization (GPU-PV) on NVIDIA GPUs. To enable WSL 2 GPU Paravirtualization, you need:
18+
## Prerequisites
1919

20-
- A machine with an NVIDIA GPU
20+
To enable WSL 2 GPU Paravirtualization, you need:
21+
22+
- A Windows machine with an NVIDIA GPU
2123
- Up to date Windows 10 or Windows 11 installation
2224
- [Up to date drivers](https://developer.nvidia.com/cuda/wsl) from NVIDIA supporting WSL 2 GPU Paravirtualization
2325
- The latest version of the WSL 2 Linux kernel. Use `wsl --update` on the command line
2426
- To make sure the [WSL 2 backend is turned on](wsl/_index.md#turn-on-docker-desktop-wsl-2) in Docker Desktop
2527

26-
To validate that everything works as expected, execute a `docker run` command with the `--gpus=all` flag. For example, the following will run a short benchmark on your GPU:
28+
## Validate GPU support
29+
30+
To confirm GPU access is working inside Docker, run the following:
2731

2832
```console
2933
$ docker run --rm -it --gpus=all nvcr.io/nvidia/k8s/cuda-sample:nbody nbody -gpu -benchmark
3034
```
31-
The output will be similar to:
35+
36+
This runs an n-body simulation benchmark on the GPU. The output will be similar to:
3237

3338
```console
3439
Run "nbody -benchmark [-numbodies=<numBodies>]" to measure performance.
@@ -58,9 +63,16 @@ GPU Device 0: "GeForce RTX 2060 with Max-Q Design" with compute capability 7.5
5863
= 2724.379 single-precision GFLOP/s at 20 flops per interaction
5964
```
6065

61-
Or if you wanted to try something more useful you could use the official [Ollama image](https://hub.docker.com/r/ollama/ollama) to run the Llama2 large language model.
66+
## Run a real-world model: Llama2 with Ollama
67+
68+
Use the [official Ollama image](https://hub.docker.com/r/ollama/ollama) to run the Llama2 LLM with GPU acceleration:
6269

6370
```console
6471
$ docker run --gpus=all -d -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama
72+
```
73+
74+
Then start the model:
75+
76+
```console
6577
$ docker exec -it ollama ollama run llama2
6678
```

content/manuals/desktop/features/kubernetes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Kubernetes on Docker Desktop runs alongside other workloads, including Swarm ser
2020

2121
## What happens when I enable Kubernetes in Docker Desktop?
2222

23-
When you enable Kubernetes in Docker Desktop, the following actions are triggered in the Docker Desktop backend and VM:
23+
The following actions are triggered in the Docker Desktop backend and VM:
2424

2525
- Generation of certificates and cluster configuration
2626
- Download and installation of Kubernetes internal components

content/manuals/desktop/features/networking.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: Understand how networking works on Docker Desktop and see the known limitations
33
keywords: networking, docker desktop, proxy, vpn, Linux, Mac, Windows
44
title: Explore networking features on Docker Desktop
5+
linkTitle: Networking
56
aliases:
67
- /desktop/linux/networking/
78
- /docker-for-mac/networking/
@@ -11,11 +12,10 @@ aliases:
1112
- /docker-for-windows/networking/
1213
- /desktop/windows/networking/
1314
- /desktop/networking/
14-
weight: 50
15+
weight: 30
1516
---
1617

17-
Docker Desktop provides several networking features to make it easier to
18-
use.
18+
Docker Desktop includes built-in networking capabilities to help you connect containers with services on your host, across containers, or through proxies and VPNs.
1919

2020
## Networking features for all platforms
2121

@@ -33,17 +33,21 @@ When you run a container with the `-p` argument, for example:
3333
$ docker run -p 80:80 -d nginx
3434
```
3535

36-
Docker Desktop makes whatever is running on port 80 in the container, in
37-
this case, `nginx`, available on port 80 of `localhost`. In this example, the
38-
host and container ports are the same. If, for example, you already have something running on port 80 of
39-
your host machine, you can connect the container to a different port:
36+
Docker Desktop makes whatever is running on port `80` in the container, in
37+
this case, `nginx`, available on port `80` of `localhost`. In this example, the
38+
host and container ports are the same.
39+
40+
To avoid conflicts with services already using port `80` on the host:
4041

4142
```console
4243
$ docker run -p 8000:80 -d nginx
4344
```
4445

45-
Now, connections to `localhost:8000` are sent to port 80 in the container. The
46-
syntax for `-p` is `HOST_PORT:CLIENT_PORT`.
46+
Now connections to `localhost:8000` are sent to port `80` in the container.
47+
48+
> [!TIP]
49+
>
50+
> The syntax for `-p` is `HOST_PORT:CLIENT_PORT`.
4751
4852
### HTTP/HTTPS Proxy support
4953

@@ -53,10 +57,6 @@ See [Proxies](/manuals/desktop/settings-and-maintenance/settings.md#proxies)
5357

5458
{{< summary-bar feature_name="SOCKS5 proxy support" >}}
5559

56-
> [!NOTE]
57-
>
58-
> Requires a Business subscription.
59-
6060
SOCKS (Socket Secure) is a protocol that facilitates the routing of network packets between a client and a server through a proxy server. It provides a way to enhance privacy, security, and network performance for users and applications.
6161

6262
You can enable SOCKS proxy support to allow outgoing requests, such as pulling images, and access Linux container backend IPs from the host.
@@ -72,7 +72,7 @@ To enable and set up SOCKS proxy support:
7272

7373
### SSH agent forwarding
7474

75-
Docker Desktop on Mac and Linux allows you to use the host’s SSH agent inside a container. To do this:
75+
Docker Desktop for Mac and Linux lets you use the host’s SSH agent inside a container. To do this:
7676

7777
1. Bind mount the SSH agent socket by adding the following parameter to your `docker run` command:
7878

@@ -104,9 +104,9 @@ services:
104104

105105
### Changing internal IP addresses
106106

107-
The internal IP addresses used by Docker can be changed from **Settings**. After changing IPs, it is necessary to reset the Kubernetes cluster and to leave any active Swarm.
107+
The internal IP addresses used by Docker can be changed from **Settings**. After changing IPs, you need to reset the Kubernetes cluster and to leave any active Swarm.
108108

109-
### There is no docker0 bridge on the host
109+
### There is no `docker0` bridge on the host
110110

111111
Because of the way networking is implemented in Docker Desktop, you cannot
112112
see a `docker0` interface on the host. This interface is actually within the
@@ -127,7 +127,7 @@ However if you are a Windows user, per-container IP addressing is possible with
127127
### I want to connect from a container to a service on the host
128128

129129
The host has a changing IP address, or none if you have no network access.
130-
We recommend that you connect to the special DNS name `host.docker.internal`,
130+
Docker recommends you connect to the special DNS name `host.docker.internal`,
131131
which resolves to the internal IP address used by the host.
132132

133133
You can also reach the gateway using `gateway.docker.internal`.
@@ -154,7 +154,7 @@ If you have installed Python on your machine, use the following instructions as
154154
Port forwarding works for `localhost`. `--publish`, `-p`, or `-P` all work.
155155
Ports exposed from Linux are forwarded to the host.
156156

157-
We recommend you publish a port, or to connect from another
157+
Docker recommends you publish a port, or to connect from another
158158
container. This is what you need to do even on Linux if the container is on an
159159
overlay network, not a bridge network, as these are not routed.
160160

content/manuals/desktop/features/synchronized-file-sharing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Synchronized file shares
3-
weight: 30
3+
weight: 50
44
description: Get started with Synchronized file shares on Docker Desktop.
55
keyword: mutagen, file sharing, docker desktop, bind mounts
66
aliases:

content/manuals/desktop/features/usbip.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Using USB/IP with Docker Desktop
33
linkTitle: USB/IP support
4-
weight: 100
4+
weight: 80
55
description: How to use USB/IP in Docker Desktop
66
keywords: usb, usbip, docker desktop, macos, windows, linux
77
toc_max: 3
@@ -11,15 +11,11 @@ aliases:
1111

1212
{{< summary-bar feature_name="USB/IP support" >}}
1313

14-
> [!NOTE]
15-
>
16-
> Available on Docker Desktop for Mac, Linux, and Windows with the Hyper-V backend.
17-
1814
USB/IP enables you to share USB devices over the network, which can then be accessed from within Docker containers. This page focuses on sharing USB devices connected to the machine you run Docker Desktop on. You can repeat the following process to attach and use additional USB devices as needed.
1915

2016
> [!NOTE]
2117
>
22-
> The Docker Desktop VM kernel image comes pre-configured with drivers for many common USB devices, but Docker can't guarantee every possible USB device will work with this setup.
18+
> Docker Desktop includes built-in drivers for many common USB devices but Docker can't guarantee every possible USB device works with this setup.
2319
2420
## Setup and use
2521

@@ -48,6 +44,8 @@ To attach the USB device, start a privileged Docker container with the PID names
4844
$ docker run --rm -it --privileged --pid=host alpine
4945
```
5046

47+
`--privileged` gives the container full access to the host, and `--pid=host` allows it to share the host’s process namespace.
48+
5149
### Step three: Enter the mount namespace of PID 1
5250

5351
Inside the container, enter the mount namespace of the `init` process to gain access to the pre-installed USB/IP tools:
@@ -56,7 +54,7 @@ Inside the container, enter the mount namespace of the `init` process to gain ac
5654
$ nsenter -t 1 -m
5755
```
5856

59-
### Step four: Use USB/IP tools
57+
### Step four: Use the USB/IP tools
6058

6159
Now you can use the USB/IP tools as you would on any other system:
6260

@@ -102,7 +100,7 @@ Example output:
102100
event0 mice
103101
```
104102

105-
### Step five: Use the attached device in another container
103+
### Step five: Access the device from another container
106104

107105
While the initial container remains running to keep the USB device operational, you can access the attached device from another container. For example:
108106

content/manuals/desktop/features/vmm.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@ title: Virtual Machine Manager for Docker Desktop on Mac
33
linkTitle: Virtual Machine Manager
44
keywords: virtualization software, resource allocation, mac, docker desktop, vm monitoring, vm performance, apple silicon
55
description: Discover Docker Desktop for Mac's Virtual Machine Manager (VMM) options, including the new Docker VMM for Apple Silicon, offering enhanced performance and efficiency
6-
weight: 110
6+
weight: 100
77
aliases:
88
- /desktop/vmm/
99
---
1010

11-
{{< summary-bar feature_name="VMM" >}}
11+
Docker Desktop supports multiple Virtual Machine Managers (VMMs) to power the Linux VM that runs containers. You can choose the most suitable option based on your system architecture (Intel or Apple Silicon), performance needs, and feature requirements. This page provides an overview of the available options.
1212

13-
The Virtual Machine Manager (VMM) in Docker Desktop for Mac is responsible for creating and managing the virtual machine used to run containers. Depending on your system architecture and performance needs, you can choose from multiple VMM options in Docker Desktop's [settings](/manuals/desktop/settings-and-maintenance/settings.md#general). This page provides an overview of the available options.
13+
To change the VMM, go to **Settings** > **General** > **Virtual Machine Manager**.
1414

1515
## Docker VMM
1616

17-
Docker VMM is a new, container-optimized hypervisor introduced in Docker Desktop 4.35 and available on Apple Silicon Macs only. Its enhanced speed and resource efficiency makes it an ideal choice for optimizing your workflow.
17+
{{< summary-bar feature_name="VMM" >}}
1818

19-
Docker VMM brings exciting advancements specifically tailored for Apple Silicon machines. By optimizing both the Linux kernel and hypervisor layers, Docker VMM delivers significant performance enhancements across common developer tasks.
19+
Docker VMM is a new, container-optimized hypervisor. By optimizing both the Linux kernel and hypervisor layers, Docker VMM delivers significant performance enhancements across common developer tasks.
2020

2121
Some key performance enhancements provided by Docker VMM include:
22-
- Faster I/O operations: With a cold cache, iterating over a large shared filesystem with `find` is 2x faster than when the Apple Virtualization Framework is used.
22+
- Faster I/O operations: With a cold cache, iterating over a large shared filesystem with `find` is 2x faster than when the Apple Virtualization framework is used.
2323
- Improved caching: With a warm cache, performance can improve by as much as 25x, even surpassing native Mac operations.
2424

2525
These improvements directly impact developers who rely on frequent file access and overall system responsiveness during containerized development. Docker VMM marks a significant leap in speed, enabling smoother workflows and faster iteration cycles.
@@ -35,9 +35,9 @@ As Docker VMM is still in Beta, there are a few known limitations:
3535
- Docker VMM does not currently support Rosetta, so emulation of amd64 architectures is slow. Docker is exploring potential solutions.
3636
- Certain databases, like MongoDB and Cassandra, may fail when using virtiofs with Docker VMM. This issue is expected to be resolved in a future release.
3737

38-
## Apple Virtualization Framework
38+
## Apple Virtualization framework
3939

40-
The Apple Virtualization Framework is a stable and well-established option for managing virtual machines on Mac. It has been a reliable choice for many Mac users over the years. This framework is best suited for developers who prefer a proven solution with solid performance and broad compatibility.
40+
The Apple Virtualization framework is a stable and well-established option for managing virtual machines on Mac. It has been a reliable choice for many Mac users over the years. This framework is best suited for developers who prefer a proven solution with solid performance and broad compatibility.
4141

4242
## QEMU (Legacy) for Apple Silicon
4343

@@ -47,7 +47,7 @@ The Apple Virtualization Framework is a stable and well-established option for m
4747
4848
QEMU is a legacy virtualization option for Apple Silicon Macs, primarily supported for older use cases.
4949

50-
Docker recommends transitioning to newer alternatives, such as Docker VMM or the Apple Virtualization Framework, as they offer superior performance and ongoing support. Docker VMM, in particular, offers substantial speed improvements and a more efficient development environment, making it a compelling choice for developers working with Apple Silicon.
50+
Docker recommends transitioning to newer alternatives, such as Docker VMM or the Apple Virtualization framework, as they offer superior performance and ongoing support. Docker VMM, in particular, offers substantial speed improvements and a more efficient development environment, making it a compelling choice for developers working with Apple Silicon.
5151

5252
Note that this is not related to using QEMU to emulate non-native architectures in [multi-platform builds](/manuals/build/building/multi-platform.md#qemu).
5353

content/manuals/desktop/features/wsl/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ keywords: wsl, wsl2, installing wsl2, wsl installation, docker wsl2, wsl docker,
55
tech preview, wsl install docker, install docker wsl, how to install docker in wsl
66
title: Docker Desktop WSL 2 backend on Windows
77
linkTitle: WSL
8-
weight: 90
8+
weight: 110
99
aliases:
1010
- /docker-for-windows/wsl/
1111
- /docker-for-windows/wsl-tech-preview/

0 commit comments

Comments
 (0)