Merge pull request #5664 from akerouanton/gw-priority

run, create, connect: add support for gw-priority
docker · Dec 6, 2024 · 66dfe6d · 66dfe6d
2 parents 97010d1 + d4db289
commit 66dfe6d
Show file tree

Hide file tree

Showing 15 changed files with 63 additions and 48 deletions.
diff --git a/cli/command/container/opts.go b/cli/command/container/opts.go
@@ -858,7 +858,9 @@ func parseNetworkAttachmentOpt(ep opts.NetworkAttachmentOpts) (*networktypes.End
 		}
 	}
 
-	epConfig := &networktypes.EndpointSettings{}
+	epConfig := &networktypes.EndpointSettings{
+		GwPriority: ep.GwPriority,
+	}
 	epConfig.Aliases = append(epConfig.Aliases, ep.Aliases...)
 	if len(ep.DriverOpts) > 0 {
 		epConfig.DriverOpts = make(map[string]string)

diff --git a/cli/command/network/connect.go b/cli/command/network/connect.go
@@ -23,6 +23,7 @@ type connectOptions struct {
 	aliases      []string
 	linklocalips []string
 	driverOpts   []string
+	gwPriority   int
 }
 
 func newConnectCommand(dockerCLI command.Cli) *cobra.Command {
@@ -55,6 +56,7 @@ func newConnectCommand(dockerCLI command.Cli) *cobra.Command {
 	flags.StringSliceVar(&options.aliases, "alias", []string{}, "Add network-scoped alias for the container")
 	flags.StringSliceVar(&options.linklocalips, "link-local-ip", []string{}, "Add a link-local address for the container")
 	flags.StringSliceVar(&options.driverOpts, "driver-opt", []string{}, "driver options for the network")
+	flags.IntVar(&options.gwPriority, "gw-priority", 0, "Highest gw-priority provides the default gateway. Accepts positive and negative values.")
 	return cmd
 }
 
@@ -73,6 +75,7 @@ func runConnect(ctx context.Context, apiClient client.NetworkAPIClient, options
 		Links:      options.links.GetAll(),
 		Aliases:    options.aliases,
 		DriverOpts: driverOpts,
+		GwPriority: options.gwPriority,
 	})
 }
 

diff --git a/cli/command/network/connect_test.go b/cli/command/network/connect_test.go
@@ -56,6 +56,7 @@ func TestNetworkConnectWithFlags(t *testing.T) {
 			"driveropt1": "optval1,optval2",
 			"driveropt2": "optval4",
 		},
+		GwPriority: 100,
 	}
 	cli := test.NewFakeCli(&fakeClient{
 		networkConnectFunc: func(ctx context.Context, networkID, container string, config *network.EndpointSettings) error {
@@ -76,6 +77,7 @@ func TestNetworkConnectWithFlags(t *testing.T) {
 		{"ip6", "fdef:f401:8da0:1234::5678"},
 		{"link", "otherctr"},
 		{"link-local-ip", "169.254.42.42"},
+		{"gw-priority", "100"},
 	} {
 		err := cmd.Flags().Set(opt.name, opt.value)
 		assert.Check(t, err)

diff --git a/docs/reference/commandline/container_run.md b/docs/reference/commandline/container_run.md
@@ -749,15 +749,16 @@ To specify options when connecting to more than one network, use the extended sy
 for the `--network` flag. Comma-separated options that can be specified in the extended
 `--network` syntax are:
 
-| Option          | Top-level Equivalent                  | Description                                     |
-|-----------------|---------------------------------------|-------------------------------------------------|
-| `name`          |                                       | The name of the network (mandatory)             |
-| `alias`         | `--network-alias`                     | Add network-scoped alias for the container      |
-| `ip`            | `--ip`                                | IPv4 address (e.g., 172.30.100.104)             |
-| `ip6`           | `--ip6`                               | IPv6 address (e.g., 2001:db8::33)               |
-| `mac-address`   | `--mac-address`                       | Container MAC address (e.g., 92:d0:c6:0a:29:33) |
-| `link-local-ip` | `--link-local-ip`                     | Container IPv4/IPv6 link-local addresses        |
-| `driver-opt`    | `docker network connect --driver-opt` | Network driver options                          |
+| Option          | Top-level Equivalent                  | Description                                                                             |
+|-----------------|---------------------------------------|-----------------------------------------------------------------------------------------|
+| `name`          |                                       | The name of the network (mandatory)                                                     |
+| `alias`         | `--network-alias`                     | Add network-scoped alias for the container                                              |
+| `ip`            | `--ip`                                | IPv4 address (e.g., 172.30.100.104)                                                     |
+| `ip6`           | `--ip6`                               | IPv6 address (e.g., 2001:db8::33)                                                       |
+| `mac-address`   | `--mac-address`                       | Container MAC address (e.g., 92:d0:c6:0a:29:33)                                         |
+| `link-local-ip` | `--link-local-ip`                     | Container IPv4/IPv6 link-local addresses                                                |
+| `driver-opt`    | `docker network connect --driver-opt` | Network driver options                                                                  |
+| `gw-priority`   |                                       | Highest gw-priority provides the default gateway. Accepts positive and negative values. |
 
 ```console
 $ docker network create --subnet 192.0.2.0/24 my-net1

diff --git a/docs/reference/commandline/network_connect.md b/docs/reference/commandline/network_connect.md
@@ -5,14 +5,15 @@ Connect a container to a network
 
 ### Options
 
-| Name                | Type          | Default | Description                                |
-|:--------------------|:--------------|:--------|:-------------------------------------------|
-| [`--alias`](#alias) | `stringSlice` |         | Add network-scoped alias for the container |
-| `--driver-opt`      | `stringSlice` |         | driver options for the network             |
-| [`--ip`](#ip)       | `string`      |         | IPv4 address (e.g., `172.30.100.104`)      |
-| `--ip6`             | `string`      |         | IPv6 address (e.g., `2001:db8::33`)        |
-| [`--link`](#link)   | `list`        |         | Add link to another container              |
-| `--link-local-ip`   | `stringSlice` |         | Add a link-local address for the container |
+| Name                | Type          | Default | Description                                                                             |
+|:--------------------|:--------------|:--------|:----------------------------------------------------------------------------------------|
+| [`--alias`](#alias) | `stringSlice` |         | Add network-scoped alias for the container                                              |
+| `--driver-opt`      | `stringSlice` |         | driver options for the network                                                          |
+| `--gw-priority`     | `int`         | `0`     | Highest gw-priority provides the default gateway. Accepts positive and negative values. |
+| [`--ip`](#ip)       | `string`      |         | IPv4 address (e.g., `172.30.100.104`)                                                   |
+| `--ip6`             | `string`      |         | IPv6 address (e.g., `2001:db8::33`)                                                     |
+| [`--link`](#link)   | `list`        |         | Add link to another container                                                           |
+| `--link-local-ip`   | `stringSlice` |         | Add a link-local address for the container                                              |
 
 
 <!---MARKER_GEN_END-->

diff --git a/opts/network.go b/opts/network.go
@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"regexp"
+	"strconv"
 	"strings"
 )
 
@@ -16,6 +17,7 @@ const (
 	networkOptMacAddress  = "mac-address"
 	networkOptLinkLocalIP = "link-local-ip"
 	driverOpt             = "driver-opt"
+	gwPriorityOpt         = "gw-priority"
 )
 
 // NetworkAttachmentOpts represents the network options for endpoint creation
@@ -28,6 +30,7 @@ type NetworkAttachmentOpts struct {
 	IPv6Address  string
 	LinkLocalIPs []string
 	MacAddress   string
+	GwPriority   int
 }
 
 // NetworkOpt represents a network config in swarm mode.
@@ -83,6 +86,11 @@ func (n *NetworkOpt) Set(value string) error { //nolint:gocyclo
 					netOpt.DriverOpts = make(map[string]string)
 				}
 				netOpt.DriverOpts[key] = val
+			case gwPriorityOpt:
+				netOpt.GwPriority, err = strconv.Atoi(val)
+				if err != nil {
+					return fmt.Errorf("invalid gw-priority: %w", err)
+				}
 			default:
 				return errors.New("invalid field key " + key)
 			}

diff --git a/opts/network_test.go b/opts/network_test.go
@@ -112,6 +112,16 @@ func TestNetworkOptAdvancedSyntax(t *testing.T) {
 				},
 			},
 		},
+		{
+			value: "name=docknet1,gw-priority=10",
+			expected: []NetworkAttachmentOpts{
+				{
+					Target:     "docknet1",
+					Aliases:    []string{},
+					GwPriority: 10,
+				},
+			},
+		},
 	}
 	for _, tc := range testCases {
 		t.Run(tc.value, func(t *testing.T) {

diff --git a/vendor.mod b/vendor.mod
@@ -13,7 +13,7 @@ require (
 	github.com/distribution/reference v0.6.0
 	github.com/docker/cli-docs-tool v0.8.0
 	github.com/docker/distribution v2.8.3+incompatible
-	github.com/docker/docker v27.0.2-0.20241120142749-e5c2b5e10d68+incompatible // master (v-next)
+	github.com/docker/docker v27.0.2-0.20241202115249-87fbd9cd3b37+incompatible // master (v-next)
 	github.com/docker/docker-credential-helpers v0.8.2
 	github.com/docker/go-connections v0.5.0
 	github.com/docker/go-units v0.5.0

diff --git a/vendor.sum b/vendor.sum
@@ -51,8 +51,8 @@ github.com/docker/cli-docs-tool v0.8.0/go.mod h1:8TQQ3E7mOXoYUs811LiPdUnAhXrcVsB
 github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
 github.com/docker/distribution v2.8.3+incompatible h1:AtKxIZ36LoNK51+Z6RpzLpddBirtxJnzDrHLEKxTAYk=
 github.com/docker/distribution v2.8.3+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=
-github.com/docker/docker v27.0.2-0.20241120142749-e5c2b5e10d68+incompatible h1:ZWh4HhdUCagAd3S+gsFPOobHbc562obYFSrz3irGSsU=
-github.com/docker/docker v27.0.2-0.20241120142749-e5c2b5e10d68+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
+github.com/docker/docker v27.0.2-0.20241202115249-87fbd9cd3b37+incompatible h1:Ct0/s+pkUCDPBsQmLVHnBEas8OlTRxNvDXdSa6Y2PfE=
+github.com/docker/docker v27.0.2-0.20241202115249-87fbd9cd3b37+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
 github.com/docker/docker-credential-helpers v0.8.2 h1:bX3YxiGzFP5sOXWc3bTPEXdEaZSeVMrFgOr3T+zrFAo=
 github.com/docker/docker-credential-helpers v0.8.2/go.mod h1:P3ci7E3lwkZg6XiHdRKft1KckHiO9a2rNtyFbZ/ry9M=
 github.com/docker/go v1.5.1-1.0.20160303222718-d30aec9fd63c h1:lzqkGL9b3znc+ZUgi7FlLnqjQhcXxkNM/quxIjBVMD0=

diff --git a/vendor/github.com/docker/docker/api/swagger.yaml b/vendor/github.com/docker/docker/api/swagger.yaml
diff --git a/vendor/github.com/docker/docker/api/types/network/endpoint.go b/vendor/github.com/docker/docker/api/types/network/endpoint.go
diff --git a/vendor/github.com/docker/docker/registry/service.go b/vendor/github.com/docker/docker/registry/service.go
diff --git a/vendor/github.com/docker/docker/registry/service_v2.go b/vendor/github.com/docker/docker/registry/service_v2.go
diff --git a/vendor/github.com/docker/docker/registry/types.go b/vendor/github.com/docker/docker/registry/types.go
diff --git a/vendor/modules.txt b/vendor/modules.txt
@@ -55,7 +55,7 @@ github.com/docker/distribution/registry/client/transport
 github.com/docker/distribution/registry/storage/cache
 github.com/docker/distribution/registry/storage/cache/memory
 github.com/docker/distribution/uuid
-# github.com/docker/docker v27.0.2-0.20241120142749-e5c2b5e10d68+incompatible
+# github.com/docker/docker v27.0.2-0.20241202115249-87fbd9cd3b37+incompatible
 ## explicit
 github.com/docker/docker/api
 github.com/docker/docker/api/types