From da93d7f4b44cb9b1ea756680a26448ff67c890fb Mon Sep 17 00:00:00 2001 From: Emil Date: Thu, 7 Mar 2024 02:36:34 +0100 Subject: [PATCH] Adds image creation and publishing --- README.md | 2 + extensions/molecule/default/verify.yml | 6 ++- playbooks/image_published_locally.yml | 17 +++++++- roles/image/README.md | 38 +++++++++++++++++ roles/image/defaults/main.yml | 2 + roles/image/handlers/main.yml | 2 + roles/image/meta/main.yml | 50 +++++++++++++++++++++++ roles/image/tasks/image.yml | 22 ++++++++++ roles/image/tasks/main.yml | 2 + roles/image/tests/inventory | 2 + roles/image/tests/test.yml | 4 ++ roles/image/vars/main.yml | 2 + roles/linux_container/tasks/container.yml | 16 +++++--- 13 files changed, 156 insertions(+), 9 deletions(-) create mode 100644 roles/image/README.md create mode 100644 roles/image/defaults/main.yml create mode 100644 roles/image/handlers/main.yml create mode 100644 roles/image/meta/main.yml create mode 100644 roles/image/tasks/image.yml create mode 100644 roles/image/tasks/main.yml create mode 100644 roles/image/tests/inventory create mode 100644 roles/image/tests/test.yml create mode 100644 roles/image/vars/main.yml diff --git a/README.md b/README.md index 1636672..5731d96 100644 --- a/README.md +++ b/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 @@ -137,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 diff --git a/extensions/molecule/default/verify.yml b/extensions/molecule/default/verify.yml index 42d5d19..bda6cb3 100644 --- a/extensions/molecule/default/verify.yml +++ b/extensions/molecule/default/verify.yml @@ -3,8 +3,12 @@ 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 diff --git a/playbooks/image_published_locally.yml b/playbooks/image_published_locally.yml index 2b84d49..bbbbc64 100644 --- a/playbooks/image_published_locally.yml +++ b/playbooks/image_published_locally.yml @@ -1,10 +1,23 @@ --- -- name: Create and publish Linux container image to a local image server +- 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: Create a test container + - 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 diff --git a/roles/image/README.md b/roles/image/README.md new file mode 100644 index 0000000..225dd44 --- /dev/null +++ b/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). diff --git a/roles/image/defaults/main.yml b/roles/image/defaults/main.yml new file mode 100644 index 0000000..ff4e5fb --- /dev/null +++ b/roles/image/defaults/main.yml @@ -0,0 +1,2 @@ +--- +lte_image_state: present diff --git a/roles/image/handlers/main.yml b/roles/image/handlers/main.yml new file mode 100644 index 0000000..91da2a7 --- /dev/null +++ b/roles/image/handlers/main.yml @@ -0,0 +1,2 @@ +--- +... diff --git a/roles/image/meta/main.yml b/roles/image/meta/main.yml new file mode 100644 index 0000000..5d7099b --- /dev/null +++ b/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. diff --git a/roles/image/tasks/image.yml b/roles/image/tasks/image.yml new file mode 100644 index 0000000..8115997 --- /dev/null +++ b/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 diff --git a/roles/image/tasks/main.yml b/roles/image/tasks/main.yml new file mode 100644 index 0000000..1cd8aec --- /dev/null +++ b/roles/image/tasks/main.yml @@ -0,0 +1,2 @@ +--- +- ansible.builtin.include_tasks: image.yml diff --git a/roles/image/tests/inventory b/roles/image/tests/inventory new file mode 100644 index 0000000..878877b --- /dev/null +++ b/roles/image/tests/inventory @@ -0,0 +1,2 @@ +localhost + diff --git a/roles/image/tests/test.yml b/roles/image/tests/test.yml new file mode 100644 index 0000000..4afc78f --- /dev/null +++ b/roles/image/tests/test.yml @@ -0,0 +1,4 @@ +--- +- hosts: localhost + remote_user: root + roles: [image] diff --git a/roles/image/vars/main.yml b/roles/image/vars/main.yml new file mode 100644 index 0000000..91da2a7 --- /dev/null +++ b/roles/image/vars/main.yml @@ -0,0 +1,2 @@ +--- +... diff --git a/roles/linux_container/tasks/container.yml b/roles/linux_container/tasks/container.yml index 0544466..6e170cd 100644 --- a/roles/linux_container/tasks/container.yml +++ b/roles/linux_container/tasks/container.yml @@ -3,11 +3,15 @@ ansible.builtin.command: incus ls {{ lte_container_name }} register: container_state changed_when: false -- name: stop and remove running container - ansible.builtin.shell: - cmd: | - incus stop {{ lte_container_name }} && \ - incus rm {{ lte_container_name }} +- 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 @@ -25,7 +29,7 @@ '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'