Per-interface sysctls #47686

robmry · 2024-04-05T16:35:32Z

- What I did

Closes Per-interface sysctls #47639

Until now it's been possible to set per-interface sysctls using, for example, --sysctl net.ipv6.conf.eth0.accept_ra=2. But, the index in the interface name is allocated serially, and the numbering in a container with more than one interface may change when a container is restarted. The change to make it possible to connect a container to more than one network when it's created increased the ambiguity.

This change adds label com.docker.network.endpoint.sysctls to the DriverOpts in EndpointSettings. This option is explicitly associated with the interface.

Settings in --sysctl for eth0 are migrated to EndpointSettings.DriverOpts.

Because using --sysctl with any interface apart from eth0 would have unpredictable results, it is now an error to use any other interface name in the top level --sysctl option. The error message includes a hint at how to use the new per-interface setting.

The per-endpoint sysctl name has the interface name replaced by the string IFNAME, for example:
net.ipv6.conf.eth0.accept_ra=2
becomes:
net.ipv6.conf.IFNAME.accept_ra=2

(The string ifname is also accepted because, for some reason, the CLI converts names to lower-case.)

The value of DriverOpts["com.docker.network.endpoint.sysctls"] is a comma separated list of these sysctls.

Settings from --sysctl are applied by the runtime lib during task creation. So, task creation fails if the endpoint does not exist. Applying per-endpoint settings during interface configuration means the endpoint can be created later, which paves the way for removal of the SetKey OCI prestart hook.

Unlike other DriverOpts, the sysctl label itself is not driver-specific, but each driver has a chance to check settings/values and raise an error if a setting would cause it a problem - no such checks have been added in this initial version. As a future extension, if required, it would be possible for the driver to echo back valid/extended/modified settings to libnetwork for it to apply to the interface. (At that point, the syntax for the options could become driver specific to allow, for example, a driver to create more than one interface.)

- How I did it

migrate per-endpoint sysctls from the top-level into per-interface DriverOpts
pass those per-interface sysctls to the osl.Network, along with other config values for the interface
apply those sysctls during interface configuration (which currently still happens during the SetKey prestart callback, but needn't)

- How to verify it

New unit and integration tests.

And ...

Migration of one or two top level --sysctl settings ...

# docker run --rm -ti --name c1 --network mynet --sysctl=net.ipv6.conf.eth0.accept_ra=2 alpine
WARNING: Migrated sysctl "net.ipv6.conf.eth0.accept_ra" to DriverOpts{"com.docker.network.endpoint.sysctls":"net.ipv6.conf.IFNAME.accept_ra=2"}.
/ #

# docker run --rm -ti --name c1 --network mynet --sysctl=net.ipv6.conf.eth0.accept_ra=2 --sysctl=net.ipv6.conf.eth0.forwarding=1 alpine
WARNING: Migrated sysctl "net.ipv6.conf.eth0.accept_ra,net.ipv6.conf.eth0.forwarding" to DriverOpts{"com.docker.network.endpoint.sysctls":"net.ipv6.conf.IFNAME.accept_ra=2,net.ipv6.conf.IFNAME.forwarding=1"}.
/ #

Inspect output ...

# docker run --rm -ti --name c1 --network mynet --sysctl=net.ipv6.conf.eth0.accept_ra=2 --sysctl=net.ipv6.conf.eth0.forwarding=1 --sysctl=net.ipv6.conf.default.disable_ipv6=0 alpine
...

# docker inspect c1
[
    {
        ...
        "HostConfig": {
            ...
            "Sysctls": {
                "net.ipv6.conf.default.disable_ipv6": "0"
            },
        ...
        "NetworkSettings": {
             ...
            "Networks": {
                "mynet": {
                ...
                    "DriverOpts": {
                        "com.docker.network.endpoint.sysctls": "net.ipv6.conf.IFNAME.accept_ra=2,net.ipv6.conf.IFNAME.forwarding=1"
                    },
                ...
]

No migration for eth1 ...

# docker run --rm -ti --name c1 --network mynet --sysctl=net.ipv6.conf.eth1.accept_ra=2 alpine
docker: Error response from daemon: unable to determine network endpoint for sysctl net.ipv6.conf.eth1.accept_ra, use driver option 'com.docker.network.endpoint.sysctls' to set per-interface sysctls.
See 'docker run --help'.

Attempt to set a per-interface sysctl for an unknown protocol ...

# docker run --rm -ti --name c1 --network mynet --sysctl=net.blah.conf.eth0.input=1 alpine
docker: Error response from daemon: invalid config for network mynet: invalid endpoint settings:
unrecognised network interface sysctl 'net.blah.conf.IFNAME.input=1'; represent 'net.X.Y.ethN.Z=V' as 'net.X.Y.IFNAME.Z=V', 'X' must be 'ipv4', 'ipv6' or 'mpls'.
See 'docker run --help'.

Nonexistent sysctl (very verbose error message at the moment) ...

# docker run --rm -ti --name c1 --network mynet --sysctl=net.ipv6.conf.eth0.foo=1 alpine
WARNING: Migrated sysctl "net.ipv6.conf.eth0.foo" to DriverOpts{"com.docker.network.endpoint.sysctls":"net.ipv6.conf.IFNAME.foo=1"}.
docker: Error response from daemon: failed to create task for container: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: error during container init: error running hook #0: error running hook: exit status 1, stdout: , stderr: failed to add interface veth93624eb to sandbox: /proc/sys/net/ipv6/conf/eth0/foo is not a sysctl file: unknown.

But, a lot of that waffle will go-away once the prestart hook is removed and settings are applied after task creation. It'll be more like ...

# docker run --rm -ti --name c1 --network mynet --sysctl=net.ipv6.conf.eth0.foo=1 alpine
WARNING: Migrated net.ipv6.conf.eth0.foo to DriverOpts{"com.docker.network.endpoint.sysctls":"ipv6.conf.foo=1"}.
docker: Error response from daemon: unable to write to '/proc/sys/net/ipv6/conf/eth0/foo': /proc/sys/net/ipv6/conf/eth0/foo is not a sysctl file: unknown.

- Description for the changelog

Allow sysctls to be set per-interface during container creation and network connection.

api/server/router/container/container_routes.go

akerouanton · 2024-04-15T14:52:20Z

api/server/router/container/container_routes.go

+			// Only try to migrate settings for "eth0", anything else would always
+			// have behaved unpredictably.
+			if spl[3] != "eth0" {
+				return "", fmt.Errorf(`unable to determine network endpoint for sysctl %s, use '--network=name=%s,sysctl=%s' or compose 'driver_opts: "%s":"%s"`,


I think we shouldn't put CLI-specific or Compose-specific remediation steps here -- the API could be called by other tools where those steps won't make any sense.

OTOH CLI error messages sometimes looks cryptic for users not familiar with our API. I think we don't have a plan for 'augmenting' CLI error messages with remediation steps. Maybe that's something we need to discuss.

Yes, it's not great, but I'm not sure how best to improve it.

I think it's quite important that we give good clues about how to specify per-interface sysctls - here, for the migration case below, and for when we refuse to migrate from the top level --sysctl in a future release.

A "for example" might help a little, since CLI and compose are probably the common cases. But, not really.

Maybe the best we can do is just delete the hints, and hope the user's able to find the right section of the docs.

I'm not sure how augmented CLI messages would work, perhaps the API would need to return some token that'd tell the client to explain how to set per-interface sysctls in its world (extended --network syntax for the CLI, or driver-opts in compose)? I'm probably missing the point (?!), but any sort of mechanism like that sounds like a big change that'd have to be out-of-scope here.

I changed the message (and updated the examples in PR description to show it) ... now it only mentions the driver-opt label - and the user will have to figure out how to use it.

But I've also updated the CLI PR docker/cli#4994 to get rid of the --network sysctl= option and document the use of [create|run] --network driver-opt=com.docker.network.endpoint.sysctls=[value] and network connect --driver-opt=com.docker.network.endpoint.sysctls= to set multiple sysctls for an endpoint.

akerouanton · 2024-04-15T14:59:46Z

api/server/router/container/container_routes.go

+		return "", nil
+	}
+
+	// TODO(robmry) - refuse to do the migration, generate an error if API > some-future-version.


Next API version should be fine.

This change should land in release 27.0 (along with re-removing the SetKey hook that requires it). So, we'd want to deprecate per-interface sysctls in --sysctl in 27.0, and remove the auto-migration in 28.0.

The current API version is 1.45, and it will be in the upcoming release 26.1. But, it might change in 27.0? In that case, if we make this code check for API version >1.45, we'll have accidentally removed the auto-migration in release 27.0.

So, it's probably best to raise a new issue to say a version check needs to be added, and mark it for milestone 28.0?

So, it's probably best to raise a new issue to say a version check needs to be added, and mark it for milestone 28.0?

#47651 bumped the API version for v27 but AFAICT there are no API changes committed yet. I'm fine with opening a new ticket for that.

Ok, good - I've restricted the migration to API <= 1.46.

api/server/router/container/container_routes.go

api/server/router/container/container_routes_test.go

corhere · 2024-05-15T16:34:29Z

api/server/router/container/container_routes.go

+	// TODO(robmry) - refuse to do the migration, generate an error if API > some-future-version.
+
+	newDriverOpt := strings.Join(netIfSysctls, ",")
+	warning := fmt.Sprintf(`Migrated %s to DriverOpts{"%s":"%s"}.`,


Suggested change

warning := fmt.Sprintf(`Migrated %s to DriverOpts{"%s":"%s"}.`,

warning := fmt.Sprintf(`Migrated sysctl %q to DriverOpts{%q:%q}.`,

The second example in the description:

# docker run --rm -ti --name c1 --network mynet --sysctl=net.ipv6.conf.eth0.accept_ra=2 --sysctl=net.ipv6.conf.eth0.forwarding=1 alpine WARNING: Migrated net.ipv6.conf.eth0.accept_ra,net.ipv6.conf.eth0.forwarding to DriverOpts{"com.docker.network.endpoint.sysctls":"ipv6.conf.accept_ra=2,ipv6.conf.forwarding=1"}.

Would become:

# docker run --rm -ti --name c1 --network mynet --sysctl=net.ipv6.conf.eth0.accept_ra=2 --sysctl=net.ipv6.conf.eth0.forwarding=1 alpine WARNING: Migrated sysctl "net.ipv6.conf.eth0.accept_ra,net.ipv6.conf.eth0.forwarding" to DriverOpts{"com.docker.network.endpoint.sysctls":"ipv6.conf.accept_ra=2,ipv6.conf.forwarding=1"}.

Maybe that's ok, or would be without the quotes around the list, and ignoring sysctl vs. sysctls.

Another option would be:

# docker run --rm -ti --name c1 --network mynet --sysctl=net.ipv6.conf.eth0.accept_ra=2 --sysctl=net.ipv6.conf.eth0.forwarding=1 alpine WARNING: Migrated sysctl "net.ipv6.conf.eth0.accept_ra" to DriverOpts{"com.docker.network.endpoint.sysctls":"ipv6.conf.accept_ra=2"}. WARNING: Migrated sysctl "net.ipv6.conf.eth0.forwarding" to DriverOpts{"com.docker.network.endpoint.sysctls":"ipv6.conf.forwarding=1"}.

But, that doesn't show the value that really needs to be passed to DriverOpts.

I think it's unambiguous as-is, the named sysctls won't be interpreted as anything but sysctls from the request.

But, could do Migrated sysctl %s to DriverOpts{%q:%q}. if you think it's necessary?

But, could do Migrated sysctl %s to DriverOpts{%q:%q}. if you think it's necessary?

Yes. You are formatting user-supplied garbage, with the expectation for users to copy-paste them back into docker commands. What if there are quote characters in the input strings?

Ah right, I see. Thank you.

daemon/container_operations.go

corhere · 2024-05-15T18:19:00Z

libnetwork/osl/interface_linux.go

+		scPath = append(scPath, sk[2:]...)
+
+		sysPath := filepath.Join(scPath...)
+		errC := make(chan error, 1)


n.InvokeFunc is a synchronous blocking call so there is no need to communicate through a channel.

var errF error f := func() { if err := ...; err != nil { errF = err return } } if err := n.InvokeFunc(f); err != nil { return err } if errF != nil { return err }

Signed-off-by: Rob Murray <rob.murray@docker.com>

api/swagger.yaml

api/server/router/container/container_routes_test.go

api/server/router/container/container_routes.go

corhere

I discovered some interesting prior art for per-iface sysctls: whatever CNI plugin OpenShift ships with accepts the full dotted sysctl name with the token IFNAME used as a placeholder for the interface name. It's an interesting contrast to our shortening scheme. Is our scheme too clever for users to figure out?

corhere · 2024-05-22T21:15:39Z

api/server/router/container/container_routes.go

+	// Append exiting per-endpoint sysctls to the migrated sysctls (give priority
+	// to per-endpoint settings).


Suggested change

// Append exiting per-endpoint sysctls to the migrated sysctls (give priority

// to per-endpoint settings).

// Append existing per-endpoint sysctls to the migrated sysctls (give priority

// to per-endpoint settings).

corhere · 2024-05-22T21:20:10Z

integration/networking/bridge_test.go

+
+	const scName = "net.ipv4.conf.eth0.forwarding"
+	for _, val := range []string{"0", "1"} {
+		t.Run("set to "+val, func(t *testing.T) {


Suggested change

t.Run("set to "+val, func(t *testing.T) {

t.Run("ipv4.conf.forwarding="+val, func(t *testing.T) {

I missed this - but changed it anyway for the new IFNAME schem, slightly-differently ... the CLI converts driver-opts to lower case (it probably shouldn't) - so the test now checks that both IFNAME and ifname are allowed, nesting loops with a structured test name.

corhere · 2024-05-22T21:38:59Z

daemon/container_operations.go

+	if sysctls, ok := epConfig.DriverOpts[netlabel.EndpointSysctls]; ok {
+		for _, sysctl := range strings.Split(sysctls, ",") {
+			scname := strings.SplitN(sysctl, ".", 3)
+			if len(scname) != 3 || (scname[0] != "ipv4" && scname[0] != "ipv6") {


On second thought, we should probably also allow mpls. As MPLS packets can transit Ethernet links, some users (particularly in datacenter and telecom environments) may have use cases for enabling MPLS on e.g. a macvlan iface.

corhere · 2024-05-22T21:51:38Z

libnetwork/osl/interface_linux.go

+		scPath := []string{"/proc/sys/net", sk[0], sk[1], ifName}
+		scPath = append(scPath, sk[2:]...)


Suggested change

scPath := []string{"/proc/sys/net", sk[0], sk[1], ifName}

scPath = append(scPath, sk[2:]...)

scPath := append([]string{"/proc/sys/net", sk[0], sk[1], ifName}, sk[2:]...)

Done, slightly differently, for the IFNAME scheme.

corhere · 2024-05-24T20:16:26Z

Maintainer call: consensus is to go forward with specifying the full sysctl name where an IFNAME token is used as a placeholder for the actual interface name, like how the tuning CNI plugin is configured to apply sysctls. We believe that users will have an easier time applying sysctls when the sysctl name is more closely aligned with the name which would be passed to the sysctl command or listed in kernel docs.

robmry · 2024-05-26T12:27:46Z

Maintainer call: consensus is to go forward with specifying the full sysctl name where an IFNAME token is used as a placeholder for the actual interface name, like how the tuning CNI plugin is configured to apply sysctls. We believe that users will have an easier time applying sysctls when the sysctl name is more closely aligned with the name which would be passed to the sysctl command or listed in kernel docs.

Done.

corhere

The commit message for abf6de3 needs to be updated to reflect the new IFNAME scheme.

Until now it's been possible to set per-interface sysctls using, for example, '--sysctl net.ipv6.conf.eth0.accept_ra=2'. But, the index in the interface name is allocated serially, and the numbering in a container with more than one interface may change when a container is restarted. The change to make it possible to connect a container to more than one network when it's created increased the ambiguity. This change adds label "com.docker.network.endpoint.sysctls" to the DriverOpts in EndpointSettings. This option is explicitly associated with the interface. Settings in "--sysctl" for "eth0" are migrated to DriverOpts. Because using "--sysctl" with any interface apart from "eth0" would have unpredictable results, it is now an error to use any other interface name in the top level "--sysctl" option. The error message includes a hint at how to use the new per-interface setting. The per-endpoint sysctl name has the interface name replaced by "IFNAME". For example: net.ipv6.conf.eth0.accept_ra=2 becomes: net.ipv6.conf.IFNAME.accept_ra=2 The value of DriverOpts["com.docker.network.endpoint.sysctls"] is a comma separated list. Settings from '--sysctl' are applied by the runtime lib during task creation. So, task creation fails if the endpoint does not exist. Applying per-endpoint settings during interface configuration means the endpoint can be created later, which paves the way for removal of the SetKey OCI prestart hook. Unlike other DriverOpts, the sysctl label itself is not driver-specific, but each driver has a chance to check settings/values and raise an error if a setting would cause it a problem - no such checks have been added in this initial version. As a future extension, if required, it would be possible for the driver to echo back valid/extended/modified settings to libnetwork for it to apply to the interface. (At that point, the syntax for the options could become driver specific to allow, for example, a driver to create more than one interface). Signed-off-by: Rob Murray <rob.murray@docker.com>

robmry · 2024-05-28T08:58:12Z

The commit message for abf6de3 needs to be updated to reflect the new IFNAME scheme.

Thank you - fixed.

akerouanton

One small nit about an outdated comment but otherwise LGTM.

akerouanton · 2024-05-29T05:32:00Z

api/server/router/container/container_routes.go

+	for k, v := range hostConfig.Sysctls {
+		// If the sysctl name matches "net.*.*.eth0.*" ...
+		if spl := strings.SplitN(k, ".", 5); len(spl) == 5 && spl[0] == "net" && strings.HasPrefix(spl[3], "eth") {
+			// Transform the name to the endpoint-specific short form.


Suggested change

// Transform the name to the endpoint-specific short form.

robmry self-assigned this Apr 5, 2024

robmry added kind/enhancement Enhancements are not bugs or new features but can improve usability or performance. area/networking impact/changelog impact/documentation labels Apr 5, 2024

robmry mentioned this pull request Apr 8, 2024

Document CLI support for per interface sysctls docker/cli#4994

Open

robmry removed the impact/documentation label Apr 8, 2024

robmry force-pushed the 47639_per-interface-sysctls branch from 79f4458 to 745a4c4 Compare April 8, 2024 09:31

robmry marked this pull request as ready for review April 8, 2024 10:12

robmry requested review from akerouanton and corhere April 8, 2024 10:12

robmry mentioned this pull request Apr 15, 2024

Docker 26 breaks kata networking kata-containers/kata-containers#9340

Open

akerouanton reviewed Apr 15, 2024

View reviewed changes

robmry force-pushed the 47639_per-interface-sysctls branch from 745a4c4 to 5d0ab3f Compare April 18, 2024 13:45

robmry force-pushed the 47639_per-interface-sysctls branch from 5d0ab3f to 5d70d23 Compare April 29, 2024 17:38

robmry force-pushed the 47639_per-interface-sysctls branch 2 times, most recently from 2edd300 to 2681c58 Compare May 8, 2024 16:07

robmry added this to the 27.0.0 milestone May 9, 2024

This was referenced May 14, 2024

Add driver_opts to services.networks compose-spec/compose-go#627

Merged

Add driver_opts to services.networks compose-spec/compose-spec#498

Merged

Per endpoint driver opts docker/compose#11815

Merged

corhere reviewed May 15, 2024

View reviewed changes

robmry force-pushed the 47639_per-interface-sysctls branch from 2681c58 to 93e43d5 Compare May 16, 2024 08:45

robmry added 2 commits May 17, 2024 11:30

Factor out selection of endpoint for config migration

a35716f

Signed-off-by: Rob Murray <rob.murray@docker.com>

Move EndpointSettings.DriverOpts from op-state to config

1e29f9b

Signed-off-by: Rob Murray <rob.murray@docker.com>

akerouanton reviewed May 17, 2024

View reviewed changes

api/swagger.yaml Show resolved Hide resolved

api/server/router/container/container_routes_test.go Show resolved Hide resolved

robmry force-pushed the 47639_per-interface-sysctls branch 4 times, most recently from b178729 to e29f2f0 Compare May 21, 2024 09:17

akerouanton reviewed May 21, 2024

View reviewed changes

api/server/router/container/container_routes.go Outdated Show resolved Hide resolved

robmry force-pushed the 47639_per-interface-sysctls branch from e29f2f0 to 058bf75 Compare May 21, 2024 10:26

akerouanton approved these changes May 21, 2024

View reviewed changes

corhere reviewed May 22, 2024

View reviewed changes

corhere approved these changes May 22, 2024

View reviewed changes

robmry force-pushed the 47639_per-interface-sysctls branch 3 times, most recently from 466bf3a to abf6de3 Compare May 26, 2024 12:25

robmry requested review from akerouanton and corhere May 26, 2024 12:27

corhere approved these changes May 27, 2024

View reviewed changes

robmry force-pushed the 47639_per-interface-sysctls branch from abf6de3 to a5dc638 Compare May 28, 2024 08:57

akerouanton approved these changes May 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Per-interface sysctls #47686

Per-interface sysctls #47686

robmry commented Apr 5, 2024 •

edited

akerouanton Apr 15, 2024

robmry Apr 16, 2024

robmry May 8, 2024 •

edited

akerouanton Apr 15, 2024

robmry Apr 18, 2024 •

edited

akerouanton May 17, 2024

robmry May 17, 2024

corhere May 15, 2024

robmry May 16, 2024

corhere May 16, 2024

robmry May 17, 2024

corhere May 15, 2024

robmry May 16, 2024

corhere left a comment

corhere May 22, 2024

robmry May 26, 2024

corhere May 22, 2024

robmry May 26, 2024

corhere May 22, 2024

robmry May 26, 2024

corhere May 22, 2024

robmry May 26, 2024

corhere commented May 24, 2024

robmry commented May 26, 2024

corhere left a comment

robmry commented May 28, 2024

akerouanton left a comment

akerouanton May 29, 2024

	warning := fmt.Sprintf(`Migrated %s to DriverOpts{"%s":"%s"}.`,
	warning := fmt.Sprintf(`Migrated sysctl %q to DriverOpts{%q:%q}.`,

		// Append exiting per-endpoint sysctls to the migrated sysctls (give priority
		// to per-endpoint settings).

	t.Run("set to "+val, func(t *testing.T) {
	t.Run("ipv4.conf.forwarding="+val, func(t *testing.T) {

		scPath := []string{"/proc/sys/net", sk[0], sk[1], ifName}
		scPath = append(scPath, sk[2:]...)

	scPath := []string{"/proc/sys/net", sk[0], sk[1], ifName}
	scPath = append(scPath, sk[2:]...)
	scPath := append([]string{"/proc/sys/net", sk[0], sk[1], ifName}, sk[2:]...)

Per-interface sysctls #47686

Are you sure you want to change the base?

Per-interface sysctls #47686

Conversation

robmry commented Apr 5, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robmry May 8, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robmry Apr 18, 2024 • edited

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

corhere 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

corhere commented May 24, 2024

robmry commented May 26, 2024

corhere left a comment

Choose a reason for hiding this comment

robmry commented May 28, 2024

akerouanton left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robmry commented Apr 5, 2024 •

edited

robmry May 8, 2024 •

edited

robmry Apr 18, 2024 •

edited