cli/push: Add `platform` switch #4984

vvoland · 2024-04-04T15:16:39Z

needs: c8d/push: Support --platform switch moby/moby#47679

- What I did
Added a platform switch to docker image push.

- How I did it

- How to verify it

$ docker pull --platform linux/arm64 busybox
$ docker tag busybox myimage
$ docker push --platform linux/arm64 myimage

- Description for the changelog

containerd image store: Add `--platform` switch to `docker image push`.

- A picture of a cute animal (not mandatory but encouraged)

codecov-commenter · 2024-04-05T11:54:37Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (cba002e) to head (9e06e58).
Report is 9 commits behind head on master.

❗ Current head 9e06e58 differs from pull request most recent head 32ac7a0

Please upload reports for the commit 32ac7a0 to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #4984       +/-   ##
==========================================
- Coverage   61.83%       0   -61.84%     
==========================================
  Files         298       0      -298     
  Lines       20731       0    -20731     
==========================================
- Hits        12818       0    -12818     
+ Misses       7000       0     -7000     
+ Partials      913       0      -913

vvoland · 2024-04-08T16:51:16Z

cli/command/image/push.go

@@ -84,6 +86,7 @@ func RunPush(ctx context.Context, dockerCli command.Cli, opts pushOptions) error
 		All:           opts.all,
 		RegistryAuth:  encodedAuth,
 		PrivilegeFunc: requestPrivilege,
+		Platform:      opts.platform,


Warn that it will strip attestations (suggested by @thaJeztah)

rumpl · 2024-04-10T08:36:57Z

cli/command/image/push.go


 	return cmd
 }

 // RunPush performs a push against the engine based on the specified options
 func RunPush(ctx context.Context, dockerCli command.Cli, opts pushOptions) error {
+	if opts.platform != "" {
+		if _, isTty := term.GetFdInfo(dockerCli.Err()); isTty {
+			_, _ = fmt.Fprint(dockerCli.Err(), "\x1b[1;37m\x1b[1;46m[ NOTE ]\x1b[0m\x1b[0m ")


There is no need to repeat the reset here, only one is enough: \x1b[0m\x1b[0m -> \x1b[0m

Do we really want to add the cyan background color here? Why not \x1b[36m to just color the text?

Ah good catch, no idea how that second one sneaked in there!

No strong opinions on the colors, I just went with a colored background to make it more visible:

It could look wildly different on other terminals/color schemes, so perhaps a text color would be a safer option.

I think setting a colored background + colored text is safer – if we just set the foregroung color and the users color scheme uses the same color for the background (and I've definitely seen cyan backgrounds), then the text will be unreadable. If we set a contrasting background+foreground color combination then that's less likely to happen.

rumpl · 2024-04-10T08:41:22Z

cli/command/image/push.go

+		_, _ = fmt.Fprintln(dockerCli.Err(), `Selecting a single platform for the push operation will push the image manifest for that platform only.
+This won't push the image index/manifest list which means that other components like Buildkit attestations won't be pushed.


Thinking about the wording here, we are talking about image manifests, index, manifest list, do we really need to be this specific? Shouldn't we have a more user-friendly terms like "single-platform image" and "multi-platform image"?

No one really wants to know the difference between an index and a manifest list :)

rumpl · 2024-04-10T08:42:24Z

cli/command/image/push.go

+		}
+		_, _ = fmt.Fprintln(dockerCli.Err(), `Selecting a single platform for the push operation will push the image manifest for that platform only.
+This won't push the image index/manifest list which means that other components like Buildkit attestations won't be pushed.
+If you want to only push a single platform while preserving the attestations, please build an image with only that platform and push it instead.`)


Related to the above, after talking about manifests manifest lists and indexes we say "single platform"

The problem is that "single platform" isn't always a 1:1 mapping between an index and a single manifest.

Is the index below a single platform image or a multi-platform image?

{ "schemaVersion": 2, "mediaType": "application/vnd.oci.image.index.v1+json", "manifests": [ { "mediaType": "application/vnd.oci.image.manifest.v1+json", "digest": "sha256:34b7d4a2f050f8a9077fd435b3b1778e091af743f0f4c8c47d109cfda47b0c48", "size": 480, "platform": { "architecture": "arm64", "os": "linux" } }, { "mediaType": "application/vnd.oci.image.manifest.v1+json", "digest": "sha256:a7931924962b793438f641b320d496ebca34968e850f7b8d7a5ea59dc88283cc", "size": 565, "annotations": { "vnd.docker.reference.digest": "sha256:34b7d4a2f050f8a9077fd435b3b1778e091af743f0f4c8c47d109cfda47b0c48", "vnd.docker.reference.type": "attestation-manifest" }, "platform": { "architecture": "unknown", "os": "unknown" } } ] }

laurazard

LGTM, I think we can discuss/keep improving the messages in the future too, but I wouldn't block this on that.

laurazard · 2024-06-06T14:26:16Z

cli/command/image/push.go

+		printNote(dockerCli, `Selecting a single platform will only push one matching image manifest from a multi-platform image index.
+This means that any other components attached to the multi-platform image index (like Buildkit attestations) won't be pushed.
+If you want to only push a single platform image while preserving the attestations, please use 'docker convert\n'
+`)


I think it's fine to be explicit here, I'd rather some users get annoyed by the extra message than having people not realize we're stripping attestations when they push a single-platform image.

thaJeztah · 2024-06-10T20:15:39Z

moby/moby#47943 was merged

laurazard · 2024-06-11T13:07:30Z

@krissetto @Benehiko can you TAL?

cli/command/image/push.go

Benehiko

Looks good to me

Benehiko · 2024-06-11T13:32:06Z

cli/command/image/push.go

+var notes []string
+
+func handleAux(dockerCli command.Cli) func(jm jsonmessage.JSONMessage) {
+	return func(jm jsonmessage.JSONMessage) {


what happens if none of data could be unmarshalled? should it not error?

There might be other aux progress messages that are not (yet) supported by the CLI. I think it's best to just skip them instead.

thaJeztah · 2024-06-11T13:33:26Z

cli/command/image/push.go


 	return cmd
 }

 // RunPush performs a push against the engine based on the specified options
 func RunPush(ctx context.Context, dockerCli command.Cli, opts pushOptions) error {
+	var platform *platforms.Platform
+	if opts.platform != "" {


Not for this PR, and not urgent, but if we decide to add more locations to pass --platform, and we want to consume those as a platforms, we could consider implementing a platform _option_ that can be used for flags, performs the validation as part of that, and directly setting a Platform`.

Yeah I think we should, but left that to a second PR that will reuse this logic.

Btw, we already have it, but for the "string" platform:

cli/cli/command/utils.go

Line 158 in 0022fe7

flags.StringVar(target, "platform", os.Getenv("DOCKER_DEFAULT_PLATFORM"), "Set platform if server is multi-platform capable")

🙈

Ah! We should look where/how that's used. If the result is only "internal", it could still make sense to change it, and have the consumer convert it to a string (where needed 🤔).

In either case; all for separate work, just that I thought of it.

thaJeztah · 2024-06-11T13:38:42Z

cli/command/image/push.go

+}
+
+func printNote(dockerCli command.Cli, format string, args ...any) {
+	if _, isTty := term.GetFdInfo(dockerCli.Err()); isTty {


Note that dockerCli.Out() has a IsTerminal() function that we can use. Not sure if that's fully correct though (is that correct if STDERR redirected, but STDOUT isn't?

We should consider providing this for both Out() and Err() (I looked at that a few times, and wondered why we didn't)

The most common case of this is when you redirect the stderr to /dev/null:

$ docker push dckr.woland.xyz/ububuu Using default tag: latest The push refers to repository [dckr.woland.xyz/ububuu] aa21f24e1940: Layer already exists latest: digest: sha256:17c24d16d63d2d089db74c2ed3e99c1ab0fd3f4f93c00b04afa8793fa793626c size: 424 [ NOTE ] Not all multiplatform-content is present and only the available single-platform image was pushed sha256:e3f92abc0967a6c19d0dfa2d55838833e947b9d74edbcb0113e48535ad4be12a -> sha256:17c24d16d63d2d089db74c2ed3e99c1ab0fd3f4f93c00b04afa8793fa793626c $ docker push dckr.woland.xyz/ububuu 2>/dev/null Using default tag: latest The push refers to repository [dckr.woland.xyz/ububuu] aa21f24e1940: Layer already exists latest: digest: sha256:17c24d16d63d2d089db74c2ed3e99c1ab0fd3f4f93c00b04afa8793fa793626c size: 424

Yeah, I think there's other places where we do it wrong, and only look at STDOUT, but not at STDERR (but switch both based on STDOUT; here's a recent discussion that I still need to reply to, because I think the same is happening for docker build ; moby/moby#47755

Perhaps a good reason to look if we should make Err() provide thee same features as Out(), so that it's easier to check for each of the outputs if they have a TTY attached or not.

In either case; not a blocker (should I mention that isTty should be isTTY ? 😂 🙈 )

Will open a follow-up with the stderr change (it will have a bunch of updates in other places, so prefer to handle it in a separate PR).

isTTY

LOL, you're just merciless Sebastiaan 🤣
...done!

so prefer to handle it in a separate PR

Yes; that's for sure something separate; and it's not a new thing, just that this is (I think) the first time we pay attention and check the right thing for a TTY 😂

OL, you're just merciless Sebastiaan 🤣

I'm the Human Linter! 😂

cli/command/image/push.go

thaJeztah

LGTM

I think most comments still visible are good for follow-up work.

full diff: moby/moby@a736d07...9d94884 Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>

Print note when the multi-platform image was reduced to a single manifest. Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>

thaJeztah

LGTM

Let's go!

vvoland added impact/changelog area/api area/ux labels Apr 4, 2024

vvoland self-assigned this Apr 4, 2024

vvoland mentioned this pull request Apr 4, 2024

WIP: containerd integration: Multi-platform images UX moby/moby#47680

Open

17 tasks

vvoland force-pushed the c8d-multiplatform-push branch from 15cdbda to 8e4f543 Compare April 5, 2024 11:51

vvoland commented Apr 8, 2024

View reviewed changes

vvoland force-pushed the c8d-multiplatform-push branch from 8e4f543 to 53336d4 Compare April 9, 2024 15:56

vvoland mentioned this pull request Apr 9, 2024

c8d/push: Support --platform switch moby/moby#47679

Merged

vvoland force-pushed the c8d-multiplatform-push branch from 53336d4 to 827a96b Compare April 9, 2024 16:06

vvoland marked this pull request as ready for review April 9, 2024 16:08

vvoland requested a review from thaJeztah as a code owner April 9, 2024 16:08

rumpl reviewed Apr 10, 2024

View reviewed changes

vvoland force-pushed the c8d-multiplatform-push branch from 827a96b to 0d0d8d5 Compare April 12, 2024 11:15

vvoland force-pushed the c8d-multiplatform-push branch 4 times, most recently from 13ffd29 to cd1d450 Compare May 10, 2024 14:55

vvoland force-pushed the c8d-multiplatform-push branch from 5c8d268 to b2de358 Compare May 20, 2024 13:19

neersighted added this to the 27.0.0 milestone May 24, 2024

vvoland force-pushed the c8d-multiplatform-push branch from b2de358 to dd83d4f Compare June 4, 2024 11:17

vvoland requested a review from a team as a code owner June 4, 2024 11:17

vvoland force-pushed the c8d-multiplatform-push branch 3 times, most recently from c1eef29 to 4f59b4a Compare June 5, 2024 12:48

laurazard approved these changes Jun 6, 2024

View reviewed changes

vvoland force-pushed the c8d-multiplatform-push branch from 4f59b4a to d6533a7 Compare June 10, 2024 17:18

vvoland force-pushed the c8d-multiplatform-push branch from d6533a7 to 253077b Compare June 11, 2024 08:39

laurazard requested review from Benehiko and krissetto June 11, 2024 13:08

thaJeztah reviewed Jun 11, 2024

View reviewed changes

cli/command/image/push.go Outdated Show resolved Hide resolved

Benehiko approved these changes Jun 11, 2024

View reviewed changes

vvoland force-pushed the c8d-multiplatform-push branch from 253077b to 431c06f Compare June 11, 2024 13:37

thaJeztah reviewed Jun 11, 2024

View reviewed changes

vvoland force-pushed the c8d-multiplatform-push branch from 431c06f to 9e06e58 Compare June 11, 2024 14:00

thaJeztah approved these changes Jun 11, 2024

View reviewed changes

vvoland added 3 commits June 11, 2024 16:39

vendor: github.com/docker/docker v27.0.0-dev (9d9488468fe2)

892784d

full diff: moby/moby@a736d07...9d94884 Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>

cli/push: Add platform switch

966fa7c

Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>

cli/push: Print aux notes

32ac7a0

Print note when the multi-platform image was reduced to a single manifest. Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>

vvoland force-pushed the c8d-multiplatform-push branch from 9e06e58 to 32ac7a0 Compare June 11, 2024 14:40

thaJeztah approved these changes Jun 11, 2024

View reviewed changes

thaJeztah merged commit 52eddcf into docker:master Jun 11, 2024
88 checks passed

vvoland mentioned this pull request Jun 11, 2024

cli: Wrap Err stream #5143

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cli/push: Add `platform` switch #4984

cli/push: Add `platform` switch #4984

vvoland commented Apr 4, 2024 •

edited

codecov-commenter commented Apr 5, 2024 •

edited

vvoland Apr 8, 2024

rumpl Apr 10, 2024

rumpl Apr 10, 2024

vvoland Apr 10, 2024

vvoland Apr 10, 2024

laurazard Jun 5, 2024

rumpl Apr 10, 2024

rumpl Apr 10, 2024

vvoland Apr 12, 2024

laurazard left a comment

laurazard Jun 6, 2024

thaJeztah commented Jun 10, 2024

laurazard commented Jun 11, 2024

Benehiko left a comment

Benehiko Jun 11, 2024

vvoland Jun 11, 2024

thaJeztah Jun 11, 2024

vvoland Jun 11, 2024

thaJeztah Jun 11, 2024

thaJeztah Jun 11, 2024

vvoland Jun 11, 2024

thaJeztah Jun 11, 2024

thaJeztah Jun 11, 2024

vvoland Jun 11, 2024

vvoland Jun 11, 2024

thaJeztah Jun 11, 2024

thaJeztah left a comment

thaJeztah left a comment

		_, _ = fmt.Fprintln(dockerCli.Err(), `Selecting a single platform for the push operation will push the image manifest for that platform only.
		This won't push the image index/manifest list which means that other components like Buildkit attestations won't be pushed.

cli/push: Add platform switch #4984

cli/push: Add platform switch #4984

Conversation

vvoland commented Apr 4, 2024 • edited

codecov-commenter commented Apr 5, 2024 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

laurazard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thaJeztah commented Jun 10, 2024

laurazard commented Jun 11, 2024

Benehiko left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thaJeztah left a comment

Choose a reason for hiding this comment

thaJeztah left a comment

Choose a reason for hiding this comment

cli/push: Add `platform` switch #4984

cli/push: Add `platform` switch #4984

vvoland commented Apr 4, 2024 •

edited

codecov-commenter commented Apr 5, 2024 •

edited