docs: document multi-platform build limitation for Docker driver#25342
Open
mohithshuka wants to merge 11 commits into
Open
docs: document multi-platform build limitation for Docker driver#25342mohithshuka wants to merge 11 commits into
mohithshuka wants to merge 11 commits into
Conversation
added 10 commits
May 15, 2026 16:36
The previous description said 'optimize your repository storage' which was vague and did not reflect the page's actual content. The manage.md page is focused on viewing, filtering, and deleting images and image indexes. Updated the description to accurately reflect this. Fixes docker#25005
The daemon configuration overview only mentioned two methods (JSON file and flags) but was missing the environment variables method via systemd. Added a new section explaining how to use systemd drop-in overrides to set daemon environment variables. Fixes docker#25062
Replace shorthand alias 'docker scout env' with the full canonical command name 'docker scout environment' in the environment integration overview page, matching the CLI reference and cli.md usage. Closes docker#25085
The _index.md page mixed 'docker scout env' and 'docker scout environment' interchangeably. The CLI reference uses 'environment' as the canonical name, so prose references are updated to match. Fixes docker#25085
…ct example Fixes docker#25192 useState was used on line 286 but was missing from the import statement, causing an error if users follow the tutorial literally.
The React code example was using useState, useEffect, and createDockerDesktopClient without importing them, which would cause errors for anyone copy-pasting the snippet. Fixes docker#25192
…rial The createDockerDesktopClient() was declared twice - once at module level (correct) and again inside the App() function (redundant/incorrect). Removed the duplicate declaration inside the function. Fixes docker#25192
The Docker driver page did not mention that multi-platform builds are unsupported, which caused confusion when users encountered runtime errors. Added a Limitations section that clearly states this and links to alternatives. Fixes docker#25044
mohithshuka
requested review from
aevesdocker and
craig-osterhout
as code owners
❌ Deploy Preview for docsdocker failed. Why did it fail? →
|
github-actions
Bot
added
area/engine
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Documentation updates across Scout, Extensions SDK, Engine daemon, and Buildx pages to reflect updated CLI behavior, clarify configuration options, and improve guidance.
Changes:
- Update Docker Scout “environments” docs to use
docker scout environmentcommand wording/examples. - Adjust Extensions SDK React examples to create a single Docker Desktop client instance outside the component.
- Expand and refine Engine daemon + Buildx documentation (env var configuration, QEMU guidance, Docker driver limitations).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| content/manuals/scout/integrations/environment/_index.md | Updates Scout environment command references/examples (but introduces duplication/inconsistencies). |
| content/manuals/extensions/extensions-sdk/guides/invoke-host-binaries.md | Updates React example to use module-scoped ddClient (but adds leading blank lines before front matter). |
| content/manuals/extensions/extensions-sdk/build/backend-extension-tutorial.md | Updates tutorial React example to use module-scoped ddClient and correct imports. |
| content/manuals/engine/daemon/_index.md | Adds environment-variable configuration section (but has rendering and correctness issues). |
| content/manuals/build/building/multi-platform.md | Clarifies when manual QEMU installation is needed. |
| content/manuals/build/builders/drivers/docker.md | Adds “Limitations” section for the Docker buildx driver (needs more precise wording). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
9
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| --- | ||
| title: Invoke host binaries | ||
| description: Add invocations to host binaries from the frontend with the extension |
| @@ -52,15 +52,15 @@ To see all of the available environments for an organization, you can use the | |||
| `docker scout env` command. | |||
|
|
||
| ```console | ||
| $ docker scout env | ||
| $ docker scout environment |
Comment on lines
+101
to
+102
| Alternatively, you can Use the `docker scout environment` command to view the images from the terminal. | ||
| use the `docker scout environment` command to view the images from the terminal. |
Comment on lines
47
to
48
| You can use both of these options together as long as you don't specify the same | ||
| option both as a flag and in the JSON file. If that happens, the Docker daemon |
|
|
||
| To set environment variables for the Docker daemon using systemd, create a | ||
| drop-in override file: | ||
|
|
Comment on lines
+111
to
+112
| [Service] | ||
| Environment="DOCKER_OPTS=--debug --tls=true" |
Comment on lines
+46
to
+48
| - Multi-platform builds are not supported. To build for multiple platforms, | ||
| use the [`docker-container` driver](./docker-container.md) or enable the | ||
| [containerd image store](../../../storage/containerd.md). |
thaJeztah
reviewed
Jun 12, 2026
Comment on lines
+42
to
+44
| ## Limitations | ||
|
|
||
| The Docker driver has the following limitations: |
Member
There was a problem hiding this comment.
This is only the case when using graph-drivers, which is no longer the default. On currently supported versions of the docker engine (v29.x) the default is to use containerd snapshotters, which provide multi-platform support.
Contributor
Author
|
Thanks for the clarification! I'll update the section to reflect that |
- Moved Limitations section before Further reading - Corrected multi-platform statement: it depends on the storage driver, not a blanket limitation. Containerd snapshotters (default in Docker Engine v29.x+) support multi-platform builds, while legacy graph-drivers do not. Based on review feedback from thaJeztah.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds a
Limitationssection to the Docker driver page that explicitlystates multi-platform builds are not supported when using the default
Docker driver. Previously, users would only discover this limitation
at runtime via an error message. This change surfaces it in the docs
so users can choose the right driver upfront.
Related issue
Closes #25044
Type of change
Preview
Added to
content/manuals/build/builders/drivers/docker.md:Before: No mention of multi-platform limitation
After: Clear
Limitationssection with links to alternatives(
docker-containerdriver and containerd image store)