q_aDddlZddlmZddlmZmZddlmZddlm Z ddlm Z eje Z GddZy) N)DEFAULT_SWARM_ADDR_POOLDEFAULT_SWARM_SUBNET_SIZE)errors)types)utilsceZdZdZej ddZej d ddZej ddZejdej ddZ ej d dd Z ej ddd Z ej ddd Z ejdej ddd Zej dd Zej dddZej d ddZy) SwarmApiMixinc||jdd}|r|g|d<tj|jg|i|S)a^ Create a :py:class:`docker.types.SwarmSpec` instance that can be used as the ``swarm_spec`` argument in :py:meth:`~docker.api.swarm.SwarmApiMixin.init_swarm`. Args: task_history_retention_limit (int): Maximum number of tasks history stored. snapshot_interval (int): Number of logs entries between snapshot. keep_old_snapshots (int): Number of snapshots to keep beyond the current snapshot. log_entries_for_slow_followers (int): Number of log entries to keep around to sync up slow followers after a snapshot is created. heartbeat_tick (int): Amount of ticks (in seconds) between each heartbeat. election_tick (int): Amount of ticks (in seconds) needed without a leader to trigger a new election. dispatcher_heartbeat_period (int): The delay for an agent to send a heartbeat to the dispatcher. node_cert_expiry (int): Automatic expiry for nodes certificates. external_cas (:py:class:`list`): Configuration for forwarding signing requests to an external certificate authority. Use a list of :py:class:`docker.types.SwarmExternalCA`. name (string): Swarm's name labels (dict): User-defined key/value metadata. signing_ca_cert (str): The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format. signing_ca_key (str): The desired signing CA key for all swarm node TLS leaf certificates, in PEM format. ca_force_rotate (int): An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified. autolock_managers (boolean): If set, generate a key and use it to lock data stored on the managers. log_driver (DriverConfig): The default log driver to use for tasks created in the orchestrator. Returns: :py:class:`docker.types.SwarmSpec` Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> spec = client.api.create_swarm_spec( snapshot_interval=5000, log_entries_for_slow_followers=1200 ) >>> client.api.init_swarm( advertise_addr='eth0', listen_addr='0.0.0.0:5000', force_new_cluster=False, swarm_spec=spec ) external_caN external_cas)popr SwarmSpec_version)selfargskwargsext_cas 2/usr/lib/python3/dist-packages/docker/api/swarm.pycreate_swarm_speczSwarmApiMixin.create_swarm_spec sApM40 &,XF> "t}}>t>v>>z1.24cb|j|j|jddS)z Get the unlock key for this Swarm manager. Returns: A ``dict`` containing an ``UnlockKey`` member z/swarm/unlockkeyT)_result_get_url)rs rget_unlock_keyzSwarmApiMixin.get_unlock_keyJs(||DIIdii0B&CDdKKrNc0|jd}|t|ts td|=t j |j drtjd|t}|=t j |j drtjd|t}||||||d} |:t j |j drtjd|| d <|j|| } |j| d S) a Initialize a new Swarm using the current connected engine as the first node. Args: advertise_addr (string): Externally reachable address advertised to other nodes. This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the port number from the listen address is used. If ``advertise_addr`` is not specified, it will be automatically detected when possible. Default: None listen_addr (string): Listen address used for inter-manager communication, as well as determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the default swarm listening port is used. Default: '0.0.0.0:2377' force_new_cluster (bool): Force creating a new Swarm, even if already part of one. Default: False swarm_spec (dict): Configuration settings of the new Swarm. Use ``APIClient.create_swarm_spec`` to generate a valid configuration. Default: None default_addr_pool (list of strings): Default Address Pool specifies default subnet pools for global scope networks. Each pool should be specified as a CIDR block, like '10.0.0.0/8'. Default: None subnet_size (int): SubnetSize specifies the subnet size of the networks created from the default subnet pool. Default: None data_path_addr (string): Address or interface to use for data path traffic. For example, 192.168.1.1, or an interface, like eth0. Returns: (str): The ID of the created node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /swarm/initzswarm_spec must be a dictionaryz1.39z6Address pool is only available for API version >= 1.39z5Subnet size is only available for API version >= 1.39) AdvertiseAddr ListenAddrDefaultAddrPool SubnetSizeForceNewClusterSpec1.30;Data address path is only available for API version >= 1.30 DataPathAddrdataT)json) r isinstancedict TypeErrorr version_ltrrInvalidVersionrr _post_jsonr) radvertise_addr listen_addrforce_new_cluster swarm_specdefault_addr_pool subnet_sizedata_path_addrurlr(responses r init_swarmzSwarmApiMixin.init_swarmTs)\ii &  !*Z*F=> >  ( v6++L"7  " v6++K!($;!,%0%0    % v6++*$2D ??3T?2||H4|00rcf|jd}|j|j|dS)a Retrieve low-level information about the current swarm. Returns: A dictionary containing data about the swarm. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/swarmTrrr)rr7s r inspect_swarmzSwarmApiMixin.inspect_swarms+ii!||DIIcND11rnode_idch|jd|}|j|j|dS)aL Retrieve low-level information about a swarm node Args: node_id (string): ID of the node to be inspected. Returns: A dictionary containing data about this node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. /nodes/{0}Tr;)rr=r7s r inspect_nodezSwarmApiMixin.inspect_nodes- ii g.||DIIcND11rc||||d}|:tj|jdrtjd||d<|j d}|j ||}|j|y)a Make this Engine join a swarm that has already been created. Args: 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 determining the networking interface used for the VXLAN Tunnel Endpoint (VTEP). Default: ``'0.0.0.0:2377`` advertise_addr (string): Externally reachable address advertised to other nodes. This can either be an address/port combination in the form ``192.168.1.1:4567``, or an interface followed by a port number, like ``eth0:4567``. If the port number is omitted, the port number from the listen address is used. If AdvertiseAddr is not specified, it will be automatically detected when possible. Default: ``None`` data_path_addr (string): Address or interface to use for data path traffic. For example, 192.168.1.1, or an interface, like eth0. Returns: ``True`` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. ) RemoteAddrsr JoinTokenrr$r%r&z /swarm/joinr'T)rr-rrr.rr/_raise_for_status) r remote_addrs join_tokenr1r0r6r(r7r8s r join_swarmzSwarmApiMixin.join_swarms@(%#+    % v6++*$2D ii &??3T?2 x(rc|jd}|j|d|i}|r|jtjk(ry|r|jtj k(ry|j |y)aP Leave a swarm. Args: force (bool): Leave the swarm even if this node is a manager. Default: ``False`` Returns: ``True`` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /swarm/leaveforceparamsT)r_post status_code http_clientNOT_ACCEPTABLESERVICE_UNAVAILABLErD)rrIr7r8s r leave_swarmzSwarmApiMixin.leave_swarmsn ii'::c7E*::; X))[-G-GG X))[-L-LL x(rc|jd}i}|rtj||d<|j|j ||dS)a List swarm nodes. Args: filters (dict): Filters to process on the nodes list. Valid filters: ``id``, ``name``, ``membership`` and ``role``. Default: ``None`` Returns: A list of dictionaries containing data about each swarm node. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z/nodesfiltersrJT)rrconvert_filtersrr)rrSr7rKs rnodeszSwarmApiMixin.nodessM"ii!  % 5 5g >F9 ||DIIc&I94@@rcx|jd|}d|i}|j||}|j|y)a Remove a node from the swarm. Args: node_id (string): ID of the node to be removed. force (bool): Force remove an active node. Default: `False` Raises: :py:class:`docker.errors.NotFound` If the node referenced doesn't exist in the swarm. :py:class:`docker.errors.APIError` If the server returns an error. Returns: `True` if the request was successful. r?rIrJT)r_deleterD)rr=rIr7rKress r remove_nodezSwarmApiMixin.remove_node5sE&ii g. U ll3vl. s#rct|trd|vrtjdd|i}|j d}|j ||}|j |y)al Unlock a locked swarm. Args: key (string): The unlock key as provided by :py:meth:`get_unlock_key` Raises: :py:class:`docker.errors.InvalidArgument` If the key argument is in an incompatible format :py:class:`docker.errors.APIError` If the server returns an error. Returns: `True` if the request was successful. Example: >>> key = client.api.get_unlock_key() >>> client.unlock_swarm(key) UnlockKeyzInvalid unlock key formatz /swarm/unlockr'T)r*r+rInvalidArgumentrr/rD)rkeyr7rXs r unlock_swarmzSwarmApiMixin.unlock_swarmPsc2 c4 #%,,-HII$Cii(ooco, s#rc|jd|t|}|j||}|j|y)a Update the node's configuration Args: node_id (string): ID of the node to be updated. version (int): The version number of the node object being updated. This is required to avoid conflicting writes. node_spec (dict): Configuration settings to update. Any values not provided will be removed. Default: ``None`` Returns: `True` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. Example: >>> node_spec = {'Availability': 'active', 'Name': 'node-name', 'Role': 'manager', 'Labels': {'foo': 'bar'} } >>> client.api.update_node(node_id='24ifsmvkjbyhk', version=8, node_spec=node_spec) z/nodes/{0}/update?version={1}r'T)rstrr/rD)rr=version node_specr7rXs r update_nodezSwarmApiMixin.update_nodets>>ii7#g,Oooc o2 s#rc|jd}|||d}|r:tj|jdrt j d||d<|j |||}|j|y)a Update the Swarm's configuration Args: version (int): The version number of the swarm object being updated. This is required to avoid conflicting writes. swarm_spec (dict): Configuration settings to update. Use :py:meth:`~docker.api.swarm.SwarmApiMixin.create_swarm_spec` to generate a valid configuration. Default: ``None``. rotate_worker_token (bool): Rotate the worker join token. Default: ``False``. rotate_manager_token (bool): Rotate the manager join token. Default: ``False``. rotate_manager_unlock_key (bool): Rotate the manager unlock key. Default: ``False``. Returns: ``True`` if the request went through. Raises: :py:class:`docker.errors.APIError` If the server returns an error. z /swarm/update)rotateWorkerTokenrotateManagerTokenraz1.25zCRotate manager unlock key is only available for API version >= 1.25rotateManagerUnlockKey)r(rKT)rrr-rrr.r/rD) rrar3rotate_worker_tokenrotate_manager_tokenrotate_manager_unlock_keyr7rKr8s r update_swarmzSwarmApiMixin.update_swarms8ii(!4"6  % v6++@0IF+ ,??3Z?G x(r)N 0.0.0.0:2377FNNNN)rlNN)F)N)NFFF)__name__ __module__ __qualname__rrminimum_versionrr9r<check_resourcer@rGrQrUrYr^rcrkrrr r s;?zU6"L#LU6":H7;7;"&U1#U1nU6" 2# 2U)$U6"2#%2"U6"?M7;0#0dU6"#6U6"A#A.U)$U6"#%2U6"!#!FU6"!#!FU6"/3).*//4+#+rr )logging http.clientclientrN constantsrrrrr getLoggerrmlogr rrrrrzs5!Jg!yyr