From 7ff0050ec29420bcd9bf01b24496de15395dbcb2 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Tue, 17 Dec 2024 12:48:06 +0100 Subject: [PATCH] engine: add page for the windowsfilter storage driver Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- _vale/Docker/Acronyms.yml | 1 + _vale/config/vocabularies/Docker/accept.txt | 1 + .../storage/drivers/select-storage-driver.md | 15 +++++--- .../storage/drivers/windowsfilter-driver.md | 36 +++++++++++++++++++ 4 files changed, 49 insertions(+), 4 deletions(-) create mode 100644 content/manuals/engine/storage/drivers/windowsfilter-driver.md diff --git a/_vale/Docker/Acronyms.yml b/_vale/Docker/Acronyms.yml index 8bad91e72b..4c85cb0d82 100644 --- a/_vale/Docker/Acronyms.yml +++ b/_vale/Docker/Acronyms.yml @@ -72,6 +72,7 @@ exceptions: - NET - NFS - NOTE + - NTFS - NTLM - NVDA - OCI diff --git a/_vale/config/vocabularies/Docker/accept.txt b/_vale/config/vocabularies/Docker/accept.txt index b5ec8d2713..e41fd82f88 100644 --- a/_vale/config/vocabularies/Docker/accept.txt +++ b/_vale/config/vocabularies/Docker/accept.txt @@ -183,3 +183,4 @@ userland untrusted vSphere vpnkit +windowsfilter diff --git a/content/manuals/engine/storage/drivers/select-storage-driver.md b/content/manuals/engine/storage/drivers/select-storage-driver.md index a4118a301b..fe441ce5fc 100644 --- a/content/manuals/engine/storage/drivers/select-storage-driver.md +++ b/content/manuals/engine/storage/drivers/select-storage-driver.md @@ -19,6 +19,12 @@ Docker host. After you have read the [storage driver overview](./_index.md), the next step is to choose the best storage driver for your workloads. Use the storage driver with the best overall performance and stability in the most usual scenarios. +> [!NOTE] +> This page discusses storage drivers for Docker Engine on Linux. If you're +> running the Docker daemon with Windows as the host OS, the only supported +> storage driver is windowsfilter. For more information, see +> [windowsfilter](windowsfilter-driver.md). + The Docker Engine provides the following storage drivers on Linux: | Driver | Description | @@ -189,7 +195,8 @@ to physical or logical disks on the Docker host. ## Related information -- [About images, containers, and storage drivers](./_index.md) -- [`overlay2` storage driver in practice](overlayfs-driver.md) -- [`btrfs` storage driver in practice](btrfs-driver.md) -- [`zfs` storage driver in practice](zfs-driver.md) +- [Storage drivers](./_index.md) +- [`overlay2` storage driver](overlayfs-driver.md) +- [`btrfs` storage driver](btrfs-driver.md) +- [`zfs` storage driver](zfs-driver.md) +- [`windowsfilter` storage driver](windowsfilter-driver.md) diff --git a/content/manuals/engine/storage/drivers/windowsfilter-driver.md b/content/manuals/engine/storage/drivers/windowsfilter-driver.md new file mode 100644 index 0000000000..a38f6d865d --- /dev/null +++ b/content/manuals/engine/storage/drivers/windowsfilter-driver.md @@ -0,0 +1,36 @@ +--- +description: Learn about the windowsfilter storage driver +keywords: container, storage, driver, windows, windowsfilter +title: windowsfilter storage driver +--- + +The windowsfilter storage driver is the default storage driver for Docker +Engine on Windows. The windowsfilter driver uses Windows-native file system +layers to for storing Docker layers and volume data on disk. The windowsfilter +storage driver only works on file systems formatted with NTFS. + +## Configure the windowsfilter storage driver + +For most use case, no configuring the windowsfilter storage driver is not +necessary. + +The default storage limit for Docker Engine on Windows is 127GB. To use a +different storage size, set the `size` option for the windowsfilter storage +driver. See [windowsfilter options](/reference/cli/dockerd.md#windowsfilter-options). + +Data is stored on the Docker host in `image` and `windowsfilter` subdirectories +within `C:\ProgramData\docker` by default. You can change the storage location +by configuring the `data-root` option in the [Daemon configuration file](/reference/cli/dockerd.md#on-windows): + +```json +{ + "data-root": "d:\\docker" +} +``` + +You must restart the daemon for the configuration change to take effect. + +## Additional information + +For more information about how container storage works on Windows, refer to +Microsoft's [Containers on Windows documentation](https://learn.microsoft.com/en-us/virtualization/windowscontainers/manage-containers/container-storage).