feat: add pve_exporter

roles/pve_exporter/README.md

@@ -0,0 +1,47 @@
+# Ansible Role: pve exporter
+
+## Description
+
+Deploy prometheus [pve exporter](https://github.com/prometheus-pve/prometheus-pve-exporter), written in python, using ansible.
+
+Possible Grafana dashboard: https://grafana.com/grafana/dashboards/10347-proxmox-via-prometheus/
+
+## Requirements
+
+- Ansible >= 2.9 (It might work on previous versions, but we cannot guarantee it)
+
+## 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/pve_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.pve_exporter
+```
+
+## 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.

roles/pve_exporter/TROUBLESHOOTING.md

@@ -0,0 +1 @@
+# Troubleshooting

roles/pve_exporter/defaults/main.yml

@@ -0,0 +1,35 @@
+---
+pve_exporter_version: 3.5.0
+# not go, but python pip. placeholders for _common
+pve_exporter_textfile_dir: ""
+pve_exporter_tls_server_config: {}
+pve_exporter_http_server_config: {}
+pve_exporter_basic_auth_users: {}
+# just for "prometheus.prometheus._common : Naive assertion of proper listen address" else not used
+pve_exporter_web_listen_address: "127.0.0.1:9221"
+
+# cluster collectors
+pve_exporter_enabled_collectors: []
+# pve_exporter_enabled_collectors:
+#   - status
+#   - version
+#   - node
+#   - cluster
+#   - resources
+pve_exporter_disabled_collectors: []
+
+pve_exporter_home: "/var/lib/pve_exporter"
+pve_exporter_virtualenv: "/var/lib/pve_exporter/venv"
+
+pve_exporter_auth_user: prometheus@pve
+pve_exporter_auth_pass:
+pve_exporter_auth_verify_ssl: true
+pve_exporter_auth_token_name: your-token-id
+pve_exporter_auth_token_value:
+
+pve_exporter_config_template: pve_exporter.yml.j2
+
+pve_exporter_system_group: "pve-exp"
+pve_exporter_system_user: "{{ pve_exporter_system_group }}"
+
+pve_exporter_config_dir: "/etc/pve_exporter"

roles/pve_exporter/handlers/main.yml

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

roles/pve_exporter/meta/argument_specs.yml

@@ -0,0 +1,86 @@
+---
+# yamllint disable rule:line-length
+argument_specs:
+  main:
+    short_description: "Prometheus Proxmox VE Exporter"
+    description:
+      - "Deploy prometheus L(pve exporter,https://github.com/prometheus-pve/prometheus-pve-exporter) using ansible"
+    author:
+      - "Prometheus Community"
+    options:
+      pve_exporter_home:
+        description: "Home of pve_exporter user and base file locations"
+        default: "/var/lib/pve_exporter"
+      pve_exporter_virtualenv:
+        description: "Python virtualenv filepath for pve_exporter"
+        default: "/var/lib/pve_exporter/venv"
+      pve_exporter_auth_user:
+        description: "Authentication PVE user name if using user/password auth"
+        default: "prometheus@pve"
+      pve_exporter_auth_pass:
+        description: "Authentication PVE user password if using user/password auth"
+      pve_exporter_auth_verify_ssl:
+        description: "Validate proxmox certificate or not"
+        type: bool
+        default: true
+      pve_exporter_auth_token_name:
+        description: "Authentication PVE user token name if using token auth"
+        default: your-token-id
+      pve_exporter_auth_token_value:
+        description: "Authentication PVE user token value from `pveum user token add ...`"
+      pve_exporter_config_template:
+        description: "Configuration template for pve_exporter"
+        default: "pve_exporter.yml.j2"
+      pve_exporter_version:
+        description: "Proxmox VE Exporter package version. Also accepts latest as parameter."
+        default: "1.0.0"
+      pve_exporter_web_listen_address:
+        description: "Address on which pve exporter will listen"
+        default: "0.0.0.0:15353"
+      pve_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/prometheus-pve/prometheus-pve-exporter#enabled-by-default)."
+        type: "list"
+        default:
+          - systemd
+          - textfile:
+              directory: "{{ pve_exporter_textfile_dir }}"
+      pve_exporter_disabled_collectors:
+        description:
+          - "List of disabled collectors."
+          - "By default pve_exporter disables collectors listed L(here,https://github.com/prometheus-pve/prometheus-pve-exporter#disabled-by-default)."
+        type: "list"
+        elements: "str"
+      pve_exporter_textfile_dir:
+        description:
+          - "Directory used by the L(Textfile Collector,https://github.com/prometheus-pve/prometheus-pve-exporter#textfile-collector)."
+          - "To get permissions to write metrics in this directory, users must be in C(pve-exp) system group."
+          - "B(Note:) More information in TROUBLESHOOTING.md guide."
+        default: "/var/lib/pve_exporter"
+      pve_exporter_tls_server_config:
+        description:
+          - "Configuration for TLS authentication."
+          - "Keys and values are the same as in L(pve_exporter docs,https://prometheus.io/docs/prometheus/latest/configuration/https/)."
+        type: "dict"
+      pve_exporter_http_server_config:
+        description:
+          - "Config for HTTP/2 support."
+          - "Keys and values are the same as in L(pve_exporter docs,https://prometheus.io/docs/prometheus/latest/configuration/https/)."
+        type: "dict"
+      pve_exporter_basic_auth_users:
+        description: "Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt."
+        type: "dict"
+      pve_exporter_system_group:
+        description:
+          - "I(Advanced)"
+          - "System group for pve exporter"
+        default: "pve-exp"
+      pve_exporter_system_user:
+        description:
+          - "I(Advanced)"
+          - "Proxmox VE Exporter user"
+        default: "pve-exp"
+      pve_exporter_config_dir:
+        description: "Path to directory with pve_exporter configuration"
+        default: "/etc/pve_exporter"

roles/pve_exporter/meta/main.yml

@@ -0,0 +1,25 @@
+---
+galaxy_info:
+  author: "Prometheus Community"
+  description: "Prometheus Proxmox VE Exporter"
+  license: "Apache"
+  min_ansible_version: "2.9"
+  platforms:
+    - name: "Ubuntu"
+      versions:
+        - "focal"
+        - "jammy"
+        - "noble"
+    - name: "Debian"
+      versions:
+        - "bullseye"
+    - name: "EL"
+      versions:
+        - "8"
+        - "9"
+  galaxy_tags:
+    - "monitoring"
+    - "prometheus"
+    - "exporter"
+    - "metrics"
+    - "system"

roles/pve_exporter/molecule/alternative/molecule.yml

@@ -0,0 +1,23 @@
+---
+provisioner:
+  playbooks:
+    prepare: "${MOLECULE_PROJECT_DIRECTORY}/../../.config/molecule/alternative/prepare.yml"
+  inventory:
+    group_vars:
+      all:
+        pve_exporter_web_listen_address:
+          - '127.0.0.1:8080'
+          - '127.0.1.1:8080'
+        pve_exporter_textfile_dir: ""
+        pve_exporter_enabled_collectors:
+          - entropy
+        pve_exporter_disabled_collectors:
+          - diskstats
+        pve_exporter_tls_server_config:
+          cert_file: /etc/pve_exporter/tls.cert
+          key_file: /etc/pve_exporter/tls.key
+        pve_exporter_http_server_config:
+          http2: true
+        pve_exporter_basic_auth_users:
+          randomuser: examplepassword
+        pve_exporter_version: 3.5.0

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

@@ -0,0 +1,43 @@
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from testinfra_helpers import get_target_hosts
+import pytest
+
+testinfra_hosts = get_target_hosts()
+
+
+def test_directories(host):
+    dirs = [
+        "/var/lib/pve_exporter"
+    ]
+    for dir in dirs:
+        d = host.file(dir)
+        assert not d.exists
+
+
+def test_service(host):
+    s = host.service("pve_exporter")
+    try:
+        assert s.is_running
+    except AssertionError:
+        # Capture service logs
+        journal_output = host.run('journalctl -u pve_exporter --since "1 hour ago"')
+        print("\n==== journalctl -u pve_exporter Output ====\n")
+        print(journal_output)
+        print("\n============================================\n")
+        raise  # Re-raise the original assertion error
+
+
+def test_protecthome_property(host):
+    s = host.service("pve_exporter")
+    p = s.systemd_properties
+    assert p.get("ProtectHome") == "yes"
+
+
+@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

roles/pve_exporter/molecule/default/molecule.yml

@@ -0,0 +1,6 @@
+---
+provisioner:
+  inventory:
+    group_vars:
+      all:
+        pve_exporter_web_listen_address: "127.0.0.1:9221"

roles/pve_exporter/molecule/default/tests/test_default.py

@@ -0,0 +1,76 @@
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+from testinfra_helpers import get_target_hosts
+
+testinfra_hosts = get_target_hosts()
+
+
+def test_directories(host):
+    dirs = [
+        "/var/lib/pve_exporter"
+    ]
+    for dir in dirs:
+        d = host.file(dir)
+        assert d.is_directory
+        assert d.exists
+
+
+def test_files(host):
+    files = [
+        "/etc/systemd/system/pve_exporter.service",
+        "/usr/local/bin/pve_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("pve-exp").exists
+    assert "pve-exp" in host.user("pve-exp").groups
+    assert host.user("pve-exp").shell == "/usr/sbin/nologin"
+
+
+def test_service(host):
+    s = host.service("pve_exporter")
+    try:
+        assert s.is_running
+    except AssertionError:
+        # Capture service logs
+        journal_output = host.run('journalctl -u pve_exporter --since "1 hour ago"')
+        print("\n==== journalctl -u pve_exporter Output ====\n")
+        print(journal_output)
+        print("\n============================================\n")
+        raise  # Re-raise the original assertion error
+
+
+def test_protecthome_property(host):
+    s = host.service("pve_exporter")
+    p = s.systemd_properties
+    assert p.get("ProtectHome") == "yes"
+
+
+def test_socket(host):
+    sockets = [
+        "tcp://127.0.0.1:9221"
+    ]
+    for socket in sockets:
+        s = host.socket(socket)
+        assert s.is_listening

roles/pve_exporter/molecule/latest/molecule.yml

@@ -0,0 +1,7 @@
+---
+provisioner:
+  inventory:
+    group_vars:
+      all:
+        pve_exporter_version: latest
+        pve_exporter_textfile_dir: /home/pve_exporter