diff options
Diffstat (limited to 'docker/api')
| -rw-r--r-- | docker/api/container.py | 48 | ||||
| -rw-r--r-- | docker/api/network.py | 21 | ||||
| -rw-r--r-- | docker/api/service.py | 32 | ||||
| -rw-r--r-- | docker/api/swarm.py | 4 |
4 files changed, 52 insertions, 53 deletions
diff --git a/docker/api/container.py b/docker/api/container.py index afe696c..efcae9b 100644 --- a/docker/api/container.py +++ b/docker/api/container.py @@ -388,13 +388,13 @@ class ContainerApiMixin(object): environment (dict or list): A dictionary or a list of strings in the following format ``["PASSWORD=xxx"]`` or ``{"PASSWORD": "xxx"}``. - dns (list): DNS name servers. Deprecated since API version 1.10. - Use ``host_config`` instead. - dns_opt (list): Additional options to be added to the container's - ``resolv.conf`` file + dns (:py:class:`list`): DNS name servers. Deprecated since API + version 1.10. Use ``host_config`` instead. + dns_opt (:py:class:`list`): Additional options to be added to the + container's ``resolv.conf`` file volumes (str or list): - volumes_from (list): List of container names or Ids to get - volumes from. + volumes_from (:py:class:`list`): List of container names or Ids to + get volumes from. network_disabled (bool): Disable networking name (str): A name for the container entrypoint (str or list): An entrypoint @@ -478,19 +478,19 @@ class ContainerApiMixin(object): device_write_bps: Limit write rate (bytes per second) from a device. device_write_iops: Limit write rate (IO per second) from a device. - devices (list): Expose host devices to the container, as a list - of strings in the form + devices (:py:class:`list`): Expose host devices to the container, + as a list of strings in the form ``<path_on_host>:<path_in_container>:<cgroup_permissions>``. For example, ``/dev/sda:/dev/xvda:rwm`` allows the container to have read-write access to the host's ``/dev/sda`` via a node named ``/dev/xvda`` inside the container. - dns (list): Set custom DNS servers. - dns_search (list): DNS search domains. + dns (:py:class:`list`): Set custom DNS servers. + dns_search (:py:class:`list`): DNS search domains. extra_hosts (dict): Addtional hostnames to resolve inside the container, as a mapping of hostname to IP address. - group_add (list): List of additional group names and/or IDs that - the container process will run as. + group_add (:py:class:`list`): List of additional group names and/or + IDs that the container process will run as. 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 @@ -539,8 +539,8 @@ class ContainerApiMixin(object): - ``Name`` One of ``on-failure``, or ``always``. - ``MaximumRetryCount`` Number of times to restart the container on failure. - security_opt (list): A list of string values to customize labels - for MLS systems, such as SELinux. + security_opt (:py:class:`list`): A list of string values to + customize labels for MLS systems, such as SELinux. shm_size (str or int): Size of /dev/shm (e.g. ``1G``). sysctls (dict): Kernel parameters to set in the container. tmpfs (dict): Temporary filesystems to mount, as a dictionary @@ -555,13 +555,13 @@ class ContainerApiMixin(object): '/mnt/vol1': 'size=3G,uid=1000' } - ulimits (list): Ulimits to set inside the container, as a list of - dicts. + ulimits (:py:class:`list`): Ulimits to set inside the container, + as a list of dicts. userns_mode (str): Sets the user namespace mode for the container when user namespace remapping option is enabled. Supported values are: ``host`` - volumes_from (list): List of container names or IDs to get - volumes from. + volumes_from (:py:class:`list`): List of container names or IDs to + get volumes from. Returns: @@ -618,17 +618,17 @@ class ContainerApiMixin(object): :py:meth:`create_networking_config`. Args: - aliases (list): A list of aliases for this endpoint. Names in - that list can be used within the network to reach the + 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 (list): A list of links for this endpoint. Containers - declared in this list will be linked to this container. - 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 network, using the IPv6 protocol. Defaults to ``None``. - link_local_ips (list): A list of link-local (IPv4/IPv6) + link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6) addresses. Returns: diff --git a/docker/api/network.py b/docker/api/network.py index 7ccda55..9f6d98f 100644 --- a/docker/api/network.py +++ b/docker/api/network.py @@ -11,13 +11,13 @@ class NetworkApiMixin(object): List networks. Similar to the ``docker networks ls`` command. Args: - names (list): List of names to filter by - ids (list): List of ids to filter by + names (:py:class:`list`): List of names to filter by + ids (:py:class:`list`): List of ids to filter by filters (dict): Filters to be processed on the network list. Available filters: - ``driver=[<driver-name>]`` Matches a network's driver. - ``label=[<key>]`` or ``label=[<key>=<value>]``. - - ``type=["custom"|"builtin"] `` Filters networks by type. + - ``type=["custom"|"builtin"]`` Filters networks by type. Returns: (dict): List of network objects. @@ -169,17 +169,18 @@ class NetworkApiMixin(object): Args: container (str): container-id/name to be connected to the network net_id (str): network id - aliases (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 (list): A list of links for this endpoint. Containers - declared in this list will be linkedto this container. - Defaults to ``None``. + 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``. 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 network, using the IPv6 protocol. Defaults to ``None``. - link_local_ips (list): A list of link-local (IPv4/IPv6) addresses. + link_local_ips (:py:class:`list`): A list of link-local + (IPv4/IPv6) addresses. """ data = { "Container": container, diff --git a/docker/api/service.py b/docker/api/service.py index 7708b75..0d8421e 100644 --- a/docker/api/service.py +++ b/docker/api/service.py @@ -13,18 +13,18 @@ class ServiceApiMixin(object): Create a service. Args: - task_template (dict): Specification of the task to start as part - of the new service. + task_template (TaskTemplate): Specification of the task to start as + part of the new service. name (string): User-defined name for the service. Optional. labels (dict): A map of labels to associate with the service. Optional. mode (string): Scheduling mode for the service (``replicated`` or ``global``). Defaults to ``replicated``. - update_config (dict): Specification for the update strategy of the - service. Default: ``None`` - networks (list): List of network names or IDs to attach the - service to. Default: ``None``. - endpoint_config (dict): Properties that can be configured to + update_config (UpdateConfig): Specification for the update strategy + of the service. Default: ``None`` + networks (:py:class:`list`): List of network names or IDs to attach + the service to. Default: ``None``. + endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. Returns: @@ -159,7 +159,7 @@ class ServiceApiMixin(object): ``label`` and ``desired-state``. Returns: - (list): List of task dictionaries. + (:py:class:`list`): List of task dictionaries. Raises: :py:class:`docker.errors.APIError` @@ -186,20 +186,18 @@ class ServiceApiMixin(object): ID). version (int): The version number of the service object being updated. This is required to avoid conflicting writes. - task_template (dict): Specification of the updated task to start - as part of the service. See the [TaskTemplate - class](#TaskTemplate) for details. + task_template (TaskTemplate): Specification of the updated task to + start as part of the service. name (string): New name for the service. Optional. labels (dict): A map of labels to associate with the service. Optional. mode (string): Scheduling mode for the service (``replicated`` or ``global``). Defaults to ``replicated``. - update_config (dict): Specification for the update strategy of the - service. See the [UpdateConfig class](#UpdateConfig) for - details. Default: ``None``. - networks (list): List of network names or IDs to attach the - service to. Default: ``None``. - endpoint_config (dict): Properties that can be configured to + update_config (UpdateConfig): Specification for the update strategy + of the service. Default: ``None``. + networks (:py:class:`list`): List of network names or IDs to attach + the service to. Default: ``None``. + endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. Returns: diff --git a/docker/api/swarm.py b/docker/api/swarm.py index 3ada538..8877056 100644 --- a/docker/api/swarm.py +++ b/docker/api/swarm.py @@ -143,8 +143,8 @@ class SwarmApiMixin(object): Make this Engine join a swarm that has already been created. Args: - remote_addrs (list): Addresses of one or more manager nodes already - participating in the Swarm to join. + remote_addrs (:py:class:`list`): Addresses of one or more manager + nodes already participating in the Swarm to join. join_token (string): Secret token for joining this Swarm. listen_addr (string): Listen address used for inter-manager communication if the node gets promoted to manager, as well as |