File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/dockermod.cpython-310.pyc
Back
o ;jɅ � @ sZ d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlZddlmZmZ ddl m Z ddl m Z dZ zddl!Z!dZ"W n e#y� dZ"Y nw zddl$Z$dZ%W n e#y� dZ%Y nw zddl&Z&dZ'W n e#y� dZ'Y nw e(ej)j*�+d ��Z,e�-e.�Z/d d d d dddd�Z0dZ1dZ2dZ3e4� Z5dZ6dZ7dgZ8dddd�Z9dd� Z:dd � Z;G d d � d ej<�Z=d d � Z>e5fd!d"�Z?d#d$� Z@d%d&� ZAd'd(� ZBd)d*� ZCd+d,� ZDd-d.� ZEd/d0� ZFd1d2� ZGd�d3d4�ZHd5d6� ZId7d8� ZJd9d:� ZKd;d<� ZLeAd=d>� �ZMd?d@� ZNdAdB� ZOdCdD� ZPdEdF� ZQdGdH� ZRd�dIdJ�ZS d�dKdL�ZTd�dMdN�ZUej)j�VeUdO�ZWdPdQ� ZXd�dSdT�ZY�d dUdV�ZZdWdX� Z[dYdZ� Z\d[d\� Z]d]d^� Z^d_d`� Z_�d dadb�Z`�d dcdd�Zadedf� Zbdgdh� Zcdidj� Zddkdl� Zedmdn� Zfdodp� Zgdqdr� Zhdsdt� Zidudv� Zjdwdx� Zkd�dydz�Zld�d{d|�Zmd}d~� Zn�ddd��Zod�d�� Zpd�d�� Zqd�d�� ZreBdddddej)jsjtfd�d���ZueBddddej)jsjtddddf d�d���Zv�dd�d��Zwej)j�Vewd��Zx�dd�d��Zy�dd�d��ZzeB�dd�d���Z{d�d�� Z| �dd�d��Z}�dd�d��Z~�dd�d��Z�dd�d��Z��dd�d��Z�d�d�� Z�ddej)jsjtfd�d��Z�ddej)jsjtfd�d��Z�d�d�� Z��dd�d��Z��dd�d��Z��dd�d��Z�dddej)jsjtfd�d��Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�� Z�d�d�d��Z��dd�d��Z�d�d�� Z�d�d Z�eBd�dĄ �Z�eBd�dƄ �Z�ej)j�Ve�dǡZ��dd�dʄZ�eBd�d̄ �Z�eBd�d΄ �Z�eBd�d�dЄ�Z�eBd�d҄ �Z�ej)j�Ve�dӡZ��dd�dՄZ� �d d�dׄZ�eB � �d d�dڄ�Z�eB � � �d d�d݄�Z� � �d d�d߄Z� � �d d�d�Z� � �d d�d�Z� � �d d�d�Z� � �d d�d�Z� � � �d d�d�Z� � � �d d�d�Z�d�d� Z��d d�d�Z�d�d�d�Z�d�d� Z�d�d�d��Z�d�d�d��Z��dd�d�Z� �dd�d��Z�dS ( a~ Management of Docker Containers .. versionadded:: 2015.8.0 .. versionchanged:: 2017.7.0 This module has replaced the legacy docker execution module. :depends: docker_ Python module .. _`create_container()`: http://docker-py.readthedocs.io/en/stable/api.html#docker.api.container.ContainerApiMixin.create_container .. _`create_host_config()`: http://docker-py.readthedocs.io/en/stable/api.html#docker.api.container.ContainerApiMixin.create_host_config .. _`connect_container_to_network()`: http://docker-py.readthedocs.io/en/stable/api.html#docker.api.network.NetworkApiMixin.connect_container_to_network .. _`create_network()`: http://docker-py.readthedocs.io/en/stable/api.html#docker.api.network.NetworkApiMixin.create_network .. _`logs()`: http://docker-py.readthedocs.io/en/stable/api.html#docker.api.container.ContainerApiMixin.logs .. _`IPAM pool`: http://docker-py.readthedocs.io/en/stable/api.html#docker.types.IPAMPool .. _docker: https://pypi.python.org/pypi/docker .. _docker-py: https://pypi.python.org/pypi/docker-py .. _lxc-attach: https://linuxcontainers.org/lxc/manpages/man1/lxc-attach.1.html .. _nsenter: http://man7.org/linux/man-pages/man1/nsenter.1.html .. _docker-exec: http://docs.docker.com/reference/commandline/cli/#exec .. _`docker-py Low-level API`: http://docker-py.readthedocs.io/en/stable/api.html .. _timelib: https://pypi.python.org/pypi/timelib .. _`trusted builds`: https://blog.docker.com/2013/11/introducing-trusted-builds/ .. _`Docker Engine API`: https://docs.docker.com/engine/api/v1.33/#operation/ContainerCreate .. 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-authentication: Authentication -------------- If you have previously performed a ``docker login`` from the minion, then the credentials saved in ``~/.docker/config.json`` will be used for any actions which require authentication. If not, then credentials can be configured in any of the following locations: - Minion config file - Grains - Pillar data - Master config file (requires :conf_minion:`pillar_opts` to be set to ``True`` in Minion config file in order to work) .. important:: Versions prior to 3000 require that Docker credentials are configured in Pillar data. Be advised that Pillar data is still recommended though, because this keeps the configuration from being stored on the Minion. Also, keep in mind that if one gets your ``~/.docker/config.json``, the password can be decoded from its contents. The configuration schema is as follows: .. code-block:: yaml docker-registries: <registry_url>: username: <username> password: <password> For example: .. code-block:: yaml docker-registries: hub: username: foo password: s3cr3t .. note:: As of the 2016.3.7, 2016.11.4, and 2017.7.0 releases of Salt, credentials for the Docker Hub can be configured simply by specifying ``hub`` in place of the registry URL. In earlier releases, it is necessary to specify the actual registry URL for the Docker Hub (i.e. ``https://index.docker.io/v1/``). More than one registry can be configured. Salt will look for Docker credentials in the ``docker-registries`` Pillar key, as well as any key ending in ``-docker-registries``. For example: .. code-block:: yaml docker-registries: 'https://mydomain.tld/registry:5000': username: foo password: s3cr3t foo-docker-registries: https://index.foo.io/v1/: username: foo password: s3cr3t bar-docker-registries: https://index.bar.io/v1/: username: foo password: s3cr3t To login to the configured registries, use the :py:func:`docker.login <salt.modules.dockermod.login>` function. This only needs to be done once for a given registry, and it will store/update the credentials in ``~/.docker/config.json``. .. note:: For Salt releases before 2016.3.7 and 2016.11.4, :py:func:`docker.login <salt.modules.dockermod.login>` is not available. Instead, Salt will try to authenticate using each of your configured registries for each push/pull, behavior which is not correct and has been resolved in newer releases. Configuration Options --------------------- The following configuration options can be set to fine-tune how Salt uses Docker: - ``docker.url``: URL to the docker service (default: local socket). - ``docker.version``: API version to use (should not need to be set manually in the vast majority of cases) - ``docker.exec_driver``: Execution driver to use, one of ``nsenter``, ``lxc-attach``, or ``docker-exec``. See the :ref:`Executing Commands Within a Running Container <docker-execution-driver>` section for more details on how this config parameter is used. These configuration options are retrieved using :py:mod:`config.get <salt.modules.config.get>` (click the link for further information). .. _docker-execution-driver: Executing Commands Within a Running Container --------------------------------------------- .. note:: With the release of Docker 1.13.1, the Execution Driver has been removed. Starting in versions 2016.3.6, 2016.11.4, and 2017.7.0, Salt defaults to using ``docker exec`` to run commands in containers, however for older Salt releases it will be necessary to set the ``docker.exec_driver`` config option to either ``docker-exec`` or ``nsenter`` for Docker versions 1.13.1 and newer. Multiple methods exist for executing commands within Docker containers: - lxc-attach_: Default for older versions of docker - nsenter_: Enters container namespace to run command - docker-exec_: Native support for executing commands in Docker containers (added in Docker 1.3) Adding a configuration option (see :py:func:`config.get <salt.modules.config.get>`) called ``docker.exec_driver`` will tell Salt which execution driver to use: .. code-block:: yaml docker.exec_driver: docker-exec If this configuration option is not found, Salt will use the appropriate interface (either nsenter_ or lxc-attach_) based on the ``Execution Driver`` value returned from ``docker info``. docker-exec_ will not be used by default, as it is presently (as of version 1.6.2) only able to execute commands as the effective user of the container. Thus, if a ``USER`` directive was used to run as a non-privileged user, docker-exec_ would be unable to perform the action as root. Salt can still use docker-exec_ as an execution driver, but must be explicitly configured (as in the example above) to do so at this time. If possible, try to manually specify the execution driver, as it will save Salt a little work. This execution module provides functions that shadow those from the :mod:`cmd <salt.modules.cmdmod>` module. They are as follows: - :py:func:`docker.retcode <salt.modules.dockermod.retcode>` - :py:func:`docker.run <salt.modules.dockermod.run>` - :py:func:`docker.run_all <salt.modules.dockermod.run_all>` - :py:func:`docker.run_stderr <salt.modules.dockermod.run_stderr>` - :py:func:`docker.run_stdout <salt.modules.dockermod.run_stdout>` - :py:func:`docker.script <salt.modules.dockermod.script>` - :py:func:`docker.script_retcode <salt.modules.dockermod.script_retcode>` Detailed Function Documentation ------------------------------- � N)�CommandExecutionError�SaltInvocationError)�__file_client__)� HighStatezrestructuredtext enTF�nsenter�importZps�rm�signal�start�tagZapply)�import_�ps_�rm_�signal_�start_�tag_�apply_)� � r )r � r z([\d.]+)�docker)ZdockerngZmoby� highstate)�slsr r c C s� t rbzt� } W n ty Y dS w | du rdS | tkrNzt� �d�}W n ty/ d}Y nw |du s8|tkr:tS dd�d� t t t��d� t t |���fS dd�d� t t t��d� t t | ���fS dS ) z. Only load if docker libs are present )Fz6Docker module found, but no version could be extractedN� VersionInfoFz9Insufficient Docker version (required: {}, installed: {})�.z<Insufficient docker-py version (required: {}, installed: {}))Fz7Could not import docker module, is docker-py installed?) � HAS_DOCKER_PY�_get_docker_py_versioninfo� Exception� MIN_DOCKER_PY�version�get� MIN_DOCKER�__virtualname__�format�join�map�str)Zdocker_py_versioninfoZdocker_versioninfo� r' �J/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/dockermod.py� __virtual__! s: � �����r) c C s t rt �� S tj�t�S )z� Return a file client If the __file_client__ context is set return it, otherwize create a new file client using __opts__. )r �value�salt� fileclientZget_file_client�__opts__r' r' r' r( � _file_clientI s r. c @ s e Zd Zddd�ZdS )�DockerJSONDecoderNc C s4 g }|� � D ]}|s q| �|�\}}|�|� q|S �N)� splitlines� raw_decode�append)�self�s�_wZobjs�line�obj�_r' r' r( �decodeV s zDockerJSONDecoder.decoder0 )�__name__� __module__� __qualname__r: r' r' r' r( r/ U s r/ c C sT zt jW S ty) zt j�d�} tdd� | D ��W Y S ty( Y Y dS w w )z7 Returns the version_info tuple from docker-py r c s � � | ]}t |�V qd S r0 ��int)�.0�nr' r' r( � <genexpr>j � � z-_get_docker_py_versioninfo.<locals>.<genexpr>N)r � version_info�AttributeError� __version__�split�tuple)Zdocker_versionr' r' r( r ` s ��r c K s| i }| t ur | |d< dD ]\}}td |t �}|t ur |||< q d|vr1dtjv r1tj�d�|d< d|vr9d|d< td dt �}|t ur�td d d |gd d �}z0tjj�|�}|d d }|d d } d| d |d< t j j |d |d f|d dd�|d< W n t y� } z t d|� d| � ���d } ~ ww z t jd i |��} W n ty� t jd i |��} Y nw t�d t| d d �� | S ) N�timeout))�base_urlz docker.url)r zdocker.version� config.optionrK Z DOCKER_HOSTr �autozdocker.machine�cmd.runzdocker-machine�inspectF�� python_shellZ HostOptionsZ AuthOptionsZDriverZ IPAddresszhttps://z:2376ZClientCertPathZ ClientKeyPathZ CaCertPathT)Z client_certZca_certZverify�tlszDocker machine z failed: zdocker-py API version: %s� api_versionr' )�NOTSET�__salt__�os�environr r+ �utils�json�loadsr rR Z TLSConfigr r Z APIClientrF ZClient�log�debug�getattr) rJ �kwargsZ client_kwargs�key�val�paramZdocker_machineZdocker_machine_jsonZdocker_machine_tlsZdocker_machine_ip�exc�retr' r' r( � _get_cliento sT � � ����� �rd c C s4 | � di �� dd�r dS | � di �� dd�rdS dS )z^ Helper for deriving the current state of the container from the inspect results. �StateZPausedF�pausedZRunning�running�stopped�r )�inspect_resultsr' r' r( � _get_state� s rk c � t �� �� fdd��}|S )z^ Decorator to run a function that requires the use of a docker.Client() instance. c s� t d di |��}|�dt�}dtvsttd d�s%tdd|i|��td< d}|turCttd d�rCtd j|krCtd j}|td _� | i |��}|durS|td _|S )z3 Ensure that the client is present �args.clean_kwargs�client_timeout� docker.clientrJ Nr' )� __utils__�poprT � __context__�hasattrrd rJ )�argsr^ rJ � orig_timeoutrc ��wrappedr' r( �wrapper� s" � � z _docker_client.<locals>.wrapper�� functools�wraps�rw rx r' rv r( �_docker_client� s r} c rl )z; Decorator to trigger a refresh of salt mine data. c s: � | i t d di |����}t� rtd ddddd� |S )z, refresh salt mine on exit. rm z mine.sendz docker.psT)�verbose�all�hostNr' )rp �_check_update_minerU )rt r^ Zreturnedrv r' r( rx � s z$_refresh_mine_cache.<locals>.wrapperry r| r' rv r( �_refresh_mine_cache� s r� c C s< zt d } W | S ty td ddd� } t d< Y | S w )Nzdocker.update_minerL T)�default)rr �KeyErrorrU )rc r' r' r( r� � s ���r� c O s� t | �}|dkr||krd||d�d| � d|� �d�S t|| g|�R i |�� t� zt | �}W n ty; d}Y nw ||k||d�d�}|S ) z) Change the state of a container �restartF��old�new� Container 'z ' already ��result�state�commentN)r� r� )r� �_client_wrapper�_clear_contextr )�name�action�expectedrt r^ �pre�postrc r' r' r( � _change_state� s � �r� c C sH d} t t�D ]}z|�d�r|| vrt�|� W q ty! Y qw dS )z9 Clear the state/exists values stored in context )ro �docker.exec_driver�docker._pull_statuszdocker.docker_versionzdocker.docker_py_versionzdocker.N)�listrr � startswithrq rF )Z keep_contextr_ r' r' r( r� s � ��r� c C s> t | dt�|�� �dd�}z|�� d W S ty Y dS w )z< Get the sha256 checksum of a file from a container z sha256sum T��ignore_retcoder N)� run_stdout�shlex�quoterH � IndexError)r� �path�outputr' r' r( � _get_sha256 s �r� c C s� d} | t vr`td | d�}|dur|t | < |S t� �dd�}|dkr*|t | < t | S |�d�r7dt | < t | S |�d�rFtrFd t | < t | S |�� sYtrYt�d � d t | < t | S t d � |���t | S ) z5 Get the method to be used in shell commands r� rL NZExecutionDriverz docker-execzlxc-z lxc-attachznative-r z�ExecutionDriver from 'docker info' is blank, falling back to using 'nsenter'. To squelch this warning, set docker.exec_driver. See the Salt documentation for the docker module for more information.zVUnknown docker ExecutionDriver '{}', or didn't find command to attach to the container) rr rU �infor r� � HAS_NSENTER�stripr[ �warning�NotImplementedErrorr# )� contextkeyZ from_config�driverr' r' r( �_get_exec_driver( s6 �� ����r� c sX z� fdd�� D ��|dur|n� }�fdd�|D �W S t tfy+ td�� ���w )z� Returns a list of the top-level images (those which are not parents). If ``subset`` (an iterable) is passed, the top-level images in the subset will be returned, otherwise all top-level images will be returned. c s g | ]}� | d �qS )�ParentIdr' �rA �x)� imagedatar' r( � <listcomp>U � z)_get_top_level_images.<locals>.<listcomp>Nc � g | ]}|� vr|�qS r' r' r� )�parentsr' r( r� W r� zcInvalid image data passed to _get_top_level_images(). Please report this issue. Full image data: {})r� � TypeErrorr r# )r� �subsetZfilter_r' )r� r� r( �_get_top_level_imagesN s ��r� c C s dd� t dd�D �td< dS )z� Populate __context__ with the current (pre-pull) image IDs (see the docstring for _pull_status for more information). c S � g | ]}|d d� �qS �N� r' r� r' r' r( r� d r� z _prep_pull.<locals>.<listcomp>T�r r� N)�imagesrr r' r' r' r( � _prep_pull_ s r� c C s@ t | t�r g }| D ]}|�|�d|� d�dd�� q |S | }|S )zx Remove container name from HostConfig:Links values to enable comparing container configurations correctly. �/r )� isinstancer� r3 �replace)Zlinksr� rc �lr' r' r( � _scrub_linksg s �r� c C s t | t�r t| dd� d�S | S )Nc S s | � d�| � dd�| � dd�fS )N�NameZHardr ZSoftri �r� r' r' r( �<lambda>z s z _ulimit_sort.<locals>.<lambda>�r_ )r� r� �sorted)Z ulimit_valr' r' r( � _ulimit_sortv s �r� c C s| z-t | �} | dk r| � d�W S | d } dD ]}| dk r&| d�d|� � W S | d } qW d S ty= t�d| � Y dS w ) z3 Format bytes as human-readable file sizes i z bytesg �@)ZKiBZMiBZGiBZTiBZPiBz3.1f� z#Unable to format file size for '%s'�unknownN)r@ r r[ �error)�numZunitr' r' r( � _size_fmt s � �r� c O sD |� dd�}ttd | d�}|du st|d�s td| � d���| dv r5ztd �� W n ty4 Y nw d }zt�d | ||� ||i |��}W |S t j j yg } z|rbt d |j j� d |j� ���� d}~w t j jyz } zt t|���d}~w ty� } z t|�}W Y d}~nd}~ww d | � �}|r�|d |� �7 }t |��)z> Common functionality for running low-level API calls �catch_api_errorsTro N�__call__zInvalid client action '�')�push�pull� zFAttempting to run docker-py's "%s" function with args=%s and kwargs=%s�Error �: zUnable to perform )rq r] rr rs r Z reload_configrF r[ r\ r �errors�APIErrorr �response� status_code� explanationZDockerExceptionr& r ) �attrrt r^ r� �func�errrc rb �msgr' r' r( r� � sL ����� ��� r� c C sR |d }d|v r| � dg ��|�� �� d � d|v r'|�� �� d | d< dS dS )zR Process a status update from a docker build, updating the data structure �streamz Running in�Intermediate_Containers���zSuccessfully built�IdN)� setdefaultr3 �rstriprH )�data�itemr� r' r' r( � _build_status� s ��r� c C sh |d }z#d|v r W dS t dd� |D ��r%|� d|� �| d< || d< W dS W dS ttfy3 Y dS w ) zQ Process a status update from docker import, updating the data structure �statuszDownloading fromNc s s � | ]}|t jv V qd S r0 )�string� hexdigitsr� r' r' r( rC � s � z!_import_status.<locals>.<genexpr>�:�Imager� )r rF r� )r� r� Z repo_nameZrepo_tagr� r' r' r( �_import_status� s ��r� c s� � fdd�}� fdd�}dt vrt�d� tt d< |d }|dkr)||d � d S |d v r5||d � d S |�d �rD|d d � � d< d S |dkrdt d turf|d }|t d v r^||� d S ||� d S d S d S )ap Process a status update from a docker pull, updating the data structure. For containers created with older versions of Docker, there is no distinction in the status updates between layers that were already present (and thus not necessary to download), and those which were actually downloaded. Because of this, any function that needs to invoke this function needs to pre-fetch the image IDs by running _prep_pull() in any function that calls _pull_status(). It is important to grab this information before anything is pulled so we aren't looking at the state of the images post-pull. We can't rely on the way that __context__ is utilized by the images() function, because by design we clear the relevant context variables once we've made changes to allow the next call to images() to pick up any changes that were made. c �. � � di �� dg �}| |vr|�| � dS dS )z& Layer already exists �LayersZAlready_PulledN�r� r3 )�id_Zalready_pulled�r� r' r( �_already_exists� � �z%_pull_status.<locals>._already_existsc r� )z$ Pulled a new layer r� ZPulledNr� )r� Zpulledr� r' r( � _new_layer� r� z _pull_status.<locals>._new_layerr� z�_pull_status context variable was not populated, information on downloaded layers may be inaccurate. Please report this to the SaltStack development team, and if possible include the image (and tag) that was being pulled.r� zAlready exists�idz Pull completezStatus: � N�StatuszDownload complete)rr r[ r� rT r� )r� r� r� r� r� r� r' r� r( � _pull_status� s, � �r� c C s� |d � � }d|v r@d|v sd|v r%| �di ��dg �}|�|d � d S d|v s-|dkrB| �di ��d g �}|�|d � d S d S d S ) zQ Process a status update from a docker push, updating the data structure r� r� zalready pushedzalready existsr� ZAlready_Pushedzsuccessfully pushed�pushedZPushedN)�lowerr� r3 )r� r� r� Zalready_pushedr� r' r' r( � _push_status s ��r� c C s| |d }d|v r1zd� |d d |d d f�}W n ty0 d�|d d |d d �}Y nw |d d }| �|� dS )z; Process an API error, updating the data structure � errorDetail�coder� �messagez{}: {}N)r$ r� r# r3 )r� r� r� r� r' r' r( � _error_detail, s � �� r� c C s t d | d�S )a{ .. versionadded:: 2016.3.6,2016.11.4,2017.7.0 .. versionchanged:: 2017.7.0 Replaced the container config args with the ones from the API's ``create_container`` function. .. versionchanged:: 2018.3.0 Added ability to limit the input to specific client functions Many functions in Salt have been written to support the full list of arguments for a given function in the `docker-py Low-level API`_. However, depending on the version of docker-py installed on the minion, the available arguments may differ. This function will get the arguments for various functions in the installed version of docker-py, to be used as a reference. limit An optional list of categories for which to limit the return. This is useful if only a specific set of arguments is desired, and also keeps other function's argspecs from needlessly being examined. **AVAILABLE LIMITS** - ``create_container`` - arguments accepted by `create_container()`_ (used by :py:func:`docker.create <salt.modules.dockermod.create>`) - ``host_config`` - arguments accepted by `create_host_config()`_ (used to build the host config for :py:func:`docker.create <salt.modules.dockermod.create>`) - ``connect_container_to_network`` - arguments used by `connect_container_to_network()`_ to construct an endpoint config when connecting to a network (used by :py:func:`docker.connect_container_to_network <salt.modules.dockermod.connect_container_to_network>`) - ``create_network`` - arguments accepted by `create_network()`_ (used by :py:func:`docker.create_network <salt.modules.dockermod.create_network>`) - ``ipam_config`` - arguments used to create an `IPAM pool`_ (used by :py:func:`docker.create_network <salt.modules.dockermod.create_network>` in the process of constructing an IPAM config dictionary) CLI Example: .. code-block:: bash salt myminion docker.get_client_args salt myminion docker.get_client_args logs salt myminion docker.get_client_args create_container,connect_container_to_network zdocker.get_client_args��limit)rp r� r' r' r( �get_client_argsA s /r c K s\ |� di �}|�dd�|v r|d ||d i}ni }td tjjjjf| ||d�td di |����}|r<t|�|d< |du rdzt d d g�}W n t yc } zt j d |d d � t d|� ���d}~ww i }i }i } t |�D ]+} | |d v r~|� | �|| < qn| |d v r�| d kr�|�|� | �� n|� | �| | < qnqntdi |��| d < | d �|� | |fS )zl Take input kwargs and return a kwargs dict to pass to docker-py's create_container() function. �networksZ network_moder� �docker.translate_input��skip_translate�ignore_collisions�validate_ip_addrsrm Znetworking_configN�create_container� host_configz.docker.create: Error getting client args: '%s'T)�exc_infozFailed to get client args: �create_host_configr' )r )rq r rp r+ rX � dockermod� translate� container�_create_networking_configr r r[ r� r� �updater� ) r r r Z client_argsr^ r rb Zfull_host_configZ host_kwargs� create_kwargs�argr' r' r( �_get_create_kwargss sR ��� ��� �r c C s� t d |pg �}t| �}t|�}i }dD �]4}|| D ]�}||v r"q|| | }|| �|�} |dv s;|du s;| du rOt|�t| �krN|| d�|�|i �|< q|dkrot|�d } t| �d } | | krn| | d�|�|i �|< q|dkr�tt|| ��}tt| |��} |d kr�t|�}t| �} |d kr�t|�}t| �} || kr�|| d�|�|i �|< q|| D ]�}||v s�||�|i �v r�q�|| �|�}|| | } |dv s�|du s�| du r�t|�t| �kr�|| d�|�|i �|< q�|dk�r t|�d } t| �d } | | k�r | | d�|�|i �|< q�|dk�r tt|| ��}tt| |��} |d k�r+t|�}t| �} |d k�r8t|�}t| �} || k�rH|| d�|�|i �|< q�q|S ) a .. versionadded:: 2017.7.0 .. versionchanged:: 2018.3.0 Renamed from ``docker.compare_container`` to ``docker.compare_containers`` (old function name remains as an alias) Compare two containers' Config and and HostConfig and return any differences between the two. first Name or ID of first container second Name or ID of second container ignore A comma-separated list (or Python list) of keys to ignore when comparing. This is useful when comparing two otherwise identical containers which have different hostnames. CLI Examples: .. code-block:: bash salt myminion docker.compare_containers foo bar salt myminion docker.compare_containers foo bar ignore=Hostname �args.split_input)�Config� HostConfig)ZOomKillDisableNr� r� r� ZLinksZUlimitsZEnv) rp �inspect_containerr �boolr� � inspect_imager� r� r� ) �first�second�ignore�result1�result2rc Z conf_dictr� �val1�val2Zimage1Zimage2r' r' r( �compare_containers� sz � �� � � ��r! �compare_containerc s dd� }t d d�� t| t�st| �n| }t|t�s t|�n|}||��||��t| �}t|�}t��}|��� |D ]H}z t|��di �} W n t y` } z t � d|| � W Y d} ~ q;d} ~ ww |dkrr|�v rr|d | vrr�|= |dkr�|�v r�|d | vr��|= q;i } � ��fd d �} �fd d ��D �D ]H}� �dg �D ]?} �| �| �}| dkr�| | ||d� |r�| dkr�z |� |d d � W n t tfy� Y nw |s�q�|dd�| �|i �| < q�q��D �]*}|�v�r7� �dg �D ]E} �| �| �}| dk�r| | ||d� q�|�r5| dk�r*z |� |d d � W n t tf�y% Y nw |�s*q�d|d�| �|i �| < q�q� �dg �D ]�} �| | }�| | }||fD ]}z|�� W �qO t�yc Y �qOw | dk�r�z |� |d d � W n tt f�y� Y nw z |� |d dd� � W n tt f�y� Y nw |�s�d}z |� |d d � W n tt f�y� Y nw z |� |d dd� � W n tt f�y� Y nw |�s�d}n| dk�r�| | |||d� �q=t|�t|� u �r�du �r�n n�q=||k�r ||d�| �|i �| < �q=q�| S )a� .. versionadded:: 2018.3.0 Returns the differences between two containers' networks. When a network is only present one of the two containers, that network's diff will simply be represented with ``True`` for the side of the diff in which the network is present) and ``False`` for the side of the diff in which the network is absent. This function works by comparing the contents of both containers' ``Networks`` keys (under ``NetworkSettings``) in the return data from :py:func:`docker.inspect_container <salt.modules.dockermod.inspect_container>`. Because each network contains some items that either A) only set at runtime, B) naturally varying from container to container, or both, by default the following keys in each network are examined: - **Aliases** - **Links** - **IPAMConfig** The exception to this is if ``IPAMConfig`` is unset (i.e. null) in one container but not the other. This happens when no static IP configuration is set, and automatic IP configuration is in effect. So, in order to report on changes between automatic IP configuration in one container and static IP configuration in another container (as we need to do for the :py:func:`docker_container.running <salt.states.docker_container.running>` state), automatic IP configuration will also be checked in these cases. This function uses the :conf_minion:`docker.compare_container_networks` minion config option to determine which keys to examine. This provides flexibility in the event that features added in a future Docker release necessitate changes to how Salt compares networks. In these cases, rather than waiting for a new Salt release one can just set :conf_minion:`docker.compare_container_networks`. .. versionchanged:: 3000 This config option can now also be set in pillar data and grains. Additionally, it can be set in the master config file, provided that :conf_minion:`pillar_opts` is enabled on the minion. .. note:: The checks for automatic IP configuration described above only apply if ``IPAMConfig`` is among the keys set for static IP checks in :conf_minion:`docker.compare_container_networks`. first Name or ID of first container (old) second Name or ID of second container (new) CLI Example: .. code-block:: bash salt myminion docker.compare_container_networks foo bar c S s | � di �� di �S )N�NetworkSettingsZNetworksri r� r' r' r( � _get_netsJ s z-compare_container_networks.<locals>._get_netsrL z!docker.compare_container_networks� Containersz'Failed to inspect Docker network %s: %sNrg r� c s� d|v}|r d}nt |d �}| o| }d|v}|r d}nt |d �}| o)| }��dg �} |r}|s6|r}| D ]} �� �| �} | rN| d d���� i �| < q8|r^d |d d���� i �d< t� �fdd�| D ��s{d|rod nd d���� i �d < d S d S |r�|s�|r�| D ]} �� �| �} | r�d | d���� i �| < q�t� �fd d�| D ��s�|r�d nd dd���� i �d < |r�|d d d���� i �d< d S d S |�d�} |�d�} | | kr�| | d���� i �d< d S d S ) Nr� Fr� Z automaticr� � IPAMConfigc 3 � � | ] }|�� � i �v V qd S r0 ri r� ��net_namerc r' r( rC � � � zFcompare_container_networks.<locals>._check_ipconfig.<locals>.<genexpr>�staticz not connectedZIPConfigurationc 3 r' r0 ri r� r( r' r( rC � r* )r r r� �any)rc r) r^ Z nets1_missingZ nets1_staticZ nets1_autoipZ nets2_missingZ nets2_staticZ nets2_autoipZ autoip_keysZ autoip_keyZ autoip_val�old_val�new_val�Z compare_keysZnets1�nets2r( r( �_check_ipconfigv sh ��� �� �� ��� ��z3compare_container_networks.<locals>._check_ipconfigc 3 � � | ] }|� vr|V qd S r0 r' r� )r0 r' r( rC � � � z-compare_container_networks.<locals>.<genexpr>r+ r& )r� ZAliasesr ZHostnamer� )r� r� F)rU r� �dictr r� �setr �inspect_networkr r r[ r� �remove� ValueErrorrF r� �sortr )r r r$ r r Zstate1Zstate2Zall_netsr) �connected_containersrb rc r1 r_ r` r- r. r� r' r/ r( �compare_container_networks s� < �� �@��� ��� � ����� $ ��(r; �Name,Id,Created,Containersc s@ t d � pg �� t| t�st| �n| }t|t�s t|�n|}i }|D ]�}|� v r)q"� �|� || }|�|�}t|�t|� u rEdu rHn nq"|dkr�|D ]g} || } |�| �} t| �t| � u rgdu rjn nqN| dkr�dd� } dd� �t�fd d �|d D �| d �} t�fd d �|�dg �D �| d �}| |kr�| |d �|�di �d< qN| | kr�| | d �|�di �| < qNq"|dkr�|D ] } || } |�| �} | dkr�q�| | kr�| | d �|�di �| < q�q"||kr�||d �||< q"� fdd�|D �D ]*}|�|�}|| }t|�t|� u �rdu �rn nq�||k�r ||d �||< q�|S )a� .. versionadded:: 2018.3.0 Compare two networks and return any differences between the two first Name or ID of first container second Name or ID of second container ignore : Name,Id,Created,Containers A comma-separated list (or Python list) of keys to ignore when comparing. CLI Example: .. code-block:: bash salt myminion docker.compare_network foo bar r FZIPAMr c S s t | �� �t | �� �fS r0 )r� �keys�valuesr� r' r' r( �kvsort8 s z compare_networks.<locals>.kvsortc S s dd� | � � D �S )Nc S s i | ] \}}|d vr||�qS ))r� Nr' �rA �k�vr' r' r( � <dictcomp>A � z9compare_networks.<locals>.strip_empty.<locals>.<dictcomp>)�items)�poolr' r' r( � strip_empty; s z%compare_networks.<locals>.strip_emptyc � g | ]}� |��qS r' r' �rA �p�rG r' r( r� D � z$compare_networks.<locals>.<listcomp>r� c rH r' r' rI rK r' r( r� G rL r� �Optionsz com.docker.network.bridge.namec 3 r2 r0 r' r� )r r' r( rC d r3 z#compare_networks.<locals>.<genexpr>) rp r� r4 r6 r3 r r r� r� )r r r Znet1Znet2rc r� r r ZsubkeyZsubval1Zsubval2r? Zconfig1Zconfig2r' )r rG r( �compare_networks s~ �������# ��� � $ �rN c C s| t | ��di �}i }|�� D ]'\}}z|�d�} W n ttfy, t�d|| |� Y qw ||d< ||| < q|s<t|�S |S )a` .. versionadded:: 2018.3.0 Return a list of running containers attached to the specified network name Network name verbose : False If ``True``, return extended info about each container (IP configuration, etc.) CLI Example: .. code-block:: bash salt myminion docker.connected net_name r% r� z�'Name' key not present in container definition for container ID '%s' within inspect results for Docker network '%s'. Full container definition: %sr� ) r6 r rE rq r� rF r[ r� r� )r� r~ � containersrc Zcid�cinfor' r' r( � connectedo s& �� rQ c G s� t d di �}ddi}|�dg �}t|t�s |�d� i }t d dd d ��� D ] \}}z|�|� W q' tyC |�d �|�� Y q'w | sJt |�} |�d i �}| D ]�}||vrb|�d |� d�� qRz|| d }|| d } W n/ ty� |�d|� d�� Y qR t y� } z|�d| � d|� d�� W Y d} ~ qRd} ~ ww ddd|d| g} |� � dkr�| �|� t � d||� t d | d d d �} | d dk||< || s�| d r�|�| d � qR| d r�|�| d � qR|r�d!|d< |S )"a� .. versionadded:: 2016.3.7,2016.11.4,2017.7.0 Performs a ``docker login`` to authenticate to one or more configured repositories. See the documentation at the top of this page to configure authentication credentials. Multiple registry URLs (matching those configured in Pillar) can be passed, and Salt will attempt to login to *just* those registries. If no registry URLs are provided, Salt will attempt to login to *all* configured registries. **RETURN DATA** A dictionary containing the following keys: - ``Results`` - A dictionary mapping registry URLs to the authentication result. ``True`` means a successful login, ``False`` means a failed login. - ``Errors`` - A list of errors encountered during the course of this function. CLI Example: .. code-block:: bash salt myminion docker.login salt myminion docker.login hub salt myminion docker.login hub https://mydomain.tld/registry/ � config.get�docker-registries�retcoder �Errors�5'docker-registries' Pillar value must be a dictionaryrL �*-docker-registriesT�Zwildcard�6Docker registry '{}' was not specified as a dictionary�Results� No match found for registry 'r� �username�passwordz$Invalid configuration for registry 'zMissing z for registry 'Nr �loginz-u�-p�hubz8Attempting to login to docker registry '%s' as user '%s'� cmd.run_allF�quiet�rQ �output_loglevel�stderr�stdoutr )rU r� r� r4 r3 rE r r� r# r� r� r� r[ r\ ) � registries� registry_authrc r� �reg_name�reg_conf�results�registryr\ r] rb �cmdZ login_cmdr' r' r( r^ � sv " � � ��� $�� ���r^ c G sX t d di �}ddi}|�dg �}t|t�s |�d� i }t d dd d ��� D ] \}}z|�|� W q' tyC |�d �|�� Y q'w | sJt |�} |�d i �}| D ]Q}||vrb|�d |� d�� qRddg}|� � dkrq|�|� t � d|� t d |ddd�} | d dk||< || s�| d r�|�| d � qR| d r�|�| d � qR|r�d|d< |S )a� .. versionadded:: 3001 Performs a ``docker logout`` to remove the saved authentication details for one or more configured repositories. Multiple registry URLs (matching those configured in Pillar) can be passed, and Salt will attempt to logout of *just* those registries. If no registry URLs are provided, Salt will attempt to logout of *all* configured registries. **RETURN DATA** A dictionary containing the following keys: - ``Results`` - A dictionary mapping registry URLs to the authentication result. ``True`` means a successful logout, ``False`` means a failed logout. - ``Errors`` - A list of errors encountered during the course of this function. CLI Example: .. code-block:: bash salt myminion docker.logout salt myminion docker.logout hub salt myminion docker.logout hub https://mydomain.tld/registry/ rR rS rT r rU rV rL rW TrX rY rZ r[ r� r �logoutr` z,Attempting to logout of docker registry '%s'ra Frb rc re rf r ) rU r� r� r4 r3 rE r r� r# r� r� r[ r\ ) rg rh rc r� ri rj rk rl rm Z logout_cmdr' r' r( rn � s\ # � � ��� ��rn c sp t | �d � g }tddd��� D ]}|d d � kr&|�dd� |d D �� q|� fd d�tdd ��� D �d �S ) a� Returns the containers and images, if any, which depend on the given image name Name or ID of image **RETURN DATA** A dictionary containing the following keys: - ``Containers`` - A list of containers which depend on the specified image - ``Images`` - A list of IDs of images which depend on the specified image CLI Example: .. code-block:: bash salt myminion docker.depends myimage salt myminion docker.depends 0123456789ab r� T)r r~ �Infor� c S � g | ]}|� d ��qS �r� ��lstripr� r' r' r( r� j � zdepends.<locals>.<listcomp>�Namesc s( g | ]\}}|d � kr|dd� �qS )r� Nr� r' )rA r� �y��image_idr' r( r� n s "r� )r% �Images)r r r> �extendr� rE )r� Zcontainer_dependsr r' rw r( �dependsN s � ��r{ c C sb t d| �}dddd�}i }|D ]}|�|d d�}|�|g ��|d � qd|v r/t�d | � |S ) a� Get information on changes made to container's filesystem since it was created. Equivalent to running the ``docker diff`` Docker CLI command. name Container name or ID **RETURN DATA** A dictionary containing any of the following keys: - ``Added`` - A list of paths that were added. - ``Changed`` - A list of paths that were changed. - ``Deleted`` - A list of paths that were deleted. These keys will only be present if there were changes, so if the container has no differences the return dict will be empty. CLI Example: .. code-block:: bash salt myminion docker.diff mycontainer �diffZChangedZAddedZDeleted)r r � ZKindZUnknown�Pathz�Unknown changes detected in docker.diff of container %s. This is probably due to a change in the Docker API. Please report this to the SaltStack developers)r� r r� r3 r[ r� )r� ZchangesZkind_maprc Zchanger_ r' r' r( r| t s �r| c C sb d| � �}|t v r t | S z td| dd�}W n tjjy( dt |< Y t | S w dt |< t | S )a Check if a given container exists name Container name or ID **RETURN DATA** A boolean (``True`` if the container exists, otherwise ``False``) CLI Example: .. code-block:: bash salt myminion docker.exists mycontainer zdocker.exists.r F)r� T)rr r� r r� r� )r� r� Zc_infor' r' r( �exists� s �r c C s� t d| �}ddd�}t�d�}g }t|�D ]S}i }|�� D ] \}} |�||�} | dkr6| s0d} n|�d| �} | || < q d|v rLt�dt� |d ��|d < d D ]} | |v r_t || �|| � d �< qN|� t � |�� q|rrd d � |D �S |S )aE Return the history for an image. Equivalent to running the ``docker history`` Docker CLI command. name Container name or ID quiet : False If ``True``, the return data will simply be a list of the commands run to build the container. .. code-block:: bash $ salt myminion docker.history nginx:latest quiet=True myminion: - FROM scratch - ADD file:ef063ed0ae9579362871b9f23d2bc0781ef7cd4de6ac822052cf6c9c5a12b1e2 in / - CMD [/bin/bash] - MAINTAINER NGINX Docker Maintainers "docker-maint@nginx.com" - apt-key adv --keyserver pgp.mit.edu --recv-keys 573BFD6B3D8FBC641079A6ABABF5BD827BD9BF62 - echo "deb http://nginx.org/packages/mainline/debian/ wheezy nginx" >> /etc/apt/sources.list - ENV NGINX_VERSION=1.7.10-1~wheezy - apt-get update && apt-get install -y ca-certificates nginx=${NGINX_VERSION} && rm -rf /var/lib/apt/lists/* - ln -sf /dev/stdout /var/log/nginx/access.log - ln -sf /dev/stderr /var/log/nginx/error.log - VOLUME [/var/cache/nginx] - EXPOSE map[80/tcp:{} 443/tcp:{}] - CMD [nginx -g daemon off;] https://github.com/saltstack/salt/pull/22421 **RETURN DATA** If ``quiet=False``, the return value will be a list of dictionaries containing information about each step taken to build the image. The keys in each step include the following: - ``Command`` - The command executed in this build step - ``Id`` - Layer ID - ``Size`` - Cumulative image size, in bytes - ``Size_Human`` - Cumulative image size, in human-readable units - ``Tags`` - Tag(s) assigned to this layer - ``Time_Created_Epoch`` - Time this build step was completed (Epoch time) - ``Time_Created_Local`` - Time this build step was completed (Minion's local timezone) CLI Example: .. code-block:: bash salt myminion docker.exists mycontainer �history�Command�Time_Created_Epoch)Z CreatedBy�Createdz^/bin/sh -c (?:#\(nop\) )?z FROM scratchr� �%Y-%m-%d %H:%M:%S %Z�Time_Created_Local)�Size�_Humanc S rp )r� ri r� r' r' r( r� rt zhistory.<locals>.<listcomp>)r� �re�compile�reversedrE r �sub�time�strftime� localtimer� r3 �copy�deepcopy) r� rb r� �key_mapZcommand_prefixrc r� �stepr_ r` Zstep_keyra r' r' r( r� � s6 6� ��r� c K sn dt vr�td|�dd�d�}ddi}|D ]p}|�dd �}|d u r!q|D ]+}|d d gd fv r0d nd }t �di �}|�|i �}|�||�} || |�|i �| < q#d|�|i �v rht�dt�|| d ��|| d< dD ]} | |�|i �v r�t|| | �|| | � d�< qjqt �di �} t � | �d i ��} |�dd�r�| � t � | �d i ��� | r�| D ] }t |�| | d< q�| S )as Returns information about the Docker images on the Minion. Equivalent to running the ``docker images`` Docker CLI command. all : False If ``True``, untagged images will also be returned verbose : False If ``True``, a ``docker inspect`` will be run on each image returned. **RETURN DATA** A dictionary with each key being an image ID, and each value some general info about that image (time created, size, tags associated with the image, etc.) CLI Example: .. code-block:: bash salt myminion docker.images salt myminion docker.images all=True z docker.imagesr� r Fr� r� r� r� N�RepoTagsz <none>:<none>ZuntaggedZtaggedr� r� �r� Z VirtualSizer� ro ) rr r� r rq r� r� r� r� r� r� r� r r ) r~ r^ r� r� ZimgZimg_idr� Z img_state�bucketZimg_keyra � context_datarc r' r' r( r� sN � ���� � �� r� c C s t d�S )z� Returns a dictionary of system-wide information. Equivalent to running the ``docker info`` Docker CLI command. CLI Example: .. code-block:: bash salt myminion docker.info r� �r� r' r' r' r( r� X s r� c C s zt | �W S ty } z d|jvr� W Y d}~nd}~ww zt| �W S ty< } z |j�d�s2� W Y d}~nd}~ww zt| �W S ty[ } z |j�d�sQ� W Y d}~nd}~ww zt| �W S tyz } z |j�d�sp� W Y d}~nd}~ww td| � ���)a� .. versionchanged:: 2017.7.0 Volumes and networks are now checked, in addition to containers and images. This is a generic container/image/volume/network inspecton function. It will run the following functions in order: - :py:func:`docker.inspect_container <salt.modules.dockermod.inspect_container>` - :py:func:`docker.inspect_image <salt.modules.dockermod.inspect_image>` - :py:func:`docker.inspect_volume <salt.modules.dockermod.inspect_volume>` - :py:func:`docker.inspect_network <salt.modules.dockermod.inspect_network>` The first of these to find a match will be returned. name Container/image/volume/network name or ID **RETURN DATA** A dictionary of container/image/volume/network information CLI Example: .. code-block:: bash salt myminion docker.inspect mycontainer salt myminion docker.inspect busybox zdoes not existNz Error 404z3Error 404: No such image/container/volume/network: )r r �strerrorr r� �inspect_volumer6 )r� rb r' r' r( rO f sF ��� ��� ��� ����rO c C s t d| �S )a� Retrieves container information. Equivalent to running the ``docker inspect`` Docker CLI command, but will only look for container information. name Container name or ID **RETURN DATA** A dictionary of container information CLI Example: .. code-block:: bash salt myminion docker.inspect_container mycontainer salt myminion docker.inspect_container 0123456789ab r r� �r� r' r' r( r � s r c C s6 t d| �}dD ]}||v rt|| �||� d�< q|S )a� Retrieves image information. Equivalent to running the ``docker inspect`` Docker CLI command, but will only look for image information. .. note:: To inspect an image, it must have been pulled from a registry or built locally. Images on a Docker registry which have not been pulled cannot be inspected. name Image name or ID **RETURN DATA** A dictionary of image information CLI Examples: .. code-block:: bash salt myminion docker.inspect_image busybox salt myminion docker.inspect_image centos:6 salt myminion docker.inspect_image 0123456789ab r r� r� )r� r� )r� rc ra r' r' r( r � s �r c K s\ t � }t| �dd�d��� D ]}|�d�}|sqdd� |p g D �D ]}|�|� q!qt|�S )a� Returns a list of containers by name. This is different from :py:func:`docker.ps <salt.modules.dockermod.ps_>` in that :py:func:`docker.ps <salt.modules.dockermod.ps_>` returns its results organized by container ID. all : False If ``True``, stopped containers will be included in return data CLI Example: .. code-block:: bash salt myminion docker.list_containers r Fr� ru c S rp rq rr r� r' r' r( r� � rt z#list_containers.<locals>.<listcomp>)r5 r r r> �addr� )r^ rc r� �names�c_namer' r' r( �list_containers� s �r� c C s< t � } t� �� D ]}|�d�sq| �t |d �� qt| �S )z} Returns a list of tagged images CLI Example: .. code-block:: bash salt myminion docker.list_tags r� )r5 r� r> r r r� )rc r� r' r' r( � list_tags� s r� c C sH z t | �}|d W S ty Y dS ty# t�d| |� Y dS w )a� .. versionadded:: 2018.3.0 Given an image name (or partial image ID), return the full image ID. If no match is found among the locally-pulled images, then ``False`` will be returned. CLI Examples: .. code-block:: bash salt myminion docker.resolve_image_id foo salt myminion docker.resolve_image_id foo:bar salt myminion docker.resolve_image_id 36540f359ca3 r� �FInspecting docker image '%s' returned an unexpected data structure: %sF)r r r� r[ r� )r� �inspect_resultr' r' r( �resolve_image_id s ���r� c K s� t d d i |��}|�dd�}|rt d |� zt| �}|d }|r(|r'|W S n|d W S W n! ty8 Y dS tyG t�d| |� Y n tyO Y nw |rW|d gS |d S ) a� .. versionadded:: 2017.7.2 .. versionchanged:: 2018.3.0 Instead of matching against pulled tags using :py:func:`docker.list_tags <salt.modules.dockermod.list_tags>`, this function now simply inspects the passed image name using :py:func:`docker.inspect_image <salt.modules.dockermod.inspect_image>` and returns the first matching tag. If no matching tags are found, it is assumed that the passed image is an untagged image ID, and the full ID is returned. Inspects the specified image name and returns the first matching tag in the inspect results. If the specified image is not pulled locally, this function will return ``False``. name Image name to resolve. If the image is found but there are no tags, this means that the image name passed was an untagged image. In this case the image ID will be returned. all : False If ``True``, a list of all matching tags will be returned. If the image is found but there are no tags, then a list will still be returned, but it will simply contain the image ID. .. versionadded:: 2018.3.0 tags .. deprecated:: 2018.3.0 CLI Examples: .. code-block:: bash salt myminion docker.resolve_tag busybox salt myminion docker.resolve_tag centos:7 all=True salt myminion docker.resolve_tag c9f378ac27d9 rm r F�args.invalid_kwargsr� r r� r� Nr' )rp rq r r r� r[ r� r� )r� r^ Zall_r� �tagsr' r' r( � resolve_tag# s2 ' � � � �r� c K s� t d di |��}d|v rtd��z t|d �|d< W n< ty$ Y n4 ttfyW trUz t�|d �|d< W n t yT } zt � d|d |� W Y d}~nd}~ww Y nw t j j�td| fi |���S ) a .. versionchanged:: 2018.3.0 Support for all of docker-py's `logs()`_ function's arguments, with the exception of ``stream``. Returns the logs for the container. An interface to docker-py's `logs()`_ function. name Container name or ID stdout : True Return stdout lines stderr : True Return stdout lines timestamps : False Show timestamps tail : all Output specified number of lines at the end of logs. Either an integer number of lines or the string ``all``. since Show logs since the specified time, passed as a UNIX epoch timestamp. Optionally, if timelib_ is installed on the minion the timestamp can be passed as a string which will be resolved to a date using ``timelib.strtodatetime()``. follow : False If ``True``, this function will block until the container exits and return the logs when it does. The default behavior is to return what is in the log at the time this function is executed. .. note: Since it blocks, this option should be used with caution. CLI Examples: .. code-block:: bash # All logs salt myminion docker.logs mycontainer # Last 100 lines of log salt myminion docker.logs mycontainer tail=100 # Just stderr salt myminion docker.logs mycontainer stdout=False # Logs since a specific UNIX timestamp salt myminion docker.logs mycontainer since=1511688459 # Flexible format for "since" argument (requires timelib) salt myminion docker.logs mycontainer since='1 hour ago' salt myminion docker.logs mycontainer since='1 week ago' salt myminion docker.logs mycontainer since='1 fortnight ago' rm r� z&The 'stream' argument is not supportedZsincez3docker.logs: Failed to parse '%s' using timelib: %sN�logsr' )rp r r@ r� r8 r� � HAS_TIMELIB�timelibZ strtodatetimer r[ r� r+ rX � stringutils� to_unicoder� )r� r^ rb r' r' r( r� h s, 8 ����� r� c C s t | �d d S )z� Returns the PID of a container name Container name or ID CLI Example: .. code-block:: bash salt myminion docker.pid mycontainer salt myminion docker.pid 0123456789ab re ZPid)r r� r' r' r( �pid� s r� c s t t�d| ��}|rt�tdd�| �n| g}|du r d}n<t|t�r(|� d�}n1d�|�}z |� d�\}}}|� � }|� � rB|d vrFt |��|d | }W n t yX t |��w i } |D ] } t| ��d i ��d i �� � fd d �t�� |�D �| | < q]|s�| �| i �S | S )aQ Returns port mapping information for a given container. Equivalent to running the ``docker port`` Docker CLI command. name Container name or ID .. versionchanged:: 2019.2.0 This value can now be a pattern expression (using the pattern-matching characters defined in fnmatch_). If a pattern expression is used, this function will return a dictionary mapping container names which match the pattern to the mappings for those containers. When no pattern expression is used, a dictionary of the mappings for the specified container name will be returned. .. _fnmatch: https://docs.python.org/2/library/fnmatch.html private_port : None If specified, get information for that specific port. Can be specified either as a port number (i.e. ``5000``), or as a port number plus the protocol (i.e. ``5000/udp``). If this argument is omitted, all port mappings will be returned. **RETURN DATA** A dictionary of port mappings, with the keys being the port and the values being the mapping(s) for that port. CLI Examples: .. code-block:: bash salt myminion docker.port mycontainer salt myminion docker.port mycontainer 5000 salt myminion docker.port mycontainer 5000/udp z[*?\[]Tr� N�*z/*zhInvalid private_port '{}'. Must either be a port number, or be in port/protocol notation (e.g. 5000/tcp)r� )ZtcpZudpr# ZPortsc s i | ]}|� | �qS r' r' r� �Zmappingsr' r( rC rt zport.<locals>.<dictcomp>)r r� �search�fnmatch�filterr� r� r@ r# � partitionr� �isdigitr rF r r ) r� Z private_portZ pattern_usedr� �patternr� Zport_numr9 �protocolrc r� r' r� r( �port� s. ' � � r� c K sL t dd| d�}ddi}i }|D ]P}|�dd�}|du r q|D ]'}|�dd ��� �d �r-d nd }|�|i �} |�||�} || | �|i �| < q d| �|i �v r_t�d t�| | d ��| | d< qt � |�d i ��} |�dd�r{| � t � |�d i ��� |�dd�r�| D ] }t |�| | d< q�|�dd�r�| �di ��di �� t d � � | S )a5 Returns information about the Docker containers on the Minion. Equivalent to running the ``docker ps`` Docker CLI command. all : False If ``True``, stopped containers will also be returned host: False If ``True``, local host's network topology will be included verbose : False If ``True``, a ``docker inspect`` will be run on each container returned. filters: None A dictionary of filters to be processed on the container list. Available filters: - exited (int): Only containers with specified exit code - status (str): One of restarting, running, paused, exited - label (str): format either "key" or "key=value" **RETURN DATA** A dictionary with each key being an container ID, and each value some general info about that container (time created, name, command, etc.) CLI Example: .. code-block:: bash salt myminion docker.ps salt myminion docker.ps all=True salt myminion docker.ps filters="{'label': 'role=web'}" rO T)r �filtersr� r� r� Nr� r� zup rg rh r� r� r Fr~ ro r� Z interfacesznetwork.interfaces)r� rq r r� r� r� r� r� r� r� r� r r rU ) r� r^ r� r� r� r Zc_idr� �c_stater� Zc_keyrc r' r' r( r sB $� �� �� �r c C s2 d| � �}|t v r t | S tt| ��t |< t | S )a8 Returns the state of the container name Container name or ID **RETURN DATA** A string representing the current state of the container (either ``running``, ``paused``, or ``stopped``) CLI Example: .. code-block:: bash salt myminion docker.state mycontainer z docker.state.)rr rk r )r� r� r' r' r( r� ` s r� c C s� t d| �}|std| � d���ddddd�}g }|r |�d� |r&|�d� i }|D ]!}|�d d �}|d urK|D ]} |�| | �} || |�|i �| < q8q*|sP|S i } |�� D ]\} } |D ]}| �|d �rj| | | < nq\qV| S ) a� Searches the registry for an image name Search keyword official : False Limit results to official builds trusted : False Limit results to `trusted builds`_ **RETURN DATA** A dictionary with each key being the name of an image, and the following information for each image: - ``Description`` - Image description - ``Official`` - A boolean (``True`` if an official build, ``False`` if not) - ``Stars`` - Number of stars the image has on the registry - ``Trusted`` - A boolean (``True`` if a trusted build, ``False`` if not) CLI Example: .. code-block:: bash salt myminion docker.search centos salt myminion docker.search centos official=True r� z%No images matched the search string 'r� Z DescriptionZOfficialZTrustedZStars)� descriptionZ is_officialZ is_trustedZ star_countr� NF)r� r r3 rq r r� rE ) r� ZofficialZtrustedr� r� r rk r� r� r_ Z mapped_keyrc r` r' r' r( r� z s@ � � ��r� c C sn t d| �}i }t|d �D ]\}}|||< q g }|d D ]}i }t|�D ] \}}|||| < q$|�|� q |S )aJ Runs the `docker top` command on a specific container name Container name or ID CLI Example: **RETURN DATA** A list of dictionaries containing information about each process .. code-block:: bash salt myminion docker.top mycontainer salt myminion docker.top 0123456789ab �topZTitlesZ Processes)r� � enumerater3 ) r� r� �columns�idxZcol_namerc �processZcur_procr` r' r' r( r� � s r� c C s� t d�} t�t�}d| v r)|�t| d ��}|r)tdd� |�d��d�D ��| d< d| v rI|�t| d ��}|rItd d� |�d��d�D ��| d < | S ) z� Returns a dictionary of Docker version information. Equivalent to running the ``docker version`` Docker CLI command. CLI Example: .. code-block:: bash salt myminion docker.version r �Versionc s r> r0 r? r� r' r' r( rC � rD zversion.<locals>.<genexpr>r r r Z ApiVersionc s r> r0 r? r� r' r' r( rC � rD ZApiVersionInfo) r� r� r� � VERSION_RE�matchr& rI �grouprH )rc Z version_rer� r' r' r( r � s ""r c C s$ t �d| � tddd� | �� D ��S )Nz"creating networking config from %sZcreate_networking_configc S s i | ] \}}|t di |���qS )�create_endpoint_config)r� r� r@ r' r' r( rC � s ��z-_create_networking_config.<locals>.<dictcomp>)r[ r\ r� rE )r r' r' r( r � s ��r c K s |� dd�rt| �st| |d� td|||d�|��\}}|r't�dt|�� t�d|dur4d|� d �nd |� t�� } t d | fd |i|��} t�� | | d < t � |du rat | d �d � d�}|| d< |r�zt |� W n ty� } z td| t| �d�d��d} ~ ww d| d< | S )u�] Create a new container image Image from which to create the container name Name for the new container. If not provided, Docker will randomly generate one for you (it will be included in the return data). start : False If ``True``, start container after creating it .. versionadded:: 2018.3.0 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: .. code-block:: bash salt myminion docker.create image=centos:7.3.1611 skip_translate=environment environment="{'FOO': 'bar'}" See the following links for more information: - `docker-py Low-level API`_ - `Docker Engine API`_ 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. ``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`` 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. **CONTAINER CONFIGURATION ARGUMENTS** 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). Examples: - ``auto_remove=True`` - ``rm=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 ``ro`` 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 Python list, however in cases where both ro/rw and an selinux context are specified, the binds *must* be specified as a Python list. Examples: - ``binds=/srv/www:/var/www:ro`` - ``binds=/srv/www:/var/www:rw`` - ``binds=/srv/www:/var/www`` - ``binds="['/srv/www:/var/www:ro,Z']"`` - ``binds="['/srv/www:/var/www:rw,Z']"`` - ``binds=/srv/www:/var/www:Z`` .. note:: The second and third examples above are equivalent to each other, as are the last two examples. blkio_weight Block IO weight (relative weight), accepts a weight value between 10 and 1000. Example: ``blkio_weight=100`` blkio_weight_device Block IO weight (relative device weight), specified as a list of expressions in the format ``PATH:WEIGHT`` Example: ``blkio_weight_device=/dev/sda:100`` cap_add List of capabilities to add within the container. Can be passed as a comma-separated list or a Python list. Requires Docker 1.2.0 or newer. Examples: - ``cap_add=SYS_ADMIN,MKNOD`` - ``cap_add="[SYS_ADMIN, MKNOD]"`` cap_drop List of capabilities to drop within the container. Can be passed as a comma-separated string or a Python list. Requires Docker 1.2.0 or newer. Examples: - ``cap_drop=SYS_ADMIN,MKNOD``, - ``cap_drop="[SYS_ADMIN, MKNOD]"`` command (or *cmd*) Command to run in the container Example: ``command=bash`` or ``cmd=bash`` .. versionchanged:: 2015.8.1 ``cmd`` is now also accepted 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``). Examples: - ``cpuset_cpus="0-3"`` - ``cpuset="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. Examples: - ``cpuset_mems="0-3"`` - ``cpuset_mems="0,1"`` cpu_group The length of a CPU period in microseconds Example: ``cpu_group=100000`` cpu_period Microseconds of CPU time that the container can get in a CPU period Example: ``cpu_period=50000`` cpu_shares CPU shares (relative weight), specified as an integer between 2 and 1024. Example: ``cpu_shares=512`` detach : False If ``True``, run the container's command in the background (daemon mode) Example: ``detach=True`` devices List of host devices to expose within the container Examples: - ``devices="/dev/net/tun,/dev/xvda1:/dev/xvda1,/dev/xvdb1:/dev/xvdb1:r"`` - ``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``. Examples: - ``device_read_bps="/dev/sda:1mb,/dev/sdb:5mb"`` - ``device_read_bps="['/dev/sda:100mb', '/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. Examples: - ``device_read_iops="/dev/sda:1000,/dev/sdb:500"`` - ``device_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``. Examples: - ``device_write_bps="/dev/sda:100mb,/dev/sdb:50mb"`` - ``device_write_bps="['/dev/sda:100mb', '/dev/sdb:50mb']"`` 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. Examples: - ``device_write_iops="/dev/sda:1000,/dev/sdb:500"`` - ``device_write_iops="['/dev/sda:1000', '/dev/sdb:500']"`` dns List of DNS nameservers. Can be passed as a comma-separated list or a Python list. Examples: - ``dns=8.8.8.8,8.8.4.4`` - ``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 Example: ``dns_opt=ndots:9`` dns_search List of DNS search domains. Can be passed as a comma-separated list or a Python list. Examples: - ``dns_search=foo1.domain.tld,foo2.domain.tld`` - ``dns_search="[foo1.domain.tld, foo2.domain.tld]"`` domainname The domain name to use for the container Example: ``domainname=domain.tld`` entrypoint Entrypoint for the container. Either a string (e.g. ``"mycmd --arg1 --arg2"``) or a Python list (e.g. ``"['mycmd', '--arg1', '--arg2']"``) Examples: - ``entrypoint="cat access.log"`` - ``entrypoint="['cat', 'access.log']"`` environment (or *env*) Either a dictionary of environment variable names and their values, or a Python list of strings in the format ``VARNAME=value``. Examples: - ``environment='VAR1=value,VAR2=value'`` - ``environment="['VAR1=value', 'VAR2=value']"`` - ``environment="{'VAR1': 'value', 'VAR2': 'value'}"`` extra_hosts Additional hosts to add to the container's /etc/hosts file. Can be passed as a comma-separated list or a Python list. Requires Docker 1.3.0 or newer. Examples: - ``extra_hosts=web1:10.9.8.7,web2:10.9.8.8`` - ``extra_hosts="['web1:10.9.8.7', 'web2:10.9.8.8']"`` - ``extra_hosts="{'web1': '10.9.8.7', 'web2': '10.9.8.8'}"`` .. note:: To skip IP address validation, use ``validate_ip_addrs=False`` group_add List of additional group names and/or IDs that the container process will run as Examples: - ``group_add=web,network`` - ``group_add="['web', 'network']"`` hostname Hostname of the container. If not provided, and if a ``name`` has been provided, the ``hostname`` will default to the ``name`` that was passed. Example: ``hostname=web1`` .. warning:: If the container is started with ``network_mode=host``, the hostname will be overridden by the hostname of the Minion. interactive (or *stdin_open*): False Leave stdin open, even if not attached Examples: - ``interactive=True`` - ``stdin_open=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 Examples: - ``ipc_mode=container:foo`` - ``ipc=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 Example: ``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 (or *label*) Add metadata to the container. Labels can be set both with and without values: Examples: - ``labels=foo,bar=baz`` - ``labels="['foo', 'bar=baz']"`` .. versionchanged:: 2018.3.0 Labels both with and without values can now be mixed. Earlier releases only permitted one method or the other. links Link this container to another. Links should be specified in the format ``<container_name_or_id>:<link_alias>``. Multiple links can be passed, ether as a comma separated list or a Python list. Examples: - ``links=web1:link1,web2:link2``, - ``links="['web1:link1', 'web2:link2']"`` - ``links="{'web1': 'link1', 'web2': 'link2'}"`` log_driver Set container's logging driver. Requires Docker 1.6 or newer. Example: - ``log_driver=syslog`` .. 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/ log_opt Config options for the ``log_driver`` config option. Requires Docker 1.6 or newer. Example: - ``log_opt="syslog-address=tcp://192.168.0.42,syslog-facility=daemon"`` - ``log_opt="['syslog-address=tcp://192.168.0.42', 'syslog-facility=daemon']"`` - ``log_opt="{'syslog-address': 'tcp://192.168.0.42', 'syslog-facility': 'daemon'}"`` lxc_conf Additional LXC configuration parameters to set before starting the container. Examples: - ``lxc_conf="lxc.utsname=docker,lxc.arch=x86_64"`` - ``lxc_conf="['lxc.utsname=docker', 'lxc.arch=x86_64']"`` - ``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. Example: ``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. Examples: - ``mem_limit=512M`` - ``memory=1073741824`` mem_swappiness Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. Example: ``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. Examples: - ``memswap_limit=1G`` - ``memory_swap=2147483648`` network_disabled : False If ``True``, networking will be disabled within the container Example: ``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. Examples: - ``network_mode=null`` - ``network_mode=container:web1`` oom_kill_disable Whether to disable OOM killer Example: ``oom_kill_disable=False`` oom_score_adj An integer value containing the score given to the container in order to tune OOM killer preferences Example: ``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. Example: ``pid_mode=host`` pids_limit Set the container's PID limit. Set to ``-1`` for unlimited. Example: ``pids_limit=2000`` port_bindings (or *publish*) Bind exposed ports which were exposed using the ``ports`` argument to :py:func:`docker.create <salt.modules.dockermod.create>`. These 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 passed as a Python list. The below two examples are equivalent: - ``port_bindings="5000:5000,2123:2123/udp,8080"`` - ``port_bindings="['5000:5000', '2123:2123/udp', 8080]"`` Port bindings can also include ranges: - ``port_bindings="14505-14506:4505-4506"`` .. 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 be passed as comma-separated list or a Python list. If the protocol is omitted, the port will be assumed to be a TCP port. Examples: - ``ports=1111,2222/udp`` - ``ports="[1111, '2222/udp']"`` privileged : False If ``True``, runs the exec process with extended privileges Example: ``privileged=True`` publish_all_ports (or *publish_all*): False Publish all ports to the host Example: ``publish_all_ports=True`` read_only : False If ``True``, mount the container’s root filesystem as read only Example: ``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. Examples: - ``restart_policy=on-failure:5`` - ``restart_policy=always`` security_opt Security configuration for MLS systems such as SELinux and AppArmor. Can be passed as a comma-separated list or a Python list. Examples: - ``security_opt=apparmor:unconfined,param2:value2`` - ``security_opt='["apparmor:unconfined", "param2:value2"]'`` .. 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 Example: ``shm_size=128M`` stop_signal The signal used to stop the container. The default is ``SIGTERM``. Example: ``stop_signal=SIGRTMIN+3`` stop_timeout Timeout to stop the container, in seconds Example: ``stop_timeout=5`` storage_opt Storage driver options for the container Examples: - ``storage_opt='dm.basesize=40G'`` - ``storage_opt="['dm.basesize=40G']"`` - ``storage_opt="{'dm.basesize': '40G'}"`` sysctls (or *sysctl*) Set sysctl options for the container Examples: - ``sysctl='fs.nr_open=1048576,kernel.pid_max=32768'`` - ``sysctls="['fs.nr_open=1048576', 'kernel.pid_max=32768']"`` - ``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. Can be passed as Python list of PATH:VALUE mappings, or a Python dictionary. However, since commas usually appear in the values, this option *cannot* be passed as a comma-separated list. Examples: - ``tmpfs="['/run:rw,noexec,nosuid,size=65536k', '/var/lib/mysql:rw,noexec,nosuid,size=600m']"`` - ``tmpfs="{'/run': 'rw,noexec,nosuid,size=65536k', '/var/lib/mysql': 'rw,noexec,nosuid,size=600m'}"`` tty : False Attach TTYs Example: ``tty=True`` ulimits (or *ulimit*) 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 passed as a comma-separated list or a Python list. Examples: - ``ulimits="nofile=1024:1024,nproc=60"`` - ``ulimits="['nofile=1024:1024', 'nproc=60']"`` user User under which to run exec process Example: ``user=foo`` userns_mode (or *user_ns_mode*) Sets the user namsepace mode, when the user namespace remapping option is enabled. Example: ``userns_mode=host`` volumes (or *volume*) List of directories to expose as volumes. Can be passed as a comma-separated list or a Python list. Examples: - ``volumes=/mnt/vol1,/mnt/vol2`` - ``volume="['/mnt/vol1', '/mnt/vol2']"`` volumes_from Container names or IDs from which the container will get volumes. Can be passed as a comma-separated list or a Python list. Example: ``volumes_from=foo``, ``volumes_from=foo,bar``, ``volumes_from="[foo, bar]"`` volume_driver Sets the container's volume driver Example: ``volume_driver=foobar`` working_dir (or *workdir*) Working directory inside the container Examples: - ``working_dir=/var/log/nginx`` - ``workdir=/var/www/myapp`` **RETURN DATA** A dictionary containing the following keys: - ``Id`` - ID of the newly-created container - ``Name`` - Name of the newly-created container CLI Example: .. code-block:: bash # Create a data-only container salt myminion docker.create myuser/mycontainer volumes="/mnt/vol1,/mnt/vol2" # Create a CentOS 7 container that will stay running once started salt myminion docker.create centos:7 name=mycent7 interactive=True tty=True command=bash rO T�rn r �UThe following arguments were ignored because they are not recognized by docker-py: %s�Edocker.create: creating container %susing the following arguments: %sN� with name '�' r� r r� � Time_Elapsedr� r� r� z(Failed to start container after creation)r� r� �r� ZStartedr' )rq r� r� r r[ r� r� r\ r� r� r� r rs r r r& ) �imager� r r r r rn r^ � unused_kwargs� time_startedr� rb r' r' r( �create sV ] � ��� ���r� c K s | � dd�rt| �st| |d� d} |durFztd |�} W n ty' Y n w | dkr7|r0|s7td�|���|s@td�|���t||d �} i } td �d D ]}z | � |�| |< W qN tyb Y qNw | � d d� t d2|||d �| ��\} }| � d i �� dd�}|r�t � dt |�� | r�t| t�r�dd� | �d�D �} t| t�r�tdd� | �� D ��s�td��t �d|dur�d|� d�nd| � t�� }td| fd |i| ��}| r�| |d < |du r�t|d �d �d �}||d < d!d"� }d#|i}z�| �rKz| �� D ]\}}td$ |d |fi |�� q�W n> t�yJ } z1|�r>zt|� W n t�y= } z|�d%g �� d&|� �� W Y d}~nd}~ww tt|�|d'��d}~ww g }t |d � |�s�ztd |d ddd(�D ] }|� t j j �!|�� �qaW n t�y� d)}|||� Y nw t�� | |d*< t"� |�s�d�#|�|d+< |�s�zt|d �} W n t�y� ||d,� Y W |S w | � d-i �} | � d.�} | d/k�r�||d0� | � d1�|d1< W |S W |S W |S t�y } z'z|�$|j%� W n t&t'f�y� |�d%g �� |j%� Y nw tt|�|d'��d}~ww )3a .. versionadded:: 2018.3.0 Equivalent to ``docker run`` on the Docker CLI. Runs the container, waits for it to exit, and returns the container's logs when complete. .. note:: Not to be confused with :py:func:`docker.run <salt.modules.dockermod.run>`, which provides a :py:func:`cmd.run <salt.modules.cmdmod.run>`-like interface for executing commands in a running container. This function accepts the same arguments as :py:func:`docker.create <salt.modules.dockermod.create>`, with the exception of ``start``. In addition, it accepts the arguments from :py:func:`docker.logs <salt.modules.dockermod.logs>`, with the exception of ``follow``, to control how logs are returned. Finally, the ``bg`` argument described below can be used to optionally run the container in the background (the default behavior is to block until the container exits). bg : False If ``True``, this function will not wait for the container to exit and will not return its logs. It will however return the container's name and ID, allowing for :py:func:`docker.logs <salt.modules.dockermod.logs>` to be used to view the logs. .. note:: The logs will be inaccessible once the container exits if ``auto_remove`` is set to ``True``, so keep this in mind. 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. networks Networks to which the container should be connected. If automatic IP configuration is being used, the networks can be a simple list of network names. If custom IP configuration is being used, then this argument must be passed as a dictionary. CLI Examples: .. code-block:: bash salt myminion docker.run_container myuser/myimage command=/usr/local/bin/myscript.sh # Run container in the background salt myminion docker.run_container myuser/myimage command=/usr/local/bin/myscript.sh bg=True # Connecting to two networks using automatic IP configuration salt myminion docker.run_container myuser/myimage command='perl /scripts/sync.py' networks=net1,net2 # net1 using automatic IP, net2 using static IPv4 address salt myminion docker.run_container myuser/myimage command='perl /scripts/sync.py' networks='{"net1": {}, "net2": {"ipv4_address": "192.168.27.12"}}' rO Tr� Nz docker.staterg zvContainer '{}' exists and is running. Run with replace=True and force=True to force removal of the existing container.zMContainer '{}' exists. Run with replace=True to remove the existing container��forcer� r� r r � AutoRemoveFr� c S s i | ]}|i �qS r' r' r� r' r' r( rC � s z!run_container.<locals>.<dictcomp>�,c s s � | ]}t |t�V qd S r0 )r� r4 r� r' r' r( rC � s � �z run_container.<locals>.<genexpr>z$Invalid format for networks argumentr� r� r� r� r r� ZReplacesr� r� r� c S sF | � dd �}|d u r|g}nt| t�r|�|� n||g}|| d< d S )NZWarnings)rq r� r� r3 )rc r� �warningsr' r' r( �_append_warning� s z&run_container.<locals>._append_warning�returnz#docker.connect_container_to_networkZ other_errorsz!Failed to auto_remove container: r� )r� Z timestampsz�Failed to get logs from container. This may be because the container exited before Salt was able to attach to it to retrieve the logs. Consider setting auto_remove to False.r� ZLogsz)Failed to inspect container after runningre r� Zexitedz Container state is not 'exited'ZExitCoder' )(rq r� r� rU r r# r r r� r r r[ r� r� r� r& rH r4 r r> r r\ r� r� r rs rE r� r3 r r+ rX r� r� r� r$ r r� r� r8 ) r� r� r r r rn �bgr� r� r r^ Z removed_idsZ pre_stateZ log_kwargs�argnamer� � auto_remover� rc r� r r) Znet_confrb Zrm_excr� r7 r� rP ZcstateZcstatusr' r' r( � run_container s I ��� � � � � �� ��� ����� ���� � ������r� c C s� t | �}|dkrtd| � d���tj�|�std��tj�|�r.tj�|tj�|��}|}n4tj� |�d }tj�|�sb|rZzt� |� W n t yY } ztd� ||���d}~ww td|� d ���|sqtj� |�rqtd � |���tj�|�s{td ��t| d t�|�� �d d�dkr�t| dt�|�� �d d�dkr�td��ntd|� d ���t| |�}|td |d�kr�t�d| ||� d S t�d|| |� z d�| |f�} W n ty� | � d|� �} Y nw dd| |g} td | dd� |td |d�kS ) a: Copy a file from inside a container to the Minion name Container name source Path of the file on the container's filesystem dest Destination on the Minion. Must be an absolute path. If the destination is a directory, the file will be copied into that directory. overwrite : False Unless this option is set to ``True``, then if a file exists at the location specified by the ``dest`` argument, an error will be raised. makedirs : False Create the parent directory on the container if it does not already exist. **RETURN DATA** A boolean (``True`` if successful, otherwise ``False``) CLI Example: .. code-block:: bash salt myminion docker.copy_from mycontainer /var/log/nginx/access.log /home/myuser rg r� z' is not runningz!Destination path must be absoluter z+Unable to make destination directory {}: {}Nz Directory � does not existzFDestination path {} already exists. Use overwrite=True to overwrite itz Source path must be absoluteztest -e Tr� ztest -f z Source must be a regular file� Source file z file.get_sum�sha256z-%s:%s and %s are the same file, skipping copyz/Copying %s from container '%s' to local path %sr� r �cprN FrP )r� r rV r� �isabsr �isdirr$ �basenamerH �makedirs�OSErrorr# r rT r� r� r� rU r[ r\ r� ) r� �source�dest� overwriter� r� Zdest_dirrb Z source_sha256Zsrc_pathrm r' r' r( � copy_from� sb ! ����� �� � r� r� c C s0 |du rt � }td | td |�|t|||d�S )a Copy a file from the host into a container name Container name source File to be copied to the container. Can be a local path on the Minion or a remote file from the Salt fileserver. dest Destination on the container. Must be an absolute path. If the destination is a directory, the file will be copied into that directory. exec_driver : None If not passed, the execution driver will be detected as described :ref:`above <docker-execution-driver>`. overwrite : False Unless this option is set to ``True``, then if a file exists at the location specified by the ``dest`` argument, an error will be raised. makedirs : False Create the parent directory on the container if it does not already exist. **RETURN DATA** A boolean (``True`` if successful, otherwise ``False``) CLI Example: .. code-block:: bash salt myminion docker.copy_to mycontainer /tmp/foo /root/foo Nzcontainer_resource.copy_to� container_resource.cache_file)�container_type� exec_driverr� r� �r� rU r" )r� r� r� r� r� r� r' r' r( �copy_to_ s ' �r� c K s> d|� d�}z t j�|�st|��W n ty t|��w t j�|�r-|s-t|� d���|du r_|�d�s;|�d�r>d}n5|�d�sH|�d �rKd }n(|�d �sU|�d �r^trZd }ntd��n|dkrfd}n |dkrmd }n|dkrsd }|r�|dvr�td|� d���t j� |�}t j� |�s�|s�td� |���zt � |� W n t y� } z td|� d|� ���d}~ww |dkr�zt�|d�} W n' t y� } z td|� d|� ���d}~ww |d kr�t�� } n|d kr�t�� } t�� } z�zS|dkr�td |d�} td | �} d} | d k�r*| �d �} | �r%|d v �r | �| �}|�r | �|� n| �| � | d k�s|d v �r;| �� }|�r;| �|� | �� W n& t�yf } zzt � |� W n t �yZ Y nw td |� ���d}~ww W | � � n| � � w d!t�� | i}||d"< t � |�j |d#< t |d# �|d$< |�!t"d%��r�t#d& |�|d'< |S )(au Exports a container to a tar archive. It can also optionally compress that tar archive, and push it up to the Master. name Container name or ID path Absolute path on the Minion where the container will be exported overwrite : False Unless this option is set to ``True``, then if a file exists at the location specified by the ``path`` argument, an error will be raised. makedirs : False If ``True``, then if the parent directory of the file specified by the ``path`` argument does not exist, Salt will attempt to create it. compression : None Can be set to any of the following: - ``gzip`` or ``gz`` for gzip compression - ``bzip2`` or ``bz2`` for bzip2 compression - ``xz`` or ``lzma`` for XZ compression (requires `xz-utils`_, as well as the ``lzma`` module from Python 3.3, available in Python 2 and Python 3.0-3.2 as `backports.lzma`_) This parameter can be omitted and Salt will attempt to determine the compression type by examining the filename passed in the ``path`` parameter. .. _`xz-utils`: http://tukaani.org/xz/ .. _`backports.lzma`: https://pypi.python.org/pypi/backports.lzma push : False If ``True``, the container will be pushed to the master using :py:func:`cp.push <salt.modules.cp.push>`. .. note:: This requires :conf_master:`file_recv` to be set to ``True`` on the Master. **RETURN DATA** A dictionary will containing the following keys: - ``Path`` - Path of the file that was exported - ``Push`` - Reports whether or not the file was successfully pushed to the Master *(Only present if push=True)* - ``Size`` - Size of the file, in bytes - ``Size_Human`` - Size of the file, in human-readable units - ``Time_Elapsed`` - Time in seconds taken to perform the export CLI Examples: .. code-block:: bash salt myminion docker.export mycontainer /tmp/mycontainer.tar salt myminion docker.export mycontainer /tmp/mycontainer.tar.xz push=True �Path '�' is not absolute� already existsN�.tar.gz�.tgz�gzip�.tar.bz2�.tbz2�bzip2�.tar.xz�.txz�xz�dXZ compression unavailable. Install the backports.lzma module and xz-utils to enable XZ compression.�gz�bz2�lzma�r� r� r� �Invalid compression type 'r� zQParent dir {} of destination path does not exist. Use makedirs=True to create it.zUnable to make parent dir r� �wb�Unable to open � for writing: � files.fopen�exportr� � �r� r� z(Error occurred during container export: r� r~ r� � Size_HumanF�cp.push�Push)$rV r� r� r rF r r �endswith�HAS_LZMA�dirnamer� r# r� r� r� �openr� � BZ2Compressorr� �LZMACompressorr� rp r� �read�compress�write�flushr r7 �close�stat�st_sizer� r r� rU )r� r� r� r� � compressionr^ r� � parent_dirrb �out� compressorr� r� �bufr� rc r' r' r( r � s� A � ��� ������ � � � ����r c K s� t d di |��}|�dd�}|�dd�}d}|r t d |� t| �dkr0|s0|s0td�| ���|rV|sVt| �}z|d d }W n tyO t�d |� Y nw t | |d � t d d�}|set d| ||d� t � dd� |D �S )au Removes a container name Container name or ID force : False If ``True``, the container will be killed first before removal, as the Docker API will not permit a running container to be removed. This option is set to ``False`` by default to prevent accidental removal of a running container. stop : False If ``True``, the container will be stopped first before removal, as the Docker API will not permit a running container to be removed. This option is set to ``False`` by default to prevent accidental removal of a running container. .. versionadded:: 2017.7.0 timeout Optional timeout to be passed to :py:func:`docker.stop <salt.modules.dockermod.stop>` if stopping the container. .. versionadded:: 2018.3.0 volumes : False Also remove volumes associated with container **RETURN DATA** A list of the IDs of containers which were removed CLI Example: .. code-block:: bash salt myminion docker.rm mycontainer salt myminion docker.rm mycontainer force=True rm �stopFrJ Nr� rg zKContainer '{}' is running, use force=True to forcibly remove this containerr r� z[Failed to find AutoRemove in inspect results, Docker API may have changed. Full results: %s�rJ Tr� Zremove_container)rB r� c S � g | ] }|t d d�vr|�qS �Tr� )r r� r' r' r( r� � rD zrm_.<locals>.<listcomp>r' ) rp rq r� r r# r r� r[ r� r r r� r� ) r� r� �volumesr^ Zstop_rJ r� rj r� r' r' r( r = s6 + � �� r c C s8 t | �d }t�d| ||� td||� t |�d |kS )a� .. versionadded:: 2017.7.0 Renames a container. Returns ``True`` if successful, and raises an error if the API returns one. If unsuccessful and the API returns no error (should not happen), then ``False`` will be returned. name Name or ID of existing container new_name New name to assign to container CLI Example: .. code-block:: bash salt myminion docker.rename foo bar r� z(Renaming container '%s' (ID: %s) to '%s'�rename)r r[ r\ r� )r� �new_namer� r' r' r( r � s r c C s� t � |s|r!|s|rtd��t|t�st|�}t|t�s!t|�}|r,|r,|� d|� �nd} t�� } td| | d||| ||d� } dt�� | i} t� | sUtd| � d ���g } | D ]}| �t j j j |t d �� qYg }| D ]0}ztt|��}W n ty Y qlw |d kr�t| |� |d kr�t| |� ql|d kr�t||� qld| vr�d| � �}t�|� t�| � |r�|d�d�|��7 }t|��t| d dd�}|r�|| d< nd| � �| d< |r�| | d< |r�| �dd� | S )a� .. versionchanged:: 2018.3.0 If the built image should be tagged, then the repository and tag must now be passed separately using the ``repository`` and ``tag`` arguments, rather than together in the (now deprecated) ``image`` argument. Builds a docker image from a Dockerfile or a URL path Path to directory on the Minion containing a Dockerfile repository Optional repository name for the image being built .. versionadded:: 2018.3.0 tag : latest Tag name for the image (required if ``repository`` is passed) .. versionadded:: 2018.3.0 image .. deprecated:: 2018.3.0 Use both ``repository`` and ``tag`` instead cache : True Set to ``False`` to force the build process not to use the Docker image cache, and pull all required intermediate image layers rm : True Remove intermediate containers created during build api_response : False If ``True``: an ``API_Response`` key will be present in the return data, containing the raw output from the Docker API. fileobj Allows for a file-like object containing the contents of the Dockerfile to be passed in place of a file ``path`` argument. This argument should not be used from the CLI, only from other Salt code. dockerfile Allows for an alternative Dockerfile to be specified. Path to alternative Dockefile is relative to the build path for the Docker container. .. versionadded:: 2016.11.0 buildargs A dictionary of build arguments provided to the docker build process. **RETURN DATA** A dictionary containing one or more of the following keys: - ``Id`` - ID of the newly-built image - ``Time_Elapsed`` - Time in seconds taken to perform the build - ``Intermediate_Containers`` - IDs of containers created during the course of the build process *(Only present if rm=False)* - ``Images`` - A dictionary containing one or more of the following keys: - ``Already_Pulled`` - Layers that that were already present on the Minion - ``Pulled`` - Layers that that were pulled *(Only present if the image specified by the "repository" and "tag" arguments was not present on the Minion, or if cache=False)* - ``Status`` - A string containing a summary of the pull action (usually a message saying that an image was downloaded, or that it was up to date). *(Only present if the image specified by the "repository" and "tag" arguments was not present on the Minion, or if cache=False)* CLI Example: .. code-block:: bash salt myminion docker.build /path/to/docker/build/dir salt myminion docker.build https://github.com/myuser/myrepo.git repository=myimage tag=latest salt myminion docker.build /path/to/docker/build/dir dockerfile=Dockefile.different repository=myimage tag=dev �2If tagging, both a repository and tag are requiredr� N�buildF)r� r rb �fileobjr Znocache� dockerfile� buildargsr� zBuild failed for �&, no response returned from Docker API)�clsr� r� r� r� �. Error(s) follow: {}� Tr� r� zFailed to tag image as �Warning� API_Responser� )r� r r� r& r� r� r� r rz r+ rX rY rZ r/ �next�iter� StopIterationr� r� r� r[ r� r# r$ r� rq )r� � repositoryr �cacher � api_responser" r# r$ Z image_tagr� r� rc Z stream_datar7 r� r� � item_typer� Z resolved_tagr' r' r( r! � s| _� � � � � r! �latestc C s� t |t�s t|�}t |t�st|�}t�� }td| ||||d�}dt�� | i}t� d}dD ] } | |v r;|| } nq/|du rDtd��||d< |S )ap .. versionchanged:: 2018.3.0 The repository and tag must now be passed separately using the ``repository`` and ``tag`` arguments, rather than together in the (now deprecated) ``image`` argument. Commits a container, thereby promoting it to an image. Equivalent to running the ``docker commit`` Docker CLI command. name Container name or ID to commit repository Repository name for the image being committed .. versionadded:: 2018.3.0 tag : latest Tag name for the image .. versionadded:: 2018.3.0 image .. deprecated:: 2018.3.0 Use both ``repository`` and ``tag`` instead message Commit message (Optional) author Author name (Optional) **RETURN DATA** A dictionary containing the following keys: - ``Id`` - ID of the newly-created image - ``Image`` - Name of the newly-created image - ``Time_Elapsed`` - Time in seconds taken to perform the commit CLI Example: .. code-block:: bash salt myminion docker.commit mycontainer myuser/myimage mytag �commit)r. r r� �authorr� N)r� r� �IDz(No image ID was returned in API responser� )r� r& r� r� r� r ) r� r. r r� r4 r� r� rc rx r� r' r' r( r3 S s( 0 ��r3 c s� t dd�� � fdd�t� �D �}| s|S i }|D ]9}zt||d�|�|i �d< W q tyQ } z t|�}t�|� ||�|i �d< d|| d< W Y d }~qd }~ww |S ) a� Return top-level images (those on which no other images depend) which do not have a tag assigned to them. These include: - Images which were once tagged but were later untagged, such as those which were superseded by committing a new copy of an existing tagged image. - Images which were loaded using :py:func:`docker.load <salt.modules.dockermod.load>` (or the ``docker load`` Docker CLI command), but not tagged. prune : False Remove these images force : False If ``True``, and if ``prune=True``, then forcibly remove these images. **RETURN DATA** If ``prune=False``, the return data will be a list of dangling image IDs. If ``prune=True``, the return data will be a dictionary with each key being the ID of the dangling image, and the following information for each image: - ``Comment`` - Any error encountered when trying to prune a dangling image *(Only present if prune failed)* - ``Removed`` - A boolean (``True`` if prune was successful, ``False`` if not) CLI Example: .. code-block:: bash salt myminion docker.dangling salt myminion docker.dangling prune=True Tr� c s( g | ]}� | d du r|dd� �qS )r� Nr� r' r� �Z all_imagesr' r( r� � s �z dangling.<locals>.<listcomp>r� ZRemoved�CommentFN)r� r� �rmir� r r& r[ r� )�pruner� Zdangling_imagesrc r� rb r� r' r6 r( �dangling� s$ & � ��r: c C s t |t�s t|�}t |t�st|�}td | �}t�� }td|||d�}dt�� | i}t� |s9td| � d���|r?||d< g }|D ])} ztt| ��} W n t yV Y qCw | dkrct || ||� qC| d krlt || � qCd |vr�d| � �} |r�| d � d � |��7 } t| ��|S ) ac .. versionchanged:: 2018.3.0 The repository and tag must now be passed separately using the ``repository`` and ``tag`` arguments, rather than together in the (now deprecated) ``image`` argument. Imports content from a local tarball or a URL as a new docker image source Content to import (URL or absolute path to a tarball). URL can be a file on the Salt fileserver (i.e. ``salt://path/to/rootfs/tarball.tar.xz``. To import a file from a saltenv other than ``base`` (e.g. ``dev``), pass it at the end of the URL (ex. ``salt://path/to/rootfs/tarball.tar.xz?saltenv=dev``). repository Repository name for the image being imported .. versionadded:: 2018.3.0 tag : latest Tag name for the image .. versionadded:: 2018.3.0 image .. deprecated:: 2018.3.0 Use both ``repository`` and ``tag`` instead api_response : False If ``True`` an ``api_response`` key will be present in the return data, containing the raw output from the Docker API. **RETURN DATA** A dictionary containing the following keys: - ``Id`` - ID of the newly-created image - ``Image`` - Name of the newly-created image - ``Time_Elapsed`` - Time in seconds taken to perform the commit CLI Example: .. code-block:: bash salt myminion docker.import /tmp/cent7-minimal.tar.xz myuser/centos salt myminion docker.import /tmp/cent7-minimal.tar.xz myuser/centos:7 salt myminion docker.import salt://dockerimages/cent7-minimal.tar.xz myuser/centos:7 r� Z import_image�r. r r� zImport failed for r% r* r� r� r� r' r( )r� r& rU r� r� r� r r+ r, r- r� r� r# r$ ) r� r. r r0 r� r� r� rc r� r� r1 r� r' r' r( r � sB 3 � � � r c s� |s|r |r|s t d��td | �}tj�|�s td| � d���tdd�� ddd |g}t�� }td |�}d t�� | i}t� tdd�}|d d krad| � �} |d r]| d� |d �7 } t| ��| |d< � fdd�|D �} dd� | D �|d< t || d�} |s�|r�t | �dkr�d� d� | ��|d< |S |� d|� �} zt | d ||d �}| |d < W |S ty� d |d< Y |S ty� } zd � | d | | �|d< W Y d } ~ |S d } ~ ww |S )!a� .. versionchanged:: 2018.3.0 If the loaded image should be tagged, then the repository and tag must now be passed separately using the ``repository`` and ``tag`` arguments, rather than together in the (now deprecated) ``image`` argument. Load a tar archive that was created using :py:func:`docker.save <salt.modules.dockermod.save>` (or via the Docker CLI using ``docker save``). path Path to docker tar archive. Path can be a file on the Minion, or the URL of a file on the Salt fileserver (i.e. ``salt://path/to/docker/saved/image.tar``). To load a file from a saltenv other than ``base`` (e.g. ``dev``), pass it at the end of the URL (ex. ``salt://path/to/rootfs/tarball.tar.xz?saltenv=dev``). repository If specified, the topmost layer of the newly-loaded image will be tagged with the specified repo using :py:func:`docker.tag <salt.modules.dockermod.tag_>`. If a repository name is provided, then the ``tag`` argument is also required. .. versionadded:: 2018.3.0 tag Tag name to go along with the repository name, if the loaded image is to be tagged. .. versionadded:: 2018.3.0 image .. deprecated:: 2018.3.0 Use both ``repository`` and ``tag`` instead **RETURN DATA** A dictionary will be returned, containing the following keys: - ``Path`` - Path of the file that was saved - ``Layers`` - A list containing the IDs of the layers which were loaded. Any layers in the file that was loaded, which were already present on the Minion, will not be included. - ``Image`` - Name of tag applied to topmost layer *(Only present if tag was specified and tagging was successful)* - ``Time_Elapsed`` - Time in seconds taken to load the file - ``Warning`` - Message describing any problems encountered in attempt to tag the topmost layer *(Only present if tag was specified and tagging failed)* CLI Example: .. code-block:: bash salt myminion docker.load /path/to/image.tar salt myminion docker.load salt://path/to/docker/saved/image.tar repository=myuser/myimage tag=mytag r r� r� r� Tr� r �loadz-ira r� rT r z Failed to load image(s) from re �: {}r~ c r� r' r' r� �r� r' r( r� � r� zload.<locals>.<listcomp>c S r� r� r' r� r' r' r( r� � r� r� )r� r zHMore than one top-level image layer was loaded ({}), no image was tagged�, r) r� r; r� z:No top-level image layers were loaded, no image was taggedzFailed to tag {} as {}: {}N)r rU rV r� �isfiler r� r� r� r# r� �lenr$ r r� r )r� r. r Z local_pathrm r� r� rc r� r� Z new_layersZtop_level_imagesZ tagged_imagerb r' r> r( r< 4 sX = �� ��� ���r< c C sP g }ddd| g}t td |dd��� �D ]}|�|� q|s&td| � d���|S ) a& Returns a list of the IDs of layers belonging to the specified image, with the top-most layer (the one correspnding to the passed name) appearing last. name Image name or ID CLI Example: .. code-block:: bash salt myminion docker.layers centos:7 r r� z-qzcmd.run_stdoutFrP zImage 'z ' not found)r� rU r1 r3 r )r� rc rm r7 r' r' r( �layers� s � rB c C s2 t � d|d�}|r||d< t�� }td| fi |��}t�� | dd�}t� |s1td| � d���|r7||d < g }|D ]Q} t�d | � z tjj � | �} W n t yf } ztd | � d �d t | �id��d} ~ ww zt t| ��} W n tyx Y q;w | dkr�t|| � q;| dkr�t|| � q;|r�||d< d|d< |S )a$ .. versionchanged:: 2018.3.0 If no tag is specified in the ``image`` argument, all tags for the image will be pulled. For this reason is it recommended to pass ``image`` using the ``repo:tag`` notation. Pulls an image from a Docker registry image Image to be pulled insecure_registry : False If ``True``, the Docker client will permit the use of insecure (non-HTTPS) registries. api_response : False If ``True``, an ``API_Response`` key will be present in the return data, containing the raw output from the Docker API. .. note:: This may result in a **lot** of additional return data, especially for larger images. client_timeout Timeout in seconds for the Docker client. This is not a timeout for this function, but for receiving a response from the API. **RETURN DATA** A dictionary will be returned, containing the following keys: - ``Layers`` - A dictionary containing one or more of the following keys: - ``Already_Pulled`` - Layers that that were already present on the Minion - ``Pulled`` - Layers that that were pulled - ``Status`` - A string containing a summary of the pull action (usually a message saying that an image was downloaded, or that it was up to date). - ``Time_Elapsed`` - Time in seconds taken to perform the pull CLI Example: .. code-block:: bash salt myminion docker.pull centos salt myminion docker.pull centos:6 T�r� rn �insecure_registryr� r �r� rT zPull failed for r% r* zpull event: %s� Unable to interpret API event: 'r� �Errorr� Nr� r� rU r rT )r� r� r� r� r r[ r\ r+ rX rY rZ r r& r+ r, r- r� r� � r� rD r0 rn r^ r� r� rc r� �eventrb Z event_typer' r' r( r� � sP 6 � ��� � �r� c C s2 t | t�s t| �} d|d�}|r||d< t�� }td| fi |��}t�� | dd�}t� |s7td| � d���|r=||d < g }|D ]K} z tjj� | �} W n t yf } ztd | � d �d t| �id ��d} ~ ww zt t | ��} W n t yx Y qAw | dkr�t|| � qA| dkr�t|| � qA|r�||d< d|d< |S )a .. versionchanged:: 2015.8.4 The ``Id`` and ``Image`` keys are no longer present in the return data. This is due to changes in the Docker Remote API. Pushes an image to a Docker registry. See the documentation at top of this page to configure authentication credentials. image Image to be pushed. If just the repository name is passed, then all tagged images for the specified repo will be pushed. If the image name is passed in ``repo:tag`` notation, only the specified image will be pushed. insecure_registry : False If ``True``, the Docker client will permit the use of insecure (non-HTTPS) registries. api_response : False If ``True``, an ``API_Response`` key will be present in the return data, containing the raw output from the Docker API. client_timeout Timeout in seconds for the Docker client. This is not a timeout for this function, but for receiving a response from the API. **RETURN DATA** A dictionary will be returned, containing the following keys: - ``Layers`` - A dictionary containing one or more of the following keys: - ``Already_Pushed`` - Layers that that were already present on the Minion - ``Pushed`` - Layers that that were pushed - ``Time_Elapsed`` - Time in seconds taken to perform the push CLI Example: .. code-block:: bash salt myminion docker.push myuser/mycontainer salt myminion docker.push myuser/mycontainer:mytag TrC rD r� r rE zPush failed for r% r* rF r� rG r� Nr� r� rU r rT )r� r& r� r� r� r r+ rX rY rZ r r+ r, r- r� r� rH r' r' r( r� ! sP 2 � ��� � �r� c O sl t dd�}t� }|�dd�}|�dd� }g }| D ]}}t|�d }z td|||dd� W q tjjy� } z\| jj d kr~|� | j � t |�} | d sN| d r}d } | d r`| d � d�| d ��7 } | d rx| d rl| d7 } | d� d�| d ��7 } |� | � n|� d| jj � d| j � �� W Y d} ~ qd} ~ ww t� dd� |D �dd� |D �dd�} |r�|| d< d| d< | S ) a: Removes an image name Name (in ``repo:tag`` notation) or ID of image. force : False If ``True``, the image will be removed even if the Minion has containers created from that image prune : True If ``True``, untagged parent image layers will be removed as well, set this to ``False`` to keep them. **RETURN DATA** A dictionary will be returned, containing the following two keys: - ``Layers`` - A list of the IDs of image layers that were removed - ``Tags`` - A list of the tags that were removed - ``Errors`` - A list of any errors that were encountered CLI Examples: .. code-block:: bash salt myminion docker.rmi busybox salt myminion docker.rmi busybox force=True salt myminion docker.rmi foo bar baz Tr� r� Fr9 r� Z remove_image)r� �nopruner� i� r% ry zImage is in use by zcontainer(s): {}r? z and z image(s): {}r� r� Nc S r r )r� r� r' r' r( r� � rD zrmi.<locals>.<listcomp>c S s g | ] }|t � vr|�qS r' )r� r� r' r' r( r� � s r )r� ZTagsrT rU r rT )r� r� r r r� r r� r� r� r� r3 r� r{ r# r$ r� ) r� r^ Z pre_imagesZpre_tagsr� rJ r� r� rx rb Zdepsr� rc r' r' r( r8 sR � � �� �r8 c K s d|� d�}z t j�|�st|��W n ty t|��w t j�|�r-|s-t|� d���|du r_|�d�s;|�d�r>d}n5|�d�sH|�d �rKd }n(|�d �sU|�d �r^trZd }ntd��n|dkrfd}n |dkrmd }n|dkrsd }|r�|dvr�td|� d���t j� |�}t j� |�s�|s�td� |���|r�t d � }n|}| t | �d v r�| nt | �d } ddd|| g} t�� } td | d d �} | d d kr�d!|� �}| d" r�|d#� | d" �7 }t|��|�r�|dk�rzt�|d$�} W n* t�y } z td%|� d&|� ���d}~ww |d k�rt�� }n |d k�rt�� }z�zgt d' |d(��U}|dk�r0t d' |d$�} d}|d)k�r\|�d*�}|�rW|d+v �rR|�|�}|�rQ| �|� n| �|� |d)k�s7|d+v �rm|�� }|�rm| �|� | �� W d � n 1 �s|w Y W n& t�y� } zzt � |� W n t�y� Y nw td,|� ���d}~ww W zt � |� W n t�y� Y nw | � � nzt � |� W n t�y� Y nw | � � w d-t�� | i}||d.< t � |�j |d/< t |d/ �|d0< |�!d1d ��rtd2 |�|d3< |S )4a% Saves an image and to a file on the minion. Equivalent to running the ``docker save`` Docker CLI command, but unlike ``docker save`` this will also work on named images instead of just images IDs. name Name or ID of image. Specify a specific tag by using the ``repo:tag`` notation. path Absolute path on the Minion where the image will be exported overwrite : False Unless this option is set to ``True``, then if the destination file exists an error will be raised. makedirs : False If ``True``, then if the parent directory of the file specified by the ``path`` argument does not exist, Salt will attempt to create it. compression : None Can be set to any of the following: - ``gzip`` or ``gz`` for gzip compression - ``bzip2`` or ``bz2`` for bzip2 compression - ``xz`` or ``lzma`` for XZ compression (requires `xz-utils`_, as well as the ``lzma`` module from Python 3.3, available in Python 2 and Python 3.0-3.2 as `backports.lzma`_) This parameter can be omitted and Salt will attempt to determine the compression type by examining the filename passed in the ``path`` parameter. .. note:: Since the Docker API does not support ``docker save``, compression will be a bit slower with this function than with :py:func:`docker.export <salt.modules.dockermod.export>` since the image(s) will first be saved and then the compression done afterwards. .. _`xz-utils`: http://tukaani.org/xz/ .. _`backports.lzma`: https://pypi.python.org/pypi/backports.lzma push : False If ``True``, the container will be pushed to the master using :py:func:`cp.push <salt.modules.cp.push>`. .. note:: This requires :conf_master:`file_recv` to be set to ``True`` on the Master. **RETURN DATA** A dictionary will be returned, containing the following keys: - ``Path`` - Path of the file that was saved - ``Push`` - Reports whether or not the file was successfully pushed to the Master *(Only present if push=True)* - ``Size`` - Size of the file, in bytes - ``Size_Human`` - Size of the file, in human-readable units - ``Time_Elapsed`` - Time in seconds taken to perform the save CLI Examples: .. code-block:: bash salt myminion docker.save centos:7 /tmp/cent7.tar salt myminion docker.save 0123456789ab cdef01234567 /tmp/saved.tar r� r� r� Nr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� zSParent dir '{}' of destination path does not exist. Use makedirs=True to create it.� files.mkstempr� r� r �savez-ora FrP rT r zFailed to save image(s) to re r= r� r� r� r �rbr� r r z"Error occurred during image save: r� r~ r� r r� r r )"rV r� r� r rF r r r r r r� r# rp r r� rU r� r r� r� r r� r r r r r r r7 r r r r� r )r� r� r� r� r r^ r� r Z saved_pathZ image_to_saverm r� r� r rb r Z uncompressedr r� rc r' r' r( rL � s� J � ��� � � �� � � ������� �� rL c C sL t |t�s t|�}t |t�st|�}t| �d }td||||d�}t� |S )a? .. versionchanged:: 2018.3.0 The repository and tag must now be passed separately using the ``repository`` and ``tag`` arguments, rather than together in the (now deprecated) ``image`` argument. Tag an image into a repository and return ``True``. If the tag was unsuccessful, an error will be raised. name ID of image repository Repository name for the image to be built .. versionadded:: 2018.3.0 tag : latest Tag name for the image to be built .. versionadded:: 2018.3.0 image .. deprecated:: 2018.3.0 Use both ``repository`` and ``tag`` instead force : False Force apply tag CLI Example: .. code-block:: bash salt myminion docker.tag 0123456789ab myrepo/mycontainer mytag r� r )r. r r� )r� r& r r� r� )r� r. r r� rx r� r' r' r( r � s $ �r c C s� | dur t d | �} |durt d |�}td| |d�}t|�D ] \}}z t|d �d }W n ty6 Y q w |r?||| d< q |S )a/ .. versionchanged:: 2017.7.0 The ``names`` and ``ids`` can be passed as a comma-separated list now, as well as a Python list. .. versionchanged:: 2018.3.0 The ``Containers`` key for each network is no longer always empty. List existing networks names Filter by name ids Filter by id CLI Example: .. code-block:: bash salt myminion docker.networks names=network-web salt myminion docker.networks ids=1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc Nr r )r� �idsr� r% )rp r� r� r6 r )r� rN r� r� ZnetinforO r' r' r( r � s � �r c s� t d tjjjjf|||d�t d d i � ����� d� vrOi }� fdd�ddgtd �d D �D ] }� �|�||< q0� �d d �}|sD|rOt d |i |��� d< td | fi � ��} t � | S )a�$ .. versionchanged:: 2018.3.0 Support added for network configuration options other than ``driver`` and ``driver_opts``, as well as IPAM configuration. Create a new network .. note:: This function 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 ARGUMENTS <salt-modules-dockermod-create-network-netconf>` and :ref:`IP ADDRESS MANAGEMENT (IPAM) <salt-modules-dockermod-create-network-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 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. See the following links for more information: - `docker-py Low-level API`_ - `Docker Engine API`_ .. versionadded:: 2018.3.0 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 as input, IP address validation will be performed. To disable, set this to ``False`` .. note:: When validating subnets, whether or not the IP portion of the subnet is a valid subnet boundary will not be checked. The IP will portion will be validated, and the subnet size will be checked to confirm it is a valid number (1-32 for IPv4, 1-128 for IPv6). .. versionadded:: 2018.3.0 .. _salt-modules-dockermod-create-network-netconf: **NETWORK CONFIGURATION ARGUMENTS** driver Network driver Example: ``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``. Examples: - ``driver_opts='macvlan_mode=bridge,parent=eth0'`` - ``driver_opts="['macvlan_mode=bridge', 'parent=eth0']"`` - ``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. Example: ``check_duplicate=False`` internal : False If ``True``, restricts external access to the network Example: ``internal=True`` labels Add metadata to the network. Labels can be set both with and without values: Examples (*with* values): - ``labels="label1=value1,label2=value2"`` - ``labels="['label1=value1', 'label2=value2']"`` - ``labels="{'label1': 'value1', 'label2': 'value2'}"`` Examples (*without* values): - ``labels=label1,label2`` - ``labels="['label1', 'label2']"`` enable_ipv6 (or *ipv6*) : False Enable IPv6 on the network Example: ``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. Example: ``attachable=True`` .. note:: 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``) Example: ``scope=local`` ingress : False If ``True``, create an ingress network which provides the routing-mesh in swarm mode Example: ``ingress=True`` .. _salt-modules-dockermod-create-network-ipam: **IP ADDRESS MANAGEMENT (IPAM)** This function supports networks with either IPv4, or both IPv4 and IPv6. If configuring IPv4, then you can pass the IPAM arguments as shown below, as individual arguments on the Salt CLI. However, if configuring IPv4 and IPv6, the arguments must be passed as a list of dictionaries, in the ``ipam_pools`` argument. See the **CLI Examples** below. `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 Example: ``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``. Examples: - ``ipam_opts='foo=bar,baz=qux'`` - ``ipam_opts="['foo=bar', 'baz=quz']"`` - ``ipam_opts="{'foo': 'bar', 'baz': 'qux'}"`` *IPAM POOL ARGUMENTS* subnet Subnet in CIDR format that represents a network segment Example: ``subnet=192.168.50.0/25`` iprange (or *ip_range*) Allocate container IP from a sub-range within the subnet Subnet in CIDR format that represents a network segment Example: ``iprange=192.168.50.64/26`` gateway IPv4 gateway for the master subnet Example: ``gateway=192.168.50.1`` 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``. Examples: - ``aux_addresses='foo.bar.tld=192.168.50.10,hello.world.tld=192.168.50.11'`` - ``aux_addresses="['foo.bar.tld=192.168.50.10', 'hello.world.tld=192.168.50.11']"`` - ``aux_addresses="{'foo.bar.tld': '192.168.50.10', 'hello.world.tld': '192.168.50.11'}"`` CLI Examples: .. code-block:: bash salt myminion docker.create_network web_network driver=bridge # IPv4 salt myminion docker.create_network macvlan_network driver=macvlan driver_opts="{'parent':'eth0'}" gateway=172.20.0.1 subnet=172.20.0.0/24 # IPv4 and IPv6 salt myminion docker.create_network mynet ipam_pools='[{"subnet": "10.0.0.0/24", "gateway": "10.0.0.1"}, {"subnet": "fe3f:2180:26:1::60/123", "gateway": "fe3f:2180:26:1::61"}]' r r rm Zipamc s g | ]}|� v r|�qS r' r' r� �r^ r' r( r� � s �z"create_network.<locals>.<listcomp>Z ipam_driverZ ipam_optsZ ipam_config� ipam_poolsr' zdocker.create_ipam_config�create_network) rp r+ rX r r �networkr rq r� r� ) r� r r r rn r^ Z ipam_kwargsr_ rP r� r' rO r( rQ � s8 r ��� � � � �rQ c C � t d| �}t� dS )a Remove a network network_id Network name or ID CLI Examples: .. code-block:: bash salt myminion docker.remove_network mynet salt myminion docker.remove_network 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc �remove_networkT�r� r� �� network_idr� r' r' r( rT � s rT c C � t d| �}t� |S )z� Inspect Network network_id ID of network CLI Example: .. code-block:: bash salt myminion docker.inspect_network 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc r6 rU rV r' r' r( r6 s r6 c K sN t d di |��}t�d| ||� td| |fi |��}t�d| |� t� dS )av .. versionadded:: 2015.8.3 .. versionchanged:: 2017.7.0 Support for ``ipv4_address`` argument added .. versionchanged:: 2018.3.0 All arguments are now passed through to `connect_container_to_network()`_, allowing for any new arguments added to this function to be supported automagically. Connect container to network. See the `connect_container_to_network()`_ docs for information on supported arguments. container Container name or ID net_id Network name or ID CLI Examples: .. code-block:: bash salt myminion docker.connect_container_to_network web-1 mynet salt myminion docker.connect_container_to_network web-1 mynet ipv4_address=10.20.0.10 salt myminion docker.connect_container_to_network web-1 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc rm zNConnecting container '%s' to network '%s' with the following configuration: %s� connect_container_to_networkz5Successfully connected container '%s' to network '%s'TNr' )rp r[ r\ r� r� )r Znet_idr^ r� r' r' r( rY " s" ����rY c C s2 t �d| |� td| |�}t �d| |� t� dS )a� .. versionadded:: 2015.8.3 Disconnect container from network container Container name or ID network_id Network name or ID CLI Examples: .. code-block:: bash salt myminion docker.disconnect_container_from_network web-1 mynet salt myminion docker.disconnect_container_from_network web-1 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc z.Disconnecting container '%s' from network '%s'�!disconnect_container_from_networkz:Successfully disconnected container '%s' from network '%s'T)r[ r\ r� r� )r rW r� r' r' r( rZ O s ��rZ c C s� t | �}g }g }|D ]-}z t|| � |�|� W q ty7 } zt|�}d|vr-|�|� W Y d}~q d}~ww |rCtd||d�d��|S )aG .. versionadded:: 2018.3.0 Runs :py:func:`docker.disconnect_container_from_network <salt.modules.dockermod.disconnect_container_from_network>` on all containers connected to the specified network, and returns the names of all containers that were disconnected. network_id Network name or ID CLI Examples: .. code-block:: bash salt myminion docker.disconnect_all_containers_from_network mynet salt myminion docker.disconnect_all_containers_from_network 1f9d2454d0872b68dd9e8744c6e7a4c66b86f10abaccc21e14f7f014f729b2bc Z404Nz+One or more containers failed to be removed)Zremovedr� r� )rQ rZ r3 r r& )rW r: rc ZfailedZcnamerb r� r' r' r( �&disconnect_all_containers_from_networko s& ���r[ c C s t d| d�}|S )z� List existing volumes .. versionadded:: 2015.8.4 filters There is one available filter: dangling=true CLI Example: .. code-block:: bash salt myminion docker.volumes filters="{'dangling': True}" r �r� r� )r� r� r' r' r( r � s r c C s t d| ||d�}t� |S )a- Create a new volume .. versionadded:: 2015.8.4 name name of volume driver Driver of the volume driver_opts Options for the driver volume CLI Example: .. code-block:: bash salt myminion docker.create_volume my_volume driver=local � create_volume)r� � driver_optsrU )r� r� r^ r� r' r' r( r] � s �r] c C rS )z� Remove a volume .. versionadded:: 2015.8.4 name Name of volume CLI Example: .. code-block:: bash salt myminion docker.remove_volume my_volume � remove_volumeTrU �r� r� r' r' r( r_ � s r_ c C rX )z� Inspect Volume .. versionadded:: 2015.8.4 name Name of volume CLI Example: .. code-block:: bash salt myminion docker.inspect_volume my_volume r� rU r` r' r' r( r� � s r� c C s t | dd�S )a4 Kill all processes in a running container instead of performing a graceful shutdown name Container name or ID **RETURN DATA** A dictionary will be returned, containing the following keys: - ``status`` - A dictionary showing the prior state of the container as well as the new state - ``result`` - A boolean noting whether or not the action was successful - ``comment`` - Only present if the container cannot be killed CLI Example: .. code-block:: bash salt myminion docker.kill mycontainer �killrh �r� r� r' r' r( ra � s ra c C �6 t | �}|dkrd||d�d| � d�d�S t| dd�S ) a� Pauses a container name Container name or ID **RETURN DATA** A dictionary will be returned, containing the following keys: - ``status`` - A dictionary showing the prior state of the container as well as the new state - ``result`` - A boolean noting whether or not the action was successful - ``comment`` - Only present if the container cannot be paused CLI Example: .. code-block:: bash salt myminion docker.pause mycontainer rh Fr� r� z' is stopped, cannot pauser� �pauserf �r� r� �r� � orig_stater' r' r( rd � � rd �freeze� c C s$ t | dd|d�}|d rd|d< |S )a� Restarts a container name Container name or ID timeout : 10 Timeout in seconds after which the container will be killed (if it has not yet gracefully shut down) **RETURN DATA** A dictionary will be returned, containing the following keys: - ``status`` - A dictionary showing the prior state of the container as well as the new state - ``result`` - A boolean noting whether or not the action was successful - ``restarted`` - If restart was successful, this key will be present and will be set to ``True``. CLI Examples: .. code-block:: bash salt myminion docker.restart mycontainer salt myminion docker.restart mycontainer timeout=20 r� rg r r� TZ restartedrb )r� rJ rc r' r' r( r� 4 s r� c C s t d| |d� dS )a% Send a signal to a container. 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. name Container name or ID signal Signal to send to container **RETURN DATA** If the signal was successfully sent, ``True`` will be returned. Otherwise, an error will be raised. CLI Example: .. code-block:: bash salt myminion docker.signal mycontainer SIGHUP ra )r Tr� )r� r r' r' r( r W s r c C rc ) a� Start a container name Container name or ID **RETURN DATA** A dictionary will be returned, containing the following keys: - ``status`` - A dictionary showing the prior state of the container as well as the new state - ``result`` - A boolean noting whether or not the action was successful - ``comment`` - Only present if the container cannot be started CLI Example: .. code-block:: bash salt myminion docker.start mycontainer rf Fr� r� z' is paused, cannot startr� r rg re rf r' r' r( r s s � r c K s� |du r z t | �d d }W n ty tjjj}Y nw t| �}|dkrM|�dd�rAt| dd�}|d du r@d � | �|d < |S n d||d �d � | �d �S t| dd|d�}||d d< |S )a� Stops a running container name Container name or ID unpause : False If ``True`` and the container is paused, it will be unpaused before attempting to stop the container. timeout Timeout in seconds after which the container will be killed (if it has not yet gracefully shut down) .. versionchanged:: 2017.7.0 If this argument is not passed, then the container's configuration will be checked. If the container was created using the ``stop_timeout`` argument, then the configured timeout will be used, otherwise the timeout will be 10 seconds. **RETURN DATA** A dictionary will be returned, containing the following keys: - ``status`` - A dictionary showing the prior state of the container as well as the new state - ``result`` - A boolean noting whether or not the action was successful - ``comment`` - Only present if the container can not be stopped CLI Examples: .. code-block:: bash salt myminion docker.stop mycontainer salt myminion docker.stop mycontainer unpause=True salt myminion docker.stop mycontainer timeout=20 Nr Z StopTimeoutrf �unpauseFrg r� z Failed to unpause container '{}'r� r� zJContainer '{}' is paused, run with unpause=True to unpause before stoppingr� r rh r r� r� ) r r� r+ rX r ZSHUTDOWN_TIMEOUTr� r r� r# )r� rJ r^ rg Zunpause_resultrc r' r' r( r � s0 ' � ��� r c C rc ) a� Unpauses a container name Container name or ID **RETURN DATA** A dictionary will be returned, containing the following keys: - ``status`` - A dictionary showing the prior state of the container as well as the new state - ``result`` - A boolean noting whether or not the action was successful - ``comment`` - Only present if the container can not be unpaused CLI Example: .. code-block:: bash salt myminion docker.pause mycontainer rh Fr� r� z ' is stopped, cannot unpauser� rk rg re rf r' r' r( rk � rh rk �unfreezec C s� zt | �}W n ty |d| � d�d� Y S w |dk}td| �}t� zt | �}W n ty6 d}Y nw |r<|}n |dkrCd}nd}|||d �|d �}|rXd| � d �|d < |rf|d rf|d dk|d < |S )a� Wait for the container to exit gracefully, and return its exit code .. note:: This function will block until the container is stopped. name Container name or ID ignore_already_stopped Boolean flag that prevents execution to fail, if a container is already stopped. fail_on_exit_status Boolean flag to report execution as failure if ``exit_status`` is different than 0. **RETURN DATA** A dictionary will be returned, containing the following keys: - ``status`` - A dictionary showing the prior state of the container as well as the new state - ``result`` - A boolean noting whether or not the action was successful - ``exit_status`` - Exit status for the container - ``comment`` - Only present if the container is already stopped CLI Example: .. code-block:: bash salt myminion docker.wait mycontainer r� z' absent�r� r� rh �waitNTFr� )r� r� � exit_statusz' already stoppedr� r� ro r )r� r r� r� ) r� Zignore_already_stoppedZfail_on_exit_statusr� Zalready_stoppedr� r� �successr� r' r' r( rn s: # �� �� rn c K s |du rt | |||f�sd}td di |��}t|�D ]}t|| t�s/tjj�|| �||< qi }|s6| r>t d|d�|d< |sB|rJt d|d�|d< |sN|rVt d |d�|d < |sZ|r|z t d |d�|d < W n t y{ t d t dt dd��d�|d < Y nw |r�t d|d�|d< |S )a! .. versionadded:: 2019.2.0 Prune Docker's various subsystems .. note:: This requires docker-py version 2.1.0 or later. containers : False If ``True``, prunes stopped containers (documentation__) .. __: https://docs.docker.com/engine/reference/commandline/container_prune/#filtering images : False If ``True``, prunes unused images (documentation__) .. __: https://docs.docker.com/engine/reference/commandline/image_prune/#filtering networks : False If ``False``, prunes unreferenced networks (documentation__) .. __: https://docs.docker.com/engine/reference/commandline/network_prune/#filtering) build : False If ``True``, clears the builder cache .. note:: Only supported in Docker 17.07.x and newer. Additionally, filters do not apply to this argument. volumes : False If ``True``, prunes unreferenced volumes (documentation__) .. __: https://docs.docker.com/engine/reference/commandline/volume_prune/ system If ``True``, prunes containers, images, networks, and builder cache. Assumed to be ``True`` if none of ``containers``, ``images``, ``networks``, or ``build`` are set to ``True``. .. note:: ``volumes=True`` must still be used to prune volumes filters - ``dangling=True`` (images only) - remove only dangling images - ``until=<timestamp>`` - only remove objects created before given timestamp. Not applicable to volumes. See the documentation links above for examples of valid time expressions. - ``label`` - only remove objects matching the label expression. Valid expressions include ``labelname`` or ``labelname=value``. CLI Examples: .. code-block:: bash salt myminion docker.prune system=True salt myminion docker.prune system=True until=12h salt myminion docker.prune images=True dangling=True salt myminion docker.prune images=True label=foo,bar=baz NTrm Zprune_containersr\ rO Z prune_imagesr� Zprune_networksr Z prune_buildr! Z_resultZ_postZ_urlz /build/pruneZ prune_volumesr r' ) r, rp r� r� r r+ rX rt Z split_inputr� r ) rO r r� r! r �systemr� �fnamerc r' r' r( r9 G s6 G � ��r9 r\ c C sD |du rt � }td | |t|||||||| d� } |dv r | S | | S )z/ Common logic for docker.run functions Nzcontainer_resource.run) r� r� r� �stdinrQ rd r� �use_vt�keep_env)Nr r� ) r� rm r� r� rs rQ rd r� rt ru rc r' r' r( �_run� s$ �rv �basec C s dd� } t d ddtj�|�d d�} |r-td || ||�}|s,| | � d dd d d d �S ntd ||�}|sB| | � d dd d d d �S t�|| � |du rOt� }t| | | |d� t | d| � t | |rj| d t |� n| ||||| | | d� }| | � t | d| � |S )z5 Common logic to run a script on a container c S sF zt �| � W dS ty" } zt�d| |� W Y d}~dS d}~ww )z> Remove the tempfile allocated for the script z-cmd.script: Unable to clean tempfile '%s': %sN)rV r7 r� r[ r� )r� rb r' r' r( �_cleanup_tempfile� s ��z"_script.<locals>._cleanup_tempfilerK �/tmpr+ r )�dir�prefix�suffixzcp.get_templater r� T)r� rT rf re Z cache_errorz cp.cache_fileN)r� z chmod 700 r� )r� rs rQ rd r� rt ru zrm ) rp rV r� �splitextrU �shutil�copyfiler� r� �run�run_allr& )r� r� �saltenvrt �templater� rs rQ rd r� rt ru rx r� Zfn_rc r' r' r( �_script� sV ��� � � r� c C � t | ||d||||||d� S )a5 Run :py:func:`cmd.retcode <salt.modules.cmdmod.retcode>` within a container name Container name or ID in which to run the command cmd Command to run exec_driver : None If not passed, the execution driver will be detected as described :ref:`above <docker-execution-driver>`. stdin : None Standard input to be used for the command output_loglevel : debug Level at which to log the output from the command. Set to ``quiet`` to suppress logging. use_vt : False Use SaltStack's utils.vt to stream output to console. keep_env : None If not passed, only a sane default PATH environment variable will be set. If ``True``, all environment variables from the container's host will be kept. Otherwise, a comma-separated list (or Python list) of environment variable names can be passed, and those environment variables will be kept. CLI Example: .. code-block:: bash salt myminion docker.retcode mycontainer 'ls -l /etc' rT �r� r� rs rQ rd rt r� ru �rv � r� rm r� rs rQ rd rt r� ru r' r' r( rT # � /�rT c C r� )a) Run :py:func:`cmd.run <salt.modules.cmdmod.run>` within a container name Container name or ID in which to run the command cmd Command to run exec_driver : None If not passed, the execution driver will be detected as described :ref:`above <docker-execution-driver>`. stdin : None Standard input to be used for the command output_loglevel : debug Level at which to log the output from the command. Set to ``quiet`` to suppress logging. use_vt : False Use SaltStack's utils.vt to stream output to console. keep_env : None If not passed, only a sane default PATH environment variable will be set. If ``True``, all environment variables from the container's host will be kept. Otherwise, a comma-separated list (or Python list) of environment variable names can be passed, and those environment variables will be kept. CLI Example: .. code-block:: bash salt myminion docker.run mycontainer 'ls -l /etc' Nr� r� r� r' r' r( r� ` r� r� c C r� )a� Run :py:func:`cmd.run_all <salt.modules.cmdmod.run_all>` within a container .. note:: While the command is run within the container, it is initiated from the host. Therefore, the PID in the return dict is from the host, not from the container. name Container name or ID in which to run the command cmd Command to run exec_driver : None If not passed, the execution driver will be detected as described :ref:`above <docker-execution-driver>`. stdin : None Standard input to be used for the command output_loglevel : debug Level at which to log the output from the command. Set to ``quiet`` to suppress logging. use_vt : False Use SaltStack's utils.vt to stream output to console. keep_env : None If not passed, only a sane default PATH environment variable will be set. If ``True``, all environment variables from the container's host will be kept. Otherwise, a comma-separated list (or Python list) of environment variable names can be passed, and those environment variables will be kept. CLI Example: .. code-block:: bash salt myminion docker.run_all mycontainer 'ls -l /etc' r r� r� r� r' r' r( r� � s 5�r� c C r� )aB Run :py:func:`cmd.run_stderr <salt.modules.cmdmod.run_stderr>` within a container name Container name or ID in which to run the command cmd Command to run exec_driver : None If not passed, the execution driver will be detected as described :ref:`above <docker-execution-driver>`. stdin : None Standard input to be used for the command output_loglevel : debug Level at which to log the output from the command. Set to ``quiet`` to suppress logging. use_vt : False Use SaltStack's utils.vt to stream output to console. keep_env : None If not passed, only a sane default PATH environment variable will be set. If ``True``, all environment variables from the container's host will be kept. Otherwise, a comma-separated list (or Python list) of environment variable names can be passed, and those environment variables will be kept. CLI Example: .. code-block:: bash salt myminion docker.run_stderr mycontainer 'ls -l /etc' re r� r� r� r' r' r( � run_stderr� � 0�r� c C r� )aB Run :py:func:`cmd.run_stdout <salt.modules.cmdmod.run_stdout>` within a container name Container name or ID in which to run the command cmd Command to run exec_driver : None If not passed, the execution driver will be detected as described :ref:`above <docker-execution-driver>`. stdin : None Standard input to be used for the command output_loglevel : debug Level at which to log the output from the command. Set to ``quiet`` to suppress logging. use_vt : False Use SaltStack's utils.vt to stream output to console. keep_env : None If not passed, only a sane default PATH environment variable will be set. If ``True``, all environment variables from the container's host will be kept. Otherwise, a comma-separated list (or Python list) of environment variable names can be passed, and those environment variables will be kept. CLI Example: .. code-block:: bash salt myminion docker.run_stdout mycontainer 'ls -l /etc' rf r� r� r� r' r' r( r� r� r� c C s t | ||||||||| | | d� S )a� Run :py:func:`cmd.script <salt.modules.cmdmod.script>` within a container .. note:: While the command is run within the container, it is initiated from the host. Therefore, the PID in the return dict is from the host, not from the container. name Container name or ID source Path to the script. Can be a local path on the Minion or a remote file from the Salt fileserver. args A string containing additional command-line options to pass to the script. template : None Templating engine to use on the script before running. exec_driver : None If not passed, the execution driver will be detected as described :ref:`above <docker-execution-driver>`. stdin : None Standard input to be used for the script output_loglevel : debug Level at which to log the output from the script. Set to ``quiet`` to suppress logging. use_vt : False Use SaltStack's utils.vt to stream output to console. keep_env : None If not passed, only a sane default PATH environment variable will be set. If ``True``, all environment variables from the container's host will be kept. Otherwise, a comma-separated list (or Python list) of environment variable names can be passed, and those environment variables will be kept. CLI Example: .. code-block:: bash salt myminion docker.script mycontainer salt://docker_script.py salt myminion docker.script mycontainer salt://scripts/runme.sh 'arg1 arg2 "arg 3"' salt myminion docker.script mycontainer salt://scripts/runme.sh stdin='one\ntwo\nthree\nfour\nfive\n' output_loglevel=quiet � r� rt r� r� rs rQ rd r� rt ru �r� � r� r� r� rt r� r� rs rQ rd r� rt ru r' r' r( �script\ s B�r� c C s$ t | ||||||||| | | d� d S )aA Run :py:func:`cmd.script_retcode <salt.modules.cmdmod.script_retcode>` within a container name Container name or ID source Path to the script. Can be a local path on the Minion or a remote file from the Salt fileserver. args A string containing additional command-line options to pass to the script. template : None Templating engine to use on the script before running. exec_driver : None If not passed, the execution driver will be detected as described :ref:`above <docker-execution-driver>`. stdin : None Standard input to be used for the script output_loglevel : debug Level at which to log the output from the script. Set to ``quiet`` to suppress logging. use_vt : False Use SaltStack's utils.vt to stream output to console. keep_env : None If not passed, only a sane default PATH environment variable will be set. If ``True``, all environment variables from the container's host will be kept. Otherwise, a comma-separated list (or Python list) of environment variable names can be passed, and those environment variables will be kept. CLI Example: .. code-block:: bash salt myminion docker.script_retcode mycontainer salt://docker_script.py salt myminion docker.script_retcode mycontainer salt://scripts/runme.sh 'arg1 arg2 "arg 3"' salt myminion docker.script_retcode mycontainer salt://scripts/runme.sh stdin='one\ntwo\nthree\nfour\nfive\n' output_loglevel=quiet r� rT r� r� r' r' r( �script_retcode� s =� �r� c C s" t j�ddt�� jd d� � ��S )Nry z salt.docker.r )rV r� r$ �uuidZuuid4�hexr' r' r' r( �_generate_tmp_path� s "r� r� c C s^ t ||�}tjjj�||�}t� �}tjjj�||||| �W d � S 1 s(w Y dS )za Prepares a self contained tarball that has the state to be applied in the container N)�_compile_stater+ �clientZsshr� Zlowstate_file_refsr. Zprep_trans_tar)r� �sls_opts�mods�pillar�extra_filerefs�chunksZrefsr, r' r' r( �_prepare_trans_tar� s �$�r� c C s� t | ��b}|s|�� W d � S |�| d |i�\}}|j�|�\}}||7 }||j�|�7 }|r<|W d � S |j�|�\}}||7 }|j�|�}|rY|W d � S |j�|�W d � S 1 siw Y dS )zB Generates the chunks of lowdata from the list of modules Nr� ) r Zcompile_low_chunksZrender_highstater� Zreconcile_extendZ verify_highZ requisite_inZ apply_excludeZcompile_high_data)r� r� Zst_Z high_datar� Z ext_errorsZ req_in_errorsr' r' r( r� s& �� � $�r� c O sh t � }dd|g}t| t�|��}|d dkr d|d d�S |du r%td ��td td td d d�td dd�d�}t| |t j � |t j � |���}d}d} |D ]} | gdg } t| t�| ��}|d dkri| } nqO| sptd��| dd� |t j � |��g} t| t�| ��}|d dkr�d|d d�S z�| t j � |d�dddt j � |d�dt j � |d �d d d d d!|gt|� d"d#� |�� D � } t| t�tt| ���}|d dkr�t|d ��z2td$ |d% �}|�d&|�}t|t�r�d|v r�|d td< |�d'|�W W d(d)|g}t| t�|�� S t�y% dd*d� Y W d(d)|g}t| t�|�� S w d(d)|g}t| t�|�� w )+a� Executes a Salt function inside a running container .. versionadded:: 2016.11.0 The container does not need to have Salt installed, but Python is required. name Container name or ID function Salt execution module function CLI Example: .. code-block:: bash salt myminion docker.call test.ping salt myminion test.arg arg1 arg2 key1=val1 salt myminion dockerng.call compassionate_mirzakhani test.arg arg1 arg2 key1=val1 �mkdirr_ rT r Fre rm NzMissing function parameterz thin.gen_thinZcachedirrL Zthin_extra_modsr� Z thin_so_mods)Z extra_modsZso_mods)Zpython3z /usr/libexec/platform-pythonz --versionzgPython interpreter cannot be found inside the container. Make sure Python is installed in the containerz-cz>import tarfile; tarfile.open("{0}/{1}").extractall(path="{0}")z salt-callz --metadataz--localz --log-filer[ z --cachedirr/ z--outrY z-lrb z--c S s( g | ]\}}|� d �s|� d|� ��qS )�__�=)r� )rA r_ r* r' r' r( r� � s � �zcall.<locals>.<listcomp>zjson.find_jsonrf �localr� r �-rfz$Can't parse container command output)r� r� � subprocess� list2cmdliner rp r- rU r� rV r� r$ r� r# r� rE r% r& r r� r4 rr r8 )r� �functionrt r^ Zthin_dest_pathZmkdirp_thin_argvrc Z thin_pathZpycmdsZcontainer_python_binZpy_cmdrm Z untar_cmdZ salt_argvr� r� Z rm_thin_argvr' r' r( �call( s� �� �� �� ����� � � r� c K s& |r t | |fi |��S t| fi |��S )a� .. versionadded:: 2019.2.0 Apply states! This function will call highstate or state.sls based on the arguments passed in, ``apply`` is intended to be the main gateway for all state executions. CLI Example: .. code-block:: bash salt 'docker' docker.apply web01 salt 'docker' docker.apply web01 test salt 'docker' docker.apply web01 test,pkgs )r r )r� r� r^ r' r' r( r � s r c K sF |r dd� |� d�D �ng }|�dd�}d|vr d|d< td tfi |��}t| d �}tjjt|td ||d d ��� }|rHt |t �rH|� |� |d � |� |d � |� t | ||||� dd�d�}t� }dd|g} t| t�| ��} | d dkr�d| d d�S d} zRtd |d�} t| |tj�|d�t� dd � t| d tj�|d�| d�} W d d |g} t| t�| �� zt�|� W nH ty� } z t�d || � W Y d} ~ n4d} ~ ww d d |g} t| t�| �� zt�|� W w t�y } z t�d || � W Y d} ~ w d} ~ ww t | t ��sd!td< | S td" | ��s d#td< | S dtd< | S )$a� Apply the states defined by the specified SLS modules to the running container .. versionadded:: 2016.11.0 The container does not need to have Salt installed, but Python is required. name Container name or ID mods : None A string containing comma-separated list of SLS with defined states to apply to the container. saltenv : base Specify the environment from which to retrieve the SLS indicated by the `mods` parameter. pillarenv Specify a Pillar environment to be used when applying states. This can also be set in the minion config file using the :conf_minion:`pillarenv` option. When neither the :conf_minion:`pillarenv` minion config option nor this CLI argument is used, all Pillar environments will be merged together. .. versionadded:: 2018.3.0 pillar Custom Pillar values, passed as a dictionary of key-value pairs .. note:: Values passed this way will override Pillar values set via ``pillar_roots`` or an external Pillar source. .. versionadded:: 2018.3.0 CLI Example: .. code-block:: bash salt myminion docker.sls compassionate_mirzakhani mods=rails,web c S s g | ]}|� � �qS r' )r� )rA r� r' r' r( r� � rL zsls.<locals>.<listcomp>r� r� Nr� rw zstate.get_sls_optsz grains.itemsr� � pillarenv)�pillar_overrider� �grainsr� r� )r� r� r� r� r_ rT r Fre rm zhashutils.get_hashr� zsalt_state.tgzT)r� r� z state.pkgr r� z3docker.sls: Unable to remove state tarball '%s': %sr �state.check_resultr} ) rH rq rp r- r� r+ r� Z get_pillarZcompile_pillarr� r4 r r� r r� r� r� r� r� rV r� r$ r� r7 r� r[ r� rr )r� r� r^ r� r� r� r� Z trans_tarZtrans_dest_pathZmkdirp_trans_argvrc Ztrans_tar_sha256Z rm_trans_argvrb r' r' r( r � s� - �� � � � ��� ���� ��r c K s t | fddi|��S )a� Apply a highstate to the running container .. versionadded:: 2019.2.0 The container does not need to have Salt installed, but Python is required. name Container name or ID saltenv : base Specify the environment from which to retrieve the SLS indicated by the `mods` parameter. CLI Example: .. code-block:: bash salt myminion docker.highstate compassionate_mirzakhani r� rw )r )r� r� r^ r' r' r( r / s �opensuse/pythonc K s� t d d i t�|���}dD ]}z||= W q ty Y qw td |dddd�|��}|d } z:t| � t| |fi |��}|sIt d |�sIt|��|du r_t| | |d �}W t | � t | � |S W t | � t | � |S t | � t | � w ) aX .. versionchanged:: 2018.3.0 The repository and tag must now be passed separately using the ``repository`` and ``tag`` arguments, rather than together in the (now deprecated) ``image`` argument. Build a Docker image using the specified SLS modules on top of base image .. versionadded:: 2016.11.0 The base image does not need to have Salt installed, but Python is required. repository Repository name for the image to be built .. versionadded:: 2018.3.0 tag : latest Tag name for the image to be built .. versionadded:: 2018.3.0 name .. deprecated:: 2018.3.0 Use both ``repository`` and ``tag`` instead base : opensuse/python Name or ID of the base image mods A string containing comma-separated list of SLS with defined states to apply to the base image. saltenv : base Specify the environment from which to retrieve the SLS indicated by the `mods` parameter. pillarenv Specify a Pillar environment to be used when applying states. This can also be set in the minion config file using the :conf_minion:`pillarenv` option. When neither the :conf_minion:`pillarenv` minion config option nor this CLI argument is used, all Pillar environments will be merged together. .. versionadded:: 2018.3.0 pillar Custom Pillar values, passed as a dictionary of key-value pairs .. note:: Values passed this way will override Pillar values set via ``pillar_roots`` or an external Pillar source. .. versionadded:: 2018.3.0 dryrun: False when set to True the container will not be committed at the end of the build. The dryrun succeed also when the state contains errors. **RETURN DATA** A dictionary with the ID of the new container. In case of a dryrun, the state result is returned and the container gets removed. CLI Example: .. code-block:: bash salt myminion docker.sls_build imgname base=mybase mods=rails,web rm )r� r� rm � interactive�ttyr� zsleep infinityT)r� rm r� r� r� r� F)r Nr' ) rp r� r� r� r� r r r r3 r r ) r. r rw r� Zdryrunr^ r r_ rc r� r' r' r( � sls_buildH s: J ����� r� r0 )NFTN)r< )F)FF)NFF)FFN) NNNTTFNNN)r2 NN)r2 F)NN)rj )FFFFFN)NNNTr\ FFN) rw NNNNTr\ FFN)NNTr\ FFN)NNr� )rw )r2 r� NF)��__doc__r� r� r� rz r� rY �loggingrV r� r� r~ r� r� r� r� Zsalt.client.ssh.stater+ Zsalt.exceptionsZsalt.fileclientZ salt.pillarZ(salt.utils.dockermod.translate.containerZ&salt.utils.dockermod.translate.networkZsalt.utils.functoolsZsalt.utils.jsonZsalt.utils.pathr r Zsalt.loader.dunderr Z salt.stater Z __docformat__r r � ImportErrorr� r r� r� r rX r� �whichr� � getLoggerr; r[ Z__func_alias__r! r r� �objectrT r" Z__virtual_aliases__Z__proxyenabled__Z __outputter__r) r. � JSONDecoderr/ r rd rk r} r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r! Zalias_functionr" r; rN rQ r^ rn r{ r| r r� r� r� rO r r r� r� r� r� r� r� r� r r� r� r� r r r ZCLIENT_TIMEOUTr� r� r� r� r� r r r r! r3 r: r r< rB r� r� r8 rL r r rQ rT r6 rY rZ r[ r r] r_ r� ra rd ri r� r r r rk rl rn r9 rv r� rT r� r� r� r� r� r� r� r� r� r� r r r r� r' r' r' r( �<module> s� G � � � � �( 5" & 0 ; 3 � <Z� ~ d.]T&* VF:! ER IL C$ � � oc 4 +I � 0 I ; ]q �d �^ L C 3, � - * ! # ! E ! H �i�%�O �@ �@ �F �A �A �U �M v |�
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings