fix: Make binary installs consistent

Update the blackbox_exporter and snmp_exporter installs to be consistent
with other exporter package installs.

Signed-off-by: SuperQ <[email protected]>

roles/blackbox_exporter/defaults/main.yml

@@ -1,8 +1,10 @@
 ---
 blackbox_exporter_version: 0.24.0
+blackbox_exporter_binary_local_dir: ""
 blackbox_exporter_binary_url: "https://github.com/{{ _blackbox_exporter_repo }}/releases/download/v{{ blackbox_exporter_version }}/\
                                blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch_map[ansible_architecture] |
                                default(ansible_architecture) }}.tar.gz"
+blackbox_exporter_checksums_url: "https://github.com/{{ _blackbox_exporter_repo }}/releases/download/v{{ blackbox_exporter_version }}/sha256sums.txt"
 blackbox_exporter_skip_install: false
 
 blackbox_exporter_web_listen_address: "0.0.0.0:9115"
@@ -71,3 +73,5 @@ blackbox_exporter_configuration_modules:
 
 # Where to put the blackbox_exporter.yml main configuration file
 blackbox_exporter_config_dir: /etc
+
+blackbox_exporter_binary_install_dir: "/usr/local/bin"

roles/blackbox_exporter/handlers/main.yml

@@ -1,14 +1,14 @@
 ---
-- name: Restart blackbox exporter
-  listen: "restart blackbox exporter"
+- name: Restart blackbox_exporter
+  listen: "restart blackbox_exporter"
   become: true
   ansible.builtin.systemd:
     daemon_reload: true
     name: blackbox_exporter
     state: restarted
 
-- name: Reload blackbox exporter
-  listen: "reload blackbox exporter"
+- name: Reload blackbox_exporter
+  listen: "reload blackbox_exporter"
   become: true
   ansible.builtin.systemd:
     name: blackbox_exporter

roles/blackbox_exporter/meta/argument_specs.yml

@@ -9,15 +9,23 @@ argument_specs:
       - "Prometheus Community"
     options:
       blackbox_exporter_version:
-        description: "Blackbox exporter package version"
+        description: "Blackbox exporter package version. Also accepts latest as parameter."
         default: "0.24.0"
       blackbox_exporter_skip_install:
         description: "Blackbox exporter installation tasks gets skipped when set to true."
         type: bool
         default: false
+      blackbox_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(blackbox_exporter) binary is stored on the host where ansible is run."
+          - "This overrides the I(blackbox_exporter_version) parameter"
       blackbox_exporter_binary_url:
         description: "URL of the blackbox_exporter binaries .tar.gz file"
         default: "https://github.com/{{ _blackbox_exporter_repo }}/releases/download/v{{ blackbox_exporter_version }}/blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}.tar.gz"
+      blackbox_exporter_checksums_url:
+        description: "URL of the blackbox exporter checksums file"
+        default: "https://github.com/{{ _blackbox_exporter_repo }}/releases/download/v{{ blackbox_exporter_version }}/sha256sums.txt"
       blackbox_exporter_web_listen_address:
         description: "Address on which blackbox exporter will be listening"
         default: "0.0.0.0:9115"
@@ -37,6 +45,11 @@ argument_specs:
       blackbox_exporter_config_dir:
         description: "Directory where the blackbox exporter configuration file is placed"
         default: "/etc"
+      blackbox_exporter_binary_install_dir:
+        description:
+          - "I(Advanced)"
+          - "Directory to install blackbox_exporter binary"
+        default: "/usr/local/bin"
       blackbox_exporter_user:
         description: "The user the exporter runs as"
         default: "blackbox-exp"

roles/blackbox_exporter/molecule/latest/molecule.yml

@@ -0,0 +1,6 @@
+---
+provisioner:
+  inventory:
+    group_vars:
+      all:
+        blackbox_exporter_version: latest

roles/blackbox_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/blackbox_exporter.service",
+    "/usr/local/bin/blackbox_exporter"
+])
+def test_files(host, files):
+    f = host.file(files)
+    assert f.exists
+    assert f.is_file
+
+
+def test_service(host):
+    s = host.service("blackbox_exporter")
+    try:
+        assert s.is_running
+    except AssertionError:
+        # Capture service logs
+        journal_output = host.run('journalctl -u blackbox_exporter --since "1 hour ago"')
+        print("\n==== journalctl -u blackbox_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:9100")
+    assert s.is_listening

roles/blackbox_exporter/tasks/configure.yml

@@ -7,7 +7,7 @@
     group: root
     mode: 0644
   notify:
-    - restart blackbox exporter
+    - restart blackbox_exporter
 
 - name: Configure blackbox exporter
   ansible.builtin.template:
@@ -17,4 +17,4 @@
     group: "{{ blackbox_exporter_group }}"
     mode: 0644
   notify:
-    - reload blackbox exporter
+    - reload blackbox_exporter

roles/blackbox_exporter/tasks/install.yml

@@ -15,33 +15,56 @@
     createhome: false
   when: blackbox_exporter_user != 'root'
 
-- name: Download blackbox exporter binary to local folder
-  become: false
-  ansible.builtin.unarchive:
-    src: "{{ blackbox_exporter_binary_url }}"
-    dest: "/tmp"
-    remote_src: true
-    creates: "/tmp/blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}/\
-              blackbox_exporter"
-  register: _download_binary
-  until: _download_binary is succeeded
-  retries: 5
-  delay: 2
-  delegate_to: localhost
-  check_mode: false
-  when: not blackbox_exporter_skip_install
+- name: Get binary
+  when:
+    - blackbox_exporter_binary_local_dir | length == 0
+    - not blackbox_exporter_skip_install
+  block:
+
+    - name: Download blackbox_exporter binary to local folder
+      become: false
+      ansible.builtin.get_url:
+        url: "{{ blackbox_exporter_binary_url }}"
+        dest: "/tmp/blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch }}.tar.gz"
+        checksum: "sha256:{{ __blackbox_exporter_checksum }}"
+        mode: '0644'
+      register: _download_binary
+      until: _download_binary is succeeded
+      retries: 5
+      delay: 2
+      delegate_to: localhost
+      check_mode: false
 
-- name: Propagate blackbox exporter binary
+    - name: Unpack blackbox_exporter binary
+      become: false
+      ansible.builtin.unarchive:
+        src: "/tmp/blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch }}.tar.gz"
+        dest: "/tmp"
+        creates: "/tmp/blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch }}/blackbox_exporter"
+      delegate_to: localhost
+      check_mode: false
+
+    - name: Propagate blackbox_exporter binaries
+      ansible.builtin.copy:
+        src: "/tmp/blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch }}/blackbox_exporter"
+        dest: "{{ blackbox_exporter_binary_install_dir }}/blackbox_exporter"
+        mode: 0755
+        owner: root
+        group: root
+      notify: restart blackbox_exporter
+      when: not ansible_check_mode
+
+- name: Propagate locally distributed blackbox_exporter binary
   ansible.builtin.copy:
-    src: "/tmp/blackbox_exporter-{{ blackbox_exporter_version }}.linux-{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}/\
-          blackbox_exporter"
-    dest: "/usr/local/bin/blackbox_exporter"
-    mode: 0750
+    src: "{{ blackbox_exporter_binary_local_dir }}/blackbox_exporter"
+    dest: "{{ blackbox_exporter_binary_install_dir }}/blackbox_exporter"
+    mode: 0755
     owner: root
-    group: "{{ blackbox_exporter_group }}"
-  when: not blackbox_exporter_skip_install
-  notify:
-    - restart blackbox exporter
+    group: root
+  when:
+    - blackbox_exporter_binary_local_dir | length > 0
+    - not blackbox_exporter_skip_install
+  notify: restart blackbox_exporter
 
 - name: Install libcap on Debian systems
   ansible.builtin.package:

roles/blackbox_exporter/tasks/preflight.yml

@@ -24,3 +24,34 @@
   ansible.builtin.assert:
     that:
       - "':' in blackbox_exporter_web_listen_address"
+
+- name: Discover latest version
+  ansible.builtin.set_fact:
+    blackbox_exporter_version: "{{ (lookup('url', 'https://api.github.com/repos/prometheus/blackbox_exporter/releases/latest', headers=_github_api_headers,
+                            split_lines=False) | from_json).get('tag_name') | replace('v', '') }}"
+  run_once: true
+  until: blackbox_exporter_version is version('0.0.0', '>=')
+  retries: 10
+  when:
+    - blackbox_exporter_version == "latest"
+    - blackbox_exporter_binary_local_dir | length == 0
+    - not blackbox_exporter_skip_install
+
+- name: Get blackbox_exporter binary checksum
+  when:
+    - blackbox_exporter_binary_local_dir | length == 0
+    - not blackbox_exporter_skip_install
+  block:
+    - name: Get checksum list from github
+      ansible.builtin.set_fact:
+        __blackbox_exporter_checksums: "{{ lookup('url', blackbox_exporter_checksums_url, headers=_github_api_headers, wantlist=True) | list }}"
+      run_once: true
+      until: __blackbox_exporter_checksums is search('linux-' + go_arch + '.tar.gz')
+      retries: 10
+
+    - name: "Get checksum for {{ go_arch }}"
+      ansible.builtin.set_fact:
+        __blackbox_exporter_checksum: "{{ item.split(' ')[0] }}"
+      with_items: "{{ __blackbox_exporter_checksums }}"
+      when:
+        - "('linux-' + go_arch + '.tar.gz') in item"

roles/blackbox_exporter/vars/main.yml

@@ -5,4 +5,7 @@ go_arch_map:
   aarch64: 'arm64'
   armv7l: 'armv7'
   armv6l: 'armv6'
+
+go_arch: "{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}"
 _blackbox_exporter_repo: "prometheus/blackbox_exporter"
+_github_api_headers: "{{ {'GITHUB_TOKEN': lookup('ansible.builtin.env', 'GITHUB_TOKEN')} if (lookup('ansible.builtin.env', 'GITHUB_TOKEN')) else {} }}"

roles/snmp_exporter/defaults/main.yml

@@ -1,5 +1,6 @@
 ---
 snmp_exporter_version: 0.23.0
+snmp_exporter_binary_local_dir: ""
 snmp_exporter_binary_url: "https://github.com/{{ _snmp_exporter_repo }}/releases/download/v{{ snmp_exporter_version }}/\
                            snmp_exporter-{{ snmp_exporter_version }}.linux-{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}.tar.gz"
 snmp_exporter_checksums_url: "https://github.com/{{ _snmp_exporter_repo }}/releases/download/v{{ snmp_exporter_version }}/sha256sums.txt"
@@ -9,3 +10,5 @@ snmp_exporter_log_level: info
 
 # If this is empty, role will download snmp.yml file from https://github.com/prometheus/snmp_exporter.
 snmp_exporter_config_file: ""
+
+snmp_exporter_binary_install_dir: "/usr/local/bin"

roles/snmp_exporter/handlers/main.yml

@@ -1,14 +1,14 @@
 ---
-- name: Reload snmp exporter
-  listen: "reload snmp exporter"
+- name: Reload snmp_exporter
+  listen: "reload snmp_exporter"
   become: true
   ansible.builtin.systemd:
     daemon_reload: true
     name: snmp_exporter
     state: reloaded
 
-- name: Restart snmp exporter
-  listen: "restart snmp exporter"
+- name: Restart snmp_exporter
+  listen: "restart snmp_exporter"
   become: true
   ansible.builtin.systemd:
     daemon_reload: true

roles/snmp_exporter/meta/argument_specs.yml

@@ -9,12 +9,17 @@ argument_specs:
       - "Prometheus Community"
     options:
       snmp_exporter_version:
-        description: "SNMP exporter package version"
+        description: "SNMP exporter package version. Also accepts latest as parameter."
         default: "0.23.0"
       snmp_exporter_skip_install:
         description: "SNMP exporter installation tasks gets skipped when set to true."
         type: bool
         default: false
+      snmp_exporter_binary_local_dir:
+        description:
+          - "Enables the use of local packages instead of those distributed on github."
+          - "The parameter masnmp set to a directory where the C(snmp_exporter) binary is stored on the host where ansible is run."
+          - "This overrides the I(snmp_exporter_version) parameter"
       snmp_exporter_binary_url:
         description: "URL of the snmp exporter binaries .tar.gz file"
         default: "https://github.com/{{ _snmp_exporter_repo }}/releases/download/v{{ snmp_exporter_version }}/snmp_exporter-{{ snmp_exporter_version }}.linux-{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}.tar.gz"
@@ -31,3 +36,8 @@ argument_specs:
         description:
           - "If this is empty, role will download snmp.yml file from U(https://github.com/prometheus/snmp_exporter)."
           - "Otherwise this should contain path to file with custom snmp exporter configuration"
+      snmp_exporter_binary_install_dir:
+        description:
+          - "I(Advanced)"
+          - "Directory to install snmp_exporter binary"
+        default: "/usr/local/bin"

roles/snmp_exporter/tasks/configure.yml

@@ -7,7 +7,7 @@
     group: root
     mode: 0644
   notify:
-    - restart snmp exporter
+    - restart snmp_exporter
 
 - name: Download snmp configuration file from github repository
   ansible.builtin.get_url:
@@ -22,7 +22,7 @@
   retries: 5
   delay: 2
   notify:
-    - reload snmp exporter
+    - reload snmp_exporter
   when: not (snmp_exporter_config_file)
 
 - name: Copy configuration file
@@ -34,5 +34,5 @@
     mode: 0644
   no_log: "{{ false if (lookup('env', 'CI')) or (lookup('env', 'MOLECULE_PROVISIONER_NAME')) else true }}"
   notify:
-    - reload snmp exporter
+    - reload snmp_exporter
   when: (snmp_exporter_config_file)