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

README.md

@@ -19,6 +19,7 @@ effectively be used as a container hypervisor.
 3. Your user has been granted permissions to manage Linux containers.
 4. Python 3 has been set up correctly on the machine.
 5. [Ansible](https://pypi.org/project/ansible/) has been installed.
+6. [pigz](https://zlib.net/pigz/) has been installed.
 
 # Install the Ansible collection theliberatededge.test_linux_containers
 
@@ -33,23 +34,27 @@ ansible-galaxy collection install -U --force \
 ## Run the launch_linux_container playbook
 
 Substitute the missing variable valuess and run the playbook
-for launching Debian Bookworm linux containers.
+for creating and publishing Debian Bookworm linux container images
+to a locally running incus image server.
 
 Variables
-- `lte_container_name` stands for the desired container name that
-will be visible when running `incus ls`.
+- `lte_image_name` stands for the desired Linux container image.
 - `lte_container_root_pwd` is the password that will be set for
-the `root` user in the container named `lte_container_name`.
+the `root` user in the containers created out of the `lte_image_name`
+Linux container image.
 
 ```
 LC_ALL=C.UTF-8 ansible-playbook \
-    theliberatededge.test_linux_containers.launch_linux_container \
-        -e "lte_container_name=<container name> lte_container_root_pwd=<password>"
+    theliberatededge.test_linux_containers.image_published_locally \
+        -e "lte_image_name=<image name> lte_container_root_pwd=<password>"
 ```
 
 Once the playbook finishes execution, you should be able to
-connect to the newly launched container as user `root` via
-ssh.
+launch new containers refering to the newly published image name.
+
+```
+incus launch <image_name> <container_name>
+```
 
 ## Include playbook or role from the collection
 
@@ -62,15 +67,15 @@ assign the missing values to the variables first.
 
 ```
 ---
-- name: Launch Linux Container
+- name: Create and publish locally container image
   hosts: all
   gather_facts: false
-- name: imports and executes the playbook under test
+- name: Imports and executes the playbook
   ansible.builtin.import_playbook:
-    theliberatededge.test_linux_containers.launch_linux_container.yml
+    theliberatededge.test_linux_containers.image_publlished_locally.yml
   vars:
     lte_debian_version: bookworm
-    lte_container_name: <container name>
+    lte_image_name: <image name>
     lte_container_root_pwd: <password>
 ```
 
@@ -133,6 +138,7 @@ a container hypervisor.
 6. [git](https://git-scm.com/) has been installed on the machine.
 7. [Task](https://github.com/go-task/task) has been installed and has been
 available in the `$PATH` environment variable for the current user.
+8. [pigz](https://zlib.net/pigz/) has been installed.
 
 ### Initialize collection project locally
 

Taskfile.yml

@@ -22,9 +22,9 @@ tasks:
     cmds:
       - |
         LC_ALL=C.UTF-8 \
-        LTE_CONTAINER_NAME={{ .LTE_CONTAINER_NAME }} \
+        LTE_IMAGE_NAME={{ .LTE_IMAGE_NAME }} \
         LTE_CONTAINER_ROOT_PWD={{ .LTE_CONTAINER_ROOT_PWD }} \
         molecule test --all
     vars:
-      LTE_CONTAINER_NAME:
+      LTE_IMAGE_NAME:
         sh: cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 8 | head -n 1

extensions/molecule/default/converge.yml

@@ -4,9 +4,9 @@
   gather_facts: false
 - name: imports and executes the playbook under test
   ansible.builtin.import_playbook: >-
-    theliberatededge.test_linux_containers.launch_linux_container.yml
+    theliberatededge.test_linux_containers.image_published_locally.yml
   vars:
     lte_debian_version: bookworm
-    lte_container_name: '{{ molecule_yml.platforms[0].name }}'
+    lte_image_name: '{{ molecule_yml.platforms[0].name }}'
     lte_container_root_pwd: |-
       '{{ lookup("ansible.builtin.env", "LTE_CONTAINER_ROOT_PWD") }}'

extensions/molecule/default/destroy.yml

@@ -1,18 +1,14 @@
 ---
-- name: Create
+- name: Destroy testing resources
   hosts: localhost
   connection: local
   gather_facts: false
   tasks:
-    - name: find current container state
-      ansible.builtin.command: incus ls {{ item.name }}
-      register: state
-      changed_when: false
-      with_items: '{{ molecule_yml.platforms }}'
-    - name: stop and remove running containers
-      ansible.builtin.shell:
-        cmd: |
-          incus stop {{ item.name }} && \
-          incus rm {{ item.name }}
-      when: state.results[0].rc == 0 and "RUNNING" in state.results[0].stdout
+    - name: Stop and remove the test container
+      ansible.builtin.include_role:
+        name: >-
+          theliberatededge.test_linux_containers.linux_container
+      vars:
+        lte_container_state: absent
+        lte_container_name: '{{ item.name }}-container'
       with_items: '{{ molecule_yml.platforms }}'

extensions/molecule/default/molecule.yml

@@ -2,7 +2,7 @@
 dependency:
   name: galaxy
 platforms:
-  - name: ${LTE_CONTAINER_NAME}
+  - name: ${LTE_IMAGE_NAME}
 provisioner:
   name: ansible
   playbooks:

extensions/molecule/default/verify.yml

@@ -3,13 +3,17 @@
   hosts: localhost
   gather_facts: false
   tasks:
+    - name: Launch container based on the newly published image
+      ansible.builtin.command: |
+        incus launch {{ item.name }} {{ item.name }}-test-cntr
+      with_items: '{{ molecule_yml.platforms }}'
     - name: find current container state
-      ansible.builtin.command: incus ls {{ item.name }}
+      ansible.builtin.command: incus ls '{{ item.name }}-test-cntr'
       register: state
       with_items: '{{ molecule_yml.platforms }}'
     - name: verify launched container is running
       ansible.builtin.assert:
-        that: state.results[0].rc == 0 and "RUNNING" in state.results[0].stdout
+        that: state.results[0].rc == 0 and 'RUNNING' in state.results[0].stdout
     - name: find container ip address
       ansible.builtin.command: incus ls -c=4 -f=compact {{ item.name }}
       register: ipv4_raw

playbooks/image_published_locally.yml

@@ -0,0 +1,23 @@
+---
+- name: Create and publish a Linux container image to a local image server
+  hosts: localhost
+  gather_facts: false
+  vars:
+    - lte_container_name: '{{ lte_image_name }}-container'
+  tasks:
+    - name: Launch a test container
+      ansible.builtin.import_role:
+        name: linux_container
+    - name: Stop the newly launched test container
+      ansible.builtin.import_role:
+        name: linux_container
+      vars:
+        lte_container_state: stopped
+    - name: Publish container image to local image server
+      ansible.builtin.import_role:
+        name: image
+    - name: Remove intermitent image container
+      ansible.builtin.import_role:
+        name: linux_container
+      vars:
+        - lte_container_state: absent

playbooks/launch_linux_container.yml

@@ -1,8 +0,0 @@
----
-- name: launch linux container
-  hosts: localhost
-  gather_facts: false
-  tasks:
-    - name: Create a test container image template
-      ansible.builtin.import_role:
-        name: linux_container

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'