Skip to content

docs: Add warning about using btrfs storage driver #22621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −7
Open

docs: Add warning about using btrfs storage driver #22621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions content/manuals/engine/storage/drivers/btrfs-driver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ aliases:
- /storage/storagedriver/btrfs-driver/
---

> [!IMPORTANT]
>
> In most cases you should use the `overlay2` storage driver - it's not
> required to use the `btrfs` storage driver simply because your system uses
> Btrfs as its root filesystem.
>
> Btrfs driver has known issues - see [Moby issue #27653](https://github.com/moby/moby/issues/27653)
> for more information.

Btrfs is a copy-on-write filesystem that supports many advanced storage
technologies, making it a good fit for Docker. Btrfs is included in the
mainline Linux kernel.
Expand Down
20 changes: 13 additions & 7 deletions content/manuals/engine/storage/drivers/select-storage-driver.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,19 @@ With regard to Docker, the backing filesystem is the filesystem where
`/var/lib/docker/` is located. Some storage drivers only work with specific
backing filesystems.

| Storage driver | Supported backing filesystems |
| :--------------- | :---------------------------- |
| `overlay2` | `xfs` with ftype=1, `ext4` |
| `fuse-overlayfs` | any filesystem |
| `btrfs` | `btrfs` |
| `zfs` | `zfs` |
| `vfs` | any filesystem |
| Storage driver | Supported backing filesystems |
| :--------------- | :-----------------------------------------------------|
| `overlay2` | `xfs` with ftype=1, `ext4`, `btrfs`, (and more\*) |
| `fuse-overlayfs` | any filesystem |
| `btrfs` | `btrfs` |
| `zfs` | `zfs` |
| `vfs` | any filesystem |

> [!NOTE]
> \* Most filesystems should work if they have the required features.
> Consult [OverlayFS](https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html)
> for more information.


## Other considerations

Expand Down