Skip to content

Commit c97b4b6

Browse files
committed
docs: Add warning about using btrfs storage driver
Recommend to use overlay2 and clarify that using btrfs filesystem doesn't require using the btrfs storage driver. Signed-off-by: Paweł Gronowski <[email protected]>
1 parent bce2b8b commit c97b4b6

File tree

2 files changed

+22
-7
lines changed

2 files changed

+22
-7
lines changed

content/manuals/engine/storage/drivers/btrfs-driver.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ aliases:
66
- /storage/storagedriver/btrfs-driver/
77
---
88

9+
> [!IMPORTANT]
10+
>
11+
> In most cases you should use the `overlay2` storage driver - it's not
12+
> required to use the `btrfs` storage driver simply because your system uses
13+
> Btrfs as its root filesystem.
14+
>
15+
> Btrfs driver has known issues - see [Moby issue #27653](https://github.com/moby/moby/issues/27653)
16+
> for more information.
17+
918
Btrfs is a copy-on-write filesystem that supports many advanced storage
1019
technologies, making it a good fit for Docker. Btrfs is included in the
1120
mainline Linux kernel.

content/manuals/engine/storage/drivers/select-storage-driver.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,13 +102,19 @@ With regard to Docker, the backing filesystem is the filesystem where
102102
`/var/lib/docker/` is located. Some storage drivers only work with specific
103103
backing filesystems.
104104

105-
| Storage driver | Supported backing filesystems |
106-
| :--------------- | :---------------------------- |
107-
| `overlay2` | `xfs` with ftype=1, `ext4` |
108-
| `fuse-overlayfs` | any filesystem |
109-
| `btrfs` | `btrfs` |
110-
| `zfs` | `zfs` |
111-
| `vfs` | any filesystem |
105+
| Storage driver | Supported backing filesystems |
106+
| :--------------- | :-----------------------------------------------------|
107+
| `overlay2` | `xfs` with ftype=1, `ext4`, `btrfs`, (and more\*) |
108+
| `fuse-overlayfs` | any filesystem |
109+
| `btrfs` | `btrfs` |
110+
| `zfs` | `zfs` |
111+
| `vfs` | any filesystem |
112+
113+
> [!NOTE]
114+
> \* Most filesystems should work if they have the required features.
115+
> Consult [OverlayFS](https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html)
116+
> for more information.
117+
112118

113119
## Other considerations
114120

0 commit comments

Comments
 (0)