File Manager

003 File Manager

Current Path: /usr/local/lib/python3.8/site-packages/salt/states

usr / local / lib / python3.8 / site-packages / salt / states /

📁 ..
📄 __init__.py(25 B)
📁 __pycache__
📄 acme.py(5.08 KB)
📄 alias.py(2.49 KB)
📄 alternatives.py(6.75 KB)
📄 ansiblegate.py(7.61 KB)
📄 apache.py(3.95 KB)
📄 apache_conf.py(2.72 KB)
📄 apache_module.py(2.73 KB)
📄 apache_site.py(2.66 KB)
📄 aptpkg.py(1.42 KB)
📄 archive.py(67.76 KB)
📄 artifactory.py(6.84 KB)
📄 at.py(7.54 KB)
📄 augeas.py(10.57 KB)
📄 aws_sqs.py(2.59 KB)
📄 azurearm_compute.py(10.86 KB)
📄 azurearm_dns.py(25.09 KB)
📄 azurearm_network.py(87.86 KB)
📄 azurearm_resource.py(27.22 KB)
📄 beacon.py(7.58 KB)
📄 bigip.py(96.63 KB)
📄 blockdev.py(5.13 KB)
📄 boto3_elasticache.py(48.01 KB)
📄 boto3_elasticsearch.py(32.6 KB)
📄 boto3_route53.py(37.54 KB)
📄 boto3_sns.py(12.69 KB)
📄 boto_apigateway.py(82.78 KB)
📄 boto_asg.py(31.93 KB)
📄 boto_cfn.py(11.53 KB)
📄 boto_cloudfront.py(6.01 KB)
📄 boto_cloudtrail.py(13.18 KB)
📄 boto_cloudwatch_alarm.py(6.4 KB)
📄 boto_cloudwatch_event.py(12.33 KB)
📄 boto_cognitoidentity.py(13.69 KB)
📄 boto_datapipeline.py(18.5 KB)
📄 boto_dynamodb.py(29.32 KB)
📄 boto_ec2.py(71.98 KB)
📄 boto_elasticache.py(16.75 KB)
📄 boto_elasticsearch_domain.py(12.27 KB)
📄 boto_elb.py(55.1 KB)
📄 boto_elbv2.py(12.19 KB)
📄 boto_iam.py(69.16 KB)
📄 boto_iam_role.py(27.12 KB)
📄 boto_iot.py(25.33 KB)
📄 boto_kinesis.py(16.69 KB)
📄 boto_kms.py(12.11 KB)
📄 boto_lambda.py(35.52 KB)
📄 boto_lc.py(11.04 KB)
📄 boto_rds.py(26 KB)
📄 boto_route53.py(19.38 KB)
📄 boto_s3.py(9.32 KB)
📄 boto_s3_bucket.py(24.67 KB)
📄 boto_secgroup.py(32.62 KB)
📄 boto_sns.py(8.92 KB)
📄 boto_sqs.py(7.97 KB)
📄 boto_vpc.py(61.77 KB)
📄 bower.py(8.26 KB)
📄 btrfs.py(10.31 KB)
📄 cabal.py(5.73 KB)
📄 ceph.py(1.9 KB)
📄 chef.py(3.68 KB)
📄 chocolatey.py(17.33 KB)
📄 chronos_job.py(4.6 KB)
📄 cimc.py(14.32 KB)
📄 cisconso.py(3.14 KB)
📄 cloud.py(14.4 KB)
📄 cmd.py(41.24 KB)
📄 composer.py(8.38 KB)
📄 cron.py(23.39 KB)
📄 cryptdev.py(6.17 KB)
📄 csf.py(9.98 KB)
📄 cyg.py(7.05 KB)
📄 ddns.py(4.2 KB)
📄 debconfmod.py(6.33 KB)
📄 dellchassis.py(24.49 KB)
📄 disk.py(6.49 KB)
📄 docker_container.py(85.27 KB)
📄 docker_image.py(16.38 KB)
📄 docker_network.py(36.34 KB)
📄 docker_volume.py(6.72 KB)
📄 drac.py(4.17 KB)
📄 dvs.py(26.29 KB)
📄 elasticsearch.py(20.38 KB)
📄 elasticsearch_index.py(3.25 KB)
📄 elasticsearch_index_template.py(3.67 KB)
📄 environ.py(5.81 KB)
📄 eselect.py(2.27 KB)
📄 esxcluster.py(21.16 KB)
📄 esxdatacenter.py(3.24 KB)
📄 esxi.py(61.77 KB)
📄 esxvm.py(18.86 KB)
📄 etcd_mod.py(8.36 KB)
📄 ethtool.py(7.84 KB)
📄 event.py(2.48 KB)
📄 file.py(299.79 KB)
📄 firewall.py(1.33 KB)
📄 firewalld.py(26.08 KB)
📄 gem.py(7.13 KB)
📄 git.py(124.23 KB)
📄 github.py(27.25 KB)
📄 glance_image.py(2.26 KB)
📄 glassfish.py(21.47 KB)
📄 glusterfs.py(12.12 KB)
📄 gnomedesktop.py(7.47 KB)
📄 gpg.py(5.28 KB)
📄 grafana.py(12.11 KB)
📄 grafana4_dashboard.py(17.31 KB)
📄 grafana4_datasource.py(6.15 KB)
📄 grafana4_org.py(7.73 KB)
📄 grafana4_user.py(5.52 KB)
📄 grafana_dashboard.py(17.74 KB)
📄 grafana_datasource.py(5.31 KB)
📄 grains.py(15.57 KB)
📄 group.py(9.57 KB)
📄 heat.py(9.69 KB)
📄 helm.py(10.39 KB)
📄 hg.py(6.33 KB)
📄 highstate_doc.py(1.41 KB)
📄 host.py(8.64 KB)
📄 http.py(7.43 KB)
📄 icinga2.py(9.07 KB)
📄 idem.py(3.91 KB)
📄 ifttt.py(2.12 KB)
📄 incron.py(5.71 KB)
📄 influxdb08_database.py(2.85 KB)
📄 influxdb08_user.py(3.39 KB)
📄 influxdb_continuous_query.py(2.81 KB)
📄 influxdb_database.py(2.11 KB)
📄 influxdb_retention_policy.py(4.82 KB)
📄 influxdb_user.py(4.84 KB)
📄 infoblox_a.py(4.24 KB)
📄 infoblox_cname.py(4.19 KB)
📄 infoblox_host_record.py(6.59 KB)
📄 infoblox_range.py(6.85 KB)
📄 ini_manage.py(12.67 KB)
📄 ipmi.py(8.39 KB)
📄 ipset.py(9.66 KB)
📄 iptables.py(25.96 KB)
📄 jboss7.py(23.95 KB)
📄 jenkins.py(3.36 KB)
📄 junos.py(17.78 KB)
📄 kapacitor.py(6.46 KB)
📄 kernelpkg.py(6.42 KB)
📄 keyboard.py(2.01 KB)
📄 keystone.py(27.12 KB)
📄 keystone_domain.py(2.81 KB)
📄 keystone_endpoint.py(4.69 KB)
📄 keystone_group.py(3.25 KB)
📄 keystone_project.py(3.36 KB)
📄 keystone_role.py(2.33 KB)
📄 keystone_role_grant.py(4.08 KB)
📄 keystone_service.py(2.89 KB)
📄 keystone_user.py(3.47 KB)
📄 keystore.py(5.29 KB)
📄 kmod.py(8.38 KB)
📄 kubernetes.py(24.87 KB)
📄 layman.py(2.44 KB)
📄 ldap.py(19.78 KB)
📄 libcloud_dns.py(5.7 KB)
📄 libcloud_loadbalancer.py(5.66 KB)
📄 libcloud_storage.py(5.13 KB)
📄 linux_acl.py(24.43 KB)
📄 locale.py(2.52 KB)
📄 logadm.py(4.73 KB)
📄 logrotate.py(3.86 KB)
📄 loop.py(7.74 KB)
📄 lvm.py(13.33 KB)
📄 lvs_server.py(6.28 KB)
📄 lvs_service.py(4.38 KB)
📄 lxc.py(22.17 KB)
📄 lxd.py(7.88 KB)
📄 lxd_container.py(22.25 KB)
📄 lxd_image.py(10.59 KB)
📄 lxd_profile.py(7.11 KB)
📄 mac_assistive.py(1.59 KB)
📄 mac_keychain.py(5.59 KB)
📄 mac_xattr.py(3.15 KB)
📄 macdefaults.py(2.65 KB)
📄 macpackage.py(6.76 KB)
📄 makeconf.py(6.87 KB)
📄 marathon_app.py(4.45 KB)
📄 mdadm_raid.py(6.41 KB)
📄 memcached.py(3.95 KB)
📄 modjk.py(2.84 KB)
📄 modjk_worker.py(6.49 KB)
📄 module.py(17.99 KB)
📄 mongodb_database.py(1.65 KB)
📄 mongodb_user.py(6.26 KB)
📄 monit.py(2.68 KB)
📄 mount.py(49.55 KB)
📄 mssql_database.py(3 KB)
📄 mssql_login.py(3.64 KB)
📄 mssql_role.py(2.37 KB)
📄 mssql_user.py(3.51 KB)
📄 msteams.py(2.53 KB)
📄 mysql_database.py(6.05 KB)
📄 mysql_grants.py(8.49 KB)
📄 mysql_query.py(13.07 KB)
📄 mysql_user.py(9.51 KB)
📄 net_napalm_yang.py(9.15 KB)
📄 netacl.py(31.92 KB)
📄 netconfig.py(33.42 KB)
📄 netntp.py(12.48 KB)
📄 netsnmp.py(11.33 KB)
📄 netusers.py(16.1 KB)
📄 network.py(23.7 KB)
📄 neutron_network.py(3.96 KB)
📄 neutron_secgroup.py(4 KB)
📄 neutron_secgroup_rule.py(4.75 KB)
📄 neutron_subnet.py(4.29 KB)
📄 nexus.py(4.97 KB)
📄 nfs_export.py(4.92 KB)
📄 nftables.py(19.5 KB)
📄 npm.py(11.21 KB)
📄 ntp.py(2.12 KB)
📄 nxos.py(10.67 KB)
📄 nxos_upgrade.py(3.5 KB)
📄 openstack_config.py(3.26 KB)
📄 openvswitch_bridge.py(3.13 KB)
📄 openvswitch_port.py(17.25 KB)
📄 opsgenie.py(4.07 KB)
📄 pagerduty.py(1.89 KB)
📄 pagerduty_escalation_policy.py(5.42 KB)
📄 pagerduty_schedule.py(6.09 KB)
📄 pagerduty_service.py(3.93 KB)
📄 pagerduty_user.py(1.18 KB)
📄 panos.py(48.13 KB)
📄 pbm.py(20.46 KB)
📄 pcs.py(36.46 KB)
📄 pdbedit.py(3.48 KB)
📄 pecl.py(3.65 KB)
📄 pip_state.py(37.55 KB)
📄 pkg.py(127.05 KB)
📄 pkgbuild.py(11.37 KB)
📄 pkgng.py(685 B)
📄 pkgrepo.py(23.59 KB)
📄 portage_config.py(5.01 KB)
📄 ports.py(5.65 KB)
📄 postgres_cluster.py(4.19 KB)
📄 postgres_database.py(6.08 KB)
📄 postgres_extension.py(5.68 KB)
📄 postgres_group.py(8.52 KB)
📄 postgres_initdb.py(2.84 KB)
📄 postgres_language.py(3.94 KB)
📄 postgres_privileges.py(7.86 KB)
📄 postgres_schema.py(4.34 KB)
📄 postgres_tablespace.py(6.62 KB)
📄 postgres_user.py(9.49 KB)
📄 powerpath.py(2.34 KB)
📄 probes.py(15.06 KB)
📄 process.py(1.32 KB)
📄 proxy.py(4.94 KB)
📄 pushover.py(3.13 KB)
📄 pyenv.py(6.07 KB)
📄 pyrax_queues.py(2.97 KB)
📄 quota.py(1.4 KB)
📄 rabbitmq_cluster.py(1.84 KB)
📄 rabbitmq_plugin.py(2.77 KB)
📄 rabbitmq_policy.py(4.58 KB)
📄 rabbitmq_upstream.py(7.9 KB)
📄 rabbitmq_user.py(8.89 KB)
📄 rabbitmq_vhost.py(3.04 KB)
📄 rbac_solaris.py(6.67 KB)
📄 rbenv.py(7.36 KB)
📄 rdp.py(1.28 KB)
📄 redismod.py(4.76 KB)
📄 reg.py(19.22 KB)
📄 rsync.py(4.45 KB)
📄 rvm.py(6.56 KB)
📄 salt_proxy.py(1.34 KB)
📄 saltmod.py(30.88 KB)
📄 saltutil.py(8.91 KB)
📄 schedule.py(11.89 KB)
📄 selinux.py(18.61 KB)
📄 serverdensity_device.py(6.41 KB)
📄 service.py(37.06 KB)
📄 slack.py(4.98 KB)
📄 smartos.py(44.89 KB)
📄 smtp.py(2.3 KB)
📄 snapper.py(7.24 KB)
📄 solrcloud.py(4.48 KB)
📄 splunk.py(4.32 KB)
📄 splunk_search.py(3.17 KB)
📄 sqlite3.py(14.7 KB)
📄 ssh_auth.py(19.1 KB)
📄 ssh_known_hosts.py(7.87 KB)
📄 stateconf.py(494 B)
📄 status.py(2.21 KB)
📄 statuspage.py(17.29 KB)
📄 supervisord.py(10.48 KB)
📄 svn.py(8.14 KB)
📄 sysctl.py(3.82 KB)
📄 syslog_ng.py(2.97 KB)
📄 sysrc.py(2.82 KB)
📄 telemetry_alert.py(7.04 KB)
📄 test.py(13.09 KB)
📄 testinframod.py(1.35 KB)
📄 timezone.py(3.42 KB)
📄 tls.py(1.81 KB)
📄 tomcat.py(9.72 KB)
📄 trafficserver.py(8.82 KB)
📄 tuned.py(3.32 KB)
📄 uptime.py(1.87 KB)
📄 user.py(35.43 KB)
📄 vagrant.py(11.4 KB)
📄 vault.py(3.28 KB)
📄 vbox_guest.py(4.05 KB)
📄 victorops.py(3.32 KB)
📄 virt.py(80.06 KB)
📄 virtualenv_mod.py(11.21 KB)
📄 webutil.py(3.78 KB)
📄 win_certutil.py(2.88 KB)
📄 win_dacl.py(7.96 KB)
📄 win_dism.py(13.02 KB)
📄 win_dns_client.py(8.32 KB)
📄 win_firewall.py(6.87 KB)
📄 win_iis.py(31.56 KB)
📄 win_lgpo.py(25.41 KB)
📄 win_license.py(1.6 KB)
📄 win_network.py(14.18 KB)
📄 win_path.py(6.39 KB)
📄 win_pki.py(5.56 KB)
📄 win_powercfg.py(3.79 KB)
📄 win_servermanager.py(10.4 KB)
📄 win_smtp_server.py(10.01 KB)
📄 win_snmp.py(6.64 KB)
📄 win_system.py(13.78 KB)
📄 win_wua.py(14.47 KB)
📄 win_wusa.py(3.53 KB)
📄 winrepo.py(2.74 KB)
📄 wordpress.py(4.82 KB)
📄 x509.py(26.98 KB)
📄 xml.py(1.75 KB)
📄 xmpp.py(2.61 KB)
📄 zabbix_action.py(9.35 KB)
📄 zabbix_host.py(27.25 KB)
📄 zabbix_hostgroup.py(5.64 KB)
📄 zabbix_mediatype.py(16.89 KB)
📄 zabbix_template.py(35.14 KB)
📄 zabbix_user.py(15.76 KB)
📄 zabbix_usergroup.py(9.64 KB)
📄 zabbix_usermacro.py(9.69 KB)
📄 zabbix_valuemap.py(8.11 KB)
📄 zcbuildout.py(5.16 KB)
📄 zenoss.py(2.89 KB)
📄 zfs.py(34.27 KB)
📄 zk_concurrency.py(5.81 KB)
📄 zone.py(46.49 KB)
📄 zookeeper.py(11.53 KB)
📄 zpool.py(13.08 KB)

Editing: docker_image.py

"""
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.
"""

import logging

import salt.utils.args
import salt.utils.dockermod
from salt.exceptions import CommandExecutionError

# Enable proper logging
log = logging.getLogger(__name__)

# Define the module's virtual name
__virtualname__ = "docker_image"
__virtual_aliases__ = ("moby_image",)

def __virtual__():
    """
    Only load if the docker execution module is available
    """
    if "docker.version" in __salt__:
        return __virtualname__
    return (False, __salt__.missing_fun_string("docker.version"))

def present(
    name,
    tag=None,
    build=None,
    load=None,
    force=False,
    insecure_registry=False,
    client_timeout=salt.utils.dockermod.CLIENT_TIMEOUT,
    dockerfile=None,
    sls=None,
    base="opensuse/python",
    saltenv="base",
    pillarenv=None,
    pillar=None,
    **kwargs
):
    """
    .. 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.save
        <salt.modules.dockermod.save>` (or the ``docker save`` 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-separated 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
    """
    ret = {"name": name, "changes": {}, "result": False, "comment": ""}

if not isinstance(name, str):
        name = str(name)

# At most one of the args that result in an image being built can be used
    num_build_args = len([x for x in (build, load, sls) if x is not None])
    if num_build_args > 1:
        ret["comment"] = "Only one of 'build', 'load', or 'sls' is permitted."
        return ret
    elif num_build_args == 1:
        # If building, we need the tag to be specified
        if not tag:
            ret["comment"] = (
                "The 'tag' argument is required if any one of 'build', "
                "'load', or 'sls' is used."
            )
            return ret
        if not isinstance(tag, str):
            tag = str(tag)
        full_image = ":".join((name, tag))
    else:
        if tag:
            name = "{}:{}".format(name, tag)
        full_image = name

try:
        image_info = __salt__["docker.inspect_image"](full_image)
    except CommandExecutionError as exc:
        msg = exc.__str__()
        if "404" in msg:
            # Image not present
            image_info = None
        else:
            ret["comment"] = msg
            return ret

if image_info is not None:
        # Specified image is present
        if not force:
            ret["result"] = True
            ret["comment"] = "Image {} already present".format(full_image)
            return ret

if build or sls:
        action = "built"
    elif load:
        action = "loaded"
    else:
        action = "pulled"

if __opts__["test"]:
        ret["result"] = None
        if (image_info is not None and force) or image_info is None:
            ret["comment"] = "Image {} will be {}".format(full_image, action)
            return ret

if build:
        # Get the functions default value and args
        argspec = salt.utils.args.get_function_argspec(__salt__["docker.build"])
        # Map any if existing args from kwargs into the build_args dictionary
        build_args = dict(list(zip(argspec.args, argspec.defaults)))
        for k in build_args:
            if k in kwargs.get("kwargs", {}):
                build_args[k] = kwargs.get("kwargs", {}).get(k)
        try:
            # map values passed from the state to the build args
            build_args["path"] = build
            build_args["repository"] = name
            build_args["tag"] = tag
            build_args["dockerfile"] = dockerfile
            image_update = __salt__["docker.build"](**build_args)
        except Exception as exc:  # pylint: disable=broad-except
            ret["comment"] = "Encountered error building {} as {}: {}".format(
                build, full_image, exc
            )
            return ret
        if image_info is None or image_update["Id"] != image_info["Id"][:12]:
            ret["changes"] = image_update

elif sls:
        _locals = locals()
        sls_build_kwargs = {
            k: _locals[k]
            for k in ("saltenv", "pillarenv", "pillar")
            if _locals[k] is not None
        }
        try:
            image_update = __salt__["docker.sls_build"](
                repository=name, tag=tag, base=base, mods=sls, **sls_build_kwargs
            )
        except Exception as exc:  # pylint: disable=broad-except
            ret[
                "comment"
            ] = "Encountered error using SLS {} for building {}: {}".format(
                sls, full_image, exc
            )
            return ret
        if image_info is None or image_update["Id"] != image_info["Id"][:12]:
            ret["changes"] = image_update

elif load:
        try:
            image_update = __salt__["docker.load"](path=load, repository=name, tag=tag)
        except Exception as exc:  # pylint: disable=broad-except
            ret["comment"] = "Encountered error loading {} as {}: {}".format(
                load, full_image, exc
            )
            return ret
        if image_info is None or image_update.get("Layers", []):
            ret["changes"] = image_update

else:
        try:
            image_update = __salt__["docker.pull"](
                name, insecure_registry=insecure_registry, client_timeout=client_timeout
            )
        except Exception as exc:  # pylint: disable=broad-except
            ret["comment"] = "Encountered error pulling {}: {}".format(full_image, exc)
            return ret
        if (
            image_info is not None
            and image_info["Id"][:12]
            == image_update.get("Layers", {}).get("Already_Pulled", [None])[0]
        ):
            # Image was pulled again (because of force) but was also
            # already there. No new image was available on the registry.
            pass
        elif image_info is None or image_update.get("Layers", {}).get("Pulled"):
            # Only add to the changes dict if layers were pulled
            ret["changes"] = image_update

error = False

try:
        __salt__["docker.inspect_image"](full_image)
    except CommandExecutionError as exc:
        msg = exc.__str__()
        if "404" not in msg:
            error = "Failed to inspect image '{}' after it was {}: {}".format(
                full_image, action, msg
            )

if error:
        ret["comment"] = error
    else:
        ret["result"] = True
        if not ret["changes"]:
            ret["comment"] = "Image '{}' was {}, but there were no changes".format(
                name, action
            )
        else:
            ret["comment"] = "Image '{}' was {}".format(full_image, action)
    return ret

def absent(name=None, images=None, force=False):
    """
    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.
    """
    ret = {"name": name, "changes": {}, "result": False, "comment": ""}

if not name and not images:
        ret["comment"] = "One of 'name' and 'images' must be provided"
        return ret
    elif images is not None:
        targets = images
    elif name:
        targets = [name]

to_delete = []
    for target in targets:
        resolved_tag = __salt__["docker.resolve_tag"](target)
        if resolved_tag is not False:
            to_delete.append(resolved_tag)

if not to_delete:
        ret["result"] = True
        if len(targets) == 1:
            ret["comment"] = "Image {} is not present".format(name)
        else:
            ret["comment"] = "All specified images are not present"
        return ret

if __opts__["test"]:
        ret["result"] = None
        if len(to_delete) == 1:
            ret["comment"] = "Image {} will be removed".format(to_delete[0])
        else:
            ret["comment"] = "The following images will be removed: {}".format(
                ", ".join(to_delete)
            )
        return ret

result = __salt__["docker.rmi"](*to_delete, force=force)
    post_tags = __salt__["docker.list_tags"]()
    failed = [x for x in to_delete if x in post_tags]

if failed:
        if [x for x in to_delete if x not in post_tags]:
            ret["changes"] = result
            ret["comment"] = "The following image(s) failed to be removed: {}".format(
                ", ".join(failed)
            )
        else:
            ret["comment"] = "None of the specified images were removed"
            if "Errors" in result:
                ret["comment"] += ". The following errors were encountered: {}".format(
                    "; ".join(result["Errors"])
                )
    else:
        ret["changes"] = result
        if len(to_delete) == 1:
            ret["comment"] = "Image {} was removed".format(to_delete[0])
        else:
            ret["comment"] = "The following images were removed: {}".format(
                ", ".join(to_delete)
            )
        ret["result"] = True

return ret

def mod_watch(name, sfun=None, **kwargs):
    """
    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.
    """
    if sfun == "present":
        # Force image to be updated
        kwargs["force"] = True
        return present(name, **kwargs)

return {
        "name": name,
        "changes": {},
        "result": False,
        "comment": "watch requisite is not implemented for {}".format(sfun),
    }

003 File Manager

Editing: docker_image.py

Upload File

Create Folder