Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[docs-scanner] Conflicting guidance on when to use overlay2 vs containerd

Aperta Adatta ai principianti
#26,165 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
75/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

L'issue indica due file specifici: content/manuals/engine/storage/drivers/select-storage-driver.md e content/manuals/engine/storage/drivers/overlayfs-driver.md. Iniziate leggendo questi file per comprendere le attuali linee guida in conflitto. Quindi, redigete una sezione decisionale chiara per la pagina select-storage-driver, che spieghi quando usare overlay2 rispetto a containerd, e aggiornate la pagina overlayfs-driver per chiarire la sua affermazione. Verificate le modifiche compilando la documentazione localmente o controllando l'output renderizzato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Files:

  • content/manuals/engine/storage/drivers/select-storage-driver.md
  • content/manuals/engine/storage/drivers/overlayfs-driver.md
Issue

The select-storage-driver page says:

For systems using classic storage drivers, overlay2 provides broad compatibility across Linux distributions. Use Docker volumes for write-heavy workloads instead of relying on writing data to the container's writable layer.

This guidance presents overlay2 as a recommended choice "for systems using classic storage drivers," but doesn't explain when or why a user would choose to use classic storage drivers instead of the containerd image store (the default for 29.0+).

Meanwhile, overlayfs-driver.md says:

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.

But then immediately contradicts this with:

Docker Engine 29.0 and later uses the containerd image store by default. The overlay2 driver is a legacy storage driver that is superseded by the overlayfs containerd snapshotter.

Why this matters

A reader following these pages will be confused about whether they should be using overlay2 or the containerd image store. The guidance says "in most cases you should use overlay2" but then says it's "legacy" and "superseded." There's no clear decision tree for when to use which system.

Suggested fix

Add a clear decision section to select-storage-driver.md that explains:

  • Docker Engine 29.0+ uses containerd image store by default for fresh installations (recommended)
  • Classic storage drivers (including overlay2) are still available for:
    • Systems upgraded from earlier versions that haven't migrated
    • Specific compatibility requirements (list them if any exist)
  • How to determine which system you're currently using
  • When and why you might need to stay on classic storage drivers vs migrating to containerd

Remove or update the "in most cases you should use overlay2" statement in overlayfs-driver.md to clarify it only applies to users who must use classic storage drivers.


Found by nightly documentation quality scanner

Lingua principale
Markdown
Stelle
4.7k
Fork
8.5k
Merge medio
2g 18h
PR unite (30g)
121

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di docker/docs

Tutte le issue di docker/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.