diff options
| author | Joffrey F <joffrey@docker.com> | 2018-11-08 16:52:32 -0800 |
|---|---|---|
| committer | Joffrey F <joffrey@docker.com> | 2018-11-08 16:55:58 -0800 |
| commit | 6064947431dd36b8aa33a5f2eb850b03302de5ee (patch) | |
| tree | d5d034510d944dde4fb4cedfcc07ce295b97ccf4 | |
| parent | d5bc46ad456ca7f8c008baa31f6623d4f58ccdcd (diff) | |
| download | docker-py-6064947431dd36b8aa33a5f2eb850b03302de5ee.tar.gz | |
Update links docs and fix bug in normalize_links
Signed-off-by: Joffrey F <joffrey@docker.com>
| -rw-r--r-- | docker/api/container.py | 17 | ||||
| -rw-r--r-- | docker/models/containers.py | 6 | ||||
| -rw-r--r-- | docker/utils/utils.py | 2 |
3 files changed, 15 insertions, 10 deletions
diff --git a/docker/api/container.py b/docker/api/container.py index 3947832..8858aa6 100644 --- a/docker/api/container.py +++ b/docker/api/container.py @@ -473,9 +473,11 @@ class ContainerApiMixin(object): signals and reaps processes init_path (str): Path to the docker-init binary ipc_mode (str): Set the IPC mode for the container. - isolation (str): Isolation technology to use. Default: `None`. - links (dict or list of tuples): Either a dictionary mapping name - to alias or as a list of ``(name, alias)`` tuples. + isolation (str): Isolation technology to use. Default: ``None``. + links (dict): Mapping of links using the + ``{'container': 'alias'}`` format. The alias is optional. + Containers declared in this dict will be linked to the new + container using the provided alias. Default: ``None``. log_config (LogConfig): Logging configuration lxc_conf (dict): LXC config. mem_limit (float or str): Memory limit. Accepts float values @@ -605,9 +607,10 @@ class ContainerApiMixin(object): aliases (:py:class:`list`): A list of aliases for this endpoint. Names in that list can be used within the network to reach the container. Defaults to ``None``. - links (:py:class:`list`): A list of links for this endpoint. - Containers declared in this list will be linked to this - container. Defaults to ``None``. + links (dict): Mapping of links for this endpoint using the + ``{'container': 'alias'}`` format. The alias is optional. + Containers declared in this dict will be linked to this + container using the provided alias. Defaults to ``None``. ipv4_address (str): The IP address of this container on the network, using the IPv4 protocol. Defaults to ``None``. ipv6_address (str): The IP address of this container on the @@ -622,7 +625,7 @@ class ContainerApiMixin(object): >>> endpoint_config = client.create_endpoint_config( aliases=['web', 'app'], - links=['app_db'], + links={'app_db': 'db', 'another': None}, ipv4_address='132.65.0.123' ) diff --git a/docker/models/containers.py b/docker/models/containers.py index 4cd7d13..bba0395 100644 --- a/docker/models/containers.py +++ b/docker/models/containers.py @@ -574,8 +574,10 @@ class ContainerCollection(Collection): ``{"label1": "value1", "label2": "value2"}``) or a list of names of labels to set with empty values (e.g. ``["label1", "label2"]``) - links (dict or list of tuples): Either a dictionary mapping name - to alias or as a list of ``(name, alias)`` tuples. + links (dict): Mapping of links using the + ``{'container': 'alias'}`` format. The alias is optional. + Containers declared in this dict will be linked to the new + container using the provided alias. Default: ``None``. log_config (LogConfig): Logging configuration. mac_address (str): MAC address to assign to the container. mem_limit (int or str): Memory limit. Accepts float values diff --git a/docker/utils/utils.py b/docker/utils/utils.py index 4e04caf..a8e814d 100644 --- a/docker/utils/utils.py +++ b/docker/utils/utils.py @@ -441,7 +441,7 @@ def normalize_links(links): if isinstance(links, dict): links = six.iteritems(links) - return ['{0}:{1}'.format(k, v) for k, v in sorted(links)] + return ['{0}:{1}'.format(k, v) if v else k for k, v in sorted(links)] def parse_env_file(env_file): |