[devscripts_sno] Add role for deploying devscript as SNO

docs/dictionary/en-custom.txt

@@ -1,3 +1,4 @@
+ACL
 AES
 APIs
 Amartya
@@ -16,6 +17,7 @@ LDAP
 LLM
 MachineConfig
 Marjanovic
+MiB
 Nemanja
 NICs
 NodeHealthCheck

roles/devscripts/README.md

@@ -59,6 +59,7 @@ networks.
 * `cifmw_devscripts_cpu_passthrough` (bool) Enable host-passthrough cpu model
   to virtual machine instead of using QEMU on nested environment. Defaults
   to `false`.
+* `cifmw_devscripts_sno` (bool) Enable Single Node OpenShift. Defaults to `false`.
 
 ### Secrets management
 

roles/devscripts/defaults/main.yml

@@ -75,3 +75,4 @@ cifmw_devscripts_installer_timeout: 7200  # 2 hours
 cifmw_devscripts_etcd_slow_profile: true
 cifmw_devscripts_disable_console: false
 cifmw_devscripts_cpu_passthrough: false
+cifmw_devscripts_sno: false

roles/devscripts/templates/conf_ciuser.j2

@@ -7,6 +7,22 @@ set +x
 export CI_TOKEN=$(cat {{ cifmw_devscripts_repo_dir }}/ci_token)
 set -x
 
+
+{% if cifmw_devscripts_sno %}
+# SNO configuration
+# https://github.com/openshift-metal3/dev-scripts/blob/master/AGENTS.md
+{% for item in ['working_dir', 'assets_extra_folder', 'openshift_release_type',
+    'openshift_version', 'cluster_name', 'base_domain', 'ntp_servers',
+    'external_subnet_v4', 'ip_stack', 'agent_e2e_test_scenario',
+    'agent_platform_type'] %}
+export {{ item.upper() }}="{{ cifmw_devscripts_config[item] }}"
+{% endfor %}
+export NUM_MASTERS=1
+export NUM_WORKERS=0
+{% else %}
+
 {% for item in cifmw_devscripts_config %}
 export {{ item.upper() }}="{{ cifmw_devscripts_config[item] }}"
 {% endfor %}
+
+{% endif %}

roles/devscripts_sno/README.md

@@ -0,0 +1,177 @@
+# devscripts_sno
+
+Deploy a Single Node OpenShift (SNO) cluster on libvirt/KVM using the
+[dev-scripts](https://github.com/openshift-metal3/dev-scripts) agent installer
+(`make agent`).
+
+This role is a thin wrapper around the `devscripts` role: it prepares secrets
+and host prerequisites, runs the dev-scripts configuration and host-prep steps,
+executes `make agent`, and copies the resulting kubeconfig to `~/.kube/config`.
+
+It complements the full `devscripts` deployment path (baremetal/libvirt with
+`make all`) and the physical bare metal path documented in
+[bm_sno](../bm_sno/README.md) (`cifmw_bm_sno: true`).
+
+When used from the reproducer, set `cifmw_devscripts_sno: true` so the
+`devscripts` configuration template exports SNO-specific variables (see
+[dev-scripts AGENTS.md](https://github.com/openshift-metal3/dev-scripts/blob/master/AGENTS.md)).
+That flag is separate from including this role by name; reproducer scenarios
+such as `scenarios/reproducers/va-hci-minimal-sno.yml` combine the flag with
+`cifmw_devscripts_config_overrides` for a one-master layout.
+
+## Parameters
+
+### Role-specific
+
+| Parameter | Type | Default | Description |
+| --- | --- | --- | --- |
+| `cifmw_devscripts_sno_installer_timeout` | int | `7200` | Seconds before `make agent` is killed by `timeout` (2 hours) |
+| `cifmw_devscripts_sno_repo_dir` | str | `~/src/github.com/openshift-metal3/dev-scripts` | Path to the dev-scripts repository |
+| `cifmw_devscripts_sno_data_dir` | str | `~/ci-framework-data` | Base directory for CI Framework data on the host |
+| `cifmw_devscripts_sno_artifacts_dir` | str | `{{ cifmw_devscripts_sno_data_dir }}/artifacts` | Directory for role script artifacts and logs |
+
+### Required for standalone use
+
+When running this role outside the reproducer playbook, provide secret content
+(the role writes files from these variables in `pre.yml`):
+
+| Parameter | Description |
+| --- | --- |
+| `cifmw_manage_secrets_citoken_content` | CI token string written to `cifmw_manage_secrets_citoken_file` |
+| `cifmw_manage_secrets_pullsecret_content` | Pull secret JSON written to `cifmw_manage_secrets_pullsecret_file` |
+
+Default secret file paths (from `defaults/main.yml`):
+
+| Parameter | Default |
+| --- | --- |
+| `cifmw_manage_secrets_citoken_file` | `{{ ansible_user_dir }}/secrets/ci_token` |
+| `cifmw_manage_secrets_pullsecret_file` | `{{ ansible_user_dir }}/secrets/pull_secret.json` |
+
+Alternatively, use the file-based variables documented in the
+[devscripts role README](../devscripts/README.md#secrets-management) if you
+integrate with `manage_secrets` directly.
+
+### SNO and dev-scripts configuration
+
+Set `cifmw_devscripts_sno: true` so `conf_ciuser.j2` exports the reduced SNO
+variable set (`NUM_MASTERS=1`, `NUM_WORKERS=0`, and agent-related keys).
+
+Cluster version, networking, and VM sizing are controlled through
+`cifmw_devscripts_config_overrides` (and optional
+`cifmw_devscripts_config_overrides_patch.*` keys), same as the `devscripts`
+role. See [devscripts README](../devscripts/README.md#parameters) and
+[Supported keys in cifmw_devscripts_config_overrides](../devscripts/README.md#supported-keys-in-cifmw_devscripts_config_overrides).
+
+Common SNO overrides (also used in `scenarios/reproducers/va-hci-minimal-sno.yml`):
+
+| Key | Example | Description |
+| --- | --- | --- |
+| `num_masters` | `1` | Single control-plane node |
+| `master_memory` | `16384` | Memory (MiB) for the master VM |
+| `master_disk` | `120` | Root disk size (GiB) |
+| `master_vcpu` | `12` | vCPUs for the master VM |
+| `agent_e2e_test_scenario` | `SNO_IPV4` | Agent installer test scenario |
+| `agent_platform_type` | `none` | Agent platform type |
+| `openshift_version` | `stable-4.18` | OpenShift version (minor or `stable-X.Y`) |
+| `openshift_release_type` | `ga` | Release type (`nightly`, `ga`, `okd`) |
+| `external_subnet_v4` | `192.168.111.0/24` | External network for the cluster |
+| `ip_stack` | `v4` | IP stack (`v4`, `v6`, `v6v4`) |
+
+Additional dev-scripts variables (for example `cifmw_devscripts_cpu_passthrough`,
+`cifmw_devscripts_host_bm_net_ip_addr`) follow the `devscripts` role
+documentation.
+
+## Task files
+
+| Task file | Description |
+| --- | --- |
+| `main.yml` | Orchestrates pre, QEMU ACL, setup, and post phases |
+| `pre.yml` | Maps role vars to `devscripts`, writes secrets, installs packages |
+| `prepare_qemu_home_access.yml` | Installs `acl`/`qemu-kvm` and grants `qemu` traverse on the user home |
+| `setup.yml` | Runs `devscripts` `build_config.yml` and `100_pre.yml`, then `make agent` |
+| `post.yml` | Copies cluster kubeconfig to `~/.kube/config` |
+
+## Examples
+
+### Standalone playbook
+
+See `example-playbook.yaml` in this role directory:
+
+```bash
+ansible-playbook \
+  -e @secrets.yaml \
+  -e @scenarios/reproducers/va-hci-minimal-sno.yml \
+  -i inventory.yaml \
+  roles/devscripts_sno/example-playbook.yaml
+```
+
+Minimal `secrets.yaml` for standalone runs:
+
+```yaml
+cifmw_devscripts_sno: true
+cifmw_manage_secrets_citoken_content: "{{ lookup('env', 'CI_TOKEN') }}"
+cifmw_manage_secrets_pullsecret_content: |
+  {{ lookup('file', lookup('env', 'HOME') ~ '/pull-secret') }}
+
+cifmw_devscripts_config_overrides:
+  openshift_version: "stable-4.18"
+  openshift_release_type: ga
+  num_masters: 1
+  master_memory: 16384
+  master_disk: 120
+  master_vcpu: 12
+  external_subnet_v4: 192.168.111.0/24
+  ip_stack: v4
+  agent_e2e_test_scenario: SNO_IPV4
+  agent_platform_type: none
+```
+
+### Reproducer scenario (libvirt SNO)
+
+From `scenarios/reproducers/va-hci-minimal-sno.yml`:
+
+```yaml
+cifmw_devscripts_sno: true
+cifmw_reproducer_allow_one_ocp: true
+cifmw_devscripts_cpu_passthrough: true
+cifmw_devscripts_host_bm_net_ip_addr: "192.168.111.1"
+
+cifmw_devscripts_config_overrides:
+  num_masters: 1
+  master_memory: 16384
+  master_disk: 120
+  master_vcpu: 12
+  external_subnet_v4: 192.168.111.0/24
+  ip_stack: v4
+  agent_e2e_test_scenario: SNO_IPV4
+  agent_platform_type: none
+  openshift_release_type: ga
+  openshift_version: stable-4.18
+```
+
+After deployment, credentials are under the dev-scripts auth directory:
+
+```bash
+export KUBECONFIG=~/src/github.com/openshift-metal3/dev-scripts/ocp/ocp/auth/kubeconfig
+oc login -u kubeadmin \
+  -p "$(cat ~/src/github.com/openshift-metal3/dev-scripts/ocp/ocp/auth/kubeadmin-password)"
+```
+
+## SNO deployment methods in CI Framework
+
+| Flag | Role / method | Environment |
+| --- | --- | --- |
+| `cifmw_devscripts_sno: true` | dev-scripts agent (`make agent`) on libvirt/KVM | Virtual machine on the hypervisor |
+| `cifmw_bm_sno: true` | `bm_sno` (agent-based, iDRAC Redfish) | Physical bare metal host |
+
+See [reproducer README](../reproducer/README.md#sno-deployment-methods) for how
+these paths fit into full reproducer jobs.
+
+## References
+
+* [devscripts role](../devscripts/README.md)
+* [bm_sno role](../bm_sno/README.md)
+* [dev-scripts](https://github.com/openshift-metal3/dev-scripts)
+* [dev-scripts agent installer](https://github.com/openshift-metal3/dev-scripts/tree/master/agent)
+* [dev-scripts AGENTS.md](https://github.com/openshift-metal3/dev-scripts/blob/master/AGENTS.md)
+* [dev-scripts config_example.sh](https://github.com/openshift-metal3/dev-scripts/blob/master/config_example.sh)

roles/devscripts_sno/defaults/main.yml

@@ -0,0 +1,28 @@
+---
+# Copyright Red Hat, Inc.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+# All variables intended for modification should be placed in this file.
+# All variables within this role should have a prefix of "cifmw_devscripts_sno"
+#
+cifmw_manage_secrets_citoken_file: "{{ ansible_user_dir }}/secrets/ci_token"
+cifmw_manage_secrets_pullsecret_file: "{{ ansible_user_dir }}/secrets/pull_secret.json"
+openshift_version: "4.18.41"
+
+cifmw_devscripts_sno_installer_timeout: 7200
+cifmw_devscripts_sno_repo_dir: "{{ ansible_user_dir }}/src/github.com/openshift-metal3/dev-scripts"
+cifmw_devscripts_sno_data_dir: "{{ ansible_user_dir }}/ci-framework-data"
+cifmw_devscripts_sno_artifacts_dir: "{{ cifmw_devscripts_sno_data_dir }}/artifacts"

roles/devscripts_sno/example-playbook.yaml

@@ -0,0 +1,13 @@
+---
+# Example usage:
+# ansible-playbook \
+#   -e @secrets.yaml -e @scenarios/reproducers/va-hci-minimal-sno.yml \
+#   -i inventory.yaml \
+#   example-playbook.yaml
+- name: Deploying SNO host
+  hosts: sno.dev
+  gather_facts: true
+  tasks:
+    - name: Run devscript sno
+      ansible.builtin.include_role:
+        name: devscripts_sno

roles/devscripts_sno/meta/main.yml

@@ -0,0 +1,28 @@
+---
+# Copyright Red Hat, Inc.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+galaxy_info:
+  author: CI Framework
+  description: CI Framework Role -- devscripts_sno
+  company: Red Hat
+  license: Apache-2.0
+  min_ansible_version: "2.14"
+  namespace: cifmw
+  galaxy_tags:
+    - cifmw
+
+dependencies: []

roles/devscripts_sno/tasks/main.yml

@@ -0,0 +1,28 @@
+---
+# Copyright Red Hat, Inc.
+# All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+- name: Configure secrets and install required packages
+  ansible.builtin.include_tasks: pre.yml
+
+- name: Allow libvirt qemu user to access files under the user home directory
+  ansible.builtin.include_tasks: prepare_qemu_home_access.yml
+
+- name: Configure devscripts and run make agent command
+  ansible.builtin.include_tasks: setup.yml
+
+- name: Make post actions
+  ansible.builtin.include_tasks: post.yml

roles/devscripts_sno/tasks/post.yml

@@ -0,0 +1,13 @@
+---
+- name: Create .kube directory
+  ansible.builtin.file:
+    path: "{{ ansible_user_dir }}/.kube"
+    state: directory
+    mode: "0750"
+
+- name: Copy devscripts kubeconfig to .kube
+  ansible.builtin.copy:
+    src: "{{ cifmw_devscripts_sno_repo_dir }}/ocp/ocp/auth/kubeconfig"
+    dest: "{{ ansible_user_dir }}/.kube/config"
+    remote_src: true
+    mode: "0640"

roles/devscripts_sno/tasks/pre.yml

@@ -0,0 +1,35 @@
+---
+- name: Re-assign devscripts_sno vars with devscripts role vars
+  ansible.builtin.set_fact:
+    cifmw_devscripts_repo_dir: "{{ cifmw_devscripts_sno_repo_dir }}"
+    cifmw_devscripts_data_dir: "{{ cifmw_devscripts_sno_data_dir }}"
+    cifmw_devscripts_artifacts_dir: "{{ cifmw_devscripts_sno_artifacts_dir }}"
+    cifmw_devscripts_installer_timeout: "{{ cifmw_devscripts_sno_installer_timeout }}"
+
+- name: Ensure secret dir exists
+  ansible.builtin.file:
+    path: "{{ item | dirname }}"
+    state: directory
+    mode: "0755"
+  loop:
+    - "{{ cifmw_manage_secrets_citoken_file }}"
+    - "{{ cifmw_manage_secrets_pullsecret_file }}"
+
+- name: Copy required content - ci token
+  no_log: true
+  ansible.builtin.copy:
+    content: "{{ cifmw_manage_secrets_citoken_content }}"
+    dest: "{{ cifmw_manage_secrets_citoken_file }}"
+    mode: "0640"
+
+- name: Copy required content - pull secret
+  no_log: true
+  ansible.builtin.copy:
+    content: "{{ cifmw_manage_secrets_pullsecret_content }}"
+    dest: "{{ cifmw_manage_secrets_pullsecret_file }}"
+    mode: "0640"
+
+- name: Install required packages
+  ansible.builtin.include_role:
+    name: ci_setup
+    tasks_from: packages.yml