Skip to content

Commit 1d5fb9e

Browse files
vvolandaevesdocker
andauthored
docs: Add warning about using btrfs storage driver (#22621)
<!--Delete sections as needed --> ## Description This has been a source of confusion for many users. Recommend to use overlay2 and clarify that using btrfs filesystem doesn't require using the btrfs storage driver. ## Related issues or tickets - moby/moby#27653 <!-- Related issues, pull requests, or Jira tickets --> ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Technical review - [ ] Editorial review - [ ] Product review --------- Signed-off-by: Paweł Gronowski <[email protected]> Co-authored-by: Allie Sadler <[email protected]>
1 parent b6833c2 commit 1d5fb9e

File tree

2 files changed

+23
-7
lines changed

2 files changed

+23
-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: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -108,13 +108,20 @@ With regard to Docker, the backing filesystem is the filesystem where
108108
`/var/lib/docker/` is located. Some storage drivers only work with specific
109109
backing filesystems.
110110

111-
| Storage driver | Supported backing filesystems |
112-
| :--------------- | :---------------------------- |
113-
| `overlay2` | `xfs` with ftype=1, `ext4` |
114-
| `fuse-overlayfs` | any filesystem |
115-
| `btrfs` | `btrfs` |
116-
| `zfs` | `zfs` |
117-
| `vfs` | any filesystem |
111+
| Storage driver | Supported backing filesystems |
112+
| :--------------- | :-----------------------------------------------------|
113+
| `overlay2` | `xfs` with ftype=1, `ext4`, `btrfs`, (and more) |
114+
| `fuse-overlayfs` | any filesystem |
115+
| `btrfs` | `btrfs` |
116+
| `zfs` | `zfs` |
117+
| `vfs` | any filesystem |
118+
119+
> [!NOTE]
120+
>
121+
> Most filesystems should work if they have the required features.
122+
> Consult [OverlayFS](https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html)
123+
> for more information.
124+
118125

119126
## Other considerations
120127

0 commit comments

Comments
 (0)