Current File : //lib/python2.7/site-packages/salt/states/docker_image.pyo
�
���^c
@@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l m
Z
d d l m Z d d l
m Z e j e � Z d Z d f Z d � Z e e e e e e j j j e e d
d e e d � Z e e e d
� Z e d � Z d S( uv
Management of Docker images
.. versionadded:: 2017.7.0
:depends: docker_ Python module
.. note::
Older releases of the Python bindings for Docker were called docker-py_ in
PyPI. All releases of docker_, and releases of docker-py_ >= 1.6.0 are
supported. These python bindings can easily be installed using
:py:func:`pip.install <salt.modules.pip.install>`:
.. code-block:: bash
salt myminion pip.install docker
To upgrade from docker-py_ to docker_, you must first uninstall docker-py_,
and then install docker_:
.. code-block:: bash
salt myminion pip.uninstall docker-py
salt myminion pip.install docker
.. _docker: https://pypi.python.org/pypi/docker
.. _docker-py: https://pypi.python.org/pypi/docker-py
These states were moved from the :mod:`docker <salt.states.docker>` state
module (formerly called **dockerng**) in the 2017.7.0 release.
.. note::
To pull from a Docker registry, authentication must be configured. See
:ref:`here <docker-authentication>` for more information on how to
configure access to docker registries in :ref:`Pillar <pillar>` data.
i ( t absolute_importt print_functiont unicode_literalsN( t zip( t six( t CommandExecutionErroru docker_imageu
moby_imagec C@ s# d t k r t St t j d � f S( u?
Only load if the docker execution module is available
u docker.version( t __salt__t __virtualname__t Falset missing_fun_string( ( ( s< /usr/lib/python2.7/site-packages/salt/states/docker_image.pyt __virtual__8 s u opensuse/pythonu basec
@ s i | d 6i d 6t d 6d d 6} t | t j � sF t j | � } n t g | | | f D] } | d4 k rY | ^ qY � } | d k r� d | d <| S| d k r� | s� d | d <| St | t j � s� t j | � } n d j | | f � } n! | r d
j | | � } n | } y t d | � } WnB t
k
ri} | j � } d | k rXd4 } qj| | d <| Sn X| d4 k r�| s�t | d <d
j | � | d <| Sn | s�| r�d } n | r�d } n d } t
d rd4 | d <| d4 k r�| s�| d4 k rd j | | � | d <| Sn | rPt j j j t d � } t t t | j | j � � � } xT | j � D]F \ } } | |
j d i � k rf|
j d i � j | � | | <qfqfWy< | | d <| | d <| | d <| | d <t d | � } Wn- t k
r} d j | | | � | d <| SX| d4 k s@| d | d d k rO| | d <qOn�| rt � � � f d � d5 D� } y, t d d! | d" | d# | d$ | | � } Wn- t k
r�} d% j | | | � | d <| SX| d4 k s�| d | d d k rO| | d <qOnJ| r�y# t d& d' | d! | d" | � } Wn- t k
r]} d( j | | | � | d <| SX| d4 k s|| j d) g � rO| | d <qOn� y t d* | d+ | d, | �} Wn* t k
r�} d- j | | � | d <| SX| d4 k r| d d | j d) i � j d. d4 g � d/ k rn4 | d4 k sB| j d) i � j d0 � rO| | d <n t } y t d | � WnC t
k
r�} | j � } d | k r�d1 j | | | � } q�n X| r�| | d <nC t | d <| d s�d2 j | | � | d <n d3 j | | � | d <| S(6 u�
.. versionchanged:: 2018.3.0
The ``tag`` argument has been added. It is now required unless pulling
from a registry.
Ensure that an image is present. The image can either be pulled from a
Docker registry, built from a Dockerfile, loaded from a saved image, or
built by running SLS files against a base image.
If none of the ``build``, ``load``, or ``sls`` arguments are used, then Salt
will pull from the :ref:`configured registries <docker-authentication>`. If
the specified image already exists, it will not be pulled unless ``force``
is set to ``True``. Here is an example of a state that will pull an image
from the Docker Hub:
.. code-block:: yaml
myuser/myimage:
docker_image.present:
- tag: mytag
tag
Tag name for the image. Required when using ``build``, ``load``, or
``sls`` to create the image, but optional if pulling from a repository.
.. versionadded:: 2018.3.0
build
Path to directory on the Minion containing a Dockerfile
.. code-block:: yaml
myuser/myimage:
docker_image.present:
- build: /home/myuser/docker/myimage
- tag: mytag
myuser/myimage:
docker_image.present:
- build: /home/myuser/docker/myimage
- tag: mytag
- dockerfile: Dockerfile.alternative
The image will be built using :py:func:`docker.build
<salt.modules.dockermod.build>` and the specified image name and tag
will be applied to it.
.. versionadded:: 2016.11.0
.. versionchanged:: 2018.3.0
The ``tag`` must be manually specified using the ``tag`` argument.
load
Loads a tar archive created with :py:func:`docker.load
<salt.modules.dockermod.load>` (or the ``docker load`` Docker CLI
command), and assigns it the specified repo and tag.
.. code-block:: yaml
myuser/myimage:
docker_image.present:
- load: salt://path/to/image.tar
- tag: mytag
.. versionchanged:: 2018.3.0
The ``tag`` must be manually specified using the ``tag`` argument.
force : False
Set this parameter to ``True`` to force Salt to pull/build/load the
image even if it is already present.
client_timeout
Timeout in seconds for the Docker client. This is not a timeout for
the state, but for receiving a response from the API.
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
sls
Allow for building of image with :py:func:`docker.sls_build
<salt.modules.dockermod.sls_build>` by specifying the SLS files with
which to build. This can be a list or comma-seperated string.
.. code-block:: yaml
myuser/myimage:
docker_image.present:
- tag: latest
- sls:
- webapp1
- webapp2
- base: centos
- saltenv: base
.. versionadded: 2017.7.0
.. versionchanged:: 2018.3.0
The ``tag`` must be manually specified using the ``tag`` argument.
base
Base image with which to start :py:func:`docker.sls_build
<salt.modules.dockermod.sls_build>`
.. versionadded:: 2017.7.0
saltenv
Specify the environment from which to retrieve the SLS indicated by the
`mods` parameter.
.. versionadded:: 2017.7.0
.. versionchanged:: 2018.3.0
Now uses the effective saltenv if not explicitly passed. In earlier
versions, ``base`` was assumed as a default.
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
u nameu changesu resultu u commenti u3 Only one of 'build', 'load', or 'sls' is permitted.uO The 'tag' argument is required if any one of 'build', 'load', or 'sls' is used.u :u {0}:{1}u docker.inspect_imageu 404u Image {0} already presentu builtu loadedu pulledu testu Image {0} will be {1}u docker.buildu kwargsu pathu
repositoryu tagu
dockerfileu* Encountered error building {0} as {1}: {2}u Idi c @ s- i | ]# } � | d k r � | | � q S( N( t None( t .0t k( t _locals( s< /usr/lib/python2.7/site-packages/salt/states/docker_image.pys
<dictcomp>, s u saltenvu pillarenvu pillaru docker.sls_buildt
repositoryt tagt baset modsu5 Encountered error using SLS {0} for building {1}: {2}u docker.loadt pathu) Encountered error loading {0} as {1}: {2}u Layersu docker.pullt insecure_registryt client_timeoutu" Encountered error pulling {0}: {1}u Already_Pulledi u Pulledu3 Failed to inspect image '{0}' after it was {1}: {2}u. Image '{0}' was {1}, but there were no changesu Image '{0}' was {1}N( u saltenvu pillarenvu pillar( R t
isinstanceR t string_typest text_typet lenR t joint formatR R t __str__t Truet __opts__t saltt utilst argst get_function_argspect dictt listR t defaultst itemst gett Exceptiont locals( t nameR t buildt loadt forceR R t
dockerfilet slsR t saltenvt pillarenvt pillart kwargst rett xt num_build_argst
full_imaget
image_infot exct msgt actiont argspect
build_argsR
t vt image_updatet sls_build_kwargst error( ( R s< /usr/lib/python2.7/site-packages/salt/states/docker_image.pyt presentA s� �
4
!&
$
$
'
c C@ s� i | d 6i d 6t d 6d d 6} | r> | r> d | d <| S| d k rS | } n | re | g } n g } x: | D]2 } t d | � } | t k rr | j | � qr qr W| s� t | d <t | � d k r� d j | � | d <n
d
| d <| St d rNd | d <t | � d k r.d j | d
� | d <n d j d j | � � | d <| St d d | | � } t d � } g | D] }
|
| k rx|
^ qx} | r,g | D] }
|
| k r�|
^ q�r�| | d <d j d j | � � | d <q�d | d <d | k r�| d c d j d j | d � � 7<q�n\ | | d <t | � d k rbd j | d
� | d <n d j d j | � � | d <t | d <| S( u#
Ensure that an image is absent from the Minion. Image names can be
specified either using ``repo:tag`` notation, or just the repo name (in
which case a tag of ``latest`` is assumed).
images
Run this state on more than one image at a time. The following two
examples accomplish the same thing:
.. code-block:: yaml
remove_images:
docker_image.absent:
- names:
- busybox
- centos:6
- nginx
.. code-block:: yaml
remove_images:
docker_image.absent:
- images:
- busybox
- centos:6
- nginx
However, the second example will be a bit quicker since Salt will do
all the deletions in a single run, rather than executing the state
separately on each image (as it would in the first example).
force : False
Salt will fail to remove any images currently in use by a container.
Set this option to true to remove the image even if it is already
present.
.. note::
This option can also be overridden by Pillar data. If the Minion
has a pillar variable named ``docker.running.force`` which is
set to ``True``, it will turn on this option. This pillar variable
can even be set at runtime. For example:
.. code-block:: bash
salt myminion state.sls docker_stuff pillar="{docker.force: True}"
If this pillar variable is present and set to ``False``, then it
will turn off this option.
For more granular control, setting a pillar variable named
``docker.force.image_name`` will affect only the named image.
u nameu changesu resultu u commentu+ One of 'name' and 'images' must be providedu docker.resolve_tagi u Image {0} is not presentu$ All specified images are not presentu testu Image {0} will be removedi u) The following images will be removed: {0}u , u
docker.rmiR- u docker.list_tagsu0 The following image(s) failed to be removed: {0}u) None of the specified images were removedu Errorsu, . The following errors were encountered: {0}u ; u Image {0} was removedu& The following images were removed: {0}N( R R R t appendR R R R R ( R* t imagesR- R4 t targetst to_deletet targett resolved_tagt resultt post_tagsR5 t failed( ( s< /usr/lib/python2.7/site-packages/salt/states/docker_image.pyt absentz sb 6
%%
c K@ sL | d k r# t | d <t | | � Si | d 6i d 6t d 6d j | � d 6S( u9
The docker_image watcher, called to invoke the watch command.
.. note::
This state exists to support special handling of the ``watch``
:ref:`requisite <requisites>`. It should not be called directly.
Parameters for this function should be set by the state being triggered.
u presentu forceu nameu changesu resultu* watch requisite is not implemented for {0}u comment( R RB R R ( R* t sfunR3 ( ( s< /usr/lib/python2.7/site-packages/salt/states/docker_image.pyt mod_watch� s
( t __doc__t
__future__R R R t loggingt salt.utils.dockerR t salt.utils.argst salt.ext.six.movesR t salt.extR t salt.exceptionsR t getLoggert __name__t logR t __virtual_aliases__R
R R R t dockert CLIENT_TIMEOUTRB RL RN ( ( ( s< /usr/lib/python2.7/site-packages/salt/states/docker_image.pyt <module>% s4
� .
Mini Shell