feat: export corosync configuration

[tomjelinek]

Enhancement:
Provide ha_cluster_info module to export current cluster configuration. This PR implements a first stage, exporting corosync configuration. Other parts of configuration will follow in other PRs.

Reason:
This is the first step in implementing an info module which exports cluster configuration in a variables structure in the same format as ha_cluster role accepts.

Result:
ha_cluster_info module exports corosync configuration, which can be used to recreate the same corosync cluster when passed to the role

Issue Tracker Tickets (Jira or BZ if any):
https://issues.redhat.com/browse/RHEL-46219

[tomjelinek]

[citest]

[tomjelinek]

I updated the pcs_version vs ubuntu version matrix, as pcs main no longer builds on ubuntu-22.04. And then Python Unit Tests / python (ubuntu-24.04, main) fails when trying to upgrade pip:

+ python -m pip install --upgrade pip
error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
    python3-xyz, where xyz is the package you are trying to
    install.
    
    If you wish to install a non-Debian-packaged Python package,
    create a virtual environment using python3 -m venv path/to/venv.
    Then use path/to/venv/bin/python and path/to/venv/bin/pip. Make
    sure you have python3-full installed.
    
    If you wish to install a non-Debian packaged Python application,
    it may be easiest to use pipx install xyz, which will manage a
    virtual environment for you. Make sure you have pipx installed.
    
    See /usr/share/doc/python3.12/README.venv for more information.

note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.

I suppose upgrading pip could be removed. But I'm afraid that would solve nothing, as the next command is pip install "git+https://github.com/linux-system-roles/[email protected]" and that would probably fail with the same message. So what's the process of installing tox-lsr on ubuntu-24.04? Should I just add --break-system-packages as the message suggests?

[tomjelinek]

ansible_test fails with this error:

Running sanity test "ansible-doc"
Run command: ansible-doc -t module fedora.linux_system_roles.ha_cluster_info fedora.linux_system_roles.pcs_api_v2 fedora.linux_system_roles.pcs_qdevice_certs
ERROR: Output on stderr from ansible-doc is considered an error.

Command "ansible-doc -t module fedora.linux_system_roles.ha_cluster_info fedora.linux_system_roles.pcs_api_v2 fedora.linux_system_roles.pcs_qdevice_certs" returned exit status 0.
>>> Standard Error
Warning: : Collection fedora.linux_system_roles does not support Ansible
version 2.14.17.post0

Any idea what this means and how to fix it?

[tomjelinek]

CentOS-Stream-8|ansible-2.9 fails with Could not detect a supported package manager from the following list: ['pkg', 'apt', 'rpm', 'portage'], or the required Python library is not installed. Check warnings for details.. I think we went over this already, and the resolution was that this was an incompatibility between CentOS 8 and Ansible.

I'm not sure why the other CentOS and Fedora tests are marked as failures, when all their logs are success.

[spetrosi]

[citest]

[spetrosi]

CentOS-Stream-8|ansible-2.9 fails with Could not detect a supported package manager from the following list: ['pkg', 'apt', 'rpm', 'portage'], or the required Python library is not installed. Check warnings for details.. I think we went over this already, and the resolution was that this was an incompatibility between CentOS 8 and Ansible.

Looking into this, I think it used to work, idk what broke it.

I'm not sure why the other CentOS and Fedora tests are marked as failures, when all their logs are success.

Fixed in linux-system-roles/tft-tests#53, tests passed but some tasks run in background after the testing phase finished, it caused the failure of test plan. Now it's passing.

[spetrosi]

Fixing issue with ansible-2.9 on CS8 in linux-system-roles/tft-tests#54

[spetrosi]

[citest]

[richm]

System roles, by convention, do not support users using modules directly. In every other role that does something like this, users use the role with either no arguments like https://github.com/linux-system-roles/firewall?tab=readme-ov-file#gathering-firewall-ansible-facts:

- name: Get current cluster configuration
  include_role:
    name: linux-system-roles.ha_cluster

or with some special variable

- name: Get current cluster configuration
  include_role:
    name: linux-system-roles.ha_cluster
  vars:
    ha_cluster_get_info: true

I think the ha_cluster role will have to do something like the latter, since there are numerous public api variables, as opposed to the firewall role which just has the one main firewall variable. The latter also makes it possible for the role to

• set the state of the cluster and return the cluster configuration
• return a subset of the information

[richm]

The role would then set a global variable e.g. ha_cluster_info that users would use. This return variable will be declared in the README.md in the section Variables Exported by the Role e.g. https://github.com/linux-system-roles/kernel_settings?tab=readme-ov-file#variables-exported-by-the-role

[richm]

ping

[spetrosi]

bootloader and snapshot roles export info with <rolename>_facts variable. Let's be consistent with this naming.

[tomjelinek]

Sorry, I've been busy with other projects.

I wasn't sure what would be the correct way to expose the export functionality. So I'm glad you pointed me in the right direction. I'm going to implement this change, hopefully in a couple of weeks, once I finish tasks that require my immediate attention.

[tomjelinek]

I pushed new commits which implement this requested change.

[codecov]

Codecov Report

Attention: Patch coverage is 89.44444% with 19 lines in your changes missing coverage. Please review.

Project coverage is 78.94%. Comparing base (fd00915) to head (c94f3ad).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
library/ha_cluster_info.py	64.00%	18 Missing ⚠️
module_utils/ha_cluster_lsr/info/loader.py	98.46%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #231       +/-   ##
===========================================
+ Coverage   68.50%   78.94%   +10.43%     
===========================================
  Files           3        6        +3     
  Lines         181      361      +180     
===========================================
+ Hits          124      285      +161     
- Misses         57       76       +19     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tomjelinek]

[citest]