From 7a37d23ee6da79a641a5b89cd311efe526064c10 Mon Sep 17 00:00:00 2001 From: L3D Date: Wed, 23 Nov 2022 18:18:12 +0100 Subject: [PATCH] improve docs and meta info --- .github/.galaxy.yml | 20 -------------------- README.md | 21 +++++++++++++++++++-- defaults/main.yml | 1 + meta/main.yml | 17 +++++++++++++++++ templates/ping_exporter.service.j2 | 2 +- 5 files changed, 38 insertions(+), 23 deletions(-) delete mode 100644 .github/.galaxy.yml create mode 100644 meta/main.yml diff --git a/.github/.galaxy.yml b/.github/.galaxy.yml deleted file mode 100644 index b5dc0ec..0000000 --- a/.github/.galaxy.yml +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Galaxy release - -# yamllint disable-line rule:truthy -on: - push: - branches: ['main'] - release: - types: ['created'] - -jobs: - build: - runs-on: ubuntu-latest - steps: - - name: checkout - uses: actions/checkout@v2 - - name: galaxy - uses: robertdebock/galaxy-action@1.1.0 - with: - galaxy_api_key: ${{ secrets.galaxy_api_key }} diff --git a/README.md b/README.md index 05768f2..6b1a6b2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ -# Ansible role prometheus ping exporter -Install https://github.com/czerwonk/ping_exporter/releases +[![License](https://raw.githubusercontent.com/roles-ansible/ansible_role_prometheus_ping_exporter/main/.github/license.svg)](https://github.com/roles-ansible/ansible_role_prometheus_ping_exporter/blob/main/LICENSE) +{![Galaxy](https://github.com/roles-ansible/ansible_role_prometheus_ping_exporter/raw/main/.github/galaxy.svg)](https://galaxy.github.com/do1jlr/prometheus_ping_exporter) + +# Ansible role prometheus ping exporter +Ansible role to install the prometheus node exporter from [github.com/czerwonk/ping_exporte](https://github.com/czerwonk/ping_exporter.git) + +## Some variables +| value | default | +| --- | --- | +| ping_exporter__user | ``ping_exporter`` | +| ping_exporter__group | ``ping_exporter`` | +| ping_exporter__user_home | ``/var/lib/ping_exporter`` | +| ping_exporter__shell | ``/bin/false`` | +| ping_exporter__version | ``latest`` | +| ping_exporter__targets | `` []`` | +| ping_exporter__nameserver | ``9.9.9.9`` | +| ping_exporter__web_listen_address | ``:9427`` | +| submodules_versioncheck | ``false`` | + diff --git a/defaults/main.yml b/defaults/main.yml index 3533c5c..2567801 100644 --- a/defaults/main.yml +++ b/defaults/main.yml @@ -11,6 +11,7 @@ ping_exporter__version: 'latest' # config ping_exporter__targets: [] ping_exporter__nameserver: '9.9.9.9' +ping_exporter__web_listen_address: ":9427" # should we do a version check? (recomended) submodules_versioncheck: false diff --git a/meta/main.yml b/meta/main.yml new file mode 100644 index 0000000..c37b5a9 --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,17 @@ +--- +galaxy_info: + role_name: prometheus_ping_exporter + author: do1jlr + description: Ansible role to install a prometheus ping exporter + license: "MIT" + min_ansible_version: "2.13" + platforms: + - name: Debian + versions: ['all'] + galaxy_tags: + - icmp + - grafana + - prometheus + - ping + - monitoring +dependencies: [] diff --git a/templates/ping_exporter.service.j2 b/templates/ping_exporter.service.j2 index 8426879..f41a642 100644 --- a/templates/ping_exporter.service.j2 +++ b/templates/ping_exporter.service.j2 @@ -8,7 +8,7 @@ Type=simple WorkingDirectory={{ ping_exporter__user_home }} User={{ ping_exporter__user }} Group={{ ping_exporter__group }} -ExecStart=/usr/bin/ping_exporter --config.path {{ ping_exporter__user_home }}/ping_exporter_config.yml +ExecStart=/usr/bin/ping_exporter --config.path {{ ping_exporter__user_home }}/ping_exporter_config.yml --web.listen-address="{{ ping_exporter__web_listen_address }}" CapabilityBoundingSet=CAP_NET_RAW AmbientCapabilities=CAP_NET_RAW