File: //lib/python3/dist-packages/docker/api/__pycache__/swarm.cpython-310.pyc
o
q_a�D � @ sd d dl Z d dlmZ ddlmZmZ ddlmZ ddlm Z ddlm
Z
e � e �Z
G dd� d�ZdS ) � N� )�DEFAULT_SWARM_ADDR_POOL�DEFAULT_SWARM_SUBNET_SIZE)�errors)�types)�utilsc @ s e Zd Zdd� Ze�d�dd� �Ze�d� d d d
��Ze�d�d d � �Ze� d
�e�d�dd� ��Z
e�d� d dd��Z e�d�d dd��Z e�d�d!dd��Z
e� d
�e�d�d dd���Ze�d�dd� �Ze�d�d!dd��Ze�d� d"d d ��ZdS )#�
SwarmApiMixinc O s4 |� dd�}|r
|g|d< tj| jg|�R 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)�self�args�kwargs�ext_ca� r �2/usr/lib/python3/dist-packages/docker/api/swarm.py�create_swarm_spec
s 8
z SwarmApiMixin.create_swarm_specz1.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�}|durt|t�std��|dur(t�| jd�r"t�d��|du r(t }|dur>t�| jd�r8t�d��|du r>t
}||||||d�} |dur[t�| jd�rWt�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 dictionaryz1.39z6Address pool is only available for API version >= 1.39z5Subnet size is only available for API version >= 1.39)�
AdvertiseAddr�
ListenAddr�DefaultAddrPool�
SubnetSize�ForceNewCluster�Spec�1.30�;Data address path is only available for API version >= 1.30� DataPathAddr��dataT)�json)
r �
isinstance�dict� TypeErrorr �
version_ltr
r �InvalidVersionr r �
_post_jsonr ) r �advertise_addr� listen_addr�force_new_cluster�
swarm_spec�default_addr_pool� subnet_size�data_path_addr�urlr$ �responser r r �
init_swarmT s@
.��� �zSwarmApiMixin.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 r3 r r r �
inspect_swarm� s
zSwarmApiMixin.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}Tr6 )r r8 r3 r r r � inspect_node� s zSwarmApiMixin.inspect_nodec C s\ ||||d�}|durt �| jd�rt�d��||d< | �d�}| j||d�}| �|� dS ) 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 � JoinTokenr Nr r! r" z /swarm/joinr# T)r r) r
r r* r r+ �_raise_for_status) r � remote_addrs�
join_tokenr- r, r2 r$ r3 r4 r r r �
join_swarm� s ��
zSwarmApiMixin.join_swarmc C sR | � d�}| j|d|id�}|r|jtjkrdS |r"|jtjkr"dS | �|� dS )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 �_post� status_code� http_client�NOT_ACCEPTABLE�SERVICE_UNAVAILABLEr= )r rA r3 r4 r r r � leave_swarm s
zSwarmApiMixin.leave_swarmc C s6 | � d�}i }|rt�|�|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�filtersrB T)r r �convert_filtersr r )r rJ r3 rC r r r �nodes s
zSwarmApiMixin.nodesc C s0 | � d|�}d|i}| j||d�}| �|� dS )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.
r9 rA rB T)r �_deleter= )r r8 rA r3 rC �resr r r � remove_node5 s �
zSwarmApiMixin.remove_nodec C sL t |t�rd|vrt�d��nd|i}| �d�}| j||d�}| �|� dS )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' r �InvalidArgumentr r+ r= )r �keyr3 rN r r r � unlock_swarmP s
�
zSwarmApiMixin.unlock_swarmc C s. | � d|t|��}| j||d�}| �|� dS )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)r �strr+ r= )r r8 �version� node_specr3 rN r r r � update_nodet s
zSwarmApiMixin.update_nodec C sX | � d�}|||d�}|r t�| jd�rt�d��||d< | j|||d�}| �|� dS )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)�rotateWorkerToken�rotateManagerTokenrU z1.25zCRotate manager unlock key is only available for API version >= 1.25�rotateManagerUnlockKey)r$ rC T)r r r) r
r r* r+ r= ) r rU r/ �rotate_worker_token�rotate_manager_token�rotate_manager_unlock_keyr3 rC r4 r r r � update_swarm� s
��
zSwarmApiMixin.update_swarm)Nr FNNNN)r NN)F)N)NFFF)�__name__�
__module__� __qualname__r r �minimum_versionr r5 r7 �check_resourcer: r@ rI rL rO rS rW r^ r r r r r sH =
�W
�2
# #�r )�logging� http.client�clientrF � constantsr r � r r r � getLoggerr_ �logr r r r r �<module> s