Merge pull request #1049 from slagle/edpm_playbook_environment

Add edpm_playbook_environment variable support to all playbooks

Author: openshift-merge-bot[bot]

docs/source/contributing_playbooks.rst

@@ -26,7 +26,7 @@ roles, a new role should be submitted in the same PR implementing it.
 If possible, playbooks should not use tasks directly, only trough a role.
 
 Playbooks must use following basic layout. Exposing variables, `edpm_override_hosts`,
-`edpm_max_fail_percentage` and `edpm_any_errors_fatal`.
+`edpm_max_fail_percentage`, `edpm_any_errors_fatal`, and `edpm_playbook_environment`.
 
 .. code-block:: YAML
 
@@ -36,9 +36,34 @@ Playbooks must use following basic layout. Exposing variables, `edpm_override_ho
       become: true
       any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
       max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+      environment: "{{ edpm_playbook_environment | default({}) }}"
 
 This allows for more granular error handling and playbook application by operators.
 
+Environment Variables
+++++++++++++++++++++++
+
+All playbooks must include the `environment` key at the top level (play level) that
+references the `edpm_playbook_environment` variable. This variable allows operators
+to set environment variables (such as proxy settings) that will be applied to all
+tasks within the playbook.
+
+The `edpm_playbook_environment` variable should be a dictionary containing
+environment variable key-value pairs. If not defined, it defaults to an empty
+dictionary, ensuring backward compatibility.
+
+Example usage:
+
+.. code-block:: YAML
+
+    edpm_playbook_environment:
+      HTTP_PROXY: "http://proxy.example.com:8080"
+      HTTPS_PROXY: "http://proxy.example.com:8080"
+      NO_PROXY: "localhost,127.0.0.1"
+      http_proxy: "http://proxy.example.com:8080"
+      https_proxy: "http://proxy.example.com:8080"
+      no_proxy: "localhost,127.0.0.1"
+
 Error handling
 ++++++++++++++
 

playbooks/bootstrap.yml

@@ -3,6 +3,7 @@
   hosts: "{{ edpm_override_hosts | default('all', true) }}"
   strategy: linear
   gather_facts: false
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     - name: Wait for connection
       ansible.builtin.wait_for_connection:
@@ -14,6 +15,7 @@
   gather_facts: "{{ gather_facts | default(false) }}"
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     - name: Gather ansible_local facts
       ansible.builtin.setup:

playbooks/ceph_client.yml

@@ -6,6 +6,7 @@
   gather_facts: "{{ gather_facts | default(false) }}"
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     # Copy files from localhost, path specified in `edpm_ceph_client_files_source`
     - name: Configure EDPM as client of Ceph

playbooks/ceph_hci_pre.yml

@@ -6,6 +6,7 @@
   gather_facts: "{{ gather_facts | default(false) }}"
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     # Sets up firewall for ceph
     - name: Prepare EDPM to Host Ceph

playbooks/configure_network.yml

@@ -6,6 +6,7 @@
   gather_facts: "{{ gather_facts | default(false) }}"
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     - name: Gather ansible_local facts
       ansible.builtin.setup:

playbooks/configure_os.yml

@@ -6,6 +6,7 @@
   gather_facts: "{{ gather_facts | default(false) }}"
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     - name: Gather ansible_local facts
       ansible.builtin.setup:

playbooks/configure_ovs_dpdk.yml

@@ -4,6 +4,7 @@
   hosts: "{{ edpm_override_hosts | default('all', true) }}"
   strategy: linear
   gather_facts: "{{ gather_facts | default(false) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     - name: Gather ansible_local facts
       ansible.builtin.setup:

playbooks/download_cache.yml

@@ -6,6 +6,7 @@
   gather_facts: "{{ gather_facts | default(false) }}"
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     - name: Gather ansible_local facts
       ansible.builtin.setup:

playbooks/fips_status.yml

@@ -5,6 +5,7 @@
   gather_facts: "{{ gather_facts | default(false) }}"
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     - name: FIPS status
       ansible.builtin.include_role:

playbooks/frr.yml

@@ -6,6 +6,7 @@
   gather_facts: "{{ gather_facts | default(false) }}"
   any_errors_fatal: "{{ edpm_any_errors_fatal | default(true) }}"
   max_fail_percentage: "{{ edpm_max_fail_percentage | default(0) }}"
+  environment: "{{ edpm_playbook_environment | default({}) }}"
   tasks:
     - name: EDPM FRR
       ansible.builtin.import_role: