feat: add smartctl_exporter role (#229)

Signed-off-by: Nikolay Asenov <[email protected]>
Signed-off-by: Ben Kochie <[email protected]>
Co-authored-by: Ben Kochie <[email protected]>

roles/smartctl_exporter/README.md

@@ -0,0 +1,44 @@
+<p><img src="https://www.circonus.com/wp-content/uploads/2015/03/sol-icon-itOps.png" alt="graph logo" title="graph" align="right" height="60" /></p>
+
+# Ansible Role: smartctl_exporter
+
+## Description
+
+Deploy prometheus [smartctl_exporter](https://github.com/prometheus-community/smartctl_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/smartctl_exporter_role.html) for description and default values of the variables.
+
+## Example
+
+### Demo site
+
+We provide demo site for full monitoring solution based on prometheus and grafana. Repository with code and links to running instances is [available on github](https://github.com/prometheus/demo-site) and 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 to for your system. Running your tests is as simple as executing `molecule test`.
+
+## Continuous Intergation
+
+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 a quite 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.

roles/smartctl_exporter/defaults/main.yml

@@ -0,0 +1,30 @@
+---
+smartctl_exporter_version: 0.11.0
+smartctl_exporter_binary_local_dir: ""
+smartctl_exporter_binary_url: "https://github.com/{{ _smartctl_exporter_repo }}/releases/download/v{{ smartctl_exporter_version }}/\
+                           smartctl_exporter-{{ smartctl_exporter_version }}.linux-{{ go_arch }}.tar.gz"
+smartctl_exporter_checksums_url: "https://github.com/{{ _smartctl_exporter_repo }}/releases/download/v{{ smartctl_exporter_version }}/sha256sums.txt"
+smartctl_exporter_skip_install: false
+
+smartctl_exporter_smartctl_path: "/usr/sbin/smartctl"
+smartctl_exporter_smartctl_interval: "60s"
+smartctl_exporter_smartctl_rescan: "10m"
+smartctl_exporter_smartctl_devices: []
+smartctl_exporter_smartctl_device_exclude: ""
+smartctl_exporter_smartctl_device_include: ""
+
+smartctl_exporter_web_listen_address: "0.0.0.0:9633"
+smartctl_exporter_web_telemetry_path: "/metrics"
+
+smartctl_exporter_tls_server_config: {}
+
+smartctl_exporter_http_server_config: {}
+
+smartctl_exporter_basic_auth_users: {}
+
+smartctl_exporter_log_level: "info"
+smartctl_exporter_log_format: "logfmt"
+
+smartctl_exporter_binary_install_dir: "/usr/local/bin"
+smartctl_exporter_system_group: "smartctl-exp"
+smartctl_exporter_system_user: "{{ smartctl_exporter_system_group }}"

roles/smartctl_exporter/handlers/main.yml

@@ -0,0 +1,10 @@
+---
+- name: Restart smartctl_exporter
+  listen: "restart smartctl_exporter"
+  become: true
+  ansible.builtin.systemd:
+    daemon_reload: true
+    name: smartctl_exporter
+    state: restarted
+  when:
+    - not ansible_check_mode

roles/smartctl_exporter/meta/argument_specs.yml

@@ -0,0 +1,92 @@
+---
+# yamllint disable rule:line-length
+argument_specs:
+  main:
+    short_description: "Prometheus Smartctl Exporter"
+    description:
+      - "Deploy prometheus L(smartctl exporter,https://github.com/prometheus-community/smartctl_exporter) using ansible"
+    author:
+      - "Prometheus Community"
+    options:
+      smartctl_exporter_version:
+        description: "Smartctl exporter package version. Also accepts latest as parameter."
+        default: "0.11.0"
+      smartctl_exporter_skip_install:
+        description: "Smartctl exporter installation tasks gets skipped when set to true."
+        type: bool
+        default: false
+      smartctl_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(smartctl_exporter) binary is stored on the host where ansible is run."
+          - "This overrides the I(smartctl_exporter_version) parameter"
+      smartctl_exporter_binary_url:
+        description: "URL of the Smartctl exporter binaries .tar.gz file"
+        default: "https://github.com/{{ _smartctl_exporter_repo }}/releases/download/v{{ smartctl_exporter_version }}/smartctl_exporter-{{ smartctl_exporter_version }}.linux-{{ go_arch }}.tar.gz"
+      smartctl_exporter_checksums_url:
+        description: "URL of the Smartctl exporter checksums file"
+        default: "https://github.com/{{ _smartctl_exporter_repo }}/releases/download/v{{ smartctl_exporter_version }}/sha256sums.txt"
+      smartctl_exporter_smartctl_interval:
+        description: "The interval between smartctl polls"
+        default: "60s"
+      smartctl_exporter_smartctl_rescan:
+        description:
+          - "The interval between rescanning for new/disappeared devices."
+          - "If the interval is smaller than 1s norescanning takes place."
+          - "If any devices are configured with smartctl_exporter_smartctl_device also no rescanning takes place."
+        default: "10m"
+      smartctl_exporter_smartctl_devices:
+        description: "List of devices to be monitored by smartctl_exporter. Disables auto scan for available devices."
+        type: "list"
+        elements: "str"
+      smartctl_exporter_smartctl_device_exclude:
+        description: "Regexp of devices to exclude from automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_include)"
+        default: ""
+      smartctl_exporter_smartctl_device_include:
+        description: "Regexp of devices to include in automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_exclude)"
+        default: ""
+      smartctl_exporter_web_listen_address:
+        description: "Address on which smartctl exporter will listen"
+        default: "0.0.0.0:9633"
+      smartctl_exporter_web_telemetry_path:
+        description: "Path under which to expose metrics"
+        default: "/metrics"
+      smartctl_exporter_tls_server_config:
+        description:
+          - "Configuration for TLS authentication."
+          - "Keys and values are the same as in L(smartctl_exporter docs,https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md)."
+        type: "dict"
+      smartctl_exporter_http_server_config:
+        description:
+          - "Config for HTTP/2 support."
+          - "Keys and values are the same as in L(smartctl_exporter docs,https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md)."
+        type: "dict"
+      smartctl_exporter_basic_auth_users:
+        description: "Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt."
+        type: "dict"
+      smartctl_exporter_log_level:
+        description: "Only log messages with the given severity or above. One of: [debug, info, warn, error]"
+        default: "info"
+      smartctl_exporter_log_format:
+        description: "Output format of log messages. One of: [logfmt, json]"
+        default: "logfmt"
+      smartctl_exporter_smartctl_path:
+        description:
+          - "I(Advanced)"
+          - "The path to the smartctl binary"
+        default: "/usr/sbin/smartctl"
+      smartctl_exporter_binary_install_dir:
+        description:
+          - "I(Advanced)"
+          - "Directory to install smartctl_exporter binary"
+        default: "/usr/local/bin"
+      smartctl_exporter_system_group:
+        description:
+          - "I(Advanced)"
+          - "System group for Smartctl exporter"
+        default: "smartctl-exp"
+      smartctl_exporter_system_user:
+        description:
+          - "I(Advanced)"
+          - "Smartctl exporter user"
+        default: "smartctl-exp"

roles/smartctl_exporter/meta/main.yml

@@ -0,0 +1,30 @@
+---
+galaxy_info:
+  author: "Prometheus Community"
+  description: "Prometheus Smartctl 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"

roles/smartctl_exporter/molecule/alternative/molecule.yml

@@ -0,0 +1,21 @@
+---
+provisioner:
+  inventory:
+    group_vars:
+      all:
+        smartctl_exporter_binary_local_dir: "/tmp/smartctl_exporter-linux-amd64"
+        smartctl_exporter_web_listen_address: "127.0.0.1:8080"
+        smartctl_exporter_smartctl_interval: "30s"
+        smartctl_exporter_smartctl_rescan: "5m"
+        smartctl_exporter_smartctl_device_include: "/dev/sda"
+        smartctl_exporter_smartctl_device_exclude: "/dev/sdb"
+
+        smartctl_exporter_tls_server_config:
+          cert_file: /etc/smartctl_exporter/tls.cert
+          key_file: /etc/smartctl_exporter/tls.key
+        smartctl_exporter_http_server_config:
+          http2: true
+        smartctl_exporter_basic_auth_users:
+          randomuser: examplepassword
+        go_arch: amd64
+        smartctl_exporter_version: 0.11.0

roles/smartctl_exporter/molecule/alternative/prepare.yml

@@ -0,0 +1,78 @@
+---
+- name: Run local preparation
+  hosts: localhost
+  gather_facts: false
+  tasks:
+    - name: Download smartctl_exporter binary to local folder
+      become: false
+      ansible.builtin.get_url:
+        url: "https://github.com/prometheus-community/smartctl_exporter/releases/download/v{{\
+          \ smartctl_exporter_version }}/smartctl_exporter-{{ smartctl_exporter_version }}.linux-{{\
+          \ go_arch }}.tar.gz"
+        dest: "/tmp/smartctl_exporter-{{ smartctl_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 smartctl_exporter binary
+      become: false
+      ansible.builtin.unarchive:
+        src: "/tmp/smartctl_exporter-{{ smartctl_exporter_version }}.linux-{{ go_arch }}.tar.gz"
+        dest: "/tmp"
+        creates: "/tmp/smartctl_exporter-{{ smartctl_exporter_version }}.linux-{{ go_arch\
+          \ }}/smartctl_exporter"
+      check_mode: false
+
+    - name: Link to smartctl_exporter binaries directory
+      become: false
+      ansible.builtin.file:
+        src: "/tmp/smartctl_exporter-{{ smartctl_exporter_version }}.linux-amd64"
+        dest: "/tmp/smartctl_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 smartctl_exporter cert dir
+      ansible.builtin.file:
+        path: "{{ smartctl_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: "{{ smartctl_exporter_tls_server_config.cert_file }}"
+        - src: "/tmp/tls.key"
+          dest: "{{ smartctl_exporter_tls_server_config.key_file }}"

roles/smartctl_exporter/molecule/alternative/tests/test_alternative.py

@@ -0,0 +1,46 @@
+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/smartctl_exporter"
+    ]
+    for dir in dirs:
+        d = host.file(dir)
+        assert d.is_directory
+        assert d.exists
+
+
+def test_service(host):
+    s = host.service("smartctl_exporter")
+    try:
+        assert s.is_running
+    except AssertionError:
+        # Capture service logs
+        journal_output = host.run('journalctl -u smartctl_exporter --since "1 hour ago"')
+        print("\n==== journalctl -u smartctl_exporter Output ====\n")
+        print(journal_output)
+        print("\n============================================\n")
+        raise  # Re-raise the original assertion error
+
+
+def test_protecthome_property(host):
+    s = host.service("smartctl_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

roles/smartctl_exporter/molecule/default/molecule.yml

@@ -0,0 +1,6 @@
+---
+provisioner:
+  inventory:
+    group_vars:
+      all:
+        smartctl_exporter_web_listen_address: "127.0.0.1:9633"