Fix mac_address ignored on API v1.44+ when network is specified#3396
Open
lasssim wants to merge 1 commit into
Open
Fix mac_address ignored on API v1.44+ when network is specified#3396lasssim wants to merge 1 commit into
lasssim wants to merge 1 commit into
Conversation
lasssim
force-pushed
the
fix/mac-address-endpoint-config
branch
from
6c05d8e to
46576cc
Compare
Docker Engine API v1.44+ (Docker Engine 25.0+) deprecated the mac_address field on the container config. The MAC address must now be set via EndpointConfig in the networking_config for the target network. When both `network` and `mac_address` are passed to `containers.create()` or `containers.run()`, and the negotiated API version is >= 1.44, move `mac_address` into the EndpointConfig for the target network so it takes effect on modern Docker engines. On older API versions (< 1.44) the behaviour is unchanged — `mac_address` stays on the container config where it has always worked. Fixes docker#3283 Signed-off-by: Simon Lasselsberger <simon@lasssim.com>
lasssim
force-pushed
the
fix/mac-address-endpoint-config
branch
from
46576cc to
2cc63c9
Compare
There was a problem hiding this comment.
Pull request overview
This PR updates container argument construction to ensure mac_address is honored on Docker Engine API v1.44+ when a target network is specified, by placing the MAC address into the network’s EndpointConfig (networking_config) instead of the deprecated container-config field.
Changes:
- Move
mac_addressintonetworking_config.EndpointsConfig[network].MacAddresswhen API version >= 1.44 andnetworkis specified. - Keep legacy behavior (leave
mac_addresson container config) for API versions < 1.44. - Update and add unit tests to cover old/new API behavior for MAC address placement.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docker/models/containers.py |
Adds API-version-gated logic to relocate mac_address into the target network’s EndpointConfig. |
tests/unit/models_containers_test.py |
Updates expected args and adds tests to validate behavior across API version boundaries. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1174
to
+1176
| endpoint = networking_config.get(network) | ||
| if endpoint is not None and 'MacAddress' not in endpoint: | ||
| endpoint['MacAddress'] = mac_address |
Comment on lines
+249
to
+262
| def test_create_container_args_mac_address_new_api(self): | ||
| """On API >= 1.44, mac_address moves into EndpointConfig.""" | ||
| create_kwargs = _create_container_args({ | ||
| 'image': 'alpine', | ||
| 'command': '/bin/sh', | ||
| 'mac_address': 'abc123', | ||
| 'network': 'foo', | ||
| 'version': '1.44', | ||
| }) | ||
|
|
||
| assert 'mac_address' not in create_kwargs | ||
| net_config = create_kwargs['networking_config'] | ||
| assert net_config['EndpointsConfig']['foo']['MacAddress'] == 'abc123' | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Docker Engine API v1.44+ (Docker Engine 25.0+) deprecated the
mac_addressfield on the container config. The MAC address must now be set viaEndpointConfigin thenetworking_configfor the target network.Currently, when both
networkandmac_addressare passed tocontainers.create()orcontainers.run(), themac_addressends up on the container config where modern Docker engines silently ignore it. This PR fixes that by movingmac_addressinto theEndpointConfigfor the target network when API version >= 1.44.On older API versions (< 1.44) the behaviour is unchanged.
Reproducer
Fix
In
_create_container_args(), whennetworkis specified and the API version is >= 1.44, popmac_addressfrom the container config and inject it into theEndpointConfigfor the target network.The version check uses the existing
version_gte()helper and theversionvalue already passed throughhost_config_kwargs.Test plan
test_create_container_argsto expectMacAddressinEndpointsConfiginstead of on the container config (test usesDEFAULT_DOCKER_API_VERSION = '1.45')networking_configFixes #3283