Use role instead of playbooks - 01-bootstrap.yml

danpawlik · dasm · commit 712ef7db06d5 · 2025-05-12T11:28:15.000-07:00
Most of the playbooks which are executed inside the nested Ansible
(Ansible inside the Ansible) does not need to be in playbook,
it can be in a simple role.
The previous CI execution for 01-bootstrap.yml file was:

    Zuul CI -&gt;
        Ansible command -&gt;
        Ansible playbook -&gt;
        import playbook -&gt;
        import playbook

With this change would be one layer less:

    Zuul CI -&gt;
        Ansible command -&gt;
        Ansible playbook -&gt;
        cifmw_setup role

Signed-off-by: Daniel Pawlik &lt;dpawlik@redhat.com&gt;
diff --git a/ci/playbooks/content_provider/content_provider.yml b/ci/playbooks/content_provider/content_provider.yml
@@ -1,14 +1,12 @@
 ---
-- name: Bootstrap step
-  ansible.builtin.import_playbook: >-
-    {{
-        [
-          ansible_user_dir,
-          zuul.projects['github.com/openstack-k8s-operators/ci-framework'].src_dir,
-          'playbooks',
-          '01-bootstrap.yml'
-        ] | ansible.builtin.path_join
-    }}
+- name: Bootstrap playbook
+  hosts: "{{ cifmw_target_host | default('localhost') }}"
+  gather_facts: true
+  tasks:
+    - name: Run bootstrap
+      ansible.builtin.import_role:
+        name: cifmw_setup
+        tasks_from: bootstrap.yml
 
 - name: "Run ci/playbooks/content_provider/content_provider.yml"
   hosts: "{{ cifmw_target_host | default('localhost') }}"
diff --git a/ci/playbooks/edpm_build_images/edpm_image_builder.yml b/ci/playbooks/edpm_build_images/edpm_image_builder.yml
@@ -1,14 +1,12 @@
 ---
-- name: Boostrap node
-  ansible.builtin.import_playbook: >-
-    {{
-        [
-          ansible_user_dir,
-          zuul.projects['github.com/openstack-k8s-operators/ci-framework'].src_dir,
-          'playbooks',
-          '01-bootstrap.yml'
-        ] | ansible.builtin.path_join
-    }}
+- name: Bootstrap playbook
+  hosts: "{{ cifmw_target_host | default('localhost') }}"
+  gather_facts: true
+  tasks:
+    - name: Run bootstrap
+      ansible.builtin.import_role:
+        name: cifmw_setup
+        tasks_from: bootstrap.yml
 
 - name: "Run ci/playbooks/edpm_build_images/edpm_image_builder.yml"
   hosts: "{{ cifmw_zuul_target_host | default('localhost') }}"
diff --git a/ci/playbooks/kuttl/deploy-deps.yaml b/ci/playbooks/kuttl/deploy-deps.yaml
@@ -1,6 +1,12 @@
 ---
-- name: Run ci_framework bootstrap playbook
-  ansible.builtin.import_playbook: "../../../playbooks/01-bootstrap.yml"
+- name: Bootstrap playbook
+  hosts: "{{ cifmw_target_host | default('localhost') }}"
+  gather_facts: true
+  tasks:
+    - name: Run bootstrap
+      ansible.builtin.import_role:
+        name: cifmw_setup
+        tasks_from: bootstrap.yml
 
 - hosts: "{{ cifmw_target_host | default('localhost') }}"
   name: Install dev tools
diff --git a/ci/playbooks/kuttl/e2e-kuttl.yml b/ci/playbooks/kuttl/e2e-kuttl.yml
@@ -1,14 +1,12 @@
 ---
-- name: Bootstrap step
-  ansible.builtin.import_playbook: >-
-    {{
-        [
-          ansible_user_dir,
-          zuul.projects['github.com/openstack-k8s-operators/ci-framework'].src_dir,
-          'playbooks',
-          '01-bootstrap.yml'
-        ] | ansible.builtin.path_join
-    }}
+- name: Bootstrap playbook
+  hosts: "{{ cifmw_target_host | default('localhost') }}"
+  gather_facts: true
+  tasks:
+    - name: Run bootstrap
+      ansible.builtin.import_role:
+        name: cifmw_setup
+        tasks_from: bootstrap.yml
 
 - name: Install deps and prepare for KUTTL run
   hosts: "{{ cifmw_target_host | default('localhost') }}"
diff --git a/ci/playbooks/meta_content_provider/meta_content_provider.yml b/ci/playbooks/meta_content_provider/meta_content_provider.yml
@@ -1,19 +1,13 @@
 ---
-- name: Bootstrap step
-  ansible.builtin.import_playbook: >-
-    {{
-        [
-          ansible_user_dir,
-          zuul.projects['github.com/openstack-k8s-operators/ci-framework'].src_dir,
-          'playbooks',
-          '01-bootstrap.yml'
-        ] | ansible.builtin.path_join
-    }}
-
 - name: Run ci/playbooks/meta_content_provider/meta_content_provider.yml
   hosts: "{{ cifmw_target_host | default('localhost') }}"
   gather_facts: true
   tasks:
+    - name: Run bootstrap
+      ansible.builtin.import_role:
+        name: cifmw_setup
+        tasks_from: bootstrap.yml
+
     - name: Install necessary dependencies
       ansible.builtin.include_role:
         name: 'install_yamls_makes'
diff --git a/ci/playbooks/tcib/tcib.yml b/ci/playbooks/tcib/tcib.yml
@@ -1,14 +1,12 @@
 ---
-- name: Bootstrap step
-  ansible.builtin.import_playbook: >-
-    {{
-        [
-          ansible_user_dir,
-          zuul.projects['github.com/openstack-k8s-operators/ci-framework'].src_dir,
-          'playbooks',
-          '01-bootstrap.yml'
-        ] | ansible.builtin.path_join
-    }}
+- name: Bootstrap playbook
+  hosts: "{{ cifmw_target_host | default('localhost') }}"
+  gather_facts: true
+  tasks:
+    - name: Run bootstrap
+      ansible.builtin.import_role:
+        name: cifmw_setup
+        tasks_from: bootstrap.yml
 
 - name: "Run ci/playbooks/tcib/tcib.yml"
   hosts: "{{ cifmw_target_host | default('localhost') }}"
diff --git a/deploy-edpm.yml b/deploy-edpm.yml
@@ -18,8 +18,10 @@
       ansible.builtin.include_tasks:
         file: "ci/playbooks/tasks/inherit_parent_scenario.yml"
 
-- name: Bootstrap step
-  ansible.builtin.import_playbook: playbooks/01-bootstrap.yml
+    - name: Run bootstrap
+      ansible.builtin.import_role:
+        name: cifmw_setup
+        tasks_from: bootstrap.yml
 
 - name: Import infra entrypoint playbook
   ansible.builtin.import_playbook: playbooks/02-infra.yml
diff --git a/hooks/playbooks/ceph-deploy.yml b/hooks/playbooks/ceph-deploy.yml
@@ -14,6 +14,7 @@
     # Since the hook injects the ansible.cfg in the ansible-playbook command,
     # we therefore should know where to look for the install_yamls_makes role.
     # For the records, this role is generated in the 01-bootstrap.yml playbook
+    # (migrated to: roles/cifmw_setup/tasks/bootstrap.yml)
     # by leveraging the install_yamls role and related modules, especially
     # the generate_make_tasks.
     # And we can pass down the cifmw_make_ceph_environment set in the
diff --git a/playbooks/01-bootstrap.yml b/playbooks/01-bootstrap.yml
@@ -1,3 +1,5 @@
+---
+# NOTE: Playbook migrated to: cifmw_setup/tasks/bootstrap.yml.
 - name: Bootstrap playbook
   hosts: "{{ cifmw_target_host | default('localhost') }}"
   gather_facts: true
diff --git a/roles/cifmw_setup/defaults/main.yml b/roles/cifmw_setup/defaults/main.yml
@@ -0,0 +1,2 @@
+---
+ansible_user_dir: "{{ lookup('env', 'HOME') }}"
diff --git a/roles/cifmw_setup/tasks/bootstrap.yml b/roles/cifmw_setup/tasks/bootstrap.yml
@@ -0,0 +1,67 @@
+---
+- name: Set custom cifmw PATH reusable fact
+  tags:
+    - always
+  when:
+    - cifmw_path is not defined
+  ansible.builtin.set_fact:
+    cifmw_path: "{{ ansible_user_dir }}/.crc/bin:{{ ansible_user_dir }}/.crc/bin/oc:{{ ansible_user_dir }}/bin:{{ ansible_env.PATH }}"
+    cacheable: true
+
+- name: Get customized parameters
+  tags:
+    - always
+  ansible.builtin.set_fact:
+    ci_framework_params: >-
+      {{
+        hostvars[inventory_hostname] |
+        dict2items |
+        selectattr("key", "match",
+                   "^(cifmw|pre|post)_(?!install_yamls|openshift_token|openshift_login|openshift_kubeconfig).*") |
+        list | items2dict
+      }}
+
+- name: Install custom CAs as soon as possible
+  tags:
+    - bootstrap
+    - packages
+  ansible.builtin.import_role:
+    name: install_ca
+
+- name: Run repo_setup
+  tags:
+    - bootstrap
+    - packages
+  ansible.builtin.import_role:
+    name: repo_setup
+
+- name: Run ci_setup role
+  tags:
+    - bootstrap
+  ansible.builtin.import_role:
+    role: ci_setup
+
+- name: Prepare install_yamls make targets
+  when:
+    - cifmw_architecture_scenario is undefined
+  tags:
+    - bootstrap
+  ansible.builtin.include_role:
+    name: install_yamls
+    apply:
+      tags:
+        - bootstrap
+
+- name: Get latest image for future reference
+  tags:
+    - bootstrap
+  ansible.builtin.import_role:
+    role: discover_latest_image
+
+- name: Create artifacts with custom params
+  tags:
+    - always
+  ansible.builtin.copy:
+    mode: "0644"
+    dest: "{{ cifmw_basedir|default(ansible_user_dir ~ '/ci-framework-data') }}/artifacts/parameters/custom-params.yml"
+    content: "{{ ci_framework_params | to_nice_yaml }}"
diff --git a/roles/reproducer/tasks/main.yml b/roles/reproducer/tasks/main.yml
@@ -284,17 +284,14 @@
             - "/home/zuul/ansible-bootstrap.log"
 
         - name: Bootstrap environment on controller-0
-          environment:
-            ANSIBLE_LOG_PATH: "~/ansible-bootstrap.log"
+          vars:
+            # NOTE: need to overwrite parent vars:
+            # ./roles/reproducer/molecule/crc_layout/converge.yml
+            cifmw_basedir: "{{ ansible_user_dir ~ '/ci-framework-data' }}"
           no_log: "{{ cifmw_nolog | default(true) | bool }}"
-          ansible.builtin.command:
-            chdir: "{{ _cifmw_reproducer_framework_location }}"
-            cmd: >-
-              ansible-playbook -i ~/ci-framework-data/artifacts/zuul_inventory.yml
-              -e @~/ci-framework-data/parameters/reproducer-variables.yml
-              -e @scenarios/reproducers/networking-definition.yml
-              playbooks/01-bootstrap.yml
-            creates: "/home/zuul/ansible-bootstrap.log"
+          ansible.builtin.import_role:
+            name: cifmw_setup
+            tasks_from: bootstrap.yml
 
         - name: Install dev tools from install_yamls on controller-0
           environment:
diff --git a/scenarios/centos-9/ci.yml b/scenarios/centos-9/ci.yml
@@ -34,7 +34,8 @@ cifmw_run_tests: true
 # The actual ceph_make task understands "make_ceph_environment".
 # But since we're calling it via hook, in order to expose it properly, we
 # have to prefix it with "cifmw_". It will then end in the generated file from
-# 01-bootstrap.yml playbook (custom-params.yml), and the hook will be able
+# 01-bootstrap.yml playbook (custom-params.yml; migrated to
+# roles/cifmw_setup/tasks/bootstrap.yml), and the hook will be able
 # to load it and consume the parameters properly
 # Check hooks/playbooks/ceph-deploy.yml for the whole logic.
 cifmw_make_ceph_environment:
diff --git a/zuul.d/adoption.yaml b/zuul.d/adoption.yaml
@@ -117,7 +117,6 @@
     parent: adoption-standalone-to-crc-ceph
     files:
       # ci-framework
-      - ^playbooks/01-bootstrap.yml
       - ^playbooks/02-infra.yml
       - ^playbooks/06-deploy-edpm.yml
       - ^roles/discover_latest_image/.*
@@ -127,6 +126,7 @@
       - ^roles/openshift_login/.*
       - ^roles/openshift_setup/.*
       - ^roles/repo_setup/.*
+      - ^roles/cifmw_setup/.*
       - ^hooks/playbooks/fetch_compute_facts.yml
       - ^zuul.d/adoption.yaml
       # openstack-operator
diff --git a/zuul.d/molecule.yaml b/zuul.d/molecule.yaml
@@ -875,6 +875,15 @@
     - ^.config/molecule/.*
     name: cifmw-molecule-cifmw_external_dns
     parent: cifmw-molecule-noop
+- job:
+    files:
+    - ^common-requirements.txt
+    - ^test-requirements.txt
+    - ^roles/cifmw_setup/.*
+    - ^ci/playbooks/molecule.*
+    - ^.config/molecule/.*
+    name: cifmw-molecule-cifmw_setup
+    parent: cifmw-molecule-noop
 - job:
     files:
     - ^common-requirements.txt
diff --git a/zuul.d/projects.yaml b/zuul.d/projects.yaml
@@ -34,6 +34,7 @@
       - cifmw-molecule-cifmw_create_admin
       - cifmw-molecule-cifmw_external_dns
       - cifmw-molecule-cifmw_ntp
+      - cifmw-molecule-cifmw_setup
       - cifmw-molecule-cifmw_test_role
       - cifmw-molecule-compliance
       - cifmw-molecule-config_drive

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+---`
	`2`	`+# NOTE: Playbook migrated to: cifmw_setup/tasks/bootstrap.yml.`
`1`	`3`	`- name: Bootstrap playbook`
`2`	`4`	`hosts: "{{ cifmw_target_host \| default('localhost') }}"`
`3`	`5`	`gather_facts: true`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+---`
	`2`	`+ansible_user_dir: "{{ lookup('env', 'HOME') }}"`