feat: support for ostree systems

Feature: Allow running and testing the role with ostree managed nodes.

Reason: We have users who want to use the role to manage ostree
systems.

Result: Users can use the role to manage ostree managed nodes.
Signed-off-by: Rich Megginson <[email protected]>

.ostree/README.md

@@ -0,0 +1,3 @@
+*NOTE*: The `*.txt` files are used by `get_ostree_data.sh` to create the lists
+of packages, and to find other system roles used by this role.  DO NOT use them
+directly.

.ostree/get_ostree_data.sh

@@ -0,0 +1,132 @@
+#!/bin/bash
+
+set -euo pipefail
+
+ostree_dir="${OSTREE_DIR:-"$(dirname "$(realpath "$0")")"}"
+
+if [ -z "${4:-}" ] || [ "${1:-}" = help ] || [ "${1:-}" = -h ]; then
+    cat <<EOF
+Usage: $0 packages [runtime|testing] DISTRO-MAJOR[.MINOR] [json|yaml|raw|toml]
+The script will use the packages and roles files in $ostree_dir to
+construct the list of packages needed to build the ostree image.  The script
+will output the list of packages in the given format
+- json is a JSON list like ["pkg1","pkg2",....,"pkgN"]
+- yaml is the YAML list format
+- raw is the list of packages, one per line
+- toml is a list of [[packages]] elements as in https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index#creating-an-image-builder-blueprint-for-a-rhel-for-edge-image-using-the-command-line-interface_composing-a-rhel-for-edge-image-using-image-builder-command-line
+The DISTRO-MAJOR.MINOR is the same format used by Ansible for distribution e.g. CentOS-8, RedHat-8.9, etc.
+EOF
+    exit 1
+fi
+category="$1"
+pkgtype="$2"
+distro_ver="$3"
+format="$4"
+pkgtypes=("$pkgtype")
+if [ "$pkgtype" = testing ]; then
+    pkgtypes+=(runtime)
+fi
+
+get_rolepath() {
+    local ostree_dir role rolesdir roles_parent_dir coll_path pth
+    ostree_dir="$1"
+    role="$2"
+    roles_parent_dir="$(dirname "$(dirname "$ostree_dir")")"
+    rolesdir="$roles_parent_dir/$role/.ostree"
+    # assumes collection format
+    if [ -d "$rolesdir" ]; then
+        echo "$rolesdir"
+        return 0
+    fi
+    # assumes legacy role format like linux-system-roles.$role/
+    for rolesdir in "$roles_parent_dir"/*-system-roles."$role"/.ostree; do
+        if [ -d "$rolesdir" ]; then
+          echo "$rolesdir"
+          return 0
+        fi
+    done
+    # look elsewhere
+    coll_path="${ANSIBLE_COLLECTIONS_PATH:-}"
+    if [ -z "$coll_path" ]; then
+        coll_path="${ANSIBLE_COLLECTIONS_PATHS:-}"
+    fi
+    if [ -n "${coll_path}" ]; then
+        for pth in ${coll_path//:/ }; do
+            for rolesdir in "$pth"/ansible_collections/*/*_system_roles/roles/"$role"/.ostree; do
+                if [ -d "$rolesdir" ]; then
+                    echo "$rolesdir"
+                    return 0
+                fi
+            done
+        done
+    fi
+    1>&2 echo ERROR - could not find role "$role" - please use ANSIBLE_COLLECTIONS_PATH
+    exit 2
+}
+
+get_packages() {
+    local ostree_dir pkgtype pkgfile rolefile
+    ostree_dir="$1"
+    for pkgtype in "${pkgtypes[@]}"; do
+        for suff in "" "-$distro" "-${distro}-${major_ver}" "-${distro}-${ver}"; do
+            pkgfile="$ostree_dir/packages-${pkgtype}${suff}.txt"
+            if [ -f "$pkgfile" ]; then
+                cat "$pkgfile"
+            fi
+        done
+        rolefile="$ostree_dir/roles-${pkgtype}.txt"
+        if [ -f "$rolefile" ]; then
+            local roles role rolepath
+            roles="$(cat "$rolefile")"
+            for role in $roles; do
+                rolepath="$(get_rolepath "$ostree_dir" "$role")"
+                if [ -z "$rolepath" ]; then
+                    1>&2 echo ERROR - could not find role "$role" - please use ANSIBLE_COLLECTIONS_PATH
+                    exit 2
+                fi
+                get_packages "$rolepath"
+            done
+        fi
+    done | sort -u
+}
+
+format_packages_json() {
+    local comma pkgs pkg
+    comma=""
+    pkgs="["
+    while read -r pkg; do
+        pkgs="${pkgs}${comma}\"${pkg}\""
+        comma=,
+    done
+    pkgs="${pkgs}]"
+    echo "$pkgs"
+}
+
+format_packages_raw() {
+    cat
+}
+
+format_packages_yaml() {
+    while read -r pkg; do
+        echo "- $pkg"
+    done
+}
+
+format_packages_toml() {
+    while read -r pkg; do
+        echo "[[packages]]"
+        echo "name = \"$pkg\""
+        echo "version = \"*\""
+    done
+}
+
+distro="${distro_ver%%-*}"
+ver="${distro_ver##*-}"
+if [[ "$ver" =~ ^([0-9]*) ]]; then
+    major_ver="${BASH_REMATCH[1]}"
+else
+    echo ERROR: cannot parse major version number from version "$ver"
+    exit 1
+fi
+
+"get_$category" "$ostree_dir" | "format_${category}_$format"

.ostree/packages-runtime.txt

@@ -0,0 +1,2 @@
+iproute
+libreswan

.ostree/roles-runtime.txt

@@ -0,0 +1,2 @@
+firewall
+selinux

.sanity-ansible-ignore-2.10.txt

@@ -1,3 +1,4 @@
 plugins/filter/vpn_ipaddr.py no-unicode-literals!skip
 tests/vpn/unit/test_vpn_ipaddr.py no-unicode-literals!skip
 lsr_role2coll_extra_script-vpn shebang!skip
+roles/vpn/.ostree/get_ostree_data.sh shebang!skip

.sanity-ansible-ignore-2.11.txt

@@ -1,3 +1,4 @@
 plugins/filter/vpn_ipaddr.py no-unicode-literals!skip
 tests/vpn/unit/test_vpn_ipaddr.py no-unicode-literals!skip
 lsr_role2coll_extra_script-vpn shebang!skip
+roles/vpn/.ostree/get_ostree_data.sh shebang!skip

.sanity-ansible-ignore-2.12.txt

@@ -1,3 +1,4 @@
 plugins/filter/vpn_ipaddr.py no-unicode-literals!skip
 tests/vpn/unit/test_vpn_ipaddr.py no-unicode-literals!skip
 lsr_role2coll_extra_script-vpn shebang!skip
+roles/vpn/.ostree/get_ostree_data.sh shebang!skip

.sanity-ansible-ignore-2.13.txt

@@ -1,3 +1,4 @@
 plugins/filter/vpn_ipaddr.py no-unicode-literals!skip
 tests/vpn/unit/test_vpn_ipaddr.py no-unicode-literals!skip
 lsr_role2coll_extra_script-vpn shebang!skip
+roles/vpn/.ostree/get_ostree_data.sh shebang!skip

.sanity-ansible-ignore-2.14.txt

@@ -1,3 +1,4 @@
 plugins/filter/vpn_ipaddr.py no-unicode-literals!skip
 tests/vpn/unit/test_vpn_ipaddr.py no-unicode-literals!skip
 lsr_role2coll_extra_script-vpn shebang!skip
+roles/vpn/.ostree/get_ostree_data.sh shebang!skip

.sanity-ansible-ignore-2.15.txt

@@ -1,3 +1,4 @@
 plugins/filter/vpn_ipaddr.py no-unicode-literals!skip
 tests/vpn/unit/test_vpn_ipaddr.py no-unicode-literals!skip
 lsr_role2coll_extra_script-vpn shebang!skip
+roles/vpn/.ostree/get_ostree_data.sh shebang!skip

.sanity-ansible-ignore-2.9.txt

@@ -1,3 +1,4 @@
 plugins/filter/vpn_ipaddr.py no-unicode-literals!skip
 tests/vpn/unit/test_vpn_ipaddr.py no-unicode-literals!skip
 lsr_role2coll_extra_script-vpn shebang!skip
+roles/vpn/.ostree/get_ostree_data.sh shebang!skip

README-ostree.md

@@ -0,0 +1,66 @@
+# rpm-ostree
+
+The role supports running on [rpm-ostree](https://coreos.github.io/rpm-ostree/)
+systems. The primary issue is that the `/usr` filesystem is read-only, and the
+role cannot install packages. Instead, it will just verify that the necessary
+packages and any other `/usr` files are pre-installed. The role will change the
+package manager to one that is compatible with `rpm-ostree` systems.
+
+## Building
+
+To build an ostree image for a particular operating system distribution and
+version, use the script `.ostree/get_ostree_data.sh` to get the list of
+packages. If the role uses other system roles, then the script will include the
+packages for the other roles in the list it outputs.  The list of packages will
+be sorted in alphanumeric order.
+
+Usage:
+
+```bash
+.ostree/get_ostree_data.sh packages runtime DISTRO-VERSION FORMAT
+```
+
+`DISTRO-VERSION` is in the format that Ansible uses for `ansible_distribution`
+and `ansible_distribution_version` - for example, `Fedora-38`, `CentOS-8`,
+`RedHat-9.4`
+
+`FORMAT` is one of `toml`, `json`, `yaml`, `raw`
+
+* `toml` - each package in a TOML `[[packages]]` element
+
+```toml
+[[packages]]
+name = "package-a"
+version = "*"
+[[packages]]
+name = "package-b"
+version = "*"
+...
+```
+
+* `yaml` - a YAML list of packages
+
+```yaml
+- package-a
+- package-b
+...
+```
+
+* `json` - a JSON list of packages
+
+```json
+["package-a","package-b",...]
+```
+
+* `raw` - a plain text list of packages, one per line
+
+```bash
+package-a
+package-b
+...
+```
+
+What format you choose depends on which image builder you are using.  For
+example, if you are using something based on
+[osbuild-composer](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/composing_installing_and_managing_rhel_for_edge_images/index#creating-an-image-builder-blueprint-for-a-rhel-for-edge-image-using-the-command-line-interface_composing-a-rhel-for-edge-image-using-image-builder-command-line),
+you will probably want to use the `toml` output format.

README.md

@@ -33,15 +33,15 @@ uses the python3 built-in `ipaddress` module.
 ### Collection requirements
 
 The role requires the `firewall` role and the `selinux` role from the
-`fedora.linux_system_roles` collection, if `vpn_manage_firewall`
-and `vpn_manage_selinux` is set to true, respectively.
-(Please see also the variables in the [`Firewall and Selinux`](#firewall-and-selinux) section.)
+`fedora.linux_system_roles` collection, if `vpn_manage_firewall` and
+`vpn_manage_selinux` are set to true, respectively. (Please see also the
+variables in the [`Firewall and Selinux`](#firewall-and-selinux) section.) The
+role requires additional collections to manage `rpm-ostree` systems.
 
-If the `vpn` is a role from the `fedora.linux_system_roles`
-collection or from the Fedora RPM package, the requirement is already
-satisfied.
+If using the `vpn` role from the `fedora.linux_system_roles` collection or from
+the Fedora RPM package, the requirements are already satisfied.
 
-Otherwise, please run the following command line to install the collection.
+Otherwise, please run the following command line to install the collections.
 
 ```bash
 ansible-galaxy collection install -r meta/collection-requirements.yml
@@ -430,6 +430,10 @@ If neither `public_key_src` nor `public_key_content` is populated, the role will
 
 Minimum acceptable algorithms are AES, MODP2048 and SHA2.
 
+## rpm-ostree
+
+See README-ostree.md
+
 ## License
 
 MIT.

meta/collection-requirements.yml

@@ -1,4 +1,5 @@
 # SPDX-License-Identifier: MIT
 ---
 collections:
+  - ansible.posix
   - fedora.linux_system_roles

tasks/main.yml

@@ -7,6 +7,8 @@
   package:
     name: "{{ __vpn_packages }}"
     state: present
+    use: "{{ (__vpn_is_ostree | d(false)) |
+      ternary('ansible.posix.rhel_rpm_ostree', omit) }}"
   tags: packages
 
 - name: Configure firewall

tasks/set_vars.yml

@@ -5,6 +5,18 @@
   when: __vpn_required_facts |
     difference(ansible_facts.keys() | list) | length > 0
 
+- name: Determine if system is ostree and set flag
+  when: not __vpn_is_ostree is defined
+  block:
+    - name: Check if system is ostree
+      ansible.builtin.stat:
+        path: /run/ostree-booted
+      register: __ostree_booted_stat
+
+    - name: Set flag to indicate system is ostree
+      ansible.builtin.set_fact:
+        __vpn_is_ostree: "{{ __ostree_booted_stat.stat.exists }}"
+
 - name: Set platform/version specific variables
   include_vars: "{{ __vpn_vars_file }}"
   loop:

tests/tasks/cleanup.yml

@@ -20,6 +20,7 @@
     name: "{{ item }}"
     state: absent
   loop: "{{ __vpn_packages | d([]) }}"
+  when: not __vpn_is_ostree | d(false)
 
 - name: Clean up files
   vars:

tests/tasks/setup_test.yml

@@ -60,3 +60,20 @@
         path: "/etc/ipsec.d/policies/clear"
         state: touch
         mode: "0600"
+
+# ostree installs firewall by default because the image must
+# have all packages used by all tests - but for some tests
+# we need to ensure firewall isn't running
+- name: Ensure firewalld not running if not testing firewall
+  service:
+    name: firewalld
+    state: stopped
+    enabled: false
+  register: __firewalld_status
+  failed_when:
+    - __firewalld_status is failed
+    - not __no_such_service in __firewalld_status.msg
+  vars:
+    __no_such_service: >-
+      Could not find the requested service firewalld:
+  when: not vpn_manage_firewall | d(false)

vars/main.yml

@@ -1,5 +1,6 @@
 ---
 __vpn_packages:
+  - iproute  # for default_ipvX facts
   - libreswan
 
 __vpn_services: