i-8 Implements image creation and publishing in playbook (#22)

# Issue

This PR implements the-liberated-edge/test_linux_containers#8

# Acceptance criteria

- [x] The existing playbook has been amended, so that it creates and publishes container images to an incus server running locally.
- [x] Container image name has been parameterised and provided as an Ansible variable.

Co-authored-by: Emil <emil@theliberatededge.org>
Reviewed-on: #22

roles/image/README.md

@@ -0,0 +1,38 @@
+Role Name
+=========
+
+A brief description of the role goes here.
+
+Requirements
+------------
+
+Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+
+Role Variables
+--------------
+
+A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+
+Dependencies
+------------
+
+A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+
+    - hosts: servers
+      roles:
+         - { role: username.rolename, x: 42 }
+
+License
+-------
+
+BSD
+
+Author Information
+------------------
+
+An optional section for the role authors to include contact information, or a website (HTML is not allowed).

roles/image/defaults/main.yml

@@ -0,0 +1,2 @@
+---
+lte_image_state: present

roles/image/handlers/main.yml

@@ -0,0 +1,2 @@
+---
+...

roles/image/meta/main.yml

@@ -0,0 +1,50 @@
+---
+galaxy_info:
+  author: your name
+  description: your role description
+  company: your company (optional)
+
+  # If the issue tracker for your role is not on github, uncomment the
+  # next line and provide a value
+  # issue_tracker_url: http://example.com/issue/tracker
+
+  # Choose a valid license ID from https://spdx.org - some suggested licenses:
+  # - BSD-3-Clause (default)
+  # - MIT
+  # - GPL-2.0-or-later
+  # - GPL-3.0-only
+  # - Apache-2.0
+  # - CC-BY-4.0
+  license: license (GPL-2.0-or-later, MIT, etc)
+  min_ansible_version: 2.1
+
+  # If this a Container Enabled role, provide the minimum Ansible Container version.
+  # min_ansible_container_version:
+
+  #
+  # Provide a list of supported platforms, and for each platform a list of versions.
+  # If you don't wish to enumerate all versions for a particular platform, use 'all'.
+  # To view available platforms and versions (or releases), visit:
+  # https://galaxy.ansible.com/api/v1/platforms/
+  #
+  # platforms:
+  # - name: Fedora
+  #   versions:
+  #   - all
+  #   - 25
+  # - name: SomePlatform
+  #   versions:
+  #   - all
+  #   - 1.0
+  #   - 7
+  #   - 99.99
+  galaxy_tags: []
+    # List tags for your role here, one per line. A tag is a keyword that describes
+    # and categorizes the role. Users find roles by searching for tags. Be sure to
+    # remove the '[]' above, if you add tags to this list.
+    #
+    # NOTE: A tag is limited to a single word comprised of alphanumeric characters.
+    #       Maximum 20 tags per role.
+dependencies: []
+  # List your role dependencies here, one per line. Be sure to remove the '[]' above,
+  # if you add dependencies to this list.

roles/image/tasks/image.yml

@@ -0,0 +1,22 @@
+---
+- name: Find container image by name
+  ansible.builtin.command: incus image ls {{ lte_image_name }}
+  register: image_state
+  changed_when: false
+- name: Remove an existing container image
+  ansible.builtin.shell:
+    cmd: incus image rm {{ lte_image_name }}
+  when: >
+    lte_image_state == 'absent' and
+    'results' in image_state and
+    image_state.results[0].rc == 0 and
+    lte_image_name in image_state.results[0].stdout
+- name: Create and publish container image to local image server
+  ansible.builtin.shell:
+    cmd: |
+      incus publish --force --alias {{ lte_image_name }} \
+          --compression pigz \
+              {{ lte_container_name }}
+  when: >-
+    lte_image_state == 'present' and
+    lte_image_name not in image_state.stdout

roles/image/tasks/main.yml

@@ -0,0 +1,2 @@
+---
+- ansible.builtin.include_tasks: image.yml

roles/image/tests/inventory

@@ -0,0 +1,2 @@
+localhost
+

roles/image/tests/test.yml

@@ -0,0 +1,4 @@
+---
+- hosts: localhost
+  remote_user: root
+  roles: [image]

roles/image/vars/main.yml

@@ -0,0 +1,2 @@
+---
+...

roles/linux_container/defaults/main.yml

@@ -1,2 +1,3 @@
 ---
 lte_debian_version: bookworm
+lte_container_state: present

roles/linux_container/tasks/container.yml

@@ -3,17 +3,35 @@
   ansible.builtin.command: incus ls {{ lte_container_name }}
   register: container_state
   changed_when: false
+- name: Stop running container
+  ansible.builtin.command: incus stop {{ lte_container_name }}
+  when: >
+    lte_container_state in ['absent', 'stopped'] and
+    'results' in container_state and
+    container_state.results[0].rc == 0 and
+    'RUNNING' in container_state.results[0].stdout
+- name: Remove stopped container
+  ansible.builtin.command: incus rm {{ lte_container_name }}
+  when: >
+    lte_container_state == 'absent' and
+    'results' in container_state and
+    container_state.results[0].rc == 0 and
+    'RUNNING' in container_state.results[0].stdout
 - name: launch debian bookworm linux container
   ansible.builtin.shell:
     cmd: |
       incus launch \
         images:debian/{{ lte_debian_version }}/cloud \
         {{ lte_container_name }}
-  when: (container_state.rc == 1) or ("RUNNING" not in container_state.stdout)
+  when: >
+    lte_container_state == 'present' and
+    container_state.rc == 1 or
+    'RUNNING' not in container_state.stdout
 - name: update apt cache and upgrade system packages
   ansible.builtin.shell:
-    cmd: |-
+    cmd: |
       incus exec {{ lte_container_name }} -- \
         bash -c \
           '/usr/bin/apt update && /usr/bin/apt upgrade -y'
+  when: lte_container_state == 'present'
   changed_when: false

roles/linux_container/tasks/main.yml

@@ -1,4 +1,6 @@
 ---
 - ansible.builtin.include_tasks: container.yml
 - ansible.builtin.include_tasks: ume.yml
+  when: lte_container_state == 'present'
 - ansible.builtin.include_tasks: openssh-server.yml
+  when: lte_container_state == 'present'