diff --git a/roles/bind_exporter/README.md b/roles/bind_exporter/README.md new file mode 100644 index 0000000..49c65b5 --- /dev/null +++ b/roles/bind_exporter/README.md @@ -0,0 +1,85 @@ +

graph logo

+ +# Ansible Role: BIND exporter + + +Deploy prometheus [bind exporter](https://github.com/prometheus-community/bind_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/bind_exporter_role.html) for description and default values of the variables. + +## Example + +### Playbook + +Use it in a playbook as follows: +```yaml +- hosts: all + collections: + - prometheus.prometheus + roles: + - prometheus.prometheus.bind_exporter +``` + +### TLS config + +Before running bind_exporter role, the user needs to provision their own certificate and key. +```yaml +- hosts: all + pre_tasks: + - name: Create bind_exporter cert dir + ansible.builtin.file: + path: "/etc/bind_exporter" + state: directory + owner: root + group: root + + - name: Create cert and key + community.crypto.x509_certificate: + path: /etc/bind_exporter/tls.cert + csr_path: /etc/bind_exporter/tls.csr + privatekey_path: /etc/bind_exporter/tls.key + provider: selfsigned + collections: + - prometheus.prometheus + roles: + - prometheus.prometheus.bind_exporter + vars: + bind_exporter_tls_server_config: + cert_file: /etc/bind_exporter/tls.cert + key_file: /etc/bind_exporter/tls.key + bind_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/prometheus/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/bind_exporter/TROUBLESHOOTING.md b/roles/bind_exporter/TROUBLESHOOTING.md new file mode 100644 index 0000000..0bece12 --- /dev/null +++ b/roles/bind_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/bind_exporter/defaults/main.yml b/roles/bind_exporter/defaults/main.yml new file mode 100644 index 0000000..b514669 --- /dev/null +++ b/roles/bind_exporter/defaults/main.yml @@ -0,0 +1,26 @@ +--- +bind_exporter_version: 0.7.0 +bind_exporter_binary_local_dir: "" +bind_exporter_binary_url: "https://github.com/{{ _bind_exporter_repo }}/releases/download/v{{ bind_exporter_version }}/\ + bind_exporter-{{ bind_exporter_version }}.linux-{{ go_arch }}.tar.gz" +bind_exporter_checksums_url: "https://github.com/{{ _bind_exporter_repo }}/releases/download/v{{ bind_exporter_version }}/sha256sums.txt" +bind_exporter_skip_install: false + +bind_exporter_web_listen_address: "0.0.0.0:9119" +bind_exporter_web_telemetry_path: "/metrics" + +bind_exporter_stats_url: "http://localhost:8053/" +bind_exporter_timeout: "10s" +bind_exporter_pid_file: "/run/named/named.pid" +bind_exporter_stats_version: "auto" +bind_exporter_stats_groups: [] + +bind_exporter_tls_server_config: {} +bind_exporter_http_server_config: {} +bind_exporter_basic_auth_users: {} + +# Internal variables. +bind_exporter_binary_install_dir: "/usr/local/bin" +bind_exporter_config_dir: "/etc/bind_exporter" +bind_exporter_system_group: "bind-exp" +bind_exporter_system_user: "{{ bind_exporter_system_group }}" diff --git a/roles/bind_exporter/handlers/main.yml b/roles/bind_exporter/handlers/main.yml new file mode 100644 index 0000000..7a24b44 --- /dev/null +++ b/roles/bind_exporter/handlers/main.yml @@ -0,0 +1,10 @@ +--- +- name: Restart bind_exporter + listen: "restart bind_exporter" + become: true + ansible.builtin.systemd: + daemon_reload: true + name: bind_exporter + state: restarted + when: + - not ansible_check_mode diff --git a/roles/bind_exporter/meta/argument_specs.yml b/roles/bind_exporter/meta/argument_specs.yml new file mode 100644 index 0000000..4cfdebc --- /dev/null +++ b/roles/bind_exporter/meta/argument_specs.yml @@ -0,0 +1,90 @@ +--- +# yamllint disable rule:line-length +argument_specs: + main: + short_description: "Prometheus BIND Exporter" + description: + - "Deploy prometheus L(bind_exporter,https://github.com/prometheus-community/bind_exporter) using ansible" + author: + - "Prometheus Community" + options: + bind_exporter_version: + description: "BIND exporter package version. Also accepts latest as parameter." + default: "0.7.0" + bind_exporter_skip_install: + description: "BIND installation tasks gets skipped when set to true." + type: bool + default: false + bind_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(bind_exporter) binary is stored on the host where ansible is run." + - "This overrides the I(bind_exporter_version) parameter" + bind_exporter_binary_url: + description: "URL of the bind_exporter binaries .tar.gz file" + default: "https://github.com/{{ _bind_exporter_repo }}/download/v{{ bind_exporter_version }}/bind_exporter-{{ bind_exporter_version }}.linux-{{ go_arch }}.tar.gz" + bind_exporter_checksums_url: + description: "URL of the bind_exporter checksums file" + default: "https://github.com/{{ _bind_exporter_repo }}/releases/download/v{{ bind_exporter_version }}/sha256sums.txt" + bind_exporter_web_listen_address: + description: "Address on which bind_exporter will listen" + default: "0.0.0.0:9119" + bind_exporter_web_telemetry_path: + description: "Path under which to expose metrics" + default: "/metrics" + bind_exporter_config_dir: + description: "The path where exporter configuration is stored" + default: "/etc/bind_exporter" + bind_exporter_stats_url: + description: "HTTP XML API address of BIND server" + default: "http://localhost:8053/" + bind_exporter_timeout: + description: "Timeout for trying to get stats from BIND server" + default: "10s" + bind_exporter_pid_file: + description: "Path to BIND's pid file to export process information" + default: "/run/named/named.pid" + bind_exporter_stats_version: + description: "BIND statistics version." + default: "auto" + choices: + - "auto" + - "json" + - "xml" + - "xml.v3" + bind_exporter_stats_groups: + description: "List of statistics to collect" + default: [] + type: "list" + choices: + - "server" + - "view" + - "tasks" + bind_exporter_tls_server_config: + description: + - "Configuration for TLS authentication." + - "Keys and values are the same as in L(prometheus docs,https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md)." + type: "dict" + bind_exporter_http_server_config: + description: + - "Config for HTTP/2 support." + - "Keys and values are the same as in L(prometheus docs,https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md)." + type: "dict" + bind_exporter_basic_auth_users: + description: "Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt." + type: "dict" + bind_exporter_binary_install_dir: + description: + - "I(Advanced)" + - "Directory to install bind_exporter binary" + default: "/usr/local/bin" + bind_exporter_system_group: + description: + - "I(Advanced)" + - "System group for BIND Exporter" + default: "bind-exp" + bind_exporter_system_user: + description: + - "I(Advanced)" + - "BIND Exporter user" + default: "bind-exp" diff --git a/roles/bind_exporter/meta/main.yml b/roles/bind_exporter/meta/main.yml new file mode 100644 index 0000000..6fb907d --- /dev/null +++ b/roles/bind_exporter/meta/main.yml @@ -0,0 +1,33 @@ +--- +galaxy_info: + author: "Prometheus Community" + description: "Prometheus BIND Exporter" + license: "Apache" + min_ansible_version: "2.9" + platforms: + - name: "Ubuntu" + versions: + - "focal" + - "jammy" + - name: "Debian" + versions: + - "bullseye" + - "buster" + - name: "EL" + versions: + - "7" + - "8" + - "9" + - name: "Fedora" + versions: + - "37" + - '38' + galaxy_tags: + - "monitoring" + - "prometheus" + - "exporter" + - "metrics" + - "system" + - "bind" + - "named" + - "dns" diff --git a/roles/bind_exporter/molecule/alternative/molecule.yml b/roles/bind_exporter/molecule/alternative/molecule.yml new file mode 100644 index 0000000..ad910d8 --- /dev/null +++ b/roles/bind_exporter/molecule/alternative/molecule.yml @@ -0,0 +1,21 @@ +--- +provisioner: + inventory: + group_vars: + all: + bind_exporter_binary_local_dir: "/tmp/bind_exporter-linux-amd64" + bind_exporter_web_listen_address: + - '127.0.0.1:8080' + - '127.0.1.1:8080' + bind_exporter_stats_groups: + - server + - view + bind_exporter_tls_server_config: + cert_file: /etc/bind_exporter/tls.cert + key_file: /etc/bind_exporter/tls.key + bind_exporter_http_server_config: + http2: true + bind_exporter_basic_auth_users: + randomuser: examplepassword + go_arch: amd64 + bind_exporter_version: 0.7.0 diff --git a/roles/bind_exporter/molecule/alternative/prepare.yml b/roles/bind_exporter/molecule/alternative/prepare.yml new file mode 100644 index 0000000..a6a8579 --- /dev/null +++ b/roles/bind_exporter/molecule/alternative/prepare.yml @@ -0,0 +1,80 @@ +--- +- name: Run local preparation + hosts: localhost + gather_facts: false + tasks: + - name: Download bind_exporter binary to local folder + become: false + ansible.builtin.get_url: + url: "https://github.com/prometheus-community/bind_exporter/releases/download/v{{\ + \ bind_exporter_version }}/bind_exporter-{{ bind_exporter_version\ + \ }}.linux-{{ go_arch }}.tar.gz" + dest: "/tmp/bind_exporter-{{ bind_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 bind_exporter binary + become: false + ansible.builtin.unarchive: + src: "/tmp/bind_exporter-{{ bind_exporter_version }}.linux-{{ go_arch\ + \ }}.tar.gz" + dest: "/tmp" + creates: "/tmp/bind_exporter-{{ bind_exporter_version }}.linux-{{ go_arch\ + \ }}/bind_exporter" + check_mode: false + + - name: Link to bind_exporter binaries directory + become: false + ansible.builtin.file: + src: "/tmp/bind_exporter-{{ bind_exporter_version }}.linux-amd64" + dest: "/tmp/bind_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 + +- name: Run target preparation + hosts: all + any_errors_fatal: true + tasks: + - name: Create bind_exporter cert dir + ansible.builtin.file: + path: "{{ bind_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: "{{ bind_exporter_tls_server_config.cert_file }}" + - src: "/tmp/tls.key" + dest: "{{ bind_exporter_tls_server_config.key_file }}" diff --git a/roles/bind_exporter/molecule/alternative/tests/test_alternative.py b/roles/bind_exporter/molecule/alternative/tests/test_alternative.py new file mode 100644 index 0000000..18ea53d --- /dev/null +++ b/roles/bind_exporter/molecule/alternative/tests/test_alternative.py @@ -0,0 +1,30 @@ +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') + + +def test_service(host): + s = host.service("bind_exporter") + try: + assert s.is_running + except AssertionError: + # Capture service logs + journal_output = host.run('journalctl -u bind_exporter --since "1 hour ago"') + print("\n==== journalctl -u bind_exporter Output ====\n") + print(journal_output) + print("\n============================================\n") + raise # Re-raise the original assertion error + + +@pytest.mark.parametrize("sockets", [ + "tcp://127.0.0.1:8080", + "tcp://127.0.1.1:8080", +]) +def test_socket(host, sockets): + assert host.socket(sockets).is_listening diff --git a/roles/bind_exporter/molecule/default/molecule.yml b/roles/bind_exporter/molecule/default/molecule.yml new file mode 100644 index 0000000..0cadae8 --- /dev/null +++ b/roles/bind_exporter/molecule/default/molecule.yml @@ -0,0 +1,6 @@ +--- +provisioner: + inventory: + group_vars: + all: + bind_exporter_web_listen_address: "127.0.0.1:9119" diff --git a/roles/bind_exporter/molecule/default/tests/test_default.py b/roles/bind_exporter/molecule/default/tests/test_default.py new file mode 100644 index 0000000..64e8251 --- /dev/null +++ b/roles/bind_exporter/molecule/default/tests/test_default.py @@ -0,0 +1,73 @@ +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/bind_exporter" + ] + for dir in dirs: + d = host.file(dir) + assert d.is_directory + assert d.exists + + +def test_files(host): + files = [ + "/etc/systemd/system/bind_exporter.service", + "/usr/local/bin/bind_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("bind-exp").exists + assert "bind-exp" in host.user("bind-exp").groups + assert host.user("bind-exp").shell == "/usr/sbin/nologin" + assert host.user("bind-exp").home == "/" + + +def test_service(host): + s = host.service("bind_exporter") + try: + assert s.is_running + except AssertionError: + # Capture service logs + journal_output = host.run('journalctl -u bind_exporter --since "1 hour ago"') + print("\n==== journalctl -u bind_exporter Output ====\n") + print(journal_output) + print("\n============================================\n") + raise # Re-raise the original assertion error + + +def test_socket(host): + sockets = [ + "tcp://127.0.0.1:9119" + ] + for socket in sockets: + s = host.socket(socket) + assert s.is_listening diff --git a/roles/bind_exporter/molecule/latest/molecule.yml b/roles/bind_exporter/molecule/latest/molecule.yml new file mode 100644 index 0000000..7152db8 --- /dev/null +++ b/roles/bind_exporter/molecule/latest/molecule.yml @@ -0,0 +1,6 @@ +--- +provisioner: + inventory: + group_vars: + all: + bind_exporter_version: latest diff --git a/roles/bind_exporter/molecule/latest/tests/test_latest.py b/roles/bind_exporter/molecule/latest/tests/test_latest.py new file mode 100644 index 0000000..dc9e040 --- /dev/null +++ b/roles/bind_exporter/molecule/latest/tests/test_latest.py @@ -0,0 +1,37 @@ +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/bind_exporter.service", + "/usr/local/bin/bind_exporter" +]) +def test_files(host, files): + f = host.file(files) + assert f.exists + assert f.is_file + + +def test_service(host): + s = host.service("bind_exporter") + try: + assert s.is_running + except AssertionError: + # Capture service logs + journal_output = host.run('journalctl -u bind_exporter --since "1 hour ago"') + print("\n==== journalctl -u bind_exporter Output ====\n") + print(journal_output) + print("\n============================================\n") + raise # Re-raise the original assertion error + + +def test_socket(host): + s = host.socket("tcp://0.0.0.0:9119") + assert s.is_listening diff --git a/roles/bind_exporter/tasks/configure.yml b/roles/bind_exporter/tasks/configure.yml new file mode 100644 index 0000000..4b7841e --- /dev/null +++ b/roles/bind_exporter/tasks/configure.yml @@ -0,0 +1,42 @@ +--- +- name: Copy the bind_exporter systemd service file + ansible.builtin.template: + src: bind_exporter.service.j2 + dest: /etc/systemd/system/bind_exporter.service + owner: root + group: root + mode: '0644' + notify: restart bind_exporter + +- name: Create bind_exporter config directory + ansible.builtin.file: + path: "{{ bind_exporter_config_dir }}" + state: directory + owner: root + group: root + mode: u+rwX,g+rwX,o=rX + +- name: Configure bind_exporter web config + when: + ( bind_exporter_tls_server_config | length > 0 ) or + ( bind_exporter_http_server_config | length > 0 ) or + ( bind_exporter_basic_auth_users | length > 0 ) + block: + - name: Copy the bind_exporter web config file + ansible.builtin.template: + src: web_config.yaml.j2 + dest: "{{ bind_exporter_config_dir }}/web_config.yaml" + owner: root + group: '{{ bind_exporter_system_group }}' + mode: '0640' + notify: restart bind_exporter + +- name: Allow bind_exporter port in SELinux on RedHat OS family + community.general.seport: + ports: "{{ bind_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/bind_exporter/tasks/install.yml b/roles/bind_exporter/tasks/install.yml new file mode 100644 index 0000000..6f835da --- /dev/null +++ b/roles/bind_exporter/tasks/install.yml @@ -0,0 +1,71 @@ +--- +- name: Create the bind_exporter group + ansible.builtin.group: + name: "{{ bind_exporter_system_group }}" + state: present + system: true + when: bind_exporter_system_group not in ["root"] + +- name: Create the bind_exporter user + ansible.builtin.user: + name: "{{ bind_exporter_system_user }}" + groups: "{{ bind_exporter_system_group }}" + append: true + shell: /usr/sbin/nologin + system: true + create_home: false + home: / + when: bind_exporter_system_user not in ["root"] + +- name: Get binary + when: + - bind_exporter_binary_local_dir | length == 0 + - not bind_exporter_skip_install + block: + + - name: Download bind_exporter binary to local folder + become: false + ansible.builtin.get_url: + url: "{{ bind_exporter_binary_url }}" + dest: "/tmp/bind_exporter-{{ bind_exporter_version }}.linux-{{ go_arch }}.tar.gz" + checksum: "sha256:{{ __bind_exporter_checksum }}" + mode: '0644' + register: _download_binary + until: _download_binary is succeeded + retries: 5 + delay: 2 + delegate_to: localhost + check_mode: false + + - name: Unpack bind_exporter binary + become: false + ansible.builtin.unarchive: + src: "/tmp/bind_exporter-{{ bind_exporter_version }}.linux-{{ go_arch }}.tar.gz" + dest: "/tmp" + creates: "/tmp/bind_exporter-{{ bind_exporter_version }}.linux-{{ go_arch }}/bind_exporter" + extra_opts: + - --no-same-owner + delegate_to: localhost + check_mode: false + + - name: Propagate bind_exporter binaries + ansible.builtin.copy: + src: "/tmp/bind_exporter-{{ bind_exporter_version }}.linux-{{ go_arch }}/bind_exporter" + dest: "{{ bind_exporter_binary_install_dir }}/bind_exporter" + mode: '0755' + owner: root + group: root + notify: restart bind_exporter + when: not ansible_check_mode + +- name: Propagate locally distributed bind_exporter binary + ansible.builtin.copy: + src: "{{ bind_exporter_binary_local_dir }}/bind_exporter" + dest: "{{ bind_exporter_binary_install_dir }}/bind_exporter" + mode: '0755' + owner: root + group: root + when: + - bind_exporter_binary_local_dir | length > 0 + - not bind_exporter_skip_install + notify: restart bind_exporter diff --git a/roles/bind_exporter/tasks/main.yml b/roles/bind_exporter/tasks/main.yml new file mode 100644 index 0000000..6dc4ac9 --- /dev/null +++ b/roles/bind_exporter/tasks/main.yml @@ -0,0 +1,63 @@ +--- +- name: Preflight + ansible.builtin.include_tasks: + file: preflight.yml + apply: + tags: + - bind_exporter_install + - bind_exporter_configure + - bind_exporter_run + tags: + - bind_exporter_install + - bind_exporter_configure + - bind_exporter_run + +- name: Install + ansible.builtin.include_tasks: + file: install.yml + apply: + become: true + tags: + - bind_exporter_install + when: + ( not __bind_exporter_is_installed.stat.exists ) or + ( (__bind_exporter_current_version_output.stderr_lines | length > 0) + and (__bind_exporter_current_version_output.stderr_lines[0].split(" ")[2] != bind_exporter_version) ) or + ( (__bind_exporter_current_version_output.stdout_lines | length > 0) + and (__bind_exporter_current_version_output.stdout_lines[0].split(" ")[2] != bind_exporter_version) ) or + ( bind_exporter_binary_local_dir | length > 0 ) + tags: + - bind_exporter_install + +- name: SELinux + ansible.builtin.include_tasks: + file: selinux.yml + apply: + become: true + tags: + - bind_exporter_configure + when: ansible_selinux.status == "enabled" + tags: + - bind_exporter_configure + +- name: Configure + ansible.builtin.include_tasks: + file: configure.yml + apply: + become: true + tags: + - bind_exporter_configure + tags: + - bind_exporter_configure + +- name: Ensure BIND Exporter is enabled on boot + become: true + ansible.builtin.systemd: + daemon_reload: true + name: bind_exporter + enabled: true + state: started + when: + - not ansible_check_mode + tags: + - bind_exporter_run diff --git a/roles/bind_exporter/tasks/preflight.yml b/roles/bind_exporter/tasks/preflight.yml new file mode 100644 index 0000000..89a00e8 --- /dev/null +++ b/roles/bind_exporter/tasks/preflight.yml @@ -0,0 +1,115 @@ +--- +- 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: Assert that used version supports listen address type + ansible.builtin.assert: + that: + - >- + bind_exporter_web_listen_address is string + or + ( + bind_exporter_version is version('0.15.0', '>=') and + bind_exporter_web_listen_address | type_debug == "list" + ) + +- name: Naive assertion of proper listen address + ansible.builtin.assert: + that: + - >- + [bind_exporter_web_listen_address] | + flatten | + reject('match', '.+:\\d+$') | + list | + length == 0 + +- name: Assert that TLS config is correct + when: bind_exporter_tls_server_config | length > 0 + block: + - name: Assert that TLS key and cert path are set + ansible.builtin.assert: + that: + - "bind_exporter_tls_server_config.cert_file is defined" + - "bind_exporter_tls_server_config.key_file is defined" + + - name: Check existence of TLS cert file + ansible.builtin.stat: + path: "{{ bind_exporter_tls_server_config.cert_file }}" + register: __bind_exporter_cert_file + + - name: Check existence of TLS key file + ansible.builtin.stat: + path: "{{ bind_exporter_tls_server_config.key_file }}" + register: __bind_exporter_key_file + + - name: Assert that TLS key and cert are present + ansible.builtin.assert: + that: + - "__bind_exporter_cert_file.stat.exists" + - "__bind_exporter_key_file.stat.exists" + +- name: Check if bind_exporter is installed + ansible.builtin.stat: + path: "{{ bind_exporter_binary_install_dir }}/bind_exporter" + register: __bind_exporter_is_installed + check_mode: false + tags: + - bind_exporter_install + +- name: Gather currently installed bind_exporter version (if any) + ansible.builtin.command: "{{ bind_exporter_binary_install_dir }}/bind_exporter --version" + changed_when: false + register: __bind_exporter_current_version_output + check_mode: false + when: __bind_exporter_is_installed.stat.exists + tags: + - bind_exporter_install + +- name: Discover latest version + ansible.builtin.set_fact: + bind_exporter_version: "{{ (lookup('url', 'https://api.github.com/repos/{{ _bind_exporter_repo }}/releases/latest', headers=_github_api_headers, + split_lines=False) | from_json).get('tag_name') | replace('v', '') }}" + run_once: true + until: bind_exporter_version is version('0.0.0', '>=') + retries: 10 + when: + - bind_exporter_version == "latest" + - bind_exporter_binary_local_dir | length == 0 + - not bind_exporter_skip_install + +- name: Get bind_exporter binary checksum + when: + - bind_exporter_binary_local_dir | length == 0 + - not bind_exporter_skip_install + block: + - name: Get checksum list from github + ansible.builtin.set_fact: + __bind_exporter_checksums: "{{ lookup('url', bind_exporter_checksums_url, headers=_github_api_headers, wantlist=True) | list }}" + run_once: true + until: __bind_exporter_checksums is search('linux-' + go_arch + '.tar.gz') + retries: 10 + + - name: "Get checksum for {{ go_arch }}" + ansible.builtin.set_fact: + __bind_exporter_checksum: "{{ item.split(' ')[0] }}" + with_items: "{{ __bind_exporter_checksums }}" + when: + - "('linux-' + go_arch + '.tar.gz') in item" diff --git a/roles/bind_exporter/tasks/selinux.yml b/roles/bind_exporter/tasks/selinux.yml new file mode 100644 index 0000000..754cbd0 --- /dev/null +++ b/roles/bind_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/bind_exporter/templates/bind_exporter.service.j2 b/roles/bind_exporter/templates/bind_exporter.service.j2 new file mode 100644 index 0000000..badee86 --- /dev/null +++ b/roles/bind_exporter/templates/bind_exporter.service.j2 @@ -0,0 +1,48 @@ +{{ ansible_managed | comment }} + +[Unit] +Description=Prometheus BIND Exporter +After=network-online.target + +[Service] +Type=simple +User={{ bind_exporter_system_user }} +Group={{ bind_exporter_system_group }} +ExecStart={{ bind_exporter_binary_install_dir }}/bind_exporter \ +{% if bind_exporter_stats_groups | length > 0 %} + --bind.stats-groups="{{ bind_exporter_stats_groups | join(',') }}" \ +{% endif %} +{% if bind_exporter_tls_server_config | length > 0 or bind_exporter_http_server_config | length > 0 or bind_exporter_basic_auth_users | length > 0 %} + --web.config.file={{ bind_exporter_config_dir }}/web_config.yaml \ +{% endif %} + --bind.stats-url="{{ bind_exporter_stats_url }}" \ + --bind.timeout="{{ bind_exporter_timeout }}" \ + --bind.pid-file="{{ bind_exporter_pid_file }}" \ + --bind.stats-version={{ bind_exporter_stats_version }} \ + --web.listen-address={{ bind_exporter_web_listen_address }} \ + --web.telemetry-path={{ bind_exporter_web_telemetry_path }} + + +SyslogIdentifier=bind_exporter +Restart=always +RestartSec=1 +StartLimitInterval=0 + +{% set protect_home = 'yes' %} +{% for m in ansible_mounts if m.mount.startswith('/home') %} +{% set protect_home = 'read-only' %} +{% endfor %} +ProtectHome={{ protect_home }} +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/bind_exporter/templates/web_config.yaml.j2 b/roles/bind_exporter/templates/web_config.yaml.j2 new file mode 100644 index 0000000..cf458e4 --- /dev/null +++ b/roles/bind_exporter/templates/web_config.yaml.j2 @@ -0,0 +1,18 @@ +--- +{{ ansible_managed | comment }} +{% if bind_exporter_tls_server_config | length > 0 %} +tls_server_config: +{{ bind_exporter_tls_server_config | to_nice_yaml | indent(2, true) }} +{% endif %} + +{% if bind_exporter_http_server_config | length > 0 %} +http_server_config: +{{ bind_exporter_http_server_config | to_nice_yaml | indent(2, true) }} +{% endif %} + +{% if bind_exporter_basic_auth_users | length > 0 %} +basic_auth_users: +{% for k, v in bind_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/bind_exporter/test-requirements.txt b/roles/bind_exporter/test-requirements.txt new file mode 100644 index 0000000..7f0b6e7 --- /dev/null +++ b/roles/bind_exporter/test-requirements.txt @@ -0,0 +1 @@ +bcrypt diff --git a/roles/bind_exporter/vars/main.yml b/roles/bind_exporter/vars/main.yml new file mode 100644 index 0000000..40eba5d --- /dev/null +++ b/roles/bind_exporter/vars/main.yml @@ -0,0 +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) }}" + +_bind_exporter_repo: "prometheus-community/bind_exporter" +_github_api_headers: "{{ {'GITHUB_TOKEN': lookup('ansible.builtin.env', 'GITHUB_TOKEN')} if (lookup('ansible.builtin.env', 'GITHUB_TOKEN')) else {} }}"