Atomic containers (#21366)

* atomic_image: add support for pull --storage=

Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>

* atomic_container: new module

Manage atomic containers

Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>

lib/ansible/modules/cloud/atomic/atomic_container.py

@@ -0,0 +1,223 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# 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/>.
+
+ANSIBLE_METADATA = {'metadata_version': '1.0',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+DOCUMENTATION = '''
+---
+module: atomic_container
+short_description: Manage the containers on the atomic host platform
+description:
+    - Manage the containers on the atomic host platform
+    - Allows to manage the lifecycle of a container on the atomic host platform
+version_added: "2.4"
+author: "Giuseppe Scrivano @gscrivano"
+notes:
+    - Host should support C(atomic) command
+requirements:
+    - atomic
+    - "python >= 2.6"
+options:
+    backend:
+        description:
+          - Define the backend to use for the container
+        required: True
+        choices: ["docker", "ostree"]
+        default: None
+    name:
+        description:
+          - Name of the container
+        required: True
+        default: null
+    image:
+        description:
+          - The image to use to install the container
+        required: True
+        default: null
+    rootfs:
+        description:
+          - Define the rootfs of the image
+        required: False
+        default: null
+    state:
+        description:
+          - State of the container
+        required: True
+        choices: ["latest", "absent", "latest", "rollback"]
+        default: "latest"
+    mode:
+        description:
+          - Define if it is an user or a system container
+        required: True
+        choices: ["user", "system"]
+        default: None
+    values:
+        description:
+            - Values for the installation of the container.  This option is permitted only with mode 'user' or 'system'.
+              The values specified here will be used at installation time as --set arguments for atomic install.
+        required: False
+        default: None
+'''
+
+EXAMPLES = '''
+
+# Install the etcd system container
+- atomic_container:
+    name: etcd
+    image: rhel/etcd
+    backend: ostree
+    state: latest
+    system: True
+    values:
+        - ETCD_NAME=etcd.server
+
+# Uninstall the etcd system container
+- atomic_container:
+    name: etcd
+    image: rhel/etcd
+    backend: ostree
+    state: absent
+    system: True
+'''
+
+RETURN = '''
+msg:
+    description: The command standard output
+    returned: always
+    type: string
+    sample: [u'Using default tag: latest ...']
+'''
+
+# import module snippets
+import traceback
+
+from ansible.module_utils._text import to_native
+from ansible.module_utils.basic import AnsibleModule
+
+
+def do_install(module, mode, rootfs, container, image, values_list, backend):
+    system_list = ["--system"] if mode == 'system' else []
+    user_list = ["--user"] if mode == 'user' else []
+    rootfs_list = ["--rootfs=%s" % rootfs] if rootfs else []
+    args = ['atomic', 'install', "--storage=%s" % backend, '--name=%s' % container] + system_list + user_list + rootfs_list + values_list + [image]
+    rc, out, err = module.run_command(args, check_rc=False)
+    if rc != 0:
+        module.fail_json(rc=rc, msg=err)
+    else:
+        changed = "Extracting" in out or "Copying blob" in out
+        module.exit_json(msg=out, changed=changed)
+
+
+def do_update(module, container, image, values_list):
+    args = ['atomic', 'containers', 'update', "--rebase=%s" % image] + values_list + [container]
+    rc, out, err = module.run_command(args, check_rc=False)
+    if rc != 0:
+        module.fail_json(rc=rc, msg=err)
+    else:
+        changed = "Extracting" in out or "Copying blob" in out
+        module.exit_json(msg=out, changed=changed)
+
+
+def do_uninstall(module, name, backend):
+    args = ['atomic', 'uninstall', "--storage=%s" % backend, name]
+    rc, out, err = module.run_command(args, check_rc=False)
+    if rc != 0:
+        module.fail_json(rc=rc, msg=err)
+    module.exit_json(msg=out, changed=True)
+
+
+def do_rollback(module, name):
+    args = ['atomic', 'containers', 'rollback', name]
+    rc, out, err = module.run_command(args, check_rc=False)
+    if rc != 0:
+        module.fail_json(rc=rc, msg=err)
+    else:
+        changed = "Rolling back" in out
+        module.exit_json(msg=out, changed=changed)
+
+
+def core(module):
+    mode = module.params['mode']
+    name = module.params['name']
+    image = module.params['image']
+    rootfs = module.params['rootfs']
+    values = module.params['values']
+    backend = module.params['backend']
+    state = module.params['state']
+
+    module.run_command_environ_update = dict(LANG='C', LC_ALL='C', LC_MESSAGES='C')
+    out = {}
+    err = {}
+    rc = 0
+
+    values_list = ["--set=%s" % x for x in values] if values else []
+
+    args = ['atomic', 'containers', 'list', '--no-trunc', '-n', '--all', '-f', 'backend=%s' % backend, '-f', 'container=%s' % name]
+    rc, out, err = module.run_command(args, check_rc=False)
+    if rc != 0:
+        module.fail_json(rc=rc, msg=err)
+        return
+    present = name in out
+
+    if state == 'present' and present:
+        module.exit_json(msg=out, changed=False)
+    elif (state in ['latest', 'present']) and not present:
+        do_install(module, mode, rootfs, name, image, values_list, backend)
+    elif state == 'latest':
+        do_update(module, name, image, values_list)
+    elif state == 'absent':
+        if not present:
+            module.exit_json(msg="The container is not present", changed=False)
+        else:
+            do_uninstall(module, name, backend)
+    elif state == 'rollback':
+        do_rollback(module, name)
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            mode=dict(default=None, choices=['user', 'system']),
+            name=dict(default=None, required=True),
+            image=dict(default=None, required=True),
+            rootfs=dict(default=None),
+            state=dict(default='latest', choices=['present', 'absent', 'latest', 'rollback']),
+            backend=dict(default=None, required=True, choices=['docker', 'ostree']),
+            values=dict(type='list', default=[]),
+        ),
+    )
+
+    if module.params['values'] is not None and module.params['mode'] == 'default':
+        module.fail_json(msg="values is supported only with user or system mode", err=err)
+
+    # Verify that the platform supports atomic command
+    rc, out, err = module.run_command('atomic -v', check_rc=False)
+    if rc != 0:
+        module.fail_json(msg="Error in running atomic command", err=err)
+
+    try:
+        core(module)
+    except Exception as e:
+        module.fail_json(msg='Unanticipated error running atomic: %s' % to_native(e), exception=traceback.format_exc())
+
+
+if __name__ == '__main__':
+    main()

lib/ansible/modules/cloud/atomic/atomic_image.py

@@ -27,15 +27,22 @@ module: atomic_image
 short_description: Manage the container images on the atomic host platform
 description:
     - Manage the container images on the atomic host platform
-    - Allows to execute the commands on the container images
+    - Allows to execute the commands specified by the RUN label in the container image when present
 version_added: "2.2"
 author: "Saravanan KR @krsacme"
 notes:
-    - Host should be support C(atomic) command
+    - Host should support C(atomic) command
 requirements:
   - atomic
   - "python >= 2.6"
 options:
+    backend:
+        description:
+          - Define the backend where the image is pulled.
+        required: False
+        choices: ["docker", "ostree"]
+        default: None
+        version_added: "2.4"
     name:
         description:
           - Name of the container image
@@ -63,6 +70,11 @@ EXAMPLES = '''
     name: rhel7/rsyslog
     state: latest
 
+# Pull busybox to the OSTree backend
+- atomic_image:
+    name: busybox
+    state: latest
+    backend: ostree
 '''
 
 RETURN = '''
@@ -93,9 +105,38 @@ def core(module):
     image = module.params['name']
     state = module.params['state']
     started = module.params['started']
+    backend = module.params['backend']
     is_upgraded = False
 
     module.run_command_environ_update = dict(LANG='C', LC_ALL='C', LC_MESSAGES='C')
+    out = {}
+    err = {}
+    rc = 0
+
+    if backend:
+        if state == 'present' or state == 'latest':
+            args = ['atomic', 'pull', "--storage=%s" % backend, image]
+            rc, out, err = module.run_command(args, check_rc=False)
+            if rc < 0:
+                module.fail_json(rc=rc, msg=err)
+            else:
+                out_run = ""
+                if started:
+                    args = ['atomic', 'run', "--storage=%s" % backend, image]
+                    rc, out_run, err = module.run_command(args, check_rc=False)
+                    if rc < 0:
+                        module.fail_json(rc=rc, msg=err)
+
+                changed = "Extracting" in out or "Copying blob" in out
+                module.exit_json(msg=(out + out_run), changed=changed)
+        elif state == 'absent':
+            args = ['atomic', 'images', 'delete',  "--storage=%s" % backend, image]
+            if rc < 0:
+                module.fail_json(rc=rc, msg=err)
+            else:
+                changed = "Unable to find" not in out
+                module.exit_json(msg=out, changed=changed)
+        return
 
     if state == 'present' or state == 'latest':
         if state == 'latest':
@@ -108,9 +149,6 @@ def core(module):
     elif state == 'absent':
         args = ['atomic', 'uninstall', image]
 
-    out = {}
-    err = {}
-    rc = 0
     rc, out, err = module.run_command(args, check_rc=False)
 
     if rc < 0:
@@ -126,6 +164,7 @@ def core(module):
 def main():
     module = AnsibleModule(
         argument_spec=dict(
+            backend=dict(default=None, choices=['docker', 'ostree']),
             name=dict(default=None, required=True),
             state=dict(default='latest', choices=['present', 'absent', 'latest']),
             started=dict(default='yes', type='bool'),