From f09635db7343c6a69b8adcdc61fb524129d1bdce Mon Sep 17 00:00:00 2001 From: gardar Date: Tue, 15 Oct 2024 17:05:25 +0000 Subject: [PATCH] refactor(ipmi_exporter): delegate common tasks to _common role Signed-off-by: gardar --- roles/ipmi_exporter/defaults/main.yml | 14 ++-- roles/ipmi_exporter/meta/argument_specs.yml | 20 ++--- .../molecule/alternative/molecule.yml | 6 +- .../molecule/default/tests/test_default.py | 1 - roles/ipmi_exporter/tasks/configure.yml | 57 ++++++-------- roles/ipmi_exporter/tasks/install.yml | 74 ------------------- roles/ipmi_exporter/tasks/main.yml | 46 +++++------- roles/ipmi_exporter/tasks/preflight.yml | 68 +++-------------- roles/ipmi_exporter/tasks/selinux.yml | 23 ------ .../templates/ipmi_exporter.service.j2 | 4 +- .../templates/web_config.yaml.j2 | 18 ----- roles/ipmi_exporter/vars/main.yml | 17 +++-- 12 files changed, 76 insertions(+), 272 deletions(-) delete mode 100644 roles/ipmi_exporter/tasks/install.yml delete mode 100644 roles/ipmi_exporter/tasks/selinux.yml delete mode 100644 roles/ipmi_exporter/templates/web_config.yaml.j2 diff --git a/roles/ipmi_exporter/defaults/main.yml b/roles/ipmi_exporter/defaults/main.yml index 4635c988..caa0009f 100644 --- a/roles/ipmi_exporter/defaults/main.yml +++ b/roles/ipmi_exporter/defaults/main.yml @@ -1,10 +1,8 @@ --- ipmi_exporter_version: 1.8.0 -ipmi_exporter_binary_local_dir: "" ipmi_exporter_binary_url: "https://github.com/{{ _ipmi_exporter_repo }}/releases/download/v{{ ipmi_exporter_version }}/\ - ipmi_exporter-{{ ipmi_exporter_version }}.linux-{{ go_arch }}.tar.gz" + ipmi_exporter-{{ ipmi_exporter_version }}.{{ ansible_system | lower }}-{{ _ipmi_exporter_go_ansible_arch }}.tar.gz" ipmi_exporter_checksums_url: "https://github.com/{{ _ipmi_exporter_repo }}/releases/download/v{{ ipmi_exporter_version }}/sha256sums.txt" -ipmi_exporter_skip_install: false ipmi_exporter_modules: default: @@ -18,17 +16,17 @@ ipmi_exporter_modules: ipmi_exporter_web_listen_address: "0.0.0.0:9290" ipmi_exporter_tls_server_config: {} - ipmi_exporter_http_server_config: {} - ipmi_exporter_basic_auth_users: {} ipmi_exporter_log_level: "info" ipmi_exporter_log_format: "logfmt" ipmi_exporter_binary_install_dir: "/usr/local/bin" -ipmi_exporter_system_group: "ipmi-exp" -ipmi_exporter_system_user: "{{ ipmi_exporter_system_group }}" +ipmi_exporter_system_user: "ipmi-exp" +ipmi_exporter_system_group: "{{ ipmi_exporter_system_user }}" + +ipmi_exporter_config_dir: /etc/ipmi_exporter # Local path to stash the archive and its extraction -ipmi_exporter_archive_path: /tmp +ipmi_exporter_local_cache_path: "/tmp/ipmi_exporter-{{ ansible_system | lower }}-{{ _ipmi_exporter_go_ansible_arch }}/{{ ipmi_exporter_version }}" diff --git a/roles/ipmi_exporter/meta/argument_specs.yml b/roles/ipmi_exporter/meta/argument_specs.yml index 7142d073..76effcd3 100644 --- a/roles/ipmi_exporter/meta/argument_specs.yml +++ b/roles/ipmi_exporter/meta/argument_specs.yml @@ -11,18 +11,9 @@ argument_specs: ipmi_exporter_version: description: "ipmi_exporter package version. Also accepts latest as parameter." default: "1.8.0" - ipmi_exporter_skip_install: - description: "ipmi_exporter installation tasks gets skipped when set to true." - type: bool - default: false - ipmi_exporter_binary_local_dir: - description: - - "Enables the use of local packages instead of those distributed on github." - - "The parameter may be set to a directory where the C(ipmi_exporter) binary is stored on the host where ansible is run." - - "This overrides the I(ipmi_exporter_version) parameter" ipmi_exporter_binary_url: description: "URL of the ipmi_exporter binaries .tar.gz file" - default: "https://github.com/{{ _ipmi_exporter_repo }}/releases/download/v{{ ipmi_exporter_version }}/ipmi_exporter-{{ ipmi_exporter_version }}.linux-{{ go_arch }}.tar.gz" + default: "https://github.com/{{ _ipmi_exporter_repo }}/releases/download/v{{ ipmi_exporter_version }}/ipmi_exporter-{{ ipmi_exporter_version }}.{{ ansible_system | lower }}-{{ _ipmi_exporter_go_ansible_arch }}.tar.gz" ipmi_exporter_checksums_url: description: "URL of the ipmi_exporter checksums file" default: "https://github.com/{{ _ipmi_exporter_repo }}/releases/download/v{{ ipmi_exporter_version }}/sha256sums.txt" @@ -68,6 +59,9 @@ argument_specs: - "I(Advanced)" - "ipmi_exporter user" default: "ipmi-exp" - ipmi_exporter_archive_path: - description: 'Local path to stash the archive and its extraction' - default: "/tmp" + ipmi_exporter_local_cache_path: + description: "Local path to stash the archive and its extraction" + default: "/tmp/ipmi_exporter-{{ ansible_system | lower }}-{{ _ipmi_exporter_go_ansible_arch }}/{{ ipmi_exporter_version }}" + ipmi_exporter_config_dir: + description: "Path to directory with ipmi_exporter configuration" + default: "/etc/ipmi_exporter" diff --git a/roles/ipmi_exporter/molecule/alternative/molecule.yml b/roles/ipmi_exporter/molecule/alternative/molecule.yml index d997bc7f..f35e7095 100644 --- a/roles/ipmi_exporter/molecule/alternative/molecule.yml +++ b/roles/ipmi_exporter/molecule/alternative/molecule.yml @@ -5,7 +5,7 @@ provisioner: inventory: group_vars: all: - ipmi_exporter_binary_local_dir: "/tmp/ipmi_exporter-linux-amd64" + ipmi_exporter_local_cache_path: "/tmp/ipmi_exporter-linux-amd64" ipmi_exporter_web_listen_address: "127.0.0.1:8080" ipmi_exporter_tls_server_config: cert_file: /etc/ipmi_exporter/tls.cert @@ -14,8 +14,6 @@ provisioner: http2: true ipmi_exporter_basic_auth_users: randomuser: examplepassword - go_arch: amd64 ipmi_exporter_version: 1.6.1 ipmi_exporter_binary_url: "https://github.com/prometheus-community/ipmi_exporter/releases/download/v{{\ - \ ipmi_exporter_version }}/ipmi_exporter-{{ ipmi_exporter_version }}.linux-{{\ - \ go_arch }}.tar.gz" + \ ipmi_exporter_version }}/ipmi_exporter-{{ ipmi_exporter_version }}.linux-amd64.tar.gz" diff --git a/roles/ipmi_exporter/molecule/default/tests/test_default.py b/roles/ipmi_exporter/molecule/default/tests/test_default.py index bcde0128..b3811549 100644 --- a/roles/ipmi_exporter/molecule/default/tests/test_default.py +++ b/roles/ipmi_exporter/molecule/default/tests/test_default.py @@ -31,7 +31,6 @@ def test_user(host): assert host.group("ipmi-exp").exists assert "ipmi-exp" in host.user("ipmi-exp").groups assert host.user("ipmi-exp").shell == "/usr/sbin/nologin" - assert host.user("ipmi-exp").home == "/" def test_service(host): diff --git a/roles/ipmi_exporter/tasks/configure.yml b/roles/ipmi_exporter/tasks/configure.yml index 34a03ef8..25cc671e 100644 --- a/roles/ipmi_exporter/tasks/configure.yml +++ b/roles/ipmi_exporter/tasks/configure.yml @@ -1,47 +1,32 @@ --- -- name: Copy the ipmi_exporter systemd service file - ansible.builtin.template: - src: ipmi_exporter.service.j2 - dest: /etc/systemd/system/ipmi_exporter.service - owner: root - group: root - mode: 0644 - notify: restart ipmi_exporter - -- name: Create ipmi_exporter config directory - ansible.builtin.file: - path: "/etc/ipmi_exporter" - state: directory - owner: root - group: root - mode: u+rwX,g+rwX,o=rX - -- name: Copy the ipmi_exporter web config file - ansible.builtin.template: - src: web_config.yaml.j2 - dest: /etc/ipmi_exporter/web_config.yaml - owner: root - group: root - mode: 0644 - notify: restart ipmi_exporter +- name: "Common configure" + ansible.builtin.include_role: + name: prometheus.prometheus._common + tasks_from: configure.yml + vars: + _common_system_user: "{{ ipmi_exporter_system_user }}" + _common_system_group: "{{ ipmi_exporter_system_group }}" + _common_config_dir: "{{ ipmi_exporter_config_dir }}" + _common_tls_server_config: "{{ ipmi_exporter_tls_server_config }}" + _common_http_server_config: "{{ ipmi_exporter_http_server_config }}" + _common_basic_auth_users: "{{ ipmi_exporter_basic_auth_users }}" + tags: + - ipmi_exporter + - configure + - ipmi_exporter_configure - name: Copy the ipmi_exporter config file ansible.builtin.template: src: config.yaml.j2 dest: /etc/ipmi_exporter/config.yaml - owner: root + owner: "{{ ipmi_exporter_system_user }}" group: "{{ ipmi_exporter_system_group }}" mode: 0640 + become: true no_log: "{{ false if (lookup('env', 'CI')) or (lookup('env', 'MOLECULE_PROVISIONER_NAME')) else true }}" notify: - restart ipmi_exporter - -- name: Allow ipmi_exporter port in SELinux on RedHat OS family - community.general.seport: - ports: "{{ ipmi_exporter_web_listen_address.split(':')[-1] }}" - proto: tcp - setype: http_port_t - state: present - when: - - ansible_version.full is version_compare('2.4', '>=') - - ansible_selinux.status == "enabled" + tags: + - ipmi_exporter + - configure + - ipmi_exporter_configure diff --git a/roles/ipmi_exporter/tasks/install.yml b/roles/ipmi_exporter/tasks/install.yml deleted file mode 100644 index b251a58f..00000000 --- a/roles/ipmi_exporter/tasks/install.yml +++ /dev/null @@ -1,74 +0,0 @@ ---- -- name: Create the ipmi_exporter group - ansible.builtin.group: - name: "{{ ipmi_exporter_system_group }}" - state: present - system: true - when: ipmi_exporter_system_group != "root" - -- name: Create the ipmi_exporter user - ansible.builtin.user: - name: "{{ ipmi_exporter_system_user }}" - groups: "{{ ipmi_exporter_system_group }}" - append: true - shell: /usr/sbin/nologin - system: true - create_home: false - home: / - when: ipmi_exporter_system_user != "root" - -- name: Get binary - when: - - ipmi_exporter_binary_local_dir | length == 0 - - not ipmi_exporter_skip_install - block: - - - name: Download ipmi_exporter binary to local folder - become: false - ansible.builtin.get_url: - url: "{{ ipmi_exporter_binary_url }}" - dest: "{{ ipmi_exporter_archive_path }}/ipmi_exporter-{{ ipmi_exporter_version }}.linux-{{ go_arch }}.tar.gz" - checksum: "sha256:{{ __ipmi_exporter_checksum }}" - mode: '0644' - register: _download_binary - until: _download_binary is succeeded - retries: 5 - delay: 2 - delegate_to: localhost - check_mode: false - - - name: Unpack ipmi_exporter binary - become: false - ansible.builtin.unarchive: - src: "{{ ipmi_exporter_archive_path }}/ipmi_exporter-{{ ipmi_exporter_version }}.linux-{{ go_arch }}.tar.gz" - dest: "{{ ipmi_exporter_archive_path }}" - creates: "{{ ipmi_exporter_archive_path }}/ipmi_exporter-{{ ipmi_exporter_version }}.linux-{{ go_arch }}/ipmi_exporter" - delegate_to: localhost - check_mode: false - - - name: Propagate ipmi_exporter binaries - ansible.builtin.copy: - src: "{{ ipmi_exporter_archive_path }}/ipmi_exporter-{{ ipmi_exporter_version }}.linux-{{ go_arch }}/ipmi_exporter" - dest: "{{ ipmi_exporter_binary_install_dir }}/ipmi_exporter" - mode: 0755 - owner: root - group: root - notify: restart ipmi_exporter - when: not ansible_check_mode - -- name: Propagate locally distributed ipmi_exporter binary - ansible.builtin.copy: - src: "{{ ipmi_exporter_binary_local_dir }}/ipmi_exporter" - dest: "{{ ipmi_exporter_binary_install_dir }}/ipmi_exporter" - mode: 0755 - owner: root - group: root - when: - - ipmi_exporter_binary_local_dir | length > 0 - - not ipmi_exporter_skip_install - notify: restart ipmi_exporter - -- name: Install freeipmi package - ansible.builtin.package: - name: freeipmi - state: present diff --git a/roles/ipmi_exporter/tasks/main.yml b/roles/ipmi_exporter/tasks/main.yml index c3ebe6d1..cb731771 100644 --- a/roles/ipmi_exporter/tasks/main.yml +++ b/roles/ipmi_exporter/tasks/main.yml @@ -2,40 +2,34 @@ - name: Preflight ansible.builtin.include_tasks: file: preflight.yml - apply: - tags: - - ipmi_exporter_install - - ipmi_exporter_configure - - ipmi_exporter_run tags: - ipmi_exporter_install - ipmi_exporter_configure - ipmi_exporter_run - name: Install - ansible.builtin.include_tasks: - file: install.yml - apply: - become: true - tags: - - ipmi_exporter_install - when: - ( not __ipmi_exporter_is_installed.stat.exists ) or - ( (__ipmi_exporter_current_version_output.stderr_lines | length > 0) - and (__ipmi_exporter_current_version_output.stderr_lines[0].split(" ")[2] != ipmi_exporter_version) ) or - ( (__ipmi_exporter_current_version_output.stdout_lines | length > 0) - and (__ipmi_exporter_current_version_output.stdout_lines[0].split(" ")[2] != ipmi_exporter_version) ) or - ( ipmi_exporter_binary_local_dir | length > 0 ) + ansible.builtin.include_role: + name: prometheus.prometheus._common + tasks_from: install.yml + vars: + _common_local_cache_path: "{{ ipmi_exporter_local_cache_path }}" + _common_binaries: "{{ _ipmi_exporter_binaries }}" + _common_binary_install_dir: "{{ ipmi_exporter_binary_install_dir }}" + _common_binary_url: "{{ ipmi_exporter_binary_url }}" + _common_checksums_url: "{{ ipmi_exporter_checksums_url }}" + _common_system_group: "{{ ipmi_exporter_system_group }}" + _common_system_user: "{{ ipmi_exporter_system_user }}" + _common_config_dir: "{{ ipmi_exporter_config_dir }}" + _common_binary_unarchive_opts: ['--strip-components=1'] tags: - ipmi_exporter_install - name: SELinux - ansible.builtin.include_tasks: - file: selinux.yml - apply: - become: true - tags: - - ipmi_exporter_configure + ansible.builtin.include_role: + name: prometheus.prometheus._common + tasks_from: selinux.yml + vars: + _common_selinux_port: "{{ ipmi_exporter_web_listen_address | urlsplit('port') }}" when: ansible_selinux.status == "enabled" tags: - ipmi_exporter_configure @@ -43,10 +37,6 @@ - name: Configure ansible.builtin.include_tasks: file: configure.yml - apply: - become: true - tags: - - ipmi_exporter_configure tags: - ipmi_exporter_configure diff --git a/roles/ipmi_exporter/tasks/preflight.yml b/roles/ipmi_exporter/tasks/preflight.yml index 5baab8ca..4e07f019 100644 --- a/roles/ipmi_exporter/tasks/preflight.yml +++ b/roles/ipmi_exporter/tasks/preflight.yml @@ -1,24 +1,10 @@ --- -- name: Assert usage of systemd as an init system - ansible.builtin.assert: - that: ansible_service_mgr == 'systemd' - msg: "This role only works with systemd" - -- name: Install package fact dependencies - become: true - ansible.builtin.package: - name: "{{ _pkg_fact_req }}" - state: present - when: (_pkg_fact_req) +- name: Common preflight + ansible.builtin.include_role: + name: prometheus.prometheus._common + tasks_from: preflight.yml vars: - _pkg_fact_req: "{% if (ansible_pkg_mgr == 'apt') %}\ - {{ ('python-apt' if ansible_python_version is version('3', '<') else 'python3-apt') }} - {% else %}\ - {% endif %}" - -- name: Gather package facts - ansible.builtin.package_facts: - when: "not 'packages' in ansible_facts" + _common_dependencies: "{{ _ipmi_exporter_dependencies }}" - name: Assert that used version supports listen address type ansible.builtin.assert: @@ -61,23 +47,6 @@ - "__ipmi_exporter_cert_file.stat.exists" - "__ipmi_exporter_key_file.stat.exists" -- name: Check if ipmi_exporter is installed - ansible.builtin.stat: - path: "{{ ipmi_exporter_binary_install_dir }}/ipmi_exporter" - register: __ipmi_exporter_is_installed - check_mode: false - tags: - - ipmi_exporter_install - -- name: Gather currently installed ipmi_exporter version (if any) - ansible.builtin.command: "{{ ipmi_exporter_binary_install_dir }}/ipmi_exporter --version" - changed_when: false - register: __ipmi_exporter_current_version_output - check_mode: false - when: __ipmi_exporter_is_installed.stat.exists - tags: - - ipmi_exporter_install - - name: Discover latest version ansible.builtin.set_fact: ipmi_exporter_version: "{{ (lookup('url', 'https://api.github.com/repos/{{ _ipmi_exporter_repo }}/releases/latest', headers=_github_api_headers, @@ -87,24 +56,9 @@ retries: 10 when: - ipmi_exporter_version == "latest" - - ipmi_exporter_binary_local_dir | length == 0 - - not ipmi_exporter_skip_install - -- name: Get ipmi_exporter binary checksum - when: - - ipmi_exporter_binary_local_dir | length == 0 - - not ipmi_exporter_skip_install - block: - - name: Get checksum list from github - ansible.builtin.set_fact: - __ipmi_exporter_checksums: "{{ lookup('url', ipmi_exporter_checksums_url, headers=_github_api_headers, wantlist=True) | list }}" - run_once: true - until: __ipmi_exporter_checksums is search('linux-' + go_arch + '.tar.gz') - retries: 10 - - - name: "Get checksum for {{ go_arch }}" - ansible.builtin.set_fact: - __ipmi_exporter_checksum: "{{ item.split(' ')[0] }}" - with_items: "{{ __ipmi_exporter_checksums }}" - when: - - "('linux-' + go_arch + '.tar.gz') in item" + tags: + - ipmi_exporter + - install + - ipmi_exporter_install + - download + - ipmi_exporter_download diff --git a/roles/ipmi_exporter/tasks/selinux.yml b/roles/ipmi_exporter/tasks/selinux.yml deleted file mode 100644 index 754cbd0a..00000000 --- a/roles/ipmi_exporter/tasks/selinux.yml +++ /dev/null @@ -1,23 +0,0 @@ ---- -- name: Install selinux python packages [RedHat] - ansible.builtin.package: - name: "{{ ['libselinux-python', 'policycoreutils-python'] - if ansible_python_version is version('3', '<') else - ['python3-libselinux', 'python3-policycoreutils'] }}" - state: present - register: _install_selinux_packages - until: _install_selinux_packages is success - retries: 5 - delay: 2 - when: ansible_os_family | lower == "redhat" - -- name: Install selinux python packages [clearlinux] - ansible.builtin.package: - name: sysadmin-basic - state: present - register: _install_selinux_packages - until: _install_selinux_packages is success - retries: 5 - delay: 2 - when: - - ansible_distribution | lower == "clearlinux" diff --git a/roles/ipmi_exporter/templates/ipmi_exporter.service.j2 b/roles/ipmi_exporter/templates/ipmi_exporter.service.j2 index e59c09e7..eb88469a 100644 --- a/roles/ipmi_exporter/templates/ipmi_exporter.service.j2 +++ b/roles/ipmi_exporter/templates/ipmi_exporter.service.j2 @@ -9,10 +9,10 @@ Type=simple User={{ ipmi_exporter_system_user }} Group={{ ipmi_exporter_system_group }} ExecStart={{ ipmi_exporter_binary_install_dir }}/ipmi_exporter \ - '--config.file=/etc/ipmi_exporter/config.yaml' \ + '--config.file={{ ipmi_exporter_config_dir }}/config.yaml' \ '--web.listen-address={{ ipmi_exporter_web_listen_address }}' \ {% if ipmi_exporter_tls_server_config | length > 0 or ipmi_exporter_http_server_config | length > 0 or ipmi_exporter_basic_auth_users | length > 0 %} - '--web.config.file=/etc/ipmi_exporter/web_config.yaml' \ + '--web.config.file={{ ipmi_exporter_config_dir }}/web_config.yml' \ {% endif %} '--log.level={{ ipmi_exporter_log_level }}' \ '--log.format={{ ipmi_exporter_log_format }}' diff --git a/roles/ipmi_exporter/templates/web_config.yaml.j2 b/roles/ipmi_exporter/templates/web_config.yaml.j2 deleted file mode 100644 index 9842b7de..00000000 --- a/roles/ipmi_exporter/templates/web_config.yaml.j2 +++ /dev/null @@ -1,18 +0,0 @@ ---- -{{ ansible_managed | comment }} -{% if ipmi_exporter_tls_server_config | length > 0 %} -tls_server_config: -{{ ipmi_exporter_tls_server_config | to_nice_yaml | indent(2, true) }} -{% endif %} - -{% if ipmi_exporter_http_server_config | length > 0 %} -http_server_config: -{{ ipmi_exporter_http_server_config | to_nice_yaml | indent(2, true) }} -{% endif %} - -{% if ipmi_exporter_basic_auth_users | length > 0 %} -basic_auth_users: -{% for k, v in ipmi_exporter_basic_auth_users.items() %} - {{ k }}: {{ v | string | password_hash('bcrypt', ('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890' | shuffle(seed=inventory_hostname) | join)[:22], rounds=9) }} -{% endfor %} -{% endif %} diff --git a/roles/ipmi_exporter/vars/main.yml b/roles/ipmi_exporter/vars/main.yml index 0f385948..f0dfaf38 100644 --- a/roles/ipmi_exporter/vars/main.yml +++ b/roles/ipmi_exporter/vars/main.yml @@ -1,11 +1,12 @@ --- -go_arch_map: - i386: '386' - x86_64: 'amd64' - aarch64: 'arm64' - armv7l: 'armv7' - armv6l: 'armv6' - -go_arch: "{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}" +_ipmi_exporter_go_ansible_arch: "{{ {'i386': '386', + 'x86_64': 'amd64', + 'aarch64': 'arm64', + 'armv7l': 'armv7', + 'armv6l': 'armv6'}.get(ansible_architecture, ansible_architecture) }}" _ipmi_exporter_repo: "prometheus-community/ipmi_exporter" _github_api_headers: "{{ {'GITHUB_TOKEN': lookup('ansible.builtin.env', 'GITHUB_TOKEN')} if (lookup('ansible.builtin.env', 'GITHUB_TOKEN')) else {} }}" +_ipmi_exporter_binaries: ['ipmi_exporter'] +_ipmi_exporter_dependencies: "{{ (ansible_pkg_mgr == 'apt') + | ternary((['python-apt'] if ansible_python_version is version('3', '<') else ['python3-apt']), + []) + ['freeipmi'] }}"