ansible-collection-prometheus/roles/blackbox_exporter/README.md
gardar 2a1123ad94
docs: avoid maintaining variable documentation in many places
Signed-off-by: gardar <gardar@users.noreply.github.com>
2023-04-11 14:48:13 +00:00

2.2 KiB

blackbox logo

Ansible Role: Blackbox Exporter

Description

Deploy and manage blackbox exporter which allows blackbox probing of endpoints over HTTP, HTTPS, DNS, TCP and ICMP.

Requirements

  • Ansible >= 2.7 (It might work on previous versions, but we cannot guarantee it)
  • gnu-tar on Mac deployer host (brew install gnu-tar)

Role Variables

All variables which can be overridden are stored in defaults/main.yml file as well as in meta/argument_specs.yml. Please refer to the collection docs for description and default values of the variables.

Example

Playbook

- hosts: all
  become: true
  roles:
    - prometheus.prometheus.blackbox-exporter

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 and site is hosted on DigitalOcean.

Local Testing

The preferred way of locally testing the role is to use Docker and 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.

Troubleshooting

See troubleshooting.

License

This project is licensed under MIT License. See LICENSE for more details.