mirror of
https://github.com/prometheus-community/ansible
synced 2024-11-28 06:40:20 +00:00
84 lines
3 KiB
Markdown
84 lines
3 KiB
Markdown
|
<p><img src="https://www.circonus.com/wp-content/uploads/2015/03/sol-icon-itOps.png" alt="graph logo" title="graph" align="right" height="60" /></p>
|
||
|
|
|
||
|
|
# Ansible Role: pushgateway
|
||
|
|
|
||
|
|
## Description
|
||
|
|
|
||
|
|
Deploy prometheus [pushgateway](https://github.com/prometheus/pushgateway) using ansible.
|
||
|
|
|
||
|
|
## 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`)
|
||
|
|
- Passlib is required when using the basic authentication feature (`pip install passlib[bcrypt]`)
|
||
|
|
|
||
|
|
## 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/pushgateway_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.pushgateway
|
||
|
|
```
|
||
|
|
|
||
|
|
### TLS config
|
||
|
|
|
||
|
|
Before running pushgateway role, the user needs to provision their own certificate and key.
|
||
|
|
```yaml
|
||
|
|
- hosts: all
|
||
|
|
pre_tasks:
|
||
|
|
- name: Create pushgateway cert dir
|
||
|
|
file:
|
||
|
|
path: "/etc/pushgateway"
|
||
|
|
state: directory
|
||
|
|
owner: root
|
||
|
|
group: root
|
||
|
|
|
||
|
|
- name: Create cert and key
|
||
|
|
openssl_certificate:
|
||
|
|
path: /etc/pushgateway/tls.cert
|
||
|
|
csr_path: /etc/pushgateway/tls.csr
|
||
|
|
privatekey_path: /etc/pushgateway/tls.key
|
||
|
|
provider: selfsigned
|
||
|
|
roles:
|
||
|
|
- prometheus.prometheus.pushgateway
|
||
|
|
vars:
|
||
|
|
pushgateway_tls_server_config:
|
||
|
|
cert_file: /etc/pushgateway/tls.cert
|
||
|
|
key_file: /etc/pushgateway/tls.key
|
||
|
|
pushgateway_basic_auth_users:
|
||
|
|
randomuser: examplepassword
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
### Demo site
|
||
|
|
|
||
|
|
We provide an example site that demonstrates a full monitoring solution based on prometheus and grafana. The repository with code and links to running instances is [available on github](https://github.com/prometheus/demo-site) and the 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 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.
|