ansible/cloud/docker/docker_image.py

#!/usr/bin/python
#
# Copyright 2016 Red Hat | Ansible
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.

DOCUMENTATION = '''
---
module: docker_image

short_description: Manage docker images.

version_added: "1.5"

description:
     - Build, load or pull an image, making the image available for creating containers. Also supports tagging an
       image into a repository and archiving an image to a .tar file.

options:
  archive_path:
    description:
      - Use with state 'present' to archive an image to a .tar file.
    required: false
    default: null
  dockerfile:
    description:
      - Use with state 'present' to provide an alternate name for the Dockerfile to use when building an image.
    default: Dockerfile
  force:
    description:
      - Use with absent state to un-tag and remove all images matching the specified name. Use with states 'present'
        and 'tagged' to take action even when an image already exists. If archive_path is specified, the force option
        will cause an existing archive to be overwritten.
    default: false
  http_timeout:
    description:
      - Timeout for HTTP requests during the image build operation. Provide a positive integer value for the number of
        seconds.
    default: null
    required: false
  name:
    description:
      - "Image name. Name format will be one of: name, repository/name, registry_server:port/name.
        When pushing or pulling an image the name can optionally include the tag by appending ':tag_name'."
    required: true
  path:
    description:
      - Use with state 'present' to build an image. Will be the path to a directory containing the context and
        Dockerfile for building an image.
    aliases:
      - build_path
    default: null
    required: false
  pull:
    description:
      - When building an image downloads any updates to the FROM image in Dockerfile.
    default: true
  rm:
    description:
      - Remove intermediate containers after build.
    default: true
  nocache:
    description:
      - Do not use cache when building an image.
    default: false
  repository:
    description:
      - Full path to a repository. Use with state 'present' to tag the image into the repository.
    required: false
    default: null
  state:
    description:
      - Make assertions about the state of an image.
      - When 'absent' an image will be removed. Use the force option to un-tag and remove all images
        matching the provided name.
      - When 'present' check if an image exists using the provided name and tag. If the image is not found or the
        force option is used, the image will either be pulled, built or loaded. By default the image will be pulled
        from Docker Hub. To build the image, provide a path value set to a directory containing a context and
        Dockerfile. To load an image, specify load_path to provide a path to an archive file. To tag an image to a
        repository, provide a repository path. If the name contains a repository path, it will be pushed.
      - "NOTE: 'build' is DEPRECATED. Specifying 'build' will behave the same as 'present'."
    default: present
    choices:
      - absent
      - present
      - build (DEPRECATED)
  tag:
    description:
      - Used to select an image when pulling. Will be added to the image when pushing, tagging or building. Defaults to
       'latest' when pulling an image.
    default: latest
  use_tls:
    description:
      - "DEPRECATED. Whether to use tls to connect to the docker server. Set to 'no' when TLS will not be used. Set to
        'encrypt' to use TLS. And set to 'verify' to use TLS and verify that the server's certificate is valid for the
        server. NOTE: If you specify this option, it will set the value of the tls or tls_verify parameters."
    choices:
      - no
      - encrypt
      - verify
    default: no
    version_added: "2.0"

extends_documentation_fragment:
    - docker

requirements:
  - "python >= 2.6"
  - "docker-py >= 1.7.0"
  - "Docker API >= 1.20"

authors:
  - Pavel Antonov (@softzilla)
  - Chris Houseknecht (@chouseknecht)
  - James Tanner (@jtanner)

'''

EXAMPLES = '''

- name: pull an image
  docker_image:
    name: pacur/centos-7

- name: Tag to repository to a private registry and push it
  docker_image:
    name: pacur/centos-7
    repository: registry.ansible.com/chouseknecht/centos_images
    tag: 7.0

- name: Remove image
  docker_image:
    state: absent
    name: registry.ansible.com/chouseknecht/sinatra
    tag: v1

- name: Build an image ad push it to a private repo
  docker_image:
    path: ./sinatra
    name: registry.ansible.com/chouseknecht/sinatra
    tag: v1

- name: Archive image
  docker_image:
    name: registry.ansible.com/chouseknecht/sinatra
    tag: v1
    archive_path: my_sinatra.tar

- name: Load image from archive and push it to a private registry
  docker_image:
    name: registry.ansible.com/chouseknecht/sinatra
    tag: v1
    load_path: my_sinatra.tar
'''

RETURN = '''
actions:
    description: List of actions taken by the module.
    returned: always
    type: list
    sample: [
        "Removed image myimage"
    ]
image:
    description: Facts representing the current state of the image.
    returned: always
    type: dict
    sample: {

    }
'''

from ansible.module_utils.docker_common import *

try:
    from docker import auth
    from docker import utils
except ImportError:
    # missing docker-py handled in docker_common
    pass


class ImageManager(DockerBaseClass):

    def __init__(self, client, results):

        super(ImageManager, self).__init__()

        self.client = client
        self.results = results
        parameters = self.client.module.params
        self.check_mode = self.client.check_mode

        self.archive_path = parameters.get('archive_path')
        self.container_limits = parameters.get('container_limits')
        self.dockerfile = parameters.get('dockerfile')
        self.force = parameters.get('force')
        self.load_path = parameters.get('load_path')
        self.name = parameters.get('name')
        self.nocache = parameters.get('nocache')
        self.path = parameters.get('path')
        self.pull = parameters.get('pull')
        self.repository = parameters.get('repository')
        self.rm = parameters.get('rm')
        self.state = parameters.get('state')
        self.tag = parameters.get('tag')
        self.http_timeout = parameters.get('http_timeout')
        self.push = False

        if self.state in ['present', 'build']:
            self.present()
        elif self.state == 'absent':
            self.absent()

    def fail(self, msg):
        self.client.fail(msg)

    def present(self):
        '''
        Handles state = 'present', which includes building, loading or pulling an image,
        depending on user provided parameters.

        :returns None
        '''
        image = self.client.find_image(name=self.name, tag=self.tag)

        if not image or self.force:
            if self.path:
                # build the image
                self.push = True
                params = dict(
                    path=self.path,
                    tag=self.name,
                    rm=self.rm,
                    nocache=self.nocache,
                    stream=True,
                    timeout=self.http_timeout,
                    pull=self.pull,
                    forcerm=self.rm,
                    dockerfile=self.dockerfile,
                    decode=True
                )
                if self.tag:
                    params['tag'] = "%s:%s" % (self.name, self.tag)
                if self.container_limits:
                    params['container_limits'] = self.container_limits,
                self.log("Building image %s" % (params['tag']))
                self.results['actions'].append("Built image %s from %s" % (params['tag'], self.path))
                self.results['changed'] = True
                if not self.check_mode:
                    for line in self.client.build(**params):
                        self.log(line, pretty_print=True)
                image = self.client.find_image(name=self.name, tag=self.tag)
                if image:
                    self.results['image'] = image

            elif self.load_path:
                # Load the image from an archive
                if not os.path.isfile(self.load_path):
                    self.fail("Error loading image %s. Specified path %s does not exist." % (self.name,
                                                                                             self.load_path))
                self.push = True
                name = self.name
                if self.tag:
                    name = "%s:%s" % (self.name, self.tag)

                self.results['actions'].append("Loaded image %s from %s" % (name, self.load_path))
                self.results['changed'] = True
                if not self.check_mode:
                    try:
                        self.log("Reading image data from %s" % (self.load_path))
                        image_tar = open(self.load_path, 'r')
                        image_data = image_tar.read()
                        image_tar.close()
                    except Exception as exc:
                        self.fail("Error reading image data %s - %s" % (self.load_path, str(exc)))

                    try:
                        self.log("Loading image from %s" % (self.load_path))
                        self.client.load_image(image_data)
                    except Exception as exc:
                        self.fail("Error loading image %s - %s" % (name, str(exc)))

                image = self.client.find_image(self.name, self.tag)
                if image:
                    self.results['image'] = image
            else:
                # pull the image
                if not self.check_mode:
                    self.results['actions'].append('Pulled image %s:%s' % (self.name, self.tag))
                    self.client.pull_image(self.name, tag=self.tag)

                self.results['changed'] = True
                image = self.client.find_image(name=self.name, tag=self.tag)
                if image:
                    self.results['image'] = image

        if self.archive_path:
            self.archive_image(self.name, self.tag)

        if self.push and not self.repository:
            self.push_image(self.name, self.tag)
        elif self.repository:
            self.tag_image(self.name, self.tag, self.repository, force=self.force, push=self.push)

    def absent(self):
        '''
        Handles state = 'absent', which removes an image.

        :return None
        '''
        image = self.client.find_image(self.name, self.tag)
        if image:
            name = self.name
            if self.tag:
                name = "%s:%s" % (self.name, self.tag)
            if not self.check_mode:
                try:
                    self.client.remove_image(name, force=self.force)
                except Exception as exc:
                    self.fail("Error removing image %s - %s" % (name, str(exc)))

            self.results['changed'] = True
            self.results['actions'].append("Removed image %s" % (name))
            self.results['image']['state'] = 'Deleted'

    def archive_image(self, name, tag):
        '''
        Archive an image to a .tar file. Called when archive_path is passed.

        :param name - name of the image. Type: str
        :return None
        '''
        if not tag:
            tag = "latest"
        image = self.client.find_image(name=name, tag=tag)
        self.log("archive image:")
        self.log(image, pretty_print=True)
        if image:
            if not os.path.isfile(self.archive_path) or self.force:
                image_name = "%s:%s" % (name, tag)
                try:
                    self.log("Getting archive of image %s" % (image_name))
                    image = self.client.get_image(image_name)
                except Exception as exc:
                    self.fail("Error getting image %s - %s" % (image_name, str(exc)))

                self.results['actions'].append('Archived image %s to %s' % (image_name, self.archive_path))
                self.results['changed'] = True
                if not self.check_mode:
                    try:
                        image_tar = open(self.archive_path, 'w')
                        image_tar.write(image.data)
                        image_tar.close()
                    except Exception as exc:
                        self.fail("Error writing image archive %s - %s" % (self.archive_path, str(exc)))

                image = self.client.find_image(name=name, tag=tag)
                if image:
                    self.results['image'] = image

    def push_image(self, name, tag=None):
        '''
        If the name of the image contains a repository path, then push the image.

        :param name Name of the image to push.
        :param tag Use a specific tag.
        :return: None
        '''

        repository = name
        if not tag:
            repository, tag = utils.parse_repository_tag(name)
        registry, repo_name = auth.resolve_repository_name(repository)

        if re.search('/', repository):

            if registry:
                config = auth.load_config()
                if not auth.resolve_authconfig(config, registry):
                    self.fail("Error: configuration for %s not found. Try logging into %s first." % registry)

            try:
                self.log("pushing image %s" % (repository))
                status = None
                self.results['actions'].append("Pushed image %s to %s:%s" % (self.name, self.repository, self.tag))
                self.results['changed'] = True
                if not self.check_mode:
                    for line in self.client.push(repository, tag=tag, stream=True):
                        response = json.loads(line)
                        self.log(response, pretty_print=True)
                        if response.get('errorDetail'):
                            # there was an error
                            raise Exception(response['errorDetail']['message'])
                        status = response.get('status')
                image = self.client.find_image(name=repository, tag=tag)
                if image:
                    self.results['image'] = image
                self.results['image']['push_status'] = status
            except Exception as exc:
                if re.search('unauthorized', str(exc)):
                    self.fail("Error pushing image %s: %s. Does the repository exist?" % (repository, str(exc)))
                self.fail("Error pushing image %s: %s" % (repository, str(exc)))

    def tag_image(self, name, tag, repository, force=False, push=False):
        '''
        Tag an image into a repository.

        :param name: name of the image. required.
        :param tag: image tag.
        :param repository: path to the repository. required.
        :param force: bool. force tagging, even it image already exists with the repository path.
        :param push: bool. push the image once it's tagged.
        :return: None
        '''
        repo, repo_tag = utils.parse_repository_tag(repository)
        image = self.client.find_image(name=repo, tag=repo_tag)
        found = 'found' if image else 'not found'
        self.log("image %s was %s" % (repo, found))
        if not image or force:
            try:
                self.log("tagging %s:%s to %s" % (name, tag, repository))
                self.results['changed'] = True
                self.results['actions'].append("Tagged image %s:%s to %s" % (name, tag, repository))
                if not self.check_mode:
                    # Finding the image does not always work, especially running a localhost registry. In those
                    # cases, if we don't set force=True, it errors.
                    image_name = name
                    if tag and not re.search(tag, name):
                        image_name = "%s:%s" % (name, tag)
                    tag_status = self.client.tag(image_name, repository, tag=tag, force=True)
                    if not tag_status:
                        raise Exception("Tag operation failed.")
                image = self.client.find_image(name=repository, tag=tag)
                if image:
                    self.results['image'] = image
            except Exception as exc:
                self.fail("Error: failed to tag image %s - %s" % (name, str(exc)))

            self.push_image(repository, tag)


def main():
    argument_spec = dict(
        archive_path=dict(type='str'),
        container_limits=dict(type='dict'),
        dockerfile=dict(type='str'),
        force=dict(type='bool', default=False),
        http_timeout=dict(type='int'),
        load_path=dict(type='str'),
        name=dict(type='str', required=True),
        nocache=dict(type='str', default=False),
        path=dict(type='str', aliases=['build_path']),
        pull=dict(type='bool', default=True),
        repository=dict(type='str'),
        rm=dict(type='bool', default=True),
        state=dict(type='str', choices=['absent', 'present'], default='present'),
        tag=dict(type='str', default='latest'),
        use_tls=dict(type='str', default='no', choices=['no', 'encrypt', 'verify'])
    )

    client = AnsibleDockerClient(
        argument_spec=argument_spec,
        supports_check_mode=True,
    )

    results = dict(
        changed=False,
        actions=[],
        image={}
    )

    ImageManager(client, results)
    client.module.exit_json(**results)


# import module snippets
from ansible.module_utils.basic import *

if __name__ == '__main__':
    main()