Merge pull request #1012 from rabi/refactor_role

Refactor edpm_network_config role

Author: openshift-merge-bot[bot]

roles/edpm_bootstrap/tasks/packages.yml

@@ -61,21 +61,3 @@
     - "'%verify' in rpm_verify_result.stderr"
   changed_when: false
   become: true
-
-- name: Install and enable network service
-  when:
-    - (edpm_bootstrap_legacy_network_packages | length) > 0
-  become: true
-  block:
-    - name: Deploy network-scripts required for deprecated network service
-      ansible.builtin.dnf:
-        name: "{{ edpm_bootstrap_legacy_network_packages }}"
-        state: present
-      register: edpm_bootstrap_legacy_network_packages_result
-      until: edpm_bootstrap_legacy_network_packages_result is succeeded
-      retries: "{{ edpm_bootstrap_download_retries }}"
-      delay: "{{ edpm_bootstrap_download_delay }}"
-    - name: Ensure network service is enabled
-      ansible.builtin.systemd:
-        name: "{{ edpm_bootstrap_network_service }}"
-        enabled: true

roles/edpm_network_config/defaults/main.yml

@@ -19,12 +19,12 @@
 
 # All variables within this role should have a prefix of "edpm_network_config"
 
-# This variable let the use choose which tool will be used to configure networking on hosts
+# This variable lets the user choose which tool will be used to configure networking on hosts
 # Accepted values are:
-# * os-net-config (default) -> the os-net-config will be used
-# * nmstate (experimental, unsupported) -> the network role from linux-system-roles/rhel-system-roles will be used to
-#   configure networking on hosts. In particular, the nmstate tool should cover all the
-#   supported scenario. Refer to nmstate.io for configuration snippets.
+# * os-net-config (default) -> the os-net-config tool will be used
+#   - Can use either ifcfg or nmstate as internal provider based on edpm_network_config_nmstate
+# * nmstate (experimental, unsupported) -> the network role from linux-system-roles/rhel-system-roles will be used
+#   directly to configure networking on hosts. Refer to nmstate.io for configuration snippets.
 edpm_network_config_tool: os-net-config
 
 # Must be set to true to allow usage of nmstate as edpm_network_config_tool
@@ -48,6 +48,10 @@ edpm_network_config_debug: "{{ (ansible_verbosity | int) >= 2 | bool }}"
 edpm_network_config_hide_sensitive_logs: true
 edpm_network_config_interface_name: nic1
 edpm_network_config_manage_service: true
+# Controls which provider os-net-config uses internally:
+# * true (default) -> os-net-config uses nmstate provider (NetworkManager-based)
+# * false -> os-net-config uses ifcfg provider (legacy network scripts)
+# Note: This only applies when edpm_network_config_tool is 'os-net-config'
 edpm_network_config_nmstate: true
 edpm_network_config_os_net_config_mappings: {}
 edpm_network_config_safe_defaults: false

roles/edpm_network_config/handlers/main.yml

@@ -0,0 +1,21 @@
+---
+# Copyright 2020 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: Reload NetworkManager
+  become: true
+  ansible.builtin.systemd:
+    name: NetworkManager
+    state: reloaded

roles/edpm_network_config/tasks/download_cache.yml

@@ -1,4 +1,18 @@
 ---
+# Copyright 2023 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: Download packages needed by linux-system-role - nmstate and nmsate provider
   when: edpm_network_config_tool == 'nmstate' or edpm_network_config_nmstate | bool

roles/edpm_network_config/tasks/main.yml

@@ -14,67 +14,25 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
-- name: Fail when edpm_network_config_tool=nmstate unless edpm_network_config_tool_nmstate_override=true
-  ansible.builtin.fail:
-    msg: |
-      edpm_network_config_tool=nmstate is experimental and not supported.
-      Set edpm_network_config_tool_nmstate_override=true to continue anyway.
-  when:
-    - edpm_network_config_tool == 'nmstate'
-    - not edpm_network_config_tool_nmstate_override|bool
+# Main orchestrator for network configuration
+# Supports three scenarios:
+# 1. Direct nmstate via linux-system-roles (edpm_network_config_tool: 'nmstate')
+# 2. os-net-config with nmstate provider (tool: 'os-net-config', edpm_network_config_nmstate: true)
+# 3. os-net-config with ifcfg provider (tool: 'os-net-config', edpm_network_config_nmstate: false)
 
-- name: Install OVS NetworkManager plugin [nmstate and nmstate provider]
-  when: edpm_network_config_tool == 'nmstate' or edpm_network_config_nmstate | bool
-  become: true
-  block:
-    - name: Install OVS NetworkManager plugin [nmstate]
-      ansible.builtin.dnf:
-        name: "{{ edpm_network_config_systemrole_nmstate_dependencies }}"
-        state: present
-      register: nm_ovs_status
-      until: nm_ovs_status is succeeded
-      retries: "{{ edpm_network_config_download_retries }}"
-      delay: "{{ edpm_network_config_download_delay }}"
-    - name: Restart NetworkManager after plugin installation [nmstate]
-      ansible.builtin.systemd:
-        name: NetworkManager
-        state: restarted
-      when: nm_ovs_status.changed  # noqa: no-handler
+- name: Setup common pre-configuration
+  ansible.builtin.import_tasks: pre_config.yml
 
-- name: Import DNS NetworkManager configs tasks
-  ansible.builtin.import_tasks: dns_nm_configs.yml
+- name: Install required packages
+  ansible.builtin.import_tasks: package_management.yml
 
-- name: Configure network with network role from system roles [nmstate]
+- name: Configure network with nmstate tool
   when: edpm_network_config_tool == 'nmstate'
-  become: true
-  block:
-    - name: Render network_state variable
-      ansible.builtin.set_fact:
-        network_state: "{{ edpm_network_config_template | from_yaml }}"
-    - name: Load system-roles.network tasks [nmstate]
-      ansible.builtin.include_role:
-        name: "{{ lookup('ansible.builtin.env', 'EDPM_SYSTEMROLES', default='fedora.linux_system_roles') + '.network' }}"
+  ansible.builtin.include_tasks: nmstate_tool.yml
 
-- name: Disable auto-configuration of all interfaces by NetworkManager
+- name: Configure network with os-net-config tool
   when: edpm_network_config_tool == 'os-net-config'
-  become: true
-  block:
-    - name: Set 'no-auto-default' in /etc/NetworkManager/NetworkManager.conf
-      community.general.ini_file:
-        path: /etc/NetworkManager/NetworkManager.conf
-        state: present
-        mode: "0644"
-        no_extra_spaces: true
-        section: main
-        option: no-auto-default
-        value: "*"
-        backup: true
-      register: nm_config_update
-    - name: Restart NetworkManager
-      ansible.builtin.systemd:
-        name: NetworkManager
-        state: restarted
-      when: nm_config_update.changed  # noqa: no-handler
-    - name: Load edpm_network_config tasks for os-net-config tool
-      ansible.builtin.include_tasks:
-        file: network_config.yml
+  ansible.builtin.include_tasks: os_net_config_tool.yml
+
+- name: Run post-configuration tasks
+  ansible.builtin.include_tasks: post_config.yml