diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..5739302 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +--- +github: + - gizmoguy diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..23c4cb3 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,7 @@ +--- +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..c07813f --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,32 @@ +--- +name: Lint + +on: + pull_request: + branches: + - main + +jobs: + ansible-lint: + name: Ansible Lint + runs-on: ubuntu-latest + steps: + - name: Checkout repo + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Lint ansible + uses: wandansible/action-ansible-lint@v1 + + jinja2-lint: + name: Jinja2 Lint + runs-on: ubuntu-latest + env: + J2LINT_FILES_REGEX: '^templates/.+$' + steps: + - name: Checkout repo + uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Lint jinja2 files + uses: wandansible/action-j2lint@v1 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..b487499 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,39 @@ +--- +name: Tests + +on: + pull_request: + branches: + - main + +jobs: + generate-matrix: + name: Generate matrix + runs-on: ubuntu-latest + outputs: + matrix: ${{ steps.generate-matrix.outputs.matrix }} + steps: + - name: Generate matrix + id: generate-matrix + uses: wandnz/action-supported-distro-releases@v1 + + molecule: + name: Molecule + runs-on: ubuntu-latest + needs: generate-matrix + strategy: + matrix: + target: ${{ fromJson(needs.generate-matrix.outputs.matrix) }} + steps: + - name: Checkout repo + uses: actions/checkout@v4 + - name: Setup python + uses: actions/setup-python@v5 + with: + python-version: '3.x' + - name: Install test dependencies + run: pip3 install -r test-requirements.txt + - name: Run molecule + run: molecule test + env: + MOLECULE_DOCKER_IMAGE: ${{ matrix.target }} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f331e2a --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Brad Cowie + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e7a48d --- /dev/null +++ b/README.md @@ -0,0 +1,208 @@ +Ansible role: Prometheus Exporter - Smokeping prober +==================================================== + +Install and configure Smokeping prober for Prometheus. + +Requirements +------------ + +This role depends on the [base prometheus exporter role](https://github.com/wandansible/prometheus_exporter). + +Role Variables +-------------- + +``` +ENTRY POINT: *main* - Install and configure Smokeping prober for Prometheus + +Options (= indicates it is required): + +- smokeping_prober_arch_map Mapping of the possible values of ansible_architecture to the + exporter package architectures + default: null + type: dict + +- smokeping_prober_archive_urls Override the list of exporter archive urls for different platforms + and architectures + default: null + elements: str + type: list + +- smokeping_prober_bin_dir Directory for the exporter executable + default: null + type: str + +- smokeping_prober_binary Filename for the exporter executable + default: null + type: str + +- smokeping_prober_checksum_type The exporter package checksum type + default: null + type: str + +- smokeping_prober_checksum_url Override the URL for the exporter checksum file + default: null + type: str + +- smokeping_prober_checksums Override exporter archive checksums file contents + default: null + type: str + +- smokeping_prober_clean_src_dir Remove old downloaded archive files from exporter src directory + default: true + type: bool + +- smokeping_prober_config_file Path for configuration file + default: /etc/prometheus/exporters/smokeping_prober/config.yml + type: str + +- smokeping_prober_configure_caddy If true, configure caddy to add a TLS endpoint for the exporter + default: false + type: bool + +- smokeping_prober_description Description for the exporter systemd service + default: null + type: str + +- smokeping_prober_extra_flags Extra flags to run exporter with + default: null + type: dict + +- smokeping_prober_file_sd_dir Directory, on scrape servers, for the file service discovery target + default: /etc/prometheus/file_sd/smokeping_prober + type: str + +- smokeping_prober_flags List of flags to run exporter with, as string or list + default: null + type: raw + +- smokeping_prober_github_checksum_filename Filename for the exporter package checksums file on github + default: null + type: str + +- smokeping_prober_github_org Name of organisation for exporter github repository + default: SuperQ + type: str + +- smokeping_prober_github_repo Name of exporter github repository + default: null + type: str + +- smokeping_prober_group Name of the exporter unix group + default: null + type: str + +- smokeping_prober_groups Unix groups added to exporter unix user + default: null + elements: str + type: list + +- smokeping_prober_handler Name of the exporter handler to notify + default: null + type: str + +- smokeping_prober_install If true, install exporter + default: true + type: bool + +- smokeping_prober_labels Labels added to exporter metrics, overrides prometheus_labels + default: null + type: dict + +- smokeping_prober_listen_addresses List of addresses and ports to listen on + default: ['localhost:9374'] + elements: str + type: list + +- smokeping_prober_log_level Only log messages with the given severity or above + choices: [debug, info, warn, error] + default: warn + type: str + +- smokeping_prober_manage_user If true, add exporter unix user and group + default: true + type: bool + +- smokeping_prober_port Listen port + default: 9374 + type: int + +- smokeping_prober_privileged If true, run in privileged ICMP mode + default: true + type: bool + +- smokeping_prober_register If true, register the exporter with the scrape servers + default: false + type: bool + +- smokeping_prober_scrape_servers List of servers that scrape exporter metrics from the host, + overrides + prometheus_scrape_servers + default: null + elements: str + type: list + +- smokeping_prober_service Name of the exporter systemd service + default: null + type: str + +- smokeping_prober_service_unit_file Contents of the systemd unit file for the exporter + default: null + type: str + +- smokeping_prober_src_dir Directory for the downloaded exporter src archive + default: null + type: str + +- smokeping_prober_strip_components Strip NUMBER leading components from file names on extraction + default: 1 + type: int + +- smokeping_prober_target Scrape target hostname and port + default: null + type: str + +- smokeping_prober_targets List of prober configuration for smokeping prober to target + Each item may be given as a string or + dictionary + See here for details about the target + configuration format + https://github.com/SuperQ/smokeping_prober#configuration + default: null + elements: raw + type: list + +- smokeping_prober_user Name of the exporter unix user + default: null + type: str + +- smokeping_prober_version Version to install (use "latest" for the latest version) + default: latest + type: str +``` + +Installation +------------ + +This role can either be installed manually with the ansible-galaxy CLI tool: + + ansible-galaxy install git+https://github.com/wandansible/prometheus_exporter,main,wandansible.prometheus_exporter + ansible-galaxy install git+https://github.com/wandansible/prometheus_exporter.smokeping_prober,main,wandansible.prometheus_exporter.smokeping_prober + +Or, by adding the following to `requirements.yml`: + + - name: wandansible.prometheus_exporter + src: https://github.com/wandansible/prometheus_exporter + - name: wandansible.prometheus_exporter.smokeping_prober + src: https://github.com/wandansible/prometheus_exporter.smokeping_prober + +Roles listed in `requirements.yml` can be installed with the following ansible-galaxy command: + + ansible-galaxy install -r requirements.yml + +Example Playbook +---------------- + + - hosts: all + roles: + - role: wandansible.prometheus_exporter.smokeping_prober + become: true diff --git a/meta/argument_specs.yml b/meta/argument_specs.yml new file mode 100644 index 0000000..543cd02 --- /dev/null +++ b/meta/argument_specs.yml @@ -0,0 +1,188 @@ +--- +argument_specs: + main: + short_description: Install and configure Smokeping prober for Prometheus + options: + smokeping_prober_extra_flags: + description: Extra flags to run exporter with + type: dict + + smokeping_prober_privileged: + description: If true, run in privileged ICMP mode + type: bool + default: true + + smokeping_prober_listen_addresses: + description: List of addresses and ports to listen on + type: list + elements: str + default: ["localhost:9374"] + + smokeping_prober_log_level: + description: Only log messages with the given severity or above + type: str + default: warn + choices: + - debug + - info + - warn + - error + + smokeping_prober_port: + description: Listen port + type: int + default: 9374 + + smokeping_prober_config_file: + description: Path for configuration file + type: str + default: /etc/prometheus/exporters/smokeping_prober/config.yml + + smokeping_prober_targets: + description: + - List of prober configuration for smokeping prober to target + - Each item may be given as a string or dictionary + - | + See here for details about the target configuration format + https://github.com/SuperQ/smokeping_prober#configuration + type: list + elements: raw + + smokeping_prober_file_sd_dir: + description: Directory, on scrape servers, for the file service discovery target + type: str + default: /etc/prometheus/file_sd/smokeping_prober + + smokeping_prober_scrape_servers: + description: | + List of servers that scrape exporter metrics from the host, + overrides prometheus_scrape_servers + type: list + elements: str + + smokeping_prober_labels: + description: | + Labels added to exporter metrics, + overrides prometheus_labels + type: dict + + smokeping_prober_install: + description: If true, install exporter + type: bool + default: true + + smokeping_prober_configure_caddy: + description: If true, configure caddy to add a TLS endpoint for the exporter + type: bool + default: false + + smokeping_prober_register: + description: If true, register the exporter with the scrape servers + type: bool + default: false + + smokeping_prober_user: + description: Name of the exporter unix user + type: str + + smokeping_prober_group: + description: Name of the exporter unix group + type: str + + smokeping_prober_groups: + description: Unix groups added to exporter unix user + type: list + elements: str + + smokeping_prober_manage_user: + description: If true, add exporter unix user and group + type: bool + default: true + + smokeping_prober_bin_dir: + description: Directory for the exporter executable + type: str + + smokeping_prober_src_dir: + description: Directory for the downloaded exporter src archive + type: str + + smokeping_prober_strip_components: + description: Strip NUMBER leading components from file names on extraction + type: int + default: 1 + + smokeping_prober_clean_src_dir: + description: Remove old downloaded archive files from exporter src directory + type: bool + default: true + + smokeping_prober_github_org: + description: Name of organisation for exporter github repository + type: str + default: SuperQ + + smokeping_prober_github_repo: + description: Name of exporter github repository + type: str + + smokeping_prober_github_checksum_filename: + description: Filename for the exporter package checksums file on github + type: str + + smokeping_prober_archive_urls: + description: | + Override the list of exporter archive urls for different platforms and architectures + type: list + elements: str + + smokeping_prober_version: + description: Version to install (use "latest" for the latest version) + type: str + default: latest + + smokeping_prober_arch_map: + description: | + Mapping of the possible values of ansible_architecture + to the exporter package architectures + type: dict + + smokeping_prober_binary: + description: Filename for the exporter executable + type: str + + smokeping_prober_checksum_url: + description: Override the URL for the exporter checksum file + type: str + + smokeping_prober_checksum_type: + description: The exporter package checksum type + type: str + + smokeping_prober_checksums: + description: Override exporter archive checksums file contents + type: str + + smokeping_prober_service: + description: Name of the exporter systemd service + type: str + + smokeping_prober_service_unit_file: + description: Contents of the systemd unit file for the exporter + type: str + + smokeping_prober_handler: + description: Name of the exporter handler to notify + type: str + + smokeping_prober_description: + description: Description for the exporter systemd service + type: str + + smokeping_prober_flags: + description: List of flags to run exporter with, as string or list + type: raw + + smokeping_prober_target: + description: Scrape target hostname and port + type: str diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..97085cd --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,27 @@ +--- +galaxy_info: + namespace: wandansible + role_name: prometheus_exporter.smokeping_prober + author: WAND Network Research Group + description: Install and configure Smokeping prober for Prometheus + + license: Apache-2.0 + + min_ansible_version: "2.10" + + platforms: + - name: Debian + versions: + - buster + - bullseye + - bookworm + - trixie + - name: Ubuntu + versions: + - focal + - jammy + - noble + + galaxy_tags: [] + +dependencies: [] diff --git a/meta/requirements.yml b/meta/requirements.yml new file mode 100644 index 0000000..e836eff --- /dev/null +++ b/meta/requirements.yml @@ -0,0 +1,3 @@ +--- +- name: wandansible.prometheus_exporter + src: https://github.com/wandansible/prometheus_exporter diff --git a/molecule/default/Dockerfile.j2 b/molecule/default/Dockerfile.j2 new file mode 100644 index 0000000..6d84a42 --- /dev/null +++ b/molecule/default/Dockerfile.j2 @@ -0,0 +1,20 @@ +{% if item.registry is defined and '/' not in item.image %} +FROM {{ item.registry.url }}/{{ item.image }} +{% else %} +FROM {{ item.image }} +{% endif %} + +{% if item.env is defined %} +{% for var, value in item.env.items() %} +{% if value %} +ENV {{ var }} {{ value }} +{% endif %} +{% endfor %} +{% endif %} + +RUN export DEBIAN_FRONTEND=noninteractive \ + && apt-get update \ + && apt-get install -y python3 sudo bash ca-certificates iproute2 python3-apt aptitude systemd gnupg \ + && apt-get clean + +CMD ["/lib/systemd/systemd"] diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml new file mode 100644 index 0000000..66eabfa --- /dev/null +++ b/molecule/default/converge.yml @@ -0,0 +1,7 @@ +--- +- name: Converge + hosts: all + tasks: + - name: "Include wandansible.prometheus_exporter.smokeping_prober" + ansible.builtin.include_role: + name: "wandansible.prometheus_exporter.smokeping_prober" diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml new file mode 100644 index 0000000..33987ac --- /dev/null +++ b/molecule/default/molecule.yml @@ -0,0 +1,22 @@ +--- +role_name_check: 1 +dependency: + name: galaxy + options: + role-file: meta/requirements.yml +driver: + name: docker +platforms: + - name: instance + image: ${MOLECULE_DOCKER_IMAGE:-ubuntu:latest} + pre_build_image: false + override_command: false + privileged: true + volumes: + - /sys/fs/cgroup:/sys/fs/cgroup:rw + cgroupns_mode: host +provisioner: + name: ansible + log: true +verifier: + name: ansible diff --git a/molecule/default/prepare.yml b/molecule/default/prepare.yml new file mode 100644 index 0000000..e74184b --- /dev/null +++ b/molecule/default/prepare.yml @@ -0,0 +1,8 @@ +--- +- name: Prepare + hosts: all + tasks: + - name: "Install git" + ansible.builtin.apt: + pkg: + - "git" diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..39779a8 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,3 @@ +ansible +molecule +molecule-plugins[docker]