docker / docker/docs

Multi-platform builds and containerd image store sections are ambiguous, overlap, and missing info

Open
#20,988 1 comment 0 reactions 1 assignee View on GitHub

@dvdksn is already working on this.

Since Sep 24, 2024.

area/build area/engine kind/enhancement lifecycle/frozen
Dominant language
Markdown
Stars
4.7k
Forks
8.5k
Avg merge
2d 18h
Merged PRs (30d)
108

Description

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".

Screenshot 2024-09-24 at 19 50 54 Screenshot 2024-09-24 at 19 56 01

There's duplicate content as well;

Missing information

QEMU as prerequisite

As an important use of the containerd image-store is to facilitate multi-platform builds, we should also consider;

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.