U
    ‡…”]D  ã                   @   sf   d dl Z d dlmZ ddlmZmZ ddlmZ ddlmZ ddlm	Z	 e  
e¡ZG dd	„ d	eƒZdS )
é    N)Úhttp_clienté   )ÚDEFAULT_SWARM_ADDR_POOLÚDEFAULT_SWARM_SUBNET_SIZE)Úerrors)Útypes)Úutilsc                   @   sü   e Zd Zdd„ Ze d¡dd„ ƒZe d¡dd	d
„ƒZe d¡dd„ ƒZe 	d¡e d¡dd„ ƒƒZ
e d¡ddd„ƒZe d¡d dd„ƒZe d¡d!dd„ƒZe 	d¡e d¡d"dd„ƒƒZe d¡dd„ ƒZe d¡d#dd„ƒZe d¡d$dd„ƒZdS )%ÚSwarmApiMixinc                 O   s.   |  dd¡}|r|g|d< tj| jf|ž|ŽS )aV
  
        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.create_swarm_spec(
              snapshot_interval=5000, log_entries_for_slow_followers=1200
            )
            >>> client.init_swarm(
              advertise_addr='eth0', listen_addr='0.0.0.0:5000',
              force_new_cluster=False, swarm_spec=spec
            )
        Zexternal_caNZexternal_cas)Úpopr   Z	SwarmSpecÚ_version)ÚselfÚargsÚkwargsZext_ca© r   ú2/usr/lib/python3/dist-packages/docker/api/swarm.pyÚcreate_swarm_spec   s    8
zSwarmApiMixin.create_swarm_specz1.24c                 C   s   |   |  |  d¡¡d¡S )z”
            Get the unlock key for this Swarm manager.

            Returns:
                A ``dict`` containing an ``UnlockKey`` member
        z/swarm/unlockkeyT)Ú_resultÚ_getÚ_url)r   r   r   r   Úget_unlock_keyJ   s    zSwarmApiMixin.get_unlock_keyNú0.0.0.0:2377Fc                 C   sÒ   |   d¡}|dk	r$t|tƒs$tdƒ‚|dk	rPt | jd¡rDt d¡‚|dkrPt	}|dk	r|t | jd¡rpt d¡‚|dkr|t
}||||||dœ}	|dk	r¶t | jd¡r®t d	¡‚||	d
< | j||	d}
| j|
d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/initNzswarm_spec must be a dictionaryz1.39z6Address pool is only available for API version >= 1.39z5Subnet size is only available for API version >= 1.39)ÚAdvertiseAddrÚ
ListenAddrZDefaultAddrPoolZ
SubnetSizeZForceNewClusterZSpecú1.30ú;Data address path is only available for API version >= 1.30ÚDataPathAddr©ÚdataT)Zjson)r   Ú
isinstanceÚdictÚ	TypeErrorr   Ú
version_ltr   r   ÚInvalidVersionr   r   Ú
_post_jsonr   )r   Úadvertise_addrÚlisten_addrZforce_new_clusterÚ
swarm_specZdefault_addr_poolZsubnet_sizeÚdata_path_addrÚurlr   Úresponser   r   r   Ú
init_swarmT   s@    .
ÿÿú	ÿzSwarmApiMixin.init_swarmc                 C   s   |   d¡}|  |  |¡d¡S )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/swarmT©r   r   r   )r   r(   r   r   r   Úinspect_swarm¬   s    
zSwarmApiMixin.inspect_swarmÚnode_idc                 C   s   |   d|¡}|  |  |¡d¡S )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+   )r   r-   r(   r   r   r   Úinspect_node»   s    zSwarmApiMixin.inspect_nodec           	      C   s\   ||||dœ}|dk	r6t  | jd¡r.t d¡‚||d< |  d¡}| j||d}|  |¡ dS )	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.
        )ZRemoteAddrsr   Z	JoinTokenr   Nr   r   r   z/swarm/joinr   T)r   r!   r   r   r"   r   r#   Ú_raise_for_status)	r   Zremote_addrsZ
join_tokenr%   r$   r'   r   r(   r)   r   r   r   Ú
join_swarmÎ   s     üÿ

zSwarmApiMixin.join_swarmc                 C   sR   |   d¡}| j|d|id}|r0|jtjkr0dS |rD|jtjkrDdS |  |¡ dS )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/leaveÚforce©ÚparamsT)r   Z_postZstatus_coder   ZNOT_ACCEPTABLEZSERVICE_UNAVAILABLEr0   )r   r2   r(   r)   r   r   r   Úleave_swarm  s    

zSwarmApiMixin.leave_swarmc                 C   s6   |   d¡}i }|r t |¡|d< |  | j||dd¡S )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/nodesÚfiltersr3   T)r   r   Zconvert_filtersr   r   )r   r6   r(   r4   r   r   r   Únodes  s
    
zSwarmApiMixin.nodesc                 C   s0   |   d|¡}d|i}| j||d}|  |¡ dS )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.   r2   r3   T)r   Z_deleter0   )r   r-   r2   r(   r4   Úresr   r   r   Úremove_node5  s     ÿ
zSwarmApiMixin.remove_nodec                 C   sL   t |tƒrd|kr&t d¡‚nd|i}|  d¡}| j||d}|  |¡ dS )ag  
            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.get_unlock_key()
                >>> client.unlock_node(key)

        Z	UnlockKeyzInvalid unlock key formatz/swarm/unlockr   T)r   r   r   ZInvalidArgumentr   r#   r0   )r   Úkeyr(   r8   r   r   r   Úunlock_swarmP  s    


zSwarmApiMixin.unlock_swarmc                 C   s.   |   d|t|ƒ¡}| j||d}|  |¡ dS )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.update_node(node_id='24ifsmvkjbyhk', version=8,
                node_spec=node_spec)

        z/nodes/{0}/update?version={1}r   T)r   Ústrr#   r0   )r   r-   ÚversionZ	node_specr(   r8   r   r   r   Úupdate_nodet  s    
zSwarmApiMixin.update_nodec           	      C   sX   |   d¡}|||dœ}|r:t | jd¡r2t d¡‚||d< | j|||d}|  |¡ dS )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)ZrotateWorkerTokenZrotateManagerTokenr=   z1.25zCRotate manager unlock key is only available for API version >= 1.25ZrotateManagerUnlockKey)r   r4   T)r   r   r!   r   r   r"   r#   r0   )	r   r=   r&   Zrotate_worker_tokenZrotate_manager_tokenZrotate_manager_unlock_keyr(   r4   r)   r   r   r   Úupdate_swarm˜  s    
ýÿ
zSwarmApiMixin.update_swarm)Nr   FNNNN)r   NN)F)N)F)N)NFFF)Ú__name__Ú
__module__Ú__qualname__r   r   Zminimum_versionr   r*   r,   Zcheck_resourcer/   r1   r5   r7   r9   r;   r>   r?   r   r   r   r   r	      sL   =
	        ýW
    ÿ2
##    ýr	   )ZloggingZ	six.movesr   Z	constantsr   r   Ú r   r   r   Z	getLoggerr@   ÚlogÚobjectr	   r   r   r   r   Ú<module>   s   
