File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/states/__pycache__/docker_container.cpython-310.pyc
Back
o ;j�T � @ s� d Z ddlZddlZddlZddlZddlZddlmZ e� e �Z dZ dZ dd� Zdd � Zd d � Zd d � Zdd� Zddddddddejjjdf dd�Zddddddddejjjf dd�Z d dd�Zd dd�Zd dd �ZdS ) a Management of Docker containers .. 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. When running the :py:func:`docker_container.running <salt.states.docker_container.running>` state for the first time after upgrading to 2017.7.0, your container(s) may be replaced. The changes may show diffs for certain parameters which say that the old value was an empty string, and the new value is ``None``. This is due to the fact that in prior releases Salt was passing empty strings for these values when creating the container if they were undefined in the SLS file, where now Salt simply does not pass any arguments not explicitly defined in the SLS file. Subsequent runs of the state should not replace the container if the configuration remains unchanged. .. note:: To pull from a Docker registry, authentication must be configured. See :ref:`here <docker-authentication>` for more information on how to configure access to docker registries in :ref:`Pillar <pillar>` data. � N)�CommandExecutionErrorZdocker_container)Zmoby_containerc C s dt v rtS dt �d�fS )z? Only load if the docker execution module is available �docker.versionF)�__salt__�__virtualname__Zmissing_fun_string� r r �P/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/docker_container.py� __virtual__@ s r c C sD t |t�r || d< | S d�|�| d< t|�dkr | d d7 < | S )z� DRY code for joining comments together and conditionally adding a period at the end, and adding this comment string to the state return dict. �comment�. � �.)� isinstance�str�join�len)�ret�commentsr r r �_format_commentsI s � r c C s� | D ]B}|dkr q| | D ]6}| | | d du rC| | | d }|dkr) dS zt dd� |D ��r8W dS W q tyB Y q w q qd S ) z� Check the diff for signs of incorrect argument handling in previous releases, as discovered here: https://github.com/saltstack/salt/pull/39996#issuecomment-288025200 �Networks�newN�old� Tc s s � | ]}|d kV qdS )r Nr ��.0�xr r r � <genexpr>h s � z _check_diff.<locals>.<genexpr>F)�all� TypeError)�changesZ conf_dict�itemr r r r � _check_diffW s$ � ��� r c s� t jj�| pg �} | si } nt jj�| �} | std��| �� D ]@\}}|du r,i | |< q t jj�|�| |< | | s@td�|���dD ] }zt jj�| | | �| | |< W qB t y^ Y qBw q g }| �� D ] \}}|dur�|�� D ]\}}|du r�|� d�||�� qrqf|r�td|d��| r�z dd � t d � D �� W n ty� } ztd |� d ���d}~ww � fd d �t | �D �}|r�td�d� |����| S )z/ Common logic for parsing the networks z1Invalid network configuration (see documentation)Nz:Invalid configuration for network '{}' (see documentation))Zlinks�aliasesz6Config option '{}' for network '{}' is missing a valuez Invalid network configuration)�infoc S s g | ] }d |v r|d �qS )�Namer r r r r � <listcomp>� s z#_parse_networks.<locals>.<listcomp>zdocker.networksz)Failed to get list of existing networks: r c s g | ]}|� vr|�qS r r r �Z all_networksr r r$ � s z*The following networks are not present: {}�, )�salt�utils�argsZ split_input�dataZrepack_dictlistr �items�format�KeyError�appendr �sortedr )�networks�net_name�net_conf�key�errors�val�excZmissing_networksr r% r �_parse_networksp sr � � � �� �� � �����r7 c C s� t d |�}|du rFtd sFz t d ||d�}W n ty. } z td|� d|� ���d}~ww || d d < t d |�}|du rFtd �|���|S ) z> Resolve the image ID and pull the image if necessary zdocker.resolve_image_idF�testz docker.pull)�client_timeoutzFailed to pull z: Nr �imagez>Image '{}' not present despite a docker pull raising no errors)r �__opts__� Exceptionr r, )r r: r9 �image_idZ pull_resultr6 r r r �_resolve_image� s( ��� �r> FT�forcec . s� �i ddd��|du rd�d< d�d< �S t |t�s t|�}z| } t| �} | r+| | d < t�|| �} W n/ tya } z#d�d< |jdurOt�|j�W Y d}~S t|��d< �W Y d}~S d}~ww g � | �d d�}z td ��d }W n$ ty d}Y n t y� d�d< � � d � ��� t�� � Y S w |du}|r�td ��nd}|p�| p�|| k}|r�t d r�d�d< |r�d�d d< n || kr�|| d��d d< � � d� �|s�dnd�� t�� �S ztd |f|s�nd|||| d�| ��}|d �W n_ t �y } zd�d< � � d� |�� t�� �W Y d}~S d}~w t �y[ } z/d�d< t|�}t |t��rGt |jt��rGd|jv �rG|d 7 }� � |� t�� �W Y d}~S d}~ww � ���fd d �}�fd d �}| }�z�td |�rx�n��}| �� D ]?\}}ztd! �|fi |�� W �q t�y� } z d�d< � � t|�� t�� �W Y d}~ W |�r�|� S S d}~ww td ��} | du�r�t| �d"i ��d#i ��t| � } | �r�| D ] } td$ �| � �q�td ��} td% || �} |�s�td& � d' } | d(k �r d)}!nd*}!td+ ��|!d,�}"|"�rzt|"��r/��d-g �� d.� t d �r+d/nd�� �d �d0i �}#|#�|"� t d �rTd�d< � � d� �|�sOdnd�� n�d}|����smd�d< t�� �W |�rl|� S S |d1 �d �d2i �d3< n|�r�t d �r�� � d4|� d5�� nmz td6 �|d7� W n, t�y� } z d�d< � � d8|� �� t�� �W Y d}~W |�r�|� S S d}~ww |�d d9< � � d:|� d;�� n&|"�r� �s�t�d<�� � � d=� �t d �r�d>nd�� n � � d?�� d@�� | �r| �d �d0i �d#< t d �rd�d< � � dA� n�|�rd}$t| �D ]�}g }%d }&}'z�tdB |�v �r9td$ �|� d}&W n t�yT } z |%� t|�� W Y d}~nd}~ww || v �r�ztd! �|fi | | �� d}'W nA t�y� } z4|%� t|�� |&�r�t| | �D ] }(| | |( dC du �r�| | |(= �q�d| | |( dD< �q�W Y d}~nd}~ww |%�r�� �|%� d}$| | �d �d0i ��d#i �|< |&�r�|'�r � dE� |�� �q |&�r� � dF|� dG�� �q |'�r� � dH|� dG�� �q |$�rd�d< t�� �W |�r|� S S W |�r|� n|�r|� w w |�rB|�s'� � dI�� dG�� n|�|��s6d�d< t�� �S |d1 �d �d2i �d3< |�sN|�rY|�rN|�sY|�r�|�r�|dJk�r�t d �rld�d< � � dK� t�� �S z tdL ��dM dD })W n. t �y� } zd�d< � � dN�� dO|� dG�� t�� �W Y d}~S d}~ww td ��})t d �s |)dJk�r dP��dQf����fdRdS�}*tdT d%��dUg �}+�d �d0i ��d#i ��� D ]A\}} dV| v �r| dV dD dUk�r|+D ]+},|*� �|i ��|,�}-|-�rd|-d�| |,< z| �dV� W �q� t �y Y �q�w �q�q�t��d� ||)k�r>||)d��d dM< |du�r>� � dW|� dX|)� dG�� |�rT|| k�rT� � dY� || d��d d< |)dJk�re|�red�d< � � dZ� t�� �S )[u�� Ensure that a container with a specific configuration is present and running name Name of the container image Image to use for the container .. note:: This state will pull the image if it is not present. However, if the image needs to be built from a Dockerfile or loaded from a saved image, or if you would like to use requisites to trigger a replacement of the container when the image is updated, then the :py:func:`docker_image.present <salt.states.dockermod.image_present>` state should be used to manage the image. .. versionchanged:: 2018.3.0 If no tag is specified in the image name, and nothing matching the specified image is pulled on the minion, the ``docker pull`` that retrieves the image will pull *all tags* for the image. A tag of ``latest`` is no longer implicit for the pull. For this reason, it is recommended to specify the image in ``repo:tag`` notation. .. _docker-container-running-skip-translate: skip_translate This function translates Salt CLI or 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. An example of using this option to skip translation would be: For example, imagine that there is an issue with processing the ``port_bindings`` argument, and the following configuration no longer works as expected: .. code-block:: yaml mycontainer: docker_container.running: - image: 7.3.1611 - port_bindings: - 10.2.9.10:8080:80 By using ``skip_translate``, you can forego the input translation and configure the port binding in the format docker-py_ needs: .. code-block:: yaml mycontainer: docker_container.running: - image: 7.3.1611 - skip_translate: port_bindings - port_bindings: {8080: [('10.2.9.10', 80)], '4193/udp': 9314} See the following links for more information: - `docker-py Low-level API`_ - `Docker Engine API`_ .. _docker-py: https://pypi.python.org/pypi/docker-py .. _`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 so that both CLI and API versions of a given argument are supported. However, if both the alias and the docker-py_ version of the same argument (e.g. ``env`` and ``environment``) 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. validate_ip_addrs : True For parameters which accept IP addresses as input, IP address validation will be performed. To disable, set this to ``False`` force : False Set this parameter to ``True`` to force Salt to re-create the container irrespective of whether or not it is configured as desired. watch_action : force Control what type of action is taken when this state :ref:`watches <requisites-watch>` another state that has changes. The default action is ``force``, which runs the state with ``force`` set to ``True``, triggering a rebuild of the container. If any other value is passed, it will be assumed to be a kill signal. If the container matches the specified configuration, and is running, then the action will be to send that signal to the container. Kill signals can be either strings or numbers, and are defined in the **Standard Signals** section of the ``signal(7)`` manpage. Run ``man 7 signal`` on a Linux host to browse this manpage. For example: .. code-block:: yaml mycontainer: docker_container.running: - image: busybox - watch_action: SIGHUP - watch: - file: some_file .. note:: If the container differs from the specified configuration, or is not running, then instead of sending a signal to the container, the container will be re-created/started and no signal will be sent. start : True Set to ``False`` to suppress starting of the container if it exists, matches the desired configuration, but is not running. This is useful for data-only containers, or for non-daemonized container processes, such as the Django ``migrate`` and ``collectstatic`` commands. In instances such as this, the container only needs to be started the first time. shutdown_timeout If the container needs to be replaced, the container will be stopped using :py:func:`docker.stop <salt.modules.dockermod.stop>`. If a ``shutdown_timout`` is not set, and the container was created using ``stop_timeout``, that timeout will be used. If neither of these values were set, then a timeout of 10 seconds will be used. .. versionchanged:: 2017.7.0 This option was renamed from ``stop_timeout`` to ``shutdown_timeout`` to accommodate the ``stop_timeout`` container configuration setting. client_timeout : 60 Timeout in seconds for the Docker client. This is not a timeout for this function, but for receiving a response from the API. .. note:: This is only used if Salt needs to pull the requested image. .. _salt-states-docker-container-network-management: **NETWORK MANAGEMENT** .. versionadded:: 2018.3.0 .. versionchanged:: 2019.2.0 If the ``networks`` option is used, any networks (including the default ``bridge`` network) which are not specified will be disconnected. The ``networks`` argument can be used to ensure that a container is attached to one or more networks. Optionally, arguments can be passed to the networks. In the example below, ``net1`` is being configured with arguments, while ``net2`` and ``bridge`` are being configured *without* arguments: .. code-block:: yaml foo: docker_container.running: - image: myuser/myimage:foo - networks: - net1: - aliases: - bar - baz - ipv4_address: 10.0.20.50 - net2 - bridge - require: - docker_network: net1 - docker_network: net2 The supported arguments are the ones from the docker-py's `connect_container_to_network`_ function (other than ``container`` and ``net_id``). .. important:: Unlike with the arguments described in the **CONTAINER CONFIGURATION PARAMETERS** section below, these network configuration parameters are not translated at all. Consult the `connect_container_to_network`_ documentation for the correct type/format of data to pass. .. _`connect_container_to_network`: https://docker-py.readthedocs.io/en/stable/api.html#docker.api.network.NetworkApiMixin.connect_container_to_network To start a container with no network connectivity (only possible in 2019.2.0 and later) pass this option as an empty list. For example: .. code-block:: yaml foo: docker_container.running: - image: myuser/myimage:foo - networks: [] **CONTAINER CONFIGURATION PARAMETERS** auto_remove (or *rm*) : False Enable auto-removal of the container on daemon side when the container’s process exits (analogous to running a docker container with ``--rm`` on the CLI). .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - auto_remove: True binds Files/directories to bind mount. Each bind mount should be passed in one of the following formats: - ``<host_path>:<container_path>`` - ``host_path`` is mounted within the container as ``container_path`` with read-write access. - ``<host_path>:<container_path>:<selinux_context>`` - ``host_path`` is mounted within the container as ``container_path`` with read-write access. Additionally, the specified selinux context will be set within the container. - ``<host_path>:<container_path>:<read_only>`` - ``host_path`` is mounted within the container as ``container_path``, with the read-only or read-write setting explicitly defined. - ``<host_path>:<container_path>:<read_only>,<selinux_context>`` - ``host_path`` is mounted within the container as ``container_path``, with the read-only or read-write setting explicitly defined. Additionally, the specified selinux context will be set within the container. ``<read_only>`` can be either ``rw`` for read-write access, or ``ro`` for read-only access. When omitted, it is assumed to be read-write. ``<selinux_context>`` can be ``z`` if the volume is shared between multiple containers, or ``Z`` if the volume should be private. .. note:: When both ``<read_only>`` and ``<selinux_context>`` are specified, there must be a comma before ``<selinux_context>``. Binds can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - binds: /srv/www:/var/www:ro,/etc/foo.conf:/usr/local/etc/foo.conf:rw .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - binds: - /srv/www:/var/www:ro - /home/myuser/conf/foo.conf:/etc/foo.conf:rw However, in cases where both ro/rw and an selinux context are combined, the only option is to use a YAML list, like so: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - binds: - /srv/www:/var/www:ro,Z - /home/myuser/conf/foo.conf:/etc/foo.conf:rw,Z Since the second bind in the previous example is mounted read-write, the ``rw`` and comma can be dropped. For example: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - binds: - /srv/www:/var/www:ro,Z - /home/myuser/conf/foo.conf:/etc/foo.conf:Z blkio_weight Block IO weight (relative weight), accepts a weight value between 10 and 1000. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - blkio_weight: 100 blkio_weight_device Block IO weight (relative device weight), specified as a list of expressions in the format ``PATH:RATE`` .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - blkio_weight_device: /dev/sda:100 cap_add List of capabilities to add within the container. Can be expressed as a comma-separated list or a Python list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - cap_add: SYS_ADMIN,MKNOD .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - cap_add: - SYS_ADMIN - MKNOD .. note:: This option requires Docker 1.2.0 or newer. cap_drop List of capabilities to drop within the container. Can be expressed as a comma-separated list or a Python list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - cap_drop: SYS_ADMIN,MKNOD .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - cap_drop: - SYS_ADMIN - MKNOD .. note:: This option requires Docker 1.2.0 or newer. command (or *cmd*) Command to run in the container .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - command: bash cpuset_cpus (or *cpuset*) CPUs on which which to allow execution, specified as a string containing a range (e.g. ``0-3``) or a comma-separated list of CPUs (e.g. ``0,1``). .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - cpuset_cpus: "0,1" cpuset_mems Memory nodes on which which to allow execution, specified as a string containing a range (e.g. ``0-3``) or a comma-separated list of MEMs (e.g. ``0,1``). Only effective on NUMA systems. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - cpuset_mems: "0,1" cpu_group The length of a CPU period in microseconds .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - cpu_group: 100000 cpu_period Microseconds of CPU time that the container can get in a CPU period .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - cpu_period: 50000 cpu_shares CPU shares (relative weight), specified as an integer between 2 and 1024. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - cpu_shares: 512 detach : False If ``True``, run the container's command in the background (daemon mode) .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - detach: True devices List of host devices to expose within the container. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices: /dev/net/tun,/dev/xvda1:/dev/xvda1,/dev/xvdb1:/dev/xvdb1:r .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices: - /dev/net/tun - /dev/xvda1:/dev/xvda1 - /dev/xvdb1:/dev/xvdb1:r device_read_bps Limit read rate (bytes per second) from a device, specified as a list of expressions in the format ``PATH:RATE``, where ``RATE`` is either an integer number of bytes, or a string ending in ``kb``, ``mb``, or ``gb``. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices_read_bps: /dev/sda:1mb,/dev/sdb:5mb .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices_read_bps: - /dev/sda:1mb - /dev/sdb:5mb device_read_iops Limit read rate (I/O per second) from a device, specified as a list of expressions in the format ``PATH:RATE``, where ``RATE`` is a number of I/O operations. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices_read_iops: /dev/sda:1000,/dev/sdb:500 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices_read_iops: - /dev/sda:1000 - /dev/sdb:500 device_write_bps Limit write rate (bytes per second) from a device, specified as a list of expressions in the format ``PATH:RATE``, where ``RATE`` is either an integer number of bytes, or a string ending in ``kb``, ``mb``, or ``gb``. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices_write_bps: /dev/sda:1mb,/dev/sdb:5mb .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices_write_bps: - /dev/sda:1mb - /dev/sdb:5mb device_write_iops Limit write rate (I/O per second) from a device, specified as a list of expressions in the format ``PATH:RATE``, where ``RATE`` is a number of I/O operations. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices_write_iops: /dev/sda:1000,/dev/sdb:500 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - devices_write_iops: - /dev/sda:1000 - /dev/sdb:500 dns List of DNS nameservers. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - dns: 8.8.8.8,8.8.4.4 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - dns: - 8.8.8.8 - 8.8.4.4 .. note:: To skip IP address validation, use ``validate_ip_addrs=False`` dns_opt Additional options to be added to the container’s ``resolv.conf`` file. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - dns_opt: ndots:9 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - dns_opt: - ndots:9 dns_search List of DNS search domains. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - dns_search: foo1.domain.tld,foo2.domain.tld .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - dns_search: - foo1.domain.tld - foo2.domain.tld domainname The domain name to use for the container .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - dommainname: domain.tld entrypoint Entrypoint for the container .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - entrypoint: "mycmd --arg1 --arg2" This argument can also be specified as a list: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - entrypoint: - mycmd - --arg1 - --arg2 environment Either a list of variable/value mappings, or a list of strings in the format ``VARNAME=value``. The below three examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - environment: - VAR1: value - VAR2: value .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - environment: 'VAR1=value,VAR2=value' .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - environment: - VAR1=value - VAR2=value extra_hosts Additional hosts to add to the container's /etc/hosts file. Can be expressed as a comma-separated list or a Python list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - extra_hosts: web1:10.9.8.7,web2:10.9.8.8 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - extra_hosts: - web1:10.9.8.7 - web2:10.9.8.8 .. note:: To skip IP address validation, use ``validate_ip_addrs=False`` .. note:: This option requires Docker 1.3.0 or newer. group_add List of additional group names and/or IDs that the container process will run as. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - group_add: web,network .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - group_add: - web - network hostname Hostname of the container. If not provided, the value passed as the container's``name`` will be used for the hostname. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - hostname: web1 .. warning:: ``hostname`` cannot be set if ``network_mode`` is set to ``host``. The below example will result in an error: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - hostname: web1 - network_mode: host interactive (or *stdin_open*) : False Leave stdin open, even if not attached .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - interactive: True ipc_mode (or *ipc*) Set the IPC mode for the container. The default behavior is to create a private IPC namespace for the container, but this option can be used to change that behavior: - ``container:<container_name_or_id>`` reuses another container shared memory, semaphores and message queues - ``host``: use the host's shared memory, semaphores and message queues .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - ipc_mode: container:foo .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - ipc_mode: host .. warning:: Using ``host`` gives the container full access to local shared memory and is therefore considered insecure. isolation Specifies the type of isolation technology used by containers .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - isolation: hyperv .. note:: The default value on Windows server is ``process``, while the default value on Windows client is ``hyperv``. On Linux, only ``default`` is supported. labels Add metadata to the container. 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. links Link this container to another. Links can be specified as a list of mappings or a comma-separated or Python list of expressions in the format ``<container_name_or_id>:<link_alias>``. The below three examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - links: - web1: link1 - web2: link2 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - links: web1:link1,web2:link2 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - links: - web1:link1 - web2:link2 log_driver and log_opt Set container's logging driver and options to configure that driver. Requires Docker 1.6 or newer. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - log_driver: syslog - log_opt: - syslog-address: tcp://192.168.0.42 - syslog-facility: daemon The ``log_opt`` can also be expressed as a comma-separated or YAML list of ``key=value`` pairs. The below two examples are equivalent to the above one: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - log_driver: syslog - log_opt: "syslog-address=tcp://192.168.0.42,syslog-facility=daemon" .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - log_driver: syslog - log_opt: - syslog-address=tcp://192.168.0.42 - syslog-facility=daemon .. note:: The logging driver feature was improved in Docker 1.13 introducing option name changes. Please see Docker's `Configure logging drivers`_ documentation for more information. .. _`Configure logging drivers`: https://docs.docker.com/engine/admin/logging/overview/ lxc_conf Additional LXC configuration parameters to set before starting the container. Either a list of variable/value mappings, or a list of strings in the format ``VARNAME=value``. The below three examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - lxc_conf: - lxc.utsname: docker - lxc.arch: x86_64 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - lxc_conf: lxc.utsname=docker,lxc.arch=x86_64 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - lxc_conf: - lxc.utsname=docker - lxc.arch=x86_64 .. note:: These LXC configuration parameters will only have the desired effect if the container is using the LXC execution driver, which has been deprecated for some time. mac_address MAC address to use for the container. If not specified, a random MAC address will be used. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - mac_address: 01:23:45:67:89:0a mem_limit (or *memory*) : 0 Memory limit. Can be specified in bytes or using single-letter units (i.e. ``512M``, ``2G``, etc.). A value of ``0`` (the default) means no memory limit. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - mem_limit: 512M mem_swappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - mem_swappiness: 60 memswap_limit (or *memory_swap*) : -1 Total memory limit (memory plus swap). Set to ``-1`` to disable swap. A value of ``0`` means no swap limit. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - memswap_limit: 1G network_disabled : False If ``True``, networking will be disabled within the container .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - network_disabled: True network_mode : bridge One of the following: - ``bridge`` - Creates a new network stack for the container on the docker bridge - ``none`` - No networking (equivalent of the Docker CLI argument ``--net=none``). Not to be confused with Python's ``None``. - ``container:<name_or_id>`` - Reuses another container's network stack - ``host`` - Use the host's network stack inside the container .. warning:: Using ``host`` mode gives the container full access to the hosts system's services (such as D-bus), and is therefore considered insecure. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - network_mode: "none" .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - network_mode: container:web1 oom_kill_disable Whether to disable OOM killer .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - oom_kill_disable: False oom_score_adj An integer value containing the score given to the container in order to tune OOM killer preferences .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - oom_score_adj: 500 pid_mode Set to ``host`` to use the host container's PID namespace within the container. Requires Docker 1.5.0 or newer. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - pid_mode: host .. note:: This option requires Docker 1.5.0 or newer. pids_limit Set the container's PID limit. Set to ``-1`` for unlimited. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - pids_limit: 2000 port_bindings (or *publish*) Bind exposed ports. Port bindings should be passed in the same way as the ``--publish`` argument to the ``docker run`` CLI command: - ``ip:hostPort:containerPort`` - Bind a specific IP and port on the host to a specific port within the container. - ``ip::containerPort`` - Bind a specific IP and an ephemeral port to a specific port within the container. - ``hostPort:containerPort`` - Bind a specific port on all of the host's interfaces to a specific port within the container. - ``containerPort`` - Bind an ephemeral port on all of the host's interfaces to a specific port within the container. Multiple bindings can be separated by commas, or expressed as a YAML list, and port ranges can be defined using dashes. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - port_bindings: "4505-4506:14505-14506,2123:2123/udp,8080" .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - port_bindings: - 4505-4506:14505-14506 - 2123:2123/udp - 8080 .. note:: When specifying a protocol, it must be passed in the ``containerPort`` value, as seen in the examples above. ports A list of ports to expose on the container. Can either be a comma-separated list or a YAML list. If the protocol is omitted, the port will be assumed to be a TCP port. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - ports: 1111,2222/udp .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - ports: - 1111 - 2222/udp privileged : False If ``True``, runs the exec process with extended privileges .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - privileged: True publish_all_ports (or *publish_all*) : False Publish all ports to the host .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - ports: 8080 - publish_all_ports: True read_only : False If ``True``, mount the container’s root filesystem as read only .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - read_only: True restart_policy (or *restart*) Set a restart policy for the container. Must be passed as a string in the format ``policy[:retry_count]`` where ``policy`` is one of ``always``, ``unless-stopped``, or ``on-failure``, and ``retry_count`` is an optional limit to the number of retries. The retry count is ignored when using the ``always`` or ``unless-stopped`` restart policy. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - restart_policy: on-failure:5 bar: docker_container.running: - image: bar/baz:latest - restart_policy: always security_opt (or *security_opts*): Security configuration for MLS systems such as SELinux and AppArmor. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - security_opt: apparmor:unconfined .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - security_opt: - apparmor:unconfined .. important:: Some security options can contain commas. In these cases, this argument *must* be passed as a Python list, as splitting by comma will result in an invalid configuration. .. note:: See the documentation for security_opt at https://docs.docker.com/engine/reference/run/#security-configuration shm_size Size of /dev/shm .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - shm_size: 128M stop_signal Specify the signal docker will send to the container when stopping. Useful when running systemd as PID 1 inside the container. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - stop_signal: SIGRTMIN+3 .. note:: This option requires Docker 1.9.0 or newer and docker-py 1.7.0 or newer. .. versionadded:: 2016.11.0 stop_timeout Timeout to stop the container, in seconds .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - stop_timeout: 5 .. note:: In releases prior to 2017.7.0, this option was not set in the container configuration, but rather this timeout was enforced only when shutting down an existing container to replace it. To remove the ambiguity, and to allow for the container to have a stop timeout set for it, the old ``stop_timeout`` argument has been renamed to ``shutdown_timeout``, while ``stop_timeout`` now refer's to the container's configured stop timeout. storage_opt Storage driver options for the container. Can be either a list of strings in the format ``option=value``, or a list of mappings between option and value. The below three examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - storage_opt: - dm.basesize: 40G .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - storage_opt: dm.basesize=40G .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - storage_opt: - dm.basesize=40G sysctls (or *sysctl*) Set sysctl options for the container. Can be either a list of strings in the format ``option=value``, or a list of mappings between option and value. The below three examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - sysctls: - fs.nr_open: 1048576 - kernel.pid_max: 32768 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - sysctls: fs.nr_open=1048576,kernel.pid_max=32768 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - sysctls: - fs.nr_open=1048576 - kernel.pid_max=32768 tmpfs A map of container directories which should be replaced by tmpfs mounts and their corresponding mount options. .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - tmpfs: - /run: rw,noexec,nosuid,size=65536k tty : False Attach TTYs .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - tty: True ulimits List of ulimits. These limits should be passed in the format ``<ulimit_name>:<soft_limit>:<hard_limit>``, with the hard limit being optional. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - ulimits: nofile=1024:1024,nproc=60 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - ulimits: - nofile=1024:1024 - nproc=60 user User under which to run exec process .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - user: foo userns_mode (or *user_ns_mode*) Sets the user namsepace mode, when the user namespace remapping option is enabled .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - userns_mode: host volumes (or *volume*) List of directories to expose as volumes. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - volumes: /mnt/vol1,/mnt/vol2 .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - volumes: - /mnt/vol1 - /mnt/vol2 volumes_from Container names or IDs from which the container will get volumes. Can be expressed as a comma-separated list or a YAML list. The below two examples are equivalent: .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - volumes_from: foo .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - volumes_from: - foo volume_driver sets the container's volume driver .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - volume_driver: foobar working_dir (or *workdir*) Working directory inside the container .. code-block:: yaml foo: docker_container.running: - image: bar/baz:latest - working_dir: /var/log/nginx Tr ��namer �resultr NFrB � The 'image' argument is requiredr r0 � send_signal�docker.inspect_containerZImagezcUnable to detect current image for container '{}'. This might be due to a change in the Docker API.� docker.stater8 r Z forced_update)r r r: zContainer '{}' would be {}�createdZreplacedz docker.create)rA �skip_translate�ignore_collisions�validate_ip_addrsr9 r# z�Key '{}' missing from API response, this may be due to a change in the Docker Remote API. Please report this on the SaltStack issue tracker if it has not already been reported.�invalidz� If you feel this information is incorrect, the skip_translate argument can be used to skip input translation for the argument(s) identified as invalid. See the documentation for details.c s� ddi}�d ur �|d< t d �fi |���d �di �d< z t d || �}W n tyC } zd }� �d |� �� W Y d }~nd }~ww |rQ� �d | � d �� |S � �d � |S )N�stopT�timeout� docker.rmr � container_id�removedz docker.renameFz!Failed to rename temp container: zReplaced container '�'z!Failed to replace container '{0}')r � setdefaultr r. )�origr Z rm_kwargsrB r6 )r rA r �shutdown_timeoutr r �_replace� s, ��� �� �zrunning.<locals>._replacec s t �d� � td � � d S )Nz Removing temp container '%s'rN )�log�debugr r )�temp_container_namer r �_delete_temp_container� s z'running.<locals>._delete_temp_containerz#docker.connect_container_to_network�NetworkSettingsr z(docker.disconnect_container_from_networkz!docker.compare_container_networksr Z VersionInfo)� r ZHostnamezHostname,MacAddresszdocker.compare_containers)�ignore�warningsz�The detected changes may be due to incorrect handling of arguments in earlier Salt releases. If this warning persists after running the state again{}, and no changes were made to the SLS file, then please report this.z without test=True� container�IdrO ZaddedzSignal z would be sent to containerz docker.signal)�signalz Failed to signal container: r` z Sent signal z to containerzXdocker_container.running: detected changes without a specific comment for container '%s'zContainer '{}'{} updated.z would be� Container 'z$' is already configured as specifiedz&Network configuration would be updatedzdocker.connectedr r z6Reconnected to network '{}' with updated configurationzDisconnected from network 'rQ zConnected to network 'zCreated container '�runningzContainer would be startedz docker.start�statezFailed to start container 'z': 'r zdocker_container.runningc s4 � t vrtd ��} | �di ��di �t � < t � S )NrE rZ r )� __context__r �get)Znew_container_info)� contextkeyrA r r � _get_nets� s ��zrunning.<locals>._get_netsz config.optionZ automaticZIPConfigurationzState changed from 'z' to 'zContainer has a new imagezContainer is not running) r r r7 r> r r" r �popr r- r. r, r; r< �dictr+ �setre r rR �updaterV �warningr/ �list�extendr rd ).rA r: rH rI rJ r? � watch_action�startrT r9 r0 �kwargsZconfigured_networksr= r6 rD Zcurrent_image_id�exists� pre_stateZskip_comparisonZtemp_container�msgrU rY Z cleanup_tempZpre_net_connectr1 r2 Zpost_net_connectZ extra_netsZ extra_netZ net_changesZdocker_version_infoZcompare_containers_ignoreZcontainer_changesZ changes_ptrZnetwork_failurer4 Z disconnected� connectedr Z post_staterg Z autoip_keysr3 r5 r )r rf rA r rT rX r rb � s� = �� �� �� � �� ��� � � �� �� � 6�� �� ����� � �� �� m��� �Z��� ���� � ���� ���� ��� �� �� ��� ������ �� �� � ��� rb c K s | i ddd�} t jjjd i | ��} dD ]} | | v r)d| d< d| � d�| d < | S q|d u r8d| d< d | d < | S t|t�sAt|�}zd | v rT| d d urTt| d �| d < t| || � W n/ ty� } z#d| d< | j d urxt | | j �W Y d } ~ S t| �| d < | W Y d } ~ S d } ~ ww t d r�d | d< d� |r�dnd�| d < | S |r�d}n:d }dD ]*}z| � |�}W n ty� Y q�w |d ur�|s�d| d< d| d < | S q�t|�}q�|d ur�d| d< nd}ztd |f| |||| |||d�| ��| d< W n# t�y } zt�d� d| d< d| � �| d < W Y d } ~ n5d } ~ ww |�r"d| d < n(z| d d }W n t�y4 Y nw |�r?|dk�r?dnd| d< d|� �| d < |�r�| �di ��d �}|�r�z td | d d � W | S t�y� } z| �d g ��d | � �� W Y d } ~ | S d } ~ ww | S )!a� .. versionadded:: 2018.3.0 .. note:: If no tag is specified in the image name, and nothing matching the specified image is pulled on the minion, the ``docker pull`` that retrieves the image will pull *all tags* for the image. A tag of ``latest`` is not implicit for the pull. For this reason, it is recommended to specify the image in ``repo:tag`` notation. Like the :py:func:`cmd.run <salt.states.cmd.run>` state, only for Docker. Does the equivalent of a ``docker run`` and returns information about the container that was created, as well as its output. This state accepts the same arguments as :py:func:`docker_container.running <salt.states.docker_container.running>`, with the exception of ``watch_action``, ``start``, and ``shutdown_timeout`` (though the ``force`` argument has a different meaning in this state). In addition, this state accepts the arguments from :py:func:`docker.logs <salt.modules.dockermod.logs>`, with the exception of ``follow``, to control how logs are returned. Additionally, the following arguments are supported: creates A path or list of paths. Only run if one or more of the specified paths do not exist on the minion. bg : False If ``True``, run container in background and do not await or deliver its results. .. note:: This may not be useful in cases where other states depend on the results of this state. Also, the logs will be inaccessible once the container exits if ``auto_remove`` is set to ``True``, so keep this in mind. failhard : True If ``True``, the state will return a ``False`` result if the exit code of the container is non-zero. When this argument is set to ``False``, the state will return a ``True`` result regardless of the container's exit code. .. note:: This has no effect if ``bg`` is set to ``True``. replace : False If ``True``, and if the named container already exists, this will remove the existing container. The default behavior is to return a ``False`` result when the container already exists. force : False If ``True``, and the named container already exists, *and* ``replace`` is also set to ``True``, then the container will be forcibly removed. Otherwise, the state will not proceed and will return a ``False`` result. CLI Examples: .. code-block:: bash salt myminion docker.run_container myuser/myimage command=/usr/local/bin/myscript.sh **USAGE EXAMPLE** .. code-block:: jinja {% set pkg_version = salt.pillar.get('pkg_version', '1.0-1') %} build_package: docker_container.run: - image: myuser/builder:latest - binds: /home/myuser/builds:/build_dir - command: /scripts/build.sh {{ pkg_version }} - creates: /home/myuser/builds/myapp-{{ pkg_version }}.noarch.rpm - replace: True - networks: - mynet - require: - docker_network: mynet Tr r@ )ro rp rT �followFrB zThe 'z' argument is not supportedr NrC r0 r8 zContainer would be run{}z in the background)� auto_removeZrmz<'rm' is an alias for 'auto_remove', they cannot both be usedrw zdocker.run_container)rA rH rI rJ r9 �bg�replacer? r z#Encountered error running containerz%Encountered error running container: z#Container was run in the backgroundZExitCoder z/Container ran and exited with a return code of r_ rN r] z!Failed to auto_remove container: r )r' r( r) � clean_kwargsr r r7 r> r r" r r; r, rh r- �boolr r< rV � exceptionre rR r. )rA r: rx Zfailhardry r? rH rI rJ r9 rq r Z unsupportedr6 �remover r5 �retcodeZid_r r r �run% s� _� �� � ��� �� � �� � �� ���r c K s� | i ddd�}| s|sd|d< |S |dur6t |t�s d|d< |S g }|D ]}t |t�s/t|�}|�|� q$n| rFt | t�sCt| �g}n| g}i }|D ]&}ztd |�} W n tyf |�d g ��|� Y qJw |�| g ��|� qJg } |r�d |v r�| �d �d �|d ��� |s�d |v r�d|d < | �d�d �|d ��� | r�d|d < d�| �|d< |S |� dg �|� d g � } | s�d|d < t |�dkr�d|d � d�|d< nd|d< d |v r�|d d7 < |d d7 < |S t d r�d|d < d�d �| ��|d< |S g } | D ]>}d|i} |�r|| d < td |fi | ��}|d du �r'||d |< �qd|v �r5| �|d � �q| �d |� d �� �q| �rLd!�| �|d< |S d|d < d"�d �| ��|d< |S )#a@ Ensure that a container (or containers) is stopped name Name or ID of the container containers Run this state on more than one container at a time. The following two examples accomplish the same thing: .. code-block:: yaml stopped_containers: docker_container.stopped: - names: - foo - bar - baz .. code-block:: yaml stopped_containers: docker_container.stopped: - containers: - foo - bar - baz However, the second example will be a bit quicker since Salt will stop all specified containers in a single run, rather than executing the state separately on each image (as it would in the first example). shutdown_timeout Timeout for graceful shutdown of the container. If this timeout is exceeded, the container will be killed. If this value is not passed, then the container's configured ``stop_timeout`` will be observed. If ``stop_timeout`` was also unset on the container, then a timeout of 10 seconds will be used. unpause : False Set to ``True`` to unpause any paused containers before stopping. If unset, then an error will be raised for any container that was paused. error_on_absent : True By default, this state will return an error if any of the specified containers are absent. Set this to ``False`` to suppress that error. Fr r@ z/One of 'name' and 'containers' must be providedr Nzcontainers must be a listrF �absentz)The following container(s) are absent: {}r& ZpausedrB z)The following container(s) are paused: {}r rb Tr ra r z' is z All specified containers are z absent or z not runningr8 z.The following container(s) will be stopped: {}�unpauserM z docker.stopr zFailed to stop container 'rQ z; z+The following container(s) were stopped: {}) r rm r r. r r rR r, r re r r; )rA Z containersrT r� Zerror_on_absentrq r �targets�targetZc_stater4 Zto_stopZ stop_errorsZ stop_kwargsr r r r �stopped� s� 7 � � �� �� � �r� c C s: | i ddd�}| t d dd�vr d|d< d| � d �|d < |S t d | �}|d kr0|s0d |d < |S td rBd|d< d| � d�|d < |S zt d | |d�|d d< W n tyn } zd| � d|� �|d < |W Y d}~S d}~ww | t d dd�v r�d| � d�|d < |S |r�|d kr�d}nd}|� d| � d�|d < d|d< |S )a� Ensure that a container is absent name Name of the container force : False Set to ``True`` to remove the container even if it is running Usage Examples: .. code-block:: yaml mycontainer: docker_container.absent multiple_containers: docker_container.absent: - names: - foo - bar - baz Fr r@ zdocker.list_containersT)r rB ra z' does not existr rF r� z=Container is running, set force to True to forcibly remove itr8 Nz' will be removedrN )r? r rP z Failed to remove container 'z': rQ ZForciblyZ Successfullyz removed container ')r r; r< )rA r? r rs r6 �methodr r r r� � s: �� �r� c K s� |dkr&t �|�}|�dd�dkrd|d< nd|d< d|d< t| fi |��S |dkr:t| fi tjjjd i |����S |dkrNt | fi tjjjd i |����S | i dd |� �d �S ) a< The docker_container watcher, called to invoke the watch command. .. note:: This state exists to support special handling of the ``watch`` :ref:`requisite <requisites>`. It should not be called directly. Parameters for this function should be set by the state being triggered. rb ro r? TrD Fr� r z'watch requisite is not implemented for r@ Nr ) �copy�deepcopyre rb r� r' r( r) rz r )rA Zsfunrq Z watch_kwargsr r r � mod_watch� s �r� )NNNFT)F)N)�__doc__r� �loggingZsalt.utils.argsr' Zsalt.utils.dataZsalt.utils.dockermodZsalt.exceptionsr � getLogger�__name__rV r Z__virtual_aliases__r r r r7 r> r( Z dockermodZCLIENT_TIMEOUTrb r r� r� r� r r r r �<module> sx / D � d � Q � ;
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings