mirror of
https://github.com/prometheus-community/ansible
synced 2024-11-29 15:20:17 +00:00
52 lines
2.2 KiB
Markdown
52 lines
2.2 KiB
Markdown
<p><img src="http://jacobsmedia.com/wp-content/uploads/2015/08/black-box-edit.png" alt="blackbox logo" title="blackbox" align="right" height="60" /></p>
|
|
|
|
# Ansible Role: Blackbox Exporter
|
|
|
|
# Description
|
|
|
|
Deploy and manage [blackbox exporter](https://github.com/prometheus/blackbox_exporter) which allows blackbox probing of endpoints over HTTP, HTTPS, DNS, TCP and ICMP.
|
|
|
|
## Requirements
|
|
|
|
- Ansible >= 2.9 (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](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/blackbox_exporter_role.html) for description and default values of the variables.
|
|
|
|
## Example
|
|
|
|
### Playbook
|
|
|
|
```yaml
|
|
- 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](https://github.com/prometheus/demo-site) and site is hosted on [DigitalOcean](https://digitalocean.com).
|
|
|
|
## 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 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](CONTRIBUTING.md).
|
|
|
|
## Troubleshooting
|
|
|
|
See [troubleshooting](TROUBLESHOOTING.md).
|
|
|
|
## License
|
|
|
|
This project is licensed under MIT License. See [LICENSE](/LICENSE) for more details.
|