diff --git a/roles/chrony_exporter/README.md b/roles/chrony_exporter/README.md new file mode 100644 index 00000000..fcde4b43 --- /dev/null +++ b/roles/chrony_exporter/README.md @@ -0,0 +1,83 @@ +

graph logo

+ +# Ansible Role: chrony_exporter + +## Description + +Deploy prometheus [chrony_exporter](https://github.com/superq/chrony_exporter) using ansible. + +## Requirements + +- Ansible >= 2.9 (It might work on previous versions, but we cannot guarantee it) +- gnu-tar on Mac deployer host (`brew install gnu-tar`) +- Passlib is required when using the basic authentication feature (`pip install passlib[bcrypt]`) + +## Role Variables + +All variables which can be overridden are stored in [defaults/main.yml](defaults/main.yml) file as well as in [meta/argument_specs.yml](meta/argument_specs.yml). +Please refer to the [collection docs](https://prometheus-community.github.io/ansible/branch/main/chrony_exporter_role.html) for description and default values of the variables. + +## Example + +### Playbook + +Use it in a playbook as follows: +```yaml +- hosts: all + roles: + - prometheus.prometheus.chrony_exporter +``` + +### TLS config + +Before running chrony_exporter role, the user needs to provision their own certificate and key. +```yaml +- hosts: all + pre_tasks: + - name: Create chrony_exporter cert dir + file: + path: "/etc/chrony_exporter" + state: directory + owner: root + group: root + + - name: Create cert and key + openssl_certificate: + path: /etc/chrony_exporter/tls.cert + csr_path: /etc/chrony_exporter/tls.csr + privatekey_path: /etc/chrony_exporter/tls.key + provider: selfsigned + roles: + - prometheus.prometheus.chrony_exporter + vars: + chrony_exporter_tls_server_config: + cert_file: /etc/chrony_exporter/tls.cert + key_file: /etc/chrony_exporter/tls.key + chrony_exporter_basic_auth_users: + randomuser: examplepassword +``` + + +### Demo site + +We provide an example site that demonstrates a full monitoring solution based on prometheus and grafana. The repository with code and links to running instances is [available on github](https://github.com/superq/demo-site) and the site is hosted on [DigitalOcean](https://digitalocean.com). + +## Local Testing + +The preferred way of locally testing the role is to use Docker and [molecule](https://github.com/ansible-community/molecule) (v3.x). You will have to install Docker on your system. See "Get started" for a Docker package suitable for your system. Running your tests is as simple as executing `molecule test`. + +## Continuous Integration + +Combining molecule and circle CI allows us to test how new PRs will behave when used with multiple ansible versions and multiple operating systems. This also allows use to create test scenarios for different role configurations. As a result we have quite a large test matrix which can take more time than local testing, so please be patient. + +## Contributing + +See [contributor guideline](CONTRIBUTING.md). + +## Troubleshooting + +See [troubleshooting](TROUBLESHOOTING.md). + +## License + +This project is licensed under MIT License. See [LICENSE](/LICENSE) for more details. diff --git a/roles/chrony_exporter/TROUBLESHOOTING.md b/roles/chrony_exporter/TROUBLESHOOTING.md new file mode 100644 index 00000000..0bece12a --- /dev/null +++ b/roles/chrony_exporter/TROUBLESHOOTING.md @@ -0,0 +1,20 @@ +# Troubleshooting + +## Bad requests (HTTP 400) + +This role downloads checksums from the Github project to verify the integrity of artifacts installed on your servers. When downloading the checksums, a "bad request" error might occur. + +This happens in environments which (knowningly or unknowling) use the [netrc mechanism](https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html) to auto-login into servers. + +Unless netrc is needed by your playbook and ansible roles, please unset the var like so: + +``` +$ NETRC= ansible-playbook ... +``` + +Or: + +``` +$ export NETRC= +$ ansible-playbook ... +``` diff --git a/roles/chrony_exporter/defaults/main.yml b/roles/chrony_exporter/defaults/main.yml new file mode 100644 index 00000000..48b03d60 --- /dev/null +++ b/roles/chrony_exporter/defaults/main.yml @@ -0,0 +1,26 @@ +--- +chrony_exporter_version: 0.6.1 +chrony_exporter_binary_local_dir: "" +chrony_exporter_binary_url: "https://github.com/{{ _chrony_exporter_repo }}/releases/download/v{{ chrony_exporter_version }}/\ + chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}.tar.gz" +chrony_exporter_checksums_url: "https://github.com/{{ _chrony_exporter_repo }}/releases/download/v{{ chrony_exporter_version }}/sha256sums.txt" +chrony_exporter_skip_install: false + +chrony_exporter_web_listen_address: "0.0.0.0:9123" +chrony_exporter_web_telemetry_path: "/metrics" + +chrony_exporter_tls_server_config: {} + +chrony_exporter_http_server_config: {} + +chrony_exporter_basic_auth_users: {} + +chrony_exporter_enabled_collectors: [] +# - tracking +# - sources + +chrony_exporter_disabled_collectors: [] + +chrony_exporter_binary_install_dir: "/usr/local/bin" +chrony_exporter_system_group: "chrony-exp" +chrony_exporter_system_user: "{{ chrony_exporter_system_group }}" diff --git a/roles/chrony_exporter/handlers/main.yml b/roles/chrony_exporter/handlers/main.yml new file mode 100644 index 00000000..e31a7663 --- /dev/null +++ b/roles/chrony_exporter/handlers/main.yml @@ -0,0 +1,10 @@ +--- +- name: Restart chrony_exporter + listen: "restart chrony_exporter" + become: true + ansible.builtin.systemd: + daemon_reload: true + name: chrony_exporter + state: restarted + when: + - not ansible_check_mode diff --git a/roles/chrony_exporter/meta/argument_specs.yml b/roles/chrony_exporter/meta/argument_specs.yml new file mode 100644 index 00000000..bc432f6b --- /dev/null +++ b/roles/chrony_exporter/meta/argument_specs.yml @@ -0,0 +1,75 @@ +--- +# yamllint disable rule:line-length +argument_specs: + main: + short_description: "Prometheus Chrony Exporter" + description: + - "Deploy prometheus L(chrony_exporter,https://github.com/superq/chrony_exporter) using ansible" + author: + - "Prometheus Community" + options: + chrony_exporter_version: + description: "Chrony exporter package version. Also accepts latest as parameter." + default: "1.6.0" + chrony_exporter_skip_install: + description: "Chrony exporter installation tasks gets skipped when set to true." + type: bool + default: false + chrony_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(chrony_exporter) binary is stored on the host where ansible is run." + - "This overrides the I(chrony_exporter_version) parameter" + chrony_exporter_binary_url: + description: "URL of the chrony_exporter binaries .tar.gz file" + default: "https://github.com/{{ _chrony_exporter_repo }}/releases/download/v{{ chrony_exporter_version }}/chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}.tar.gz" + chrony_exporter_checksums_url: + description: "URL of the chrony_exporter checksums file" + default: "https://github.com/{{ _chrony_exporter_repo }}/releases/download/v{{ chrony_exporter_version }}/sha256sums.txt" + chrony_exporter_web_listen_address: + description: "Address on which chrony_exporter will listen" + default: "0.0.0.0:9123" + chrony_exporter_web_telemetry_path: + description: "Path under which to expose metrics" + default: "/metrics" + chrony_exporter_enabled_collectors: + description: + - "List of dicts defining additionally enabled collectors and their configuration." + - "It adds collectors to L(those enabled by default,https://github.com/superq/chrony_exporter#enabled-by-default)." + type: "list" + default: + - tracking + chrony_exporter_disabled_collectors: + description: + - "List of disabled collectors." + - "By default chrony_exporter disables collectors listed L(here,https://github.com/superq/chrony_exporter#disabled-by-default)." + type: "list" + elements: "str" + chrony_exporter_tls_server_config: + description: + - "Configuration for TLS authentication." + - "Keys and values are the same as in L(chrony_exporter docs,https://github.com/superq/chrony_exporter/blob/master/https/README.md#sample-config)." + type: "dict" + chrony_exporter_http_server_config: + description: + - "Config for HTTP/2 support." + - "Keys and values are the same as in L(chrony_exporter docs,https://github.com/superq/chrony_exporter/blob/master/https/README.md#sample-config)." + type: "dict" + chrony_exporter_basic_auth_users: + description: "Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt." + type: "dict" + chrony_exporter_binary_install_dir: + description: + - "I(Advanced)" + - "Directory to install chrony_exporter binary" + default: "/usr/local/bin" + chrony_exporter_system_group: + description: + - "I(Advanced)" + - "System group for chrony_exporter" + default: "chrony-exp" + chrony_exporter_system_user: + description: + - "I(Advanced)" + - "Chrony exporter user" + default: "chrony-exp" diff --git a/roles/chrony_exporter/meta/main.yml b/roles/chrony_exporter/meta/main.yml new file mode 100644 index 00000000..4bf81cc1 --- /dev/null +++ b/roles/chrony_exporter/meta/main.yml @@ -0,0 +1,31 @@ +--- +galaxy_info: + author: "Prometheus Community" + description: "Prometheus Chrony Exporter" + license: "Apache" + min_ansible_version: "2.9" + platforms: + - name: "Ubuntu" + versions: + - "bionic" + - "focal" + - "jammy" + - name: "Debian" + versions: + - "bullseye" + - "buster" + - name: "EL" + versions: + - "7" + - "8" + - "9" + - name: "Fedora" + versions: + - "36" + - "37" + galaxy_tags: + - "monitoring" + - "prometheus" + - "exporter" + - "metrics" + - "system" diff --git a/roles/chrony_exporter/molecule/alternative/converge.yml b/roles/chrony_exporter/molecule/alternative/converge.yml new file mode 100644 index 00000000..582c4920 --- /dev/null +++ b/roles/chrony_exporter/molecule/alternative/converge.yml @@ -0,0 +1,40 @@ +--- +- name: Run role + hosts: all + any_errors_fatal: true + roles: + - prometheus.prometheus.chrony_exporter + pre_tasks: + - name: Create chrony_exporter cert dir + ansible.builtin.file: + path: "{{ chrony_exporter_tls_server_config.cert_file | dirname }}" + state: directory + owner: root + group: root + mode: u+rwX,g+rwX,o=rX + + - name: Copy cert and key + ansible.builtin.copy: + src: "{{ item.src }}" + dest: "{{ item.dest }}" + mode: "{{ item.mode | default('0644') }}" + loop: + - src: "/tmp/tls.cert" + dest: "{{ chrony_exporter_tls_server_config.cert_file }}" + - src: "/tmp/tls.key" + dest: "{{ chrony_exporter_tls_server_config.key_file }}" + vars: + chrony_exporter_binary_local_dir: "/tmp/chrony_exporter-linux-amd64" + chrony_exporter_web_listen_address: "127.0.0.1:8080" + chrony_exporter_enabled_collectors: + - sources + chrony_exporter_disabled_collectors: + - tracking + + chrony_exporter_tls_server_config: + cert_file: /etc/chrony_exporter/tls.cert + key_file: /etc/chrony_exporter/tls.key + chrony_exporter_http_server_config: + http2: true + chrony_exporter_basic_auth_users: + randomuser: examplepassword diff --git a/roles/chrony_exporter/molecule/alternative/molecule.yml b/roles/chrony_exporter/molecule/alternative/molecule.yml new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/roles/chrony_exporter/molecule/alternative/molecule.yml @@ -0,0 +1 @@ +--- diff --git a/roles/chrony_exporter/molecule/alternative/prepare.yml b/roles/chrony_exporter/molecule/alternative/prepare.yml new file mode 100644 index 00000000..0a09bebc --- /dev/null +++ b/roles/chrony_exporter/molecule/alternative/prepare.yml @@ -0,0 +1,56 @@ +--- +- name: Prepare + hosts: localhost + gather_facts: false + vars: + go_arch: amd64 + chrony_exporter_version: 0.6.0 + tasks: + - name: Download chrony_exporter binary to local folder + become: false + ansible.builtin.get_url: + url: "https://github.com/superq/chrony_exporter/releases/download/v{{ chrony_exporter_version }}/\ + chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}.tar.gz" + dest: "/tmp/chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}.tar.gz" + mode: 0644 + register: _download_binary + until: _download_binary is succeeded + retries: 5 + delay: 2 + check_mode: false + + - name: Unpack chrony_exporter binary + become: false + ansible.builtin.unarchive: + src: "/tmp/chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}.tar.gz" + dest: "/tmp" + creates: "/tmp/chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}/chrony_exporter" + check_mode: false + + - name: Link to chrony_exporter binaries directory + become: false + ansible.builtin.file: + src: "/tmp/chrony_exporter-{{ chrony_exporter_version }}.linux-amd64" + dest: "/tmp/chrony_exporter-linux-amd64" + state: link + check_mode: false + + - name: Install pyOpenSSL for certificate generation + ansible.builtin.pip: + name: "pyOpenSSL" + + - name: Create private key + community.crypto.openssl_privatekey: + path: "/tmp/tls.key" + + - name: Create CSR + community.crypto.openssl_csr: + path: "/tmp/tls.csr" + privatekey_path: "/tmp/tls.key" + + - name: Create certificate + community.crypto.x509_certificate: + path: "/tmp/tls.cert" + csr_path: "/tmp/tls.csr" + privatekey_path: "/tmp/tls.key" + provider: selfsigned diff --git a/roles/chrony_exporter/molecule/alternative/tests/test_alternative.py b/roles/chrony_exporter/molecule/alternative/tests/test_alternative.py new file mode 100644 index 00000000..6d050989 --- /dev/null +++ b/roles/chrony_exporter/molecule/alternative/tests/test_alternative.py @@ -0,0 +1,38 @@ +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import os +import testinfra.utils.ansible_runner + +testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner( + os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all') + + +def test_directories(host): + dirs = [ + "/etc/chrony_exporter" + ] + for dir in dirs: + d = host.file(dir) + assert d.is_directory + assert d.exists + + +def test_service(host): + s = host.service("chrony_exporter") + assert s.is_running + + +def test_protecthome_property(host): + s = host.service("chrony_exporter") + p = s.systemd_properties + assert p.get("ProtectHome") == "yes" + + +def test_socket(host): + sockets = [ + "tcp://127.0.0.1:8080" + ] + for socket in sockets: + s = host.socket(socket) + assert s.is_listening diff --git a/roles/chrony_exporter/molecule/default/converge.yml b/roles/chrony_exporter/molecule/default/converge.yml new file mode 100644 index 00000000..65ca5f0e --- /dev/null +++ b/roles/chrony_exporter/molecule/default/converge.yml @@ -0,0 +1,8 @@ +--- +- name: Converge + hosts: all + any_errors_fatal: true + roles: + - prometheus.prometheus.chrony_exporter + vars: + chrony_exporter_web_listen_address: "127.0.0.1:9123" diff --git a/roles/chrony_exporter/molecule/default/molecule.yml b/roles/chrony_exporter/molecule/default/molecule.yml new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/roles/chrony_exporter/molecule/default/molecule.yml @@ -0,0 +1 @@ +--- diff --git a/roles/chrony_exporter/molecule/default/tests/test_default.py b/roles/chrony_exporter/molecule/default/tests/test_default.py new file mode 100644 index 00000000..c5ddd3ed --- /dev/null +++ b/roles/chrony_exporter/molecule/default/tests/test_default.py @@ -0,0 +1,72 @@ +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import os +import testinfra.utils.ansible_runner + +testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner( + os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all') + + +def test_directories(host): + dirs = [ + "/etc/chrony_exporter" + ] + for dir in dirs: + d = host.file(dir) + assert d.is_directory + assert d.exists + + +def test_files(host): + files = [ + "/etc/systemd/system/chrony_exporter.service", + "/usr/local/bin/chrony_exporter" + ] + for file in files: + f = host.file(file) + assert f.exists + assert f.is_file + + +def test_permissions_didnt_change(host): + dirs = [ + "/etc", + "/root", + "/usr", + "/var" + ] + for file in dirs: + f = host.file(file) + assert f.exists + assert f.is_directory + assert f.user == "root" + assert f.group == "root" + + +def test_user(host): + assert host.group("chrony-exp").exists + assert "chrony-exp" in host.user("chrony-exp").groups + assert host.user("chrony-exp").shell == "/usr/sbin/nologin" + assert host.user("chrony-exp").home == "/" + + +def test_service(host): + s = host.service("chrony_exporter") +# assert s.is_enabled + assert s.is_running + + +def test_protecthome_property(host): + s = host.service("chrony_exporter") + p = s.systemd_properties + assert p.get("ProtectHome") == "yes" + + +def test_socket(host): + sockets = [ + "tcp://127.0.0.1:9123" + ] + for socket in sockets: + s = host.socket(socket) + assert s.is_listening diff --git a/roles/chrony_exporter/molecule/latest/converge.yml b/roles/chrony_exporter/molecule/latest/converge.yml new file mode 100644 index 00000000..4bb57e30 --- /dev/null +++ b/roles/chrony_exporter/molecule/latest/converge.yml @@ -0,0 +1,8 @@ +--- +- name: Run role + hosts: all + any_errors_fatal: true + roles: + - prometheus.prometheus.chrony_exporter + vars: + chrony_exporter_version: latest diff --git a/roles/chrony_exporter/molecule/latest/molecule.yml b/roles/chrony_exporter/molecule/latest/molecule.yml new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/roles/chrony_exporter/molecule/latest/molecule.yml @@ -0,0 +1 @@ +--- diff --git a/roles/chrony_exporter/molecule/latest/tests/test_alternative.py b/roles/chrony_exporter/molecule/latest/tests/test_alternative.py new file mode 100644 index 00000000..9b301d1c --- /dev/null +++ b/roles/chrony_exporter/molecule/latest/tests/test_alternative.py @@ -0,0 +1,36 @@ +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +import os +import testinfra.utils.ansible_runner +import pytest + +testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner( + os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all') + + +@pytest.mark.parametrize("files", [ + "/etc/systemd/system/chrony_exporter.service", + "/usr/local/bin/chrony_exporter" +]) +def test_files(host, files): + f = host.file(files) + assert f.exists + assert f.is_file + + +def test_service(host): + s = host.service("chrony_exporter") + # assert s.is_enabled + assert s.is_running + + +def test_protecthome_property(host): + s = host.service("chrony_exporter") + p = s.systemd_properties + assert p.get("ProtectHome") == "yes" + + +def test_socket(host): + s = host.socket("tcp://0.0.0.0:9123") + assert s.is_listening diff --git a/roles/chrony_exporter/tasks/configure.yml b/roles/chrony_exporter/tasks/configure.yml new file mode 100644 index 00000000..517e624c --- /dev/null +++ b/roles/chrony_exporter/tasks/configure.yml @@ -0,0 +1,36 @@ +--- +- name: Copy the chrony_exporter systemd service file + ansible.builtin.template: + src: chrony_exporter.service.j2 + dest: /etc/systemd/system/chrony_exporter.service + owner: root + group: root + mode: 0644 + notify: restart chrony_exporter + +- name: Create chrony_exporter config directory + ansible.builtin.file: + path: "/etc/chrony_exporter" + state: directory + owner: root + group: root + mode: u+rwX,g+rwX,o=rX + +- name: Copy the chrony_exporter web config file + ansible.builtin.template: + src: web_config.yaml.j2 + dest: /etc/chrony_exporter/web_config.yaml + owner: root + group: root + mode: 0644 + notify: restart chrony_exporter + +- name: Allow chrony_exporter port in SELinux on RedHat OS family + community.general.seport: + ports: "{{ chrony_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" diff --git a/roles/chrony_exporter/tasks/install.yml b/roles/chrony_exporter/tasks/install.yml new file mode 100644 index 00000000..5a13cd00 --- /dev/null +++ b/roles/chrony_exporter/tasks/install.yml @@ -0,0 +1,69 @@ +--- +- name: Create the chrony_exporter group + ansible.builtin.group: + name: "{{ chrony_exporter_system_group }}" + state: present + system: true + when: chrony_exporter_system_group != "root" + +- name: Create the chrony_exporter user + ansible.builtin.user: + name: "{{ chrony_exporter_system_user }}" + groups: "{{ chrony_exporter_system_group }}" + append: true + shell: /usr/sbin/nologin + system: true + create_home: false + home: / + when: chrony_exporter_system_user != "root" + +- name: Discover latest version + when: + - chrony_exporter_binary_local_dir | length == 0 + - not chrony_exporter_skip_install + block: + + - name: Download chrony_exporter binary to local folder + become: false + ansible.builtin.get_url: + url: "{{ chrony_exporter_binary_url }}" + dest: "/tmp/chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}.tar.gz" + checksum: "sha256:{{ __chrony_exporter_checksum }}" + mode: '0644' + register: _download_binary + until: _download_binary is succeeded + retries: 5 + delay: 2 + delegate_to: localhost + check_mode: false + + - name: Unpack chrony_exporter binary + become: false + ansible.builtin.unarchive: + src: "/tmp/chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}.tar.gz" + dest: "/tmp" + creates: "/tmp/chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}/chrony_exporter" + delegate_to: localhost + check_mode: false + + - name: Propagate chrony_exporter binaries + ansible.builtin.copy: + src: "/tmp/chrony_exporter-{{ chrony_exporter_version }}.linux-{{ go_arch }}/chrony_exporter" + dest: "{{ chrony_exporter_binary_install_dir }}/chrony_exporter" + mode: 0755 + owner: root + group: root + notify: restart chrony_exporter + when: not ansible_check_mode + +- name: Propagate locally distributed chrony_exporter binary + ansible.builtin.copy: + src: "{{ chrony_exporter_binary_local_dir }}/chrony_exporter" + dest: "{{ chrony_exporter_binary_install_dir }}/chrony_exporter" + mode: 0755 + owner: root + group: root + when: + - chrony_exporter_binary_local_dir | length > 0 + - not chrony_exporter_skip_install + notify: restart chrony_exporter diff --git a/roles/chrony_exporter/tasks/main.yml b/roles/chrony_exporter/tasks/main.yml new file mode 100644 index 00000000..b382e24e --- /dev/null +++ b/roles/chrony_exporter/tasks/main.yml @@ -0,0 +1,63 @@ +--- +- name: Preflight + ansible.builtin.include_tasks: + file: preflight.yml + apply: + tags: + - chrony_exporter_install + - chrony_exporter_configure + - chrony_exporter_run + tags: + - chrony_exporter_install + - chrony_exporter_configure + - chrony_exporter_run + +- name: Install + ansible.builtin.include_tasks: + file: install.yml + apply: + become: true + tags: + - chrony_exporter_install + when: + ( not __chrony_exporter_is_installed.stat.exists ) or + ( (__chrony_exporter_current_version_output.stderr_lines | length > 0) + and (__chrony_exporter_current_version_output.stderr_lines[0].split(" ")[2] != chrony_exporter_version) ) or + ( (__chrony_exporter_current_version_output.stdout_lines | length > 0) + and (__chrony_exporter_current_version_output.stdout_lines[0].split(" ")[2] != chrony_exporter_version) ) or + ( chrony_exporter_binary_local_dir | length > 0 ) + tags: + - chrony_exporter_install + +- name: SELinux + ansible.builtin.include_tasks: + file: selinux.yml + apply: + become: true + tags: + - chrony_exporter_configure + when: ansible_selinux.status == "enabled" + tags: + - chrony_exporter_configure + +- name: Configure + ansible.builtin.include_tasks: + file: configure.yml + apply: + become: true + tags: + - chrony_exporter_configure + tags: + - chrony_exporter_configure + +- name: Ensure Chrony Exporter is enabled on boot + become: true + ansible.builtin.systemd: + daemon_reload: true + name: chrony_exporter + enabled: true + state: started + when: + - not ansible_check_mode + tags: + - chrony_exporter_run diff --git a/roles/chrony_exporter/tasks/preflight.yml b/roles/chrony_exporter/tasks/preflight.yml new file mode 100644 index 00000000..0d5ff0c0 --- /dev/null +++ b/roles/chrony_exporter/tasks/preflight.yml @@ -0,0 +1,105 @@ +--- +- 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) + 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" + +- name: Naive assertion of proper listen address + ansible.builtin.assert: + that: + - "':' in chrony_exporter_web_listen_address" + +- name: Assert collectors are not both disabled and enabled at the same time + ansible.builtin.assert: + that: + - "item not in chrony_exporter_enabled_collectors" + with_items: "{{ chrony_exporter_disabled_collectors }}" + +- name: Assert that TLS config is correct + when: chrony_exporter_tls_server_config | length > 0 + block: + - name: Assert that TLS key and cert path are set + ansible.builtin.assert: + that: + - "chrony_exporter_tls_server_config.cert_file is defined" + - "chrony_exporter_tls_server_config.key_file is defined" + + - name: Check existence of TLS cert file + ansible.builtin.stat: + path: "{{ chrony_exporter_tls_server_config.cert_file }}" + register: __chrony_exporter_cert_file + + - name: Check existence of TLS key file + ansible.builtin.stat: + path: "{{ chrony_exporter_tls_server_config.key_file }}" + register: __chrony_exporter_key_file + + - name: Assert that TLS key and cert are present + ansible.builtin.assert: + that: + - "{{ __chrony_exporter_cert_file.stat.exists }}" + - "{{ __chrony_exporter_key_file.stat.exists }}" + +- name: Check if chrony_exporter is installed + ansible.builtin.stat: + path: "{{ chrony_exporter_binary_install_dir }}/chrony_exporter" + register: __chrony_exporter_is_installed + check_mode: false + tags: + - chrony_exporter_install + +- name: Gather currently installed chrony_exporter version (if any) + ansible.builtin.command: "{{ chrony_exporter_binary_install_dir }}/chrony_exporter --version" + changed_when: false + register: __chrony_exporter_current_version_output + check_mode: false + when: __chrony_exporter_is_installed.stat.exists + tags: + - chrony_exporter_install + +- name: Discover latest version + ansible.builtin.set_fact: + chrony_exporter_version: "{{ (lookup('url', 'https://api.github.com/repos/superq/chrony_exporter/releases/latest', headers=_github_api_headers, + split_lines=False) | from_json).get('tag_name') | replace('v', '') }}" + run_once: true + until: chrony_exporter_version is version('0.0.0', '>=') + retries: 10 + when: + - chrony_exporter_version == "latest" + - chrony_exporter_binary_local_dir | length == 0 + - not chrony_exporter_skip_install + +- name: Get chrony_exporter binary checksum + when: + - chrony_exporter_binary_local_dir | length == 0 + - not chrony_exporter_skip_install + block: + - name: Get checksum list from github + ansible.builtin.set_fact: + __chrony_exporter_checksums: "{{ lookup('url', chrony_exporter_checksums_url, headers=_github_api_headers, wantlist=True) | list }}" + run_once: true + until: __chrony_exporter_checksums is search('linux-' + go_arch + '.tar.gz') + retries: 10 + + - name: "Get checksum for {{ go_arch }}" + ansible.builtin.set_fact: + __chrony_exporter_checksum: "{{ item.split(' ')[0] }}" + with_items: "{{ __chrony_exporter_checksums }}" + when: + - "('linux-' + go_arch + '.tar.gz') in item" diff --git a/roles/chrony_exporter/tasks/selinux.yml b/roles/chrony_exporter/tasks/selinux.yml new file mode 100644 index 00000000..754cbd0a --- /dev/null +++ b/roles/chrony_exporter/tasks/selinux.yml @@ -0,0 +1,23 @@ +--- +- 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/chrony_exporter/templates/chrony_exporter.service.j2 b/roles/chrony_exporter/templates/chrony_exporter.service.j2 new file mode 100644 index 00000000..1d6f3a0c --- /dev/null +++ b/roles/chrony_exporter/templates/chrony_exporter.service.j2 @@ -0,0 +1,50 @@ +{{ ansible_managed | comment }} + +[Unit] +Description=Prometheus Chrony Exporter +After=network-online.target + +[Service] +Type=simple +User={{ chrony_exporter_system_user }} +Group={{ chrony_exporter_system_group }} +ExecStart={{ chrony_exporter_binary_install_dir }}/chrony_exporter \ +{% for collector in chrony_exporter_enabled_collectors -%} +{% if not collector is mapping %} + '--collector.{{ collector }}' \ +{% else -%} +{% set name, options = (collector.items()|list)[0] -%} + '--collector.{{ name }}' \ +{% for k,v in options|dictsort %} + '--collector.{{ name }}.{{ k }}={{ v }}' \ +{% endfor -%} +{% endif -%} +{% endfor -%} +{% for collector in chrony_exporter_disabled_collectors %} + '--no-collector.{{ collector }}' \ +{% endfor %} +{% if chrony_exporter_tls_server_config | length > 0 or chrony_exporter_http_server_config | length > 0 or chrony_exporter_basic_auth_users | length > 0 %} + '--web.config.file=/etc/chrony_exporter/web_config.yaml' \ +{% endif %} + '--web.listen-address={{ chrony_exporter_web_listen_address }}' \ + '--web.telemetry-path={{ chrony_exporter_web_telemetry_path }}' + +SyslogIdentifier=chrony_exporter +Restart=always +RestartSec=1 +StartLimitInterval=0 + +ProtectHome=yes +NoNewPrivileges=yes + +{% if (ansible_facts.packages.systemd | first).version is version('232', '>=') %} +ProtectSystem=strict +ProtectControlGroups=true +ProtectKernelModules=true +ProtectKernelTunables=yes +{% else %} +ProtectSystem=full +{% endif %} + +[Install] +WantedBy=multi-user.target diff --git a/roles/chrony_exporter/templates/web_config.yaml.j2 b/roles/chrony_exporter/templates/web_config.yaml.j2 new file mode 100644 index 00000000..85874bb4 --- /dev/null +++ b/roles/chrony_exporter/templates/web_config.yaml.j2 @@ -0,0 +1,18 @@ +--- +{{ ansible_managed | comment }} +{% if chrony_exporter_tls_server_config | length > 0 %} +tls_server_config: +{{ chrony_exporter_tls_server_config | to_nice_yaml | indent(2, true) }} +{% endif %} + +{% if chrony_exporter_http_server_config | length > 0 %} +http_server_config: +{{ chrony_exporter_http_server_config | to_nice_yaml | indent(2, true) }} +{% endif %} + +{% if chrony_exporter_basic_auth_users | length > 0 %} +basic_auth_users: +{% for k, v in chrony_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/chrony_exporter/test-requirements.txt b/roles/chrony_exporter/test-requirements.txt new file mode 100644 index 00000000..7f0b6e75 --- /dev/null +++ b/roles/chrony_exporter/test-requirements.txt @@ -0,0 +1 @@ +bcrypt diff --git a/roles/chrony_exporter/vars/main.yml b/roles/chrony_exporter/vars/main.yml new file mode 100644 index 00000000..de3755ed --- /dev/null +++ b/roles/chrony_exporter/vars/main.yml @@ -0,0 +1,11 @@ +--- +go_arch_map: + i386: '386' + x86_64: 'amd64' + aarch64: 'arm64' + armv7l: 'armv7' + armv6l: 'armv6' + +go_arch: "{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}" +_chrony_exporter_repo: "superq/chrony_exporter" +_github_api_headers: "{{ {'GITHUB_TOKEN': lookup('ansible.builtin.env', 'GITHUB_TOKEN')} if (lookup('ansible.builtin.env', 'GITHUB_TOKEN')) else {} }}" diff --git a/tests/integration/targets/molecule-chrony_exporter-alternative/runme.sh b/tests/integration/targets/molecule-chrony_exporter-alternative/runme.sh new file mode 100755 index 00000000..d094c3e1 --- /dev/null +++ b/tests/integration/targets/molecule-chrony_exporter-alternative/runme.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +collection_root=$(pwd | grep -oP ".+\/ansible_collections\/\w+?\/\w+") +source "$collection_root/tests/integration/molecule.sh" diff --git a/tests/integration/targets/molecule-chrony_exporter-default/runme.sh b/tests/integration/targets/molecule-chrony_exporter-default/runme.sh new file mode 100755 index 00000000..d094c3e1 --- /dev/null +++ b/tests/integration/targets/molecule-chrony_exporter-default/runme.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +collection_root=$(pwd | grep -oP ".+\/ansible_collections\/\w+?\/\w+") +source "$collection_root/tests/integration/molecule.sh" diff --git a/tests/integration/targets/molecule-chrony_exporter-latest/runme.sh b/tests/integration/targets/molecule-chrony_exporter-latest/runme.sh new file mode 100755 index 00000000..d094c3e1 --- /dev/null +++ b/tests/integration/targets/molecule-chrony_exporter-latest/runme.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +collection_root=$(pwd | grep -oP ".+\/ansible_collections\/\w+?\/\w+") +source "$collection_root/tests/integration/molecule.sh"