Skip to content

Commit

Permalink
Pass networks to Daemon on container creation.
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfontein committed Jul 19, 2024
1 parent a30fd93 commit ebe2fd0
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 6 deletions.
8 changes: 8 additions & 0 deletions changelogs/fragments/933-docker_container-networks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
minor_changes:
- "docker_container - when creating a network, directly pass the networks to connect to to the Docker Daemon.
This makes creation more efficient and works around a bug in Docker Daemon that does not use the specified
MAC address in at least some cases, though only for creation (https://github.com/ansible-collections/community.docker/pull/933)."
known_issues:
- "docker_container - when specifying a MAC address for a container's network, and the network is attached
after container creation (for example, due to idempotency checks), the MAC address is at least in some
cases ignored by the Docker Daemon (https://github.com/ansible-collections/community.docker/pull/933)."
2 changes: 1 addition & 1 deletion plugins/module_utils/module_container/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ def connect_container_to_network(self, client, container_id, network_id, paramet
pass

@abc.abstractmethod
def create_container(self, client, container_name, create_parameters):
def create_container(self, client, container_name, create_parameters, networks=None):
pass

@abc.abstractmethod
Expand Down
19 changes: 16 additions & 3 deletions plugins/module_utils/module_container/docker_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,8 @@ def unpause_container(self, client, container_id):
def disconnect_container_from_network(self, client, container_id, network_id):
client.post_json('/networks/{0}/disconnect', network_id, data={'Container': container_id})

def connect_container_to_network(self, client, container_id, network_id, parameters=None):
parameters = (parameters or {}).copy()
def _create_endpoint_config(self, parameters):
parameters = parameters.copy()
params = {}
for para, dest_para in {
'ipv4_address': 'IPv4Address',
Expand All @@ -268,16 +268,29 @@ def connect_container_to_network(self, client, container_id, network_id, paramet
ipam_config[param] = params.pop(param)
if ipam_config:
params['IPAMConfig'] = ipam_config
return params

def connect_container_to_network(self, client, container_id, network_id, parameters=None):
parameters = (parameters or {}).copy()
params = self._create_endpoint_config(parameters or {})
data = {
'Container': container_id,
'EndpointConfig': params,
}
client.post_json('/networks/{0}/connect', network_id, data=data)

def create_container(self, client, container_name, create_parameters):
def create_container(self, client, container_name, create_parameters, networks=None):
params = {'name': container_name}
if 'platform' in create_parameters:
params['platform'] = create_parameters.pop('platform')
if networks is not None:
create_parameters = create_parameters.copy()
create_parameters['NetworkingConfig'] = {
'EndpointsConfig': {
network: self._create_endpoint_config(network_params)
for network, network_params in networks.items()
}
}
new_container = client.post_json_to_json('/containers/create', data=create_parameters, params=params)
client.report_warnings(new_container)
return new_container['Id']
Expand Down
11 changes: 9 additions & 2 deletions plugins/module_utils/module_container/module.py
Original file line number Diff line number Diff line change
Expand Up @@ -766,12 +766,19 @@ def container_create(self, image):
self.log("create container")
self.log("image: %s parameters:" % image)
self.log(create_parameters, pretty_print=True)
self.results['actions'].append(dict(created="Created container", create_parameters=create_parameters))
networks = {}
if self.module.params['networks']:
for network in self.module.params['networks']:
networks[network['name']] = {
key: value for key, value in network.items()
if key not in ('name', 'id')
}
self.results['actions'].append(dict(created="Created container", create_parameters=create_parameters, networks=networks))
self.results['changed'] = True
new_container = None
if not self.check_mode:
try:
container_id = self.engine_driver.create_container(self.client, self.param_name, create_parameters)
container_id = self.engine_driver.create_container(self.client, self.param_name, create_parameters, networks=networks)
except Exception as exc:
self.fail("Error creating container: %s" % to_native(exc))
return self._get_container(container_id)
Expand Down
3 changes: 3 additions & 0 deletions plugins/modules/docker_container.py
Original file line number Diff line number Diff line change
Expand Up @@ -722,6 +722,9 @@
description:
- Endpoint MAC address (for example, V(92:d0:c6:0a:29:33)).
- This is only available for Docker API version 1.44 and later.
- Please note that when a container is attached to a network after creation,
this is currently ignored by the Docker Daemon at least in some cases.
When passed on creation, this seems to work better.
type: str
version_added: 3.6.0
networks_cli_compatible:
Expand Down

0 comments on commit ebe2fd0

Please sign in to comment.