Add .IPAddresses as formatting option on docker ps

This allows showing the IP address for each network that the container is attached to,
for example:

    docker network create foo
    docker run -d --name foo nginx:alpine
    docker network connect foo foo

    container container ls --format 'table {{.ID}}\\t{{join .IPAddresses ", "}}'
    CONTAINER ID   IP ADDRESSES
    17e7d1910fc0   bridge:172.17.0.2, foo:172.19.0.2

    container container ls --format='{{json .IPAddresses}}' | jq .
    [
      "bridge:172.17.0.2",
      "foo:172.19.0.2"
    ]

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Author: thaJeztah

cli/command/formatter/container.go

@@ -29,6 +29,7 @@ const (
 	networksHeader     = "NETWORKS"
 	platformHeader     = "PLATFORM"
 	healthStatusHeader = "HEALTH STATUS"
+	ipAddressesHeader  = "IP ADDRESSES"
 )
 
 // Platform wraps a [ocispec.Platform] to implement the stringer interface.
@@ -123,6 +124,7 @@ func NewContainerContext() *ContainerContext {
 		"Networks":     networksHeader,
 		"Platform":     platformHeader,
 		"HealthStatus": healthStatusHeader,
+		"IPAddresses":  ipAddressesHeader,
 	}
 	return &containerCtx
 }
@@ -383,6 +385,25 @@ func (c *ContainerContext) HealthStatus() string {
 	}
 }
 
+// IPAddresses returns the list of IP-addresses assigned to the container
+// IP-addresses are prefixed with the name of the network, separated with a colon.
+// For example: "bridge:192.168.1.10"
+func (c *ContainerContext) IPAddresses() []string {
+	ipAddresses := []string{}
+	if c.c.NetworkSettings == nil {
+		return ipAddresses
+	}
+	for name, nw := range c.c.NetworkSettings.Networks {
+		if nw.IPAddress.IsValid() {
+			ipAddresses = append(ipAddresses, name+":"+nw.IPAddress.String())
+		}
+		if nw.GlobalIPv6Address.IsValid() {
+			ipAddresses = append(ipAddresses, name+":"+nw.GlobalIPv6Address.String())
+		}
+	}
+	return ipAddresses
+}
+
 // DisplayablePorts returns formatted string representing open ports of container
 // e.g. "0.0.0.0:80->9090/tcp, 9988/tcp"
 // it's used by command 'docker ps'

cli/command/formatter/container_test.go

@@ -14,6 +14,7 @@ import (
 
 	"github.com/docker/cli/internal/test"
 	"github.com/moby/moby/api/types/container"
+	"github.com/moby/moby/api/types/network"
 	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 	"gotest.tools/v3/assert"
 	is "gotest.tools/v3/assert/cmp"
@@ -390,7 +391,7 @@ size: 0B
 	}
 
 	containers := []container.Summary{
-		{ID: "containerID1", Names: []string{"/foobar_baz"}, Image: "ubuntu", Created: unixTime, State: container.StateRunning},
+		{ID: "containerID1", Names: []string{"/foobar_baz"}, Image: "ubuntu", Created: unixTime, State: container.StateRunning, NetworkSettings: &container.NetworkSettingsSummary{}},
 		{ID: "containerID2", Names: []string{"/foobar_bar"}, Image: "ubuntu", Created: unixTime, State: container.StateRunning},
 	}
 
@@ -579,6 +580,36 @@ func TestContainerContextWriteJSONField(t *testing.T) {
 	}
 }
 
+func TestContainerContextIPAddresses(t *testing.T) {
+	containers := []container.Summary{
+		{
+			ID: "containerID1",
+			NetworkSettings: &container.NetworkSettingsSummary{
+				Networks: map[string]*network.EndpointSettings{
+					"one": {IPAddress: netip.MustParseAddr("192.168.1.2")},
+					"two": {IPAddress: netip.MustParseAddr("192.168.178.2")},
+				},
+			},
+		},
+		{
+			ID: "containerID2",
+			NetworkSettings: &container.NetworkSettingsSummary{
+				Networks: map[string]*network.EndpointSettings{
+					"one": {IPAddress: netip.MustParseAddr("192.168.1.3")},
+					"two": {IPAddress: netip.MustParseAddr("192.168.178.3")},
+				},
+			},
+		},
+	}
+
+	out := bytes.NewBufferString("")
+	err := ContainerWrite(Context{Format: "{{.IPAddresses}}", Output: out}, containers)
+	assert.NilError(t, err)
+	assert.Equal(t, out.String(), `[one:192.168.1.2 two:192.168.178.2]
+[one:192.168.1.3 two:192.168.178.3]
+`)
+}
+
 func TestContainerBackCompat(t *testing.T) {
 	createdAtTime := time.Now().AddDate(-1, 0, 0) // 1 year ago
 

docs/reference/commandline/container_ls.md

@@ -412,6 +412,7 @@ Valid placeholders for the Go template are listed below:
 | `.Label`        | Value of a specific label for this container. For example `'{{.Label "com.docker.swarm.cpu"}}'` |
 | `.Mounts`       | Names of the volumes mounted in this container.                                                 |
 | `.Networks`     | Names of the networks attached to this container.                                               |
+| `.IPAddresses`  | List of IP-Addresses for each network that the container is attached to.                        |
 
 When using the `--format` option, the `ps` command will either output the data
 exactly as the template declares or, when using the `table` directive, includes
@@ -447,3 +448,13 @@ To list all running containers in JSON format, use the `json` directive:
 $ docker ps --format json
 {"Command":"\"/docker-entrypoint.…\"","CreatedAt":"2021-03-10 00:15:05 +0100 CET","ID":"a762a2b37a1d","Image":"nginx","Labels":"maintainer=NGINX Docker Maintainers \u003cdocker-maint@nginx.com\u003e","LocalVolumes":"0","Mounts":"","Names":"boring_keldysh","Networks":"bridge","Ports":"80/tcp","RunningFor":"4 seconds ago","Size":"0B","State":"running","Status":"Up 3 seconds"}
 ```
+
+Show the IP-addresses that containers have:
+
+```console
+$ docker ps --format "table {{.ID}}\\t{{join .IPAddresses \", \"}}"
+
+CONTAINER ID   IP ADDRESSES
+c0cf2877da71   bridge:172.17.0.3
+17e7d1910fc0   bridge:172.17.0.2, mynetwork:172.19.0.2
+```