-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: Use supported ansible-lint action; run ansible-lint against the c…
…ollection The old ansible-community ansible-lint is deprecated. There is a new ansible-lint github action. The latest Ansible repo gating tests run ansible-lint against the collection format instead of against individual roles. We have to convert the role to collection format before running ansible-test. This also requires tox-lsr 3.2.1 - bump other actions to use 3.2.1 Role developers can run this locally using `tox -e collection,ansible-lint-collection` See linux-system-roles/tox-lsr#125 Signed-off-by: Rich Megginson <rmeggins@redhat.com>
- Loading branch information
Showing
8 changed files
with
222 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| #!/usr/bin/env 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 path | ||
| 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 path in ${coll_path//:/ }; do | ||
| for rolesdir in "$path"/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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |