File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/states/__pycache__/docker_network.cpython-310.pyc
Back
o ;j�� � @ s� d Z ddlZddlZddlZddlZddlZddlmZ ddl m Z e� e �Z dZdZdd� Zd d � Z dd d�Zdd� Zdd� ZdS )a� Management of Docker networks .. versionadded:: 2017.7.0 :depends: docker_ Python module .. note:: Older releases of the Python bindings for Docker were called docker-py_ in PyPI. All releases of docker_, and releases of docker-py_ >= 1.6.0 are supported. These python bindings can easily be installed using :py:func:`pip.install <salt.modules.pip.install>`: .. code-block:: bash salt myminion pip.install docker To upgrade from docker-py_ to docker_, you must first uninstall docker-py_, and then install docker_: .. code-block:: bash salt myminion pip.uninstall docker-py salt myminion pip.install docker .. _docker: https://pypi.python.org/pypi/docker .. _docker-py: https://pypi.python.org/pypi/docker-py These states were moved from the :mod:`docker <salt.states.docker>` state module (formerly called **dockerng**) in the 2017.7.0 release. � N)� ipaddress)�CommandExecutionErrorZdocker_network)Z moby_networkc C s dt v rtS dt �d�fS )z? Only load if the docker execution module is available zdocker.versionF)�__salt__�__virtualname__Zmissing_fun_string� r r �N/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/docker_network.py� __virtual__1 s r c s� d d d�d d d�d�� | d D ]}t �|�d��}|� d |j< q|d D ]#}t �|�d��}� d |j d urAtd|j� d���|� d |j< q%� d d rY� d d sYtd ��� fd d �dD �| d< � fdd �dD �|d< d S )N)� � )�existing�desired�Config�Subnetr r z Only one IPvz pool is permittedr r zVAn IPv4 pool is required when an IPv6 pool is used. See the documentation for details.c �( g | ]}� d | dur� d | �qS )r Nr ��.0�x�Zpoolsr r � <listcomp>O � "z$_normalize_pools.<locals>.<listcomp>c r )r Nr r r r r r R r )r � ip_network�get�version� ValueError)r r �poolZsubnetr r r �_normalize_pools: s& � � �r FTc / K sr | i ddd�}zt d | �}W n) ty8 } z t| �} d| v r"d}n | |d< |W Y d} ~ S W Y d} ~ nd} ~ ww i } g } g } td |pEg �D ]D}zt d |�}W n ty_ | �|� Y qGw z|d }W n tyt | �|� Y qGw |�d i ��d d�s�| �|� qGd |i| |< qG| r�|�dg ��d�d� | ��� | r�|�dg ��d�d� | ��� i }ztd t j j j jf|||d�td d i |����}W n ty� } zt| �|d< |W Y d} ~ S d} ~ ww i }g d�}|�t d d�d � |D ]}z |�|�||< W q� t�y Y q�w d|v �r&t|�dk�r!d|d< |S |d }n-|�dd �}z td |i |��}W n t�yR } zt| �|d< |W Y d} ~ S d} ~ ww d }|du�r�t�d | � d | � d!�|d< t�d"| |� d� d#d$� td%�D ��}zB|�d&d�}|}|�d'�}|�d(i �} | �d)d�} |d*k�r�| du�r�t| �d+ } | d,d� |d( d)< t d- |fd dd.�|�� W n t�y� } zd/�t| ��|d< |W Y d} ~ S d} ~ ww |du�r�||d&< �z�zt d |�} W nJ t�y9 } z=d0t| �� �|d< |W Y d} ~ W zt d1 |� W S t�y4 } z|�dg ��d2|� d3| � d4�� W Y d} ~ S d} ~ ww d} ~ ww t|�| d5< || d6< t|d6 d7 �} t| d6 d7 �}!d8d9� }"|!d:k�rs| dk�rs|"|d6 d7 d: ��rsg |d6 d7< t d; || d<d=�}#|#�s�d}n�|#|d> | < td? �r�d|d@< dA|d< |W zt d1 |� W S t�y� } z|�dg ��d2|� d3| � d4�� W Y d} ~ S d} ~ ww |dB �rt�|dB �}|�s|�r|D ]C}z3t d |�}|dC dD | }$|$�dE��p�g }%|$�dF��p�g }&|%�r|%|| dE< |&�r |&|| dF< W �q� tttf�y Y �q�w t |�}'|'d@ �sR|'W zt d1 |� W S t�yQ } z|�dg ��d2|� d3| � d4�� W Y d} ~ S d} ~ ww i |dB< W zt d1 |� W nO t�y� } z|�dg ��d2|� d3| � d4�� W Y d} ~ n1d} ~ ww zt d1 |� W w t�y� } z|�dg ��d2|� d3| � d4�� W Y d} ~ w d} ~ ww |�rt�dG| � td? �r�d|d@< dH|d< |S ||d< zt d- | fdId i|�� W n t�y� } zdJ| � d3| � �|d< |W Y d} ~ S d} ~ ww |du�r dKndL}(d |d> |(< dM�| |du �rdLndN�|d< dBi i}|du �r(|�r(|�r(|} t | �D ] }||dB v �r8| |= �q,g })| �r�| � � D ]�\}}*i }+||v �r~dOD ]-\},}-z|*|, |+|-< W n tt f�yi Y �qPw |,� dP��r||+|- �!dQd�d: |+|-< �qPz t dR || fi |+�� W nW t�y� } zJ|+�s�|)�t| �� n8z t dR || � W n t�y� } z |)�t| �� W Y d} ~ nd} ~ ww |d> �||v �r�dSndTg ��|*d � W Y d} ~ �qCd} ~ ww |d> �||v �r�dSndTg ��|*d � �qC|)�r|d �r |d dU7 < |d dU� |)�d4 7 < nd |d@< |� � D ]\}}.|| v�r5|d> �dVg ��|.d � �q |S )Wa> .. versionchanged:: 2018.3.0 Support added for network configuration options other than ``driver`` and ``driver_opts``, as well as IPAM configuration. Ensure that a network is present .. note:: This state supports all arguments for network and IPAM pool configuration which are available for the release of docker-py installed on the minion. For that reason, the arguments described below in the :ref:`NETWORK CONFIGURATION <salt-states-docker-network-present-netconf>` and :ref:`IP ADDRESS MANAGEMENT (IPAM) <salt-states-docker-network-present-ipam>` sections may not accurately reflect what is available on the minion. The :py:func:`docker.get_client_args <salt.modules.dockermod.get_client_args>` function can be used to check the available arguments for the installed version of docker-py (they are found in the ``network_config`` and ``ipam_config`` sections of the return data), but Salt will not prevent a user from attempting to use an argument which is unsupported in the release of Docker which is installed. In those cases, network creation be attempted but will fail. name Network name skip_translate This function translates Salt SLS input into the format which docker-py expects. However, in the event that Salt's translation logic fails (due to potential changes in the Docker Remote API, or to bugs in the translation code), this argument can be used to exert granular control over which arguments are translated and which are not. Pass this argument as a comma-separated list (or Python list) of arguments, and translation for each passed argument name will be skipped. Alternatively, pass ``True`` and *all* translation will be skipped. Skipping tranlsation allows for arguments to be formatted directly in the format which docker-py expects. This allows for API changes and other issues to be more easily worked around. See the following links for more information: - `docker-py Low-level API`_ - `Docker Engine API`_ .. versionadded:: 2018.3.0 .. _`docker-py Low-level API`: http://docker-py.readthedocs.io/en/stable/api.html#docker.api.container.ContainerApiMixin.create_container .. _`Docker Engine API`: https://docs.docker.com/engine/api/v1.33/#operation/ContainerCreate ignore_collisions : False Since many of docker-py's arguments differ in name from their CLI counterparts (with which most Docker users are more familiar), Salt detects usage of these and aliases them to the docker-py version of that argument. However, if both the alias and the docker-py version of the same argument (e.g. ``options`` and ``driver_opts``) are used, an error will be raised. Set this argument to ``True`` to suppress these errors and keep the docker-py version of the argument. .. versionadded:: 2018.3.0 validate_ip_addrs : True For parameters which accept IP addresses/subnets as input, validation will be performed. To disable, set this to ``False``. .. versionadded:: 2018.3.0 containers A list of containers which should be connected to this network. .. note:: As of the 2018.3.0 release, this is not the recommended way of managing a container's membership in a network, for a couple reasons: 1. It does not support setting static IPs, aliases, or links in the container's IP configuration. 2. If a :py:func:`docker_container.running <salt.states.docker_container.running>` state replaces a container, it will not be reconnected to the network until the ``docker_network.present`` state is run again. Since containers often have ``require`` requisites to ensure that the network is present, this means that the ``docker_network.present`` state ends up being run *before* the :py:func:`docker_container.running <salt.states.docker_container.running>`, leaving the container unattached at the end of the Salt run. For these reasons, it is recommended to use :ref:`docker_container.running's network management support <salt-states-docker-container-network-management>`. reconnect : True If ``containers`` is not used, and the network is replaced, then Salt will keep track of the containers which were connected to the network and reconnect them to the network after it is replaced. Salt will first attempt to reconnect using the same IP the container had before the network was replaced. If that fails (for instance, if the network was replaced because the subnet was modified), then the container will be reconnected without an explicit IP address, and its IP will be assigned by Docker. Set this option to ``False`` to keep Salt from trying to reconnect containers. This can be useful in some cases when :ref:`managing static IPs in docker_container.running <salt-states-docker-container-network-management>`. For instance, if a network's subnet is modified, it is likely that the static IP will need to be updated in the ``docker_container.running`` state as well. When the network is replaced, the initial reconnect attempt would fail, and the container would be reconnected with an automatically-assigned IP address. Then, when the ``docker_container.running`` state executes, it would disconnect the network *again* and reconnect using the new static IP. Disabling the reconnect behavior in these cases would prevent the unnecessary extra reconnection. .. versionadded:: 2018.3.0 .. _salt-states-docker-network-present-netconf: **NETWORK CONFIGURATION ARGUMENTS** driver Network driver .. code-block:: yaml mynet: docker_network.present: - driver: macvlan driver_opts (or *driver_opt*, or *options*) Options for the network driver. Either a dictionary of option names and values or a Python list of strings in the format ``varname=value``. The below three examples are equivalent: .. code-block:: yaml mynet: docker_network.present: - driver: macvlan - driver_opts: macvlan_mode=bridge,parent=eth0 .. code-block:: yaml mynet: docker_network.present: - driver: macvlan - driver_opts: - macvlan_mode=bridge - parent=eth0 .. code-block:: yaml mynet: docker_network.present: - driver: macvlan - driver_opts: - macvlan_mode: bridge - parent: eth0 The options can also simply be passed as a dictionary, though this can be error-prone due to some :ref:`idiosyncrasies <yaml-idiosyncrasies>` with how PyYAML loads nested data structures: .. code-block:: yaml mynet: docker_network.present: - driver: macvlan - driver_opts: macvlan_mode: bridge parent: eth0 check_duplicate : True If ``True``, checks for networks with duplicate names. Since networks are primarily keyed based on a random ID and not on the name, and network name is strictly a user-friendly alias to the network which is uniquely identified using ID, there is no guaranteed way to check for duplicates. This option providess a best effort, checking for any networks which have the same name, but it is not guaranteed to catch all name collisions. .. code-block:: yaml mynet: docker_network.present: - check_duplicate: False internal : False If ``True``, restricts external access to the network .. code-block:: yaml mynet: docker_network.present: - internal: True labels Add metadata to the network. Labels can be set both with and without values, and labels with values can be passed either as ``key=value`` or ``key: value`` pairs. For example, while the below would be very confusing to read, it is technically valid, and demonstrates the different ways in which labels can be passed: .. code-block:: yaml mynet: docker_network.present: - labels: - foo - bar=baz - hello: world The labels can also simply be passed as a YAML dictionary, though this can be error-prone due to some :ref:`idiosyncrasies <yaml-idiosyncrasies>` with how PyYAML loads nested data structures: .. code-block:: yaml foo: docker_network.present: - labels: foo: '' bar: baz hello: world .. versionchanged:: 2018.3.0 Methods for specifying labels can now be mixed. Earlier releases required either labels with or without values. enable_ipv6 (or *ipv6*) : False Enable IPv6 on the network .. code-block:: yaml mynet: docker_network.present: - enable_ipv6: True .. note:: While it should go without saying, this argument must be set to ``True`` to :ref:`configure an IPv6 subnet <salt-states-docker-network-present-ipam>`. Also, if this option is turned on without an IPv6 subnet explicitly configured, you will get an error unless you have set up a fixed IPv6 subnet. Consult the `Docker IPv6 docs`_ for information on how to do this. .. _`Docker IPv6 docs`: https://docs.docker.com/v17.09/engine/userguide/networking/default_network/ipv6/ attachable : False If ``True``, and the network is in the global scope, non-service containers on worker nodes will be able to connect to the network. .. code-block:: yaml mynet: docker_network.present: - attachable: True .. note:: This option cannot be reliably managed on CentOS 7. This is because while support for this option was added in API version 1.24, its value was not added to the inpsect results until API version 1.26. The version of Docker which is available for CentOS 7 runs API version 1.24, meaning that while Salt can pass this argument to the API, it has no way of knowing the value of this config option in an existing Docker network. scope Specify the network's scope (``local``, ``global`` or ``swarm``) .. code-block:: yaml mynet: docker_network.present: - scope: local ingress : False If ``True``, create an ingress network which provides the routing-mesh in swarm mode .. code-block:: yaml mynet: docker_network.present: - ingress: True .. _salt-states-docker-network-present-ipam: **IP ADDRESS MANAGEMENT (IPAM)** This state supports networks with either IPv4, or both IPv4 and IPv6. If configuring IPv4, then you can pass the :ref:`IPAM pool arguments <salt-states-docker-network-present-ipam-pool-arguments>` below as individual arguments. However, if configuring IPv4 and IPv6, the arguments must be passed as a list of dictionaries, in the ``ipam_pools`` argument (click :ref:`here <salt-states-docker-network-present-ipam-examples>` for some examples). `These docs`_ also have more information on these arguments. .. _`These docs`: http://docker-py.readthedocs.io/en/stable/api.html#docker.types.IPAMPool *IPAM ARGUMENTS* ipam_driver IPAM driver to use, if different from the default one .. code-block:: yaml mynet: docker_network.present: - ipam_driver: foo ipam_opts Options for the IPAM driver. Either a dictionary of option names and values or a Python list of strings in the format ``varname=value``. The below three examples are equivalent: .. code-block:: yaml mynet: docker_network.present: - ipam_driver: foo - ipam_opts: foo=bar,baz=qux .. code-block:: yaml mynet: docker_network.present: - ipam_driver: foo - ipam_opts: - foo=bar - baz=qux .. code-block:: yaml mynet: docker_network.present: - ipam_driver: foo - ipam_opts: - foo: bar - baz: qux The options can also simply be passed as a dictionary, though this can be error-prone due to some :ref:`idiosyncrasies <yaml-idiosyncrasies>` with how PyYAML loads nested data structures: .. code-block:: yaml mynet: docker_network.present: - ipam_driver: macvlan - ipam_opts: foo: bar baz: qux .. _salt-states-docker-network-present-ipam-pool-arguments: *IPAM POOL ARGUMENTS* subnet Subnet in CIDR format that represents a network segment iprange (or *ip_range*) Allocate container IP from a sub-range within the subnet Subnet in CIDR format that represents a network segment gateway IPv4 or IPv6 gateway for the master subnet aux_addresses (or *aux_address*) A dictionary of mapping container names to IP addresses which should be allocated for them should they connect to the network. Either a dictionary of option names and values or a Python list of strings in the format ``host=ipaddr``. .. _salt-states-docker-network-present-ipam-examples: *IPAM CONFIGURATION EXAMPLES* Below is an example of an IPv4-only network (keep in mind that ``subnet`` is the only required argument). .. code-block:: yaml mynet: docker_network.present: - subnet: 10.0.20.0/24 - iprange: 10.0.20.128/25 - gateway: 10.0.20.254 - aux_addresses: - foo.bar.tld: 10.0.20.50 - hello.world.tld: 10.0.20.51 .. note:: The ``aux_addresses`` can be passed differently, in the same way that ``driver_opts`` and ``ipam_opts`` can. This same network could also be configured this way: .. code-block:: yaml mynet: docker_network.present: - ipam_pools: - subnet: 10.0.20.0/24 iprange: 10.0.20.128/25 gateway: 10.0.20.254 aux_addresses: foo.bar.tld: 10.0.20.50 hello.world.tld: 10.0.20.51 Here is an example of a mixed IPv4/IPv6 subnet. .. code-block:: yaml mynet: docker_network.present: - ipam_pools: - subnet: 10.0.20.0/24 gateway: 10.0.20.1 - subnet: fe3f:2180:26:1::/123 gateway: fe3f:2180:26:1::1 F� ��name�changes�result�comment�docker.inspect_network�404Nr! zargs.split_input�docker.inspect_containerZId�StateZRunning�Name�warningsz*The following containers do not exist: {}.z, z-The following containers are not running: {}.zdocker.translate_input)�skip_translate�ignore_collisions�validate_ip_addrszargs.clean_kwargs)�ipamZ ipam_driverZ ipam_opts� ipam_poolszdocker.get_client_args� ipam_configr+ � zdCannot mix the 'ipam' argument with any of the IPAM config arguments. See documentation for details.r, r zdocker.create_ipam_configTz"Docker network '%s' already exists� Network 'z0' already exists, and is configured as specifiedz"Details of docker network '%s': %sc s s � | ] }t �tj�V qd S )N)�random�choice�string�ascii_lowercase)r �_r r r � <genexpr>s s � �zpresent.<locals>.<genexpr>� � enable_ipv6�driver�optionsz com.docker.network.bridge.nameZbridge�compi�zdocker.create_network)r( r7 z0Failed to create temp network for comparison: {}z Failed to inspect temp network: �docker.remove_networkz Failed to remove temp network 'z': �.Z EnableIPv6ZIPAMr c S s" t dd� | �� D ��}|ddgkS )Nc s s � | ] \}}|d vr|V qdS ))r NNr )r �k�vr r r r5 � s � z3present.<locals>.is_default_pool.<locals>.<genexpr>ZGatewayr )�sorted�items)r �keysr r r �is_default_pool� s z present.<locals>.is_default_poolr zdocker.compare_networkszName,Id,Created,Containers)�ignorer �testr z*Network would be recreated with new config� ContainersZNetworkSettingsZNetworks�Links�Aliasesz Network '%s' will be createdzNetwork will be createdr( zFailed to create network 'Z recreated�createdzNetwork '{}' {}z was replaced with updated config))� IPv4AddressZ ipv4_address)Z IPV6AddressZ ipv6_address)rF Zlinks)rG �aliasesZAddress�/z#docker.connect_container_to_networkZ reconnected� connectedz. � disconnected)"r r �strZ __utils__�append�KeyErrorr � setdefault�format�join�salt�utilsZ dockermod� translate�network� Exception�extend�pop�len�log�debugZtrace�range�bool�__opts__�copy�deepcopyr �_remove_network�listr@ �AttributeError�endswith�rsplit)/r r( r) r* Z containersZ reconnect�kwargs�retrW �exc�msgZ to_connectZmissing_containersZstopped_containers�cname�cinfo�cidZdisconnected_containersZ ipam_kwargsZipam_kwarg_names�keyr- r, Zcreate_networkZ temp_net_namer7 Z kwargs_tmpr8 Z driver_optsZ bridge_nameZtmp_nameZ temp_net_infoZexisting_pool_countZdesired_pool_countrB r ZnetinfoZ net_linksZ net_aliasesZ remove_result�action�errorsZ connect_infoZconnect_kwargsZkey_nameZarg_nameZc_infor r r �presentW sh 5 ��� � � �� �� �� � ���� � � � �� � � � �� ���� c ����� � � ) ��� � ���� ����� ���� ��� �� ��� � � � ���� ��� �� ��� �rr c C s� | i ddd�}zt d | �}W n) ty8 } z t|�}d|v r"d}n ||d< |W Y d}~S W Y d}~nd}~ww |du rKd|d < d | � d �|d< |S td r]d|d < d | � d �|d< |S t|�S )z� Ensure that a network is absent. name Name of the network Usage Example: .. code-block:: yaml network_foo: docker_network.absent Fr r r" r# Nr! Tr r/ z' already absentrD z' will be removed)r r rN r` rc )r ri rW rj rk r r r �absent� s* ��� rs c C sJ | d i ddd�}g }| d D ]P}zt d |�}W n ty$ |}Y n w |�dd��d�}z t d || d � W n tyS } zd |� d |� �}W Y d }~qd }~ww |d �d g ��|� q|rkd�|�|d< |S z t d | d � W n ty� } zd|� �|d< W Y d }~|S d }~ww d|d d< d|d< d�| d �|d< |S )z< Remove network, including all connected containers r& Fr r rE r$ rK z(docker.disconnect_container_from_networkz Failed to disconnect container 'z' : Nr rM � r! r; zFailed to remove network: TZremovedr zRemoved network '{}')r r r �lstriprQ rO rS rR )rW ri rq rn rm rl rj r r r rc � s< � ���� rc )NFTNT)�__doc__ra �loggingr0 r2 Z&salt.utils.dockermod.translate.networkrT Z salt._compatr Zsalt.exceptionsr � getLogger�__name__r\ r Z__virtual_aliases__r r rr rs rc r r r r �<module> s6 � 4 (
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings