docker ps: add "Platform" as formatting option by thaJeztah · Pull Request #6042 · docker/cli

thaJeztah · 2025-04-28T17:12:32Z

continuing the initial work from; supersedes, closesformatter: include container image platform in container list response #5804
supersedes, closes[WIP] Add "platform" column to docker ps #3177

docker ps --format 'table {{.ID}}\t{{.Image}}\t{{.Command}}\t{{.RunningFor}}\t{{.Status}}\t{{.Ports}}\t{{.Names}}\t{{.Platform}}'
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PLATFORM
e422855eac55 docker-cli-dev "/bin/bash" 12 minutes ago Up 12 minutes strange_jennings linux/arm64

- What I did

- How I did it

- How to verify it

- Human readable description for the release notes

Add `{{.Platform}}` as formatting option for `docker ps` to show the platform of the image the container is running.

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

codecov-commenter · 2025-04-28T17:17:18Z

Codecov Report

Attention: Patch coverage is 77.77778% with 2 lines in your changes missing coverage. Please review.

Project coverage is 55.03%. Comparing base (af09051) to head (67c0be4).

Additional details and impacted files

@@ Coverage Diff @@## master #6042 +/- ##
=======================================
Coverage 55.02% 55.03% =======================================
Files 361 361 Lines 30131 30140 +9 =======================================
+ Hits 16581 16588 +7 - Misses 12595 12597 +2 
Partials 955 955

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

vvoland · 2025-05-13T13:30:27Z

+
+func (p Platform) String() string {
+	if p.Platform.OS == "" {
+ // Prevent rendering as "unknown"


Wouldn't "unknown" actually make sense here if the platform isn't known?

hm... maybe yes. I think I did this because the platform could either be missing in the response or empty, but yeah, perhaps we could.

thaJeztah · 2025-05-16T15:42:23Z

+	// if p == nil || p.Platform == nil || (p.Platform.OS == "" && p.Platform.Architecture == "") {
+	if p == nil || p.Platform == nil {


TBD: do we want a nil platform and "zero" platform to be shown as nil, or keep it as-is to distinguish both?

A case where ImageManifestDescriptor.Platform would be nil is unexpected:
https://github.com/moby/moby/blob/master/container/view.go#L419-L425
IMO, as this is user facing string, it would be appropriate to use the unknown platform.
WDYT?

thaJeztah · 2025-05-19T11:19:04Z

@vvoland @Benehiko ptal; it's currently 3 separate commits, but should be squashed; I wasn't sure which if the approaches made most sense; make it use a pointer so that it can have nil (which can also be used in templating to make a conditional template), or to always return a Platform (which may be "empty").

Benehiko · 2025-05-20T06:02:40Z

I don't have a strong preference, returning nil sounds good to me

docker ps --format 'table {{.ID}}\t{{.Image}}{{.Command}}\t{{.RunningFor}}\t{{.Status}}\t{{.Ports}}\t{{.Names}}\t{{.Platform}}' CONTAINER ID IMAGECOMMAND CREATED STATUS PORTS NAMES PLATFORM e422855eac55 docker-cli-dev"/bin/bash" 12 minutes ago Up 12 minutes strange_jennings linux/arm64 Signed-off-by: Jonathan A. Sternberg <jonathan.sternberg@docker.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

With this patch: docker ps --format 'table {{.Names}}\t{{.Platform}}' NAMES PLATFORM optimistic_nightingale linux/arm64 mycontainer linux/arm64/v8 trusting_goldstine linux/arm64 docker ps --format '{{.Platform}}' linux/arm64 linux/arm64/v8 linux/arm64 docker ps --format '{{json .Platform}}' {"architecture":"arm64","os":"linux"} {"architecture":"arm64","os":"linux","variant":"v8"} {"architecture":"arm64","os":"linux"} docker ps --format 'json' {"Command":"\"/bin/bash\"","CreatedAt":"2025-05-13 10:12:19 +0000 UTC","ID":"e8b3b2d604f1","Image":"docker-cli-dev","Labels":"desktop.docker.io/binds/0/Source=/Users/thajeztah/go/src/github.com/docker/cli,desktop.docker.io/binds/0/SourceKind=hostFile,desktop.docker.io/binds/0/Target=/go/src/github.com/docker/cli,desktop.docker.io/mounts/0/Source=/var/run/docker.sock,desktop.docker.io/mounts/0/SourceKind=dockerSocketProxied,desktop.docker.io/mounts/0/Target=/var/run/docker.sock,desktop.docker.io/ports.scheme=v2","LocalVolumes":"1","Mounts":"/host_mnt/User…,docker-cli-dev…,/run/host-serv…","Names":"optimistic_nightingale","Networks":"bridge","Platform":{"architecture":"arm64","os":"linux"},"Ports":"","RunningFor":"38 minutes ago","Size":"0B","State":"running","Status":"Up 38 minutes"} {"Command":"\"/docker-entrypoint.…\"","CreatedAt":"2025-05-13 09:58:01 +0000 UTC","ID":"c93b808dd54e","Image":"nginx:alpine","Labels":"desktop.docker.io/ports.scheme=v2,maintainer=NGINX Docker Maintainers \u003cdocker-maint@nginx.com\u003e","LocalVolumes":"0","Mounts":"","Names":"mycontainer","Networks":"bridge","Platform":{"architecture":"arm64","os":"linux","variant":"v8"},"Ports":"80/tcp","RunningFor":"53 minutes ago","Size":"0B","State":"running","Status":"Up 53 minutes"} {"Command":"\"/usr/bin/gotty --ti…\"","CreatedAt":"2025-05-13 07:31:18 +0000 UTC","ID":"cbb981b06e46","Image":"thajeztah/dockershell:latest","Labels":"desktop.docker.io/ports.scheme=v2,com.thajeztah.docker-shell=1","LocalVolumes":"0","Mounts":"","Names":"trusting_goldstine","Networks":"bridge","Platform":{"architecture":"arm64","os":"linux"},"Ports":"0.0.0.0:55000-\u003e8080/tcp","RunningFor":"3 hours ago","Size":"0B","State":"running","Status":"Up 3 hours"} Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah · 2025-05-21T10:49:19Z

@vvoland updated to squash the last 2 commits; PTAL

vvoland

LGTM, thanks!

thaJeztah force-pushed the carry_5804_docker_ps_platform branch 2 times, most recently from f1b444d to 0441757Compare May 13, 2025 10:58

vvoland reviewed May 13, 2025
View reviewed changes

thaJeztah force-pushed the carry_5804_docker_ps_platform branch from 0441757 to ef49b5dCompare May 16, 2025 12:16

thaJeztah mentioned this pull request May 16, 2025
cli/command/formatter: fix .Labels format being randomized #6073
Merged

thaJeztah force-pushed the carry_5804_docker_ps_platform branch 4 times, most recently from 7c82cc2 to 159c2dfCompare May 16, 2025 15:41

thaJeztah commented May 16, 2025
View reviewed changes

thaJeztah force-pushed the carry_5804_docker_ps_platform branch from 159c2df to b5f1a2bCompare May 16, 2025 19:33

thaJeztah added this to the 28.2.0 milestone May 16, 2025

thaJeztah marked this pull request as ready for review May 16, 2025 19:38

thaJeztah added kind/enhancement status/1-design-review docs/revisit labels May 16, 2025

Benehiko approved these changes May 20, 2025
View reviewed changes

thaJeztah mentioned this pull request May 21, 2025
include platform and creation date listing image docker/compose#12856
Merged

jsternbergand others added 2 commits May 21, 2025 12:43

thaJeztah force-pushed the carry_5804_docker_ps_platform branch from b5f1a2b to 67c0be4Compare May 21, 2025 10:44

thaJeztah added impact/changelog area/ux status/2-code-review and removed status/1-design-review labels May 21, 2025

vvoland removed the kind/enhancement label May 21, 2025

vvoland added the kind/feature label May 21, 2025

vvoland approved these changes May 21, 2025
View reviewed changes

vvoland merged commit 97e060e into docker:masterMay 21, 2025

thaJeztah deleted the carry_5804_docker_ps_platform branch May 21, 2025 12:59

thaJeztah mentioned this pull request Jan 14, 2026
[WIP] Add "platform" column to docker ps #3177
Closed

Navigation Menu

Uh oh!

docker ps: add "Platform" as formatting option - #6042

docker ps: add "Platform" as formatting option#6042
vvoland merged 2 commits into
docker:masterfrom
thaJeztah:carry_5804_docker_ps_platform

thaJeztah commented Apr 28, 2025•
edited
Loading

Uh oh!

codecov-commenter commented Apr 28, 2025•
edited
Loading

Uh oh!

vvolandMay 13, 2025

Uh oh!

thaJeztahMay 16, 2025

Uh oh!

thaJeztahMay 16, 2025

Uh oh!

vvolandMay 21, 2025

Uh oh!

thaJeztah commented May 19, 2025

Uh oh!

Benehiko commented May 20, 2025

Uh oh!

thaJeztah commented May 21, 2025

Uh oh!

vvoland left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		// if p == nil \|\| p.Platform == nil \|\| (p.Platform.OS == "" && p.Platform.Architecture == "") {
		if p == nil \|\| p.Platform == nil {

Uh oh!

Conversation

thaJeztah commented Apr 28, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Apr 28, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

vvolandMay 13, 2025

Choose a reason for hiding this comment

Uh oh!

thaJeztahMay 16, 2025

Choose a reason for hiding this comment

Uh oh!

thaJeztahMay 16, 2025

Choose a reason for hiding this comment

Uh oh!

vvolandMay 21, 2025

Choose a reason for hiding this comment

Uh oh!

thaJeztah commented May 19, 2025

Uh oh!

Benehiko commented May 20, 2025

Uh oh!

thaJeztah commented May 21, 2025

Uh oh!

vvoland left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

thaJeztah commented Apr 28, 2025•
edited
Loading

codecov-commenter commented Apr 28, 2025•
edited
Loading