Multi-platform builds and containerd image store sections are ambiguous, overlap, and missing info
I maintainer di solito rispondono entro 1 giorno
@dvdksn ci sta già lavorando.
Dal 24/9/2024.
Valutazione
Questa issue non è ancora stata valutata.
Descrizione
Is this a docs issue?
- My issue is about the documentation content or website
Type of issue
Information is incorrect
Description
The "Multi-platform builds" section is confusing, and has some parts that are ambiguous;
- It outlines prerequisites
- But due to how they are presented, are easy to be interpreted as "you must enable the containerd image store" AND "create a custom builder"
That's incorrect, because creating a custom builder is only needed if the containerd image-store is NOT enabled. There's information in the first paragraphs, but the "make sure that your builder and Docker Engine support multi-platform build" makes it easy to interpret it as "I need to configure both to make this work".
There's duplicate content as well;
- the "multi-platform images" page has a short form of switching to the containerd image-store, but doesn't mention all the details; https://docs.docker.com/build/building/multi-platform/#enable-the-containerd-image-store
- the containerd image-store section in desktop has more details for desktop https://docs.docker.com/desktop/containerd/
- and there's a third section in the engine section; https://docs.docker.com/engine/storage/containerd/
Missing information
QEMU as prerequisite
As an important use of the containerd image-store is to facilitate multi-platform builds, we should also consider;
- Adding steps to enable the QEMU userland-emulation in the install steps
- ☝️ this could cross-reference the https://docs.docker.com/build/building/multi-platform/#qemu section
- ☝️ probably make it more clear in that section that its NOT needed when running Docker Desktop
Storage drivers
Given that the containerd image-store uses different drivers than graphdrivers, we may want to mention this, and perhaps include an example that specifies the default driver to use, e.g.;
{
"features": {
"containerd-snapshotter": true
},
"storage-driver": "overlayfs"
}
- Perhaps the storage-drivers section should also include information about snapshotters
- Mention which pages do NOT apply to the containerd image-store
Location
https://docs.docker.com/build/building/multi-platform/#prerequisites
Suggestion
See above
- Lingua principale
- Markdown
- Stelle
- 4.7k
- Fork
- 8.5k
- Merge medio
- 1g 18h
- PR unite (30g)
- 121
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di docker/docs
-
[docs-scanner] Container proxy table misleadingly presents nested properties as separate parametersForse già presa @dave123981 l’ha presa 1 giorno fa. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
-
[docs-scanner] Conflicting WSL version requirements between ECI pagesForse già presa @dave123981 l’ha presa 2 giorni fa. Aperta
Difficoltà 1/5 1-3 ore Idoneità per principianti 90/100
I maintainer di solito rispondono entro 1 giorno
-
status/triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
status/triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
I maintainer di solito rispondono entro 1 giorno