mirror of
https://github.com/prometheus-community/ansible
synced 2024-11-22 03:43:09 +00:00
feat: Add pushgateway role
Add role to manage the Prometheus Pushgateway. Signed-off-by: SuperQ <superq@gmail.com>
This commit is contained in:
parent
1b5a051aea
commit
c676915376
28 changed files with 860 additions and 0 deletions
83
roles/pushgateway/README.md
Normal file
83
roles/pushgateway/README.md
Normal file
|
@ -0,0 +1,83 @@
|
|||
<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.
|
20
roles/pushgateway/TROUBLESHOOTING.md
Normal file
20
roles/pushgateway/TROUBLESHOOTING.md
Normal file
|
@ -0,0 +1,20 @@
|
|||
# Troubleshooting
|
||||
|
||||
## Bad requests (HTTP 400)
|
||||
|
||||
This role downloads checksums from the Github project to verify the integrity of artifacts installed on your servers. When downloading the checksums, a "bad request" error might occur.
|
||||
|
||||
This happens in environments which (knowningly or unknowling) use the [netrc mechanism](https://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-file.html) to auto-login into servers.
|
||||
|
||||
Unless netrc is needed by your playbook and ansible roles, please unset the var like so:
|
||||
|
||||
```
|
||||
$ NETRC= ansible-playbook ...
|
||||
```
|
||||
|
||||
Or:
|
||||
|
||||
```
|
||||
$ export NETRC=
|
||||
$ ansible-playbook ...
|
||||
```
|
20
roles/pushgateway/defaults/main.yml
Normal file
20
roles/pushgateway/defaults/main.yml
Normal file
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
pushgateway_version: 1.6.0
|
||||
pushgateway_binary_local_dir: ""
|
||||
pushgateway_binary_url: "https://github.com/{{ _pushgateway_repo }}/releases/download/v{{ pushgateway_version }}/\
|
||||
pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}.tar.gz"
|
||||
pushgateway_checksums_url: "https://github.com/{{ _pushgateway_repo }}/releases/download/v{{ pushgateway_version }}/sha256sums.txt"
|
||||
pushgateway_skip_install: false
|
||||
|
||||
pushgateway_web_listen_address: "0.0.0.0:9091"
|
||||
pushgateway_web_telemetry_path: "/metrics"
|
||||
|
||||
pushgateway_tls_server_config: {}
|
||||
|
||||
pushgateway_http_server_config: {}
|
||||
|
||||
pushgateway_basic_auth_users: {}
|
||||
|
||||
pushgateway_binary_install_dir: "/usr/local/bin"
|
||||
pushgateway_system_group: "pushgateway"
|
||||
pushgateway_system_user: "{{ pushgateway_system_group }}"
|
10
roles/pushgateway/handlers/main.yml
Normal file
10
roles/pushgateway/handlers/main.yml
Normal file
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
- name: Restart pushgateway
|
||||
listen: "restart pushgateway"
|
||||
become: true
|
||||
ansible.builtin.systemd:
|
||||
daemon_reload: true
|
||||
name: pushgateway
|
||||
state: restarted
|
||||
when:
|
||||
- not ansible_check_mode
|
62
roles/pushgateway/meta/argument_specs.yml
Normal file
62
roles/pushgateway/meta/argument_specs.yml
Normal file
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
# yamllint disable rule:line-length
|
||||
argument_specs:
|
||||
main:
|
||||
short_description: "Prometheus Pushgateway"
|
||||
description:
|
||||
- "Deploy prometheus L(Pushgateway,https://github.com/prometheus/pushgateway) using ansible"
|
||||
author:
|
||||
- "Prometheus Community"
|
||||
options:
|
||||
pushgateway_version:
|
||||
description: "Pushgateway package version. Also accepts latest as parameter."
|
||||
default: "1.1.2"
|
||||
pushgateway_skip_install:
|
||||
description: "Pushgateway installation tasks gets skipped when set to true."
|
||||
type: bool
|
||||
default: false
|
||||
pushgateway_binary_local_dir:
|
||||
description:
|
||||
- "Enables the use of local packages instead of those distributed on github."
|
||||
- "The parameter may be set to a directory where the C(pushgateway) binary is stored on the host where ansible is run."
|
||||
- "This overrides the I(pushgateway_version) parameter"
|
||||
pushgateway_binary_url:
|
||||
description: "URL of the Pushgateway binaries .tar.gz file"
|
||||
default: "https://github.com/{{ _pushgateway_repo }}/releases/download/v{{ pushgateway_version }}/pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}.tar.gz"
|
||||
pushgateway_checksums_url:
|
||||
description: "URL of the Pushgateway checksums file"
|
||||
default: "https://github.com/{{ _pushgateway_repo }}/releases/download/v{{ pushgateway_version }}/sha256sums.txt"
|
||||
pushgateway_web_listen_address:
|
||||
description: "Address on which Pushgateway will listen"
|
||||
default: "0.0.0.0:9091"
|
||||
pushgateway_web_telemetry_path:
|
||||
description: "Path under which to expose metrics"
|
||||
default: "/metrics"
|
||||
pushgateway_tls_server_config:
|
||||
description:
|
||||
- "Configuration for TLS authentication."
|
||||
- "Keys and values are the same as in L(pushgateway docs,https://github.com/prometheus/pushgateway/blob/master/https/README.md#sample-config)."
|
||||
type: "dict"
|
||||
pushgateway_http_server_config:
|
||||
description:
|
||||
- "Config for HTTP/2 support."
|
||||
- "Keys and values are the same as in L(pushgateway docs,https://github.com/prometheus/pushgateway/blob/master/https/README.md#sample-config)."
|
||||
type: "dict"
|
||||
pushgateway_basic_auth_users:
|
||||
description: "Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt."
|
||||
type: "dict"
|
||||
pushgateway_binary_install_dir:
|
||||
description:
|
||||
- "I(Advanced)"
|
||||
- "Directory to install pushgateway binary"
|
||||
default: "/usr/local/bin"
|
||||
pushgateway_system_group:
|
||||
description:
|
||||
- "I(Advanced)"
|
||||
- "System group for Pushgateway"
|
||||
default: "pushgateway"
|
||||
pushgateway_system_user:
|
||||
description:
|
||||
- "I(Advanced)"
|
||||
- "Pushgateway user"
|
||||
default: "pushgateway"
|
31
roles/pushgateway/meta/main.yml
Normal file
31
roles/pushgateway/meta/main.yml
Normal file
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
galaxy_info:
|
||||
author: "Prometheus Community"
|
||||
description: "Prometheus Pushgateway"
|
||||
license: "Apache"
|
||||
min_ansible_version: "2.9"
|
||||
platforms:
|
||||
- name: "Ubuntu"
|
||||
versions:
|
||||
- "bionic"
|
||||
- "focal"
|
||||
- "jammy"
|
||||
- name: "Debian"
|
||||
versions:
|
||||
- "bullseye"
|
||||
- "buster"
|
||||
- name: "EL"
|
||||
versions:
|
||||
- "7"
|
||||
- "8"
|
||||
- "9"
|
||||
- name: "Fedora"
|
||||
versions:
|
||||
- "36"
|
||||
- "37"
|
||||
galaxy_tags:
|
||||
- "monitoring"
|
||||
- "prometheus"
|
||||
- "exporter"
|
||||
- "metrics"
|
||||
- "system"
|
36
roles/pushgateway/molecule/alternative/converge.yml
Normal file
36
roles/pushgateway/molecule/alternative/converge.yml
Normal file
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
- name: Run role
|
||||
hosts: all
|
||||
any_errors_fatal: true
|
||||
roles:
|
||||
- prometheus.prometheus.pushgateway
|
||||
pre_tasks:
|
||||
- name: Create pushgateway cert dir
|
||||
ansible.builtin.file:
|
||||
path: "{{ pushgateway_tls_server_config.cert_file | dirname }}"
|
||||
state: directory
|
||||
owner: root
|
||||
group: root
|
||||
mode: u+rwX,g+rwX,o=rX
|
||||
|
||||
- name: Copy cert and key
|
||||
ansible.builtin.copy:
|
||||
src: "{{ item.src }}"
|
||||
dest: "{{ item.dest }}"
|
||||
mode: "{{ item.mode | default('0644') }}"
|
||||
loop:
|
||||
- src: "/tmp/tls.cert"
|
||||
dest: "{{ pushgateway_tls_server_config.cert_file }}"
|
||||
- src: "/tmp/tls.key"
|
||||
dest: "{{ pushgateway_tls_server_config.key_file }}"
|
||||
vars:
|
||||
pushgateway_binary_local_dir: "/tmp/pushgateway-linux-amd64"
|
||||
pushgateway_web_listen_address: "127.0.0.1:8080"
|
||||
|
||||
pushgateway_tls_server_config:
|
||||
cert_file: /etc/pushgateway/tls.cert
|
||||
key_file: /etc/pushgateway/tls.key
|
||||
pushgateway_http_server_config:
|
||||
http2: true
|
||||
pushgateway_basic_auth_users:
|
||||
randomuser: examplepassword
|
1
roles/pushgateway/molecule/alternative/molecule.yml
Normal file
1
roles/pushgateway/molecule/alternative/molecule.yml
Normal file
|
@ -0,0 +1 @@
|
|||
---
|
56
roles/pushgateway/molecule/alternative/prepare.yml
Normal file
56
roles/pushgateway/molecule/alternative/prepare.yml
Normal file
|
@ -0,0 +1,56 @@
|
|||
---
|
||||
- name: Prepare
|
||||
hosts: localhost
|
||||
gather_facts: false
|
||||
vars:
|
||||
go_arch: amd64
|
||||
pushgateway_version: 1.5.1
|
||||
tasks:
|
||||
- name: Download pushgateway binary to local folder
|
||||
become: false
|
||||
ansible.builtin.get_url:
|
||||
url: "https://github.com/prometheus/pushgateway/releases/download/v{{ pushgateway_version }}/\
|
||||
pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}.tar.gz"
|
||||
dest: "/tmp/pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}.tar.gz"
|
||||
mode: 0644
|
||||
register: _download_binary
|
||||
until: _download_binary is succeeded
|
||||
retries: 5
|
||||
delay: 2
|
||||
check_mode: false
|
||||
|
||||
- name: Unpack pushgateway binary
|
||||
become: false
|
||||
ansible.builtin.unarchive:
|
||||
src: "/tmp/pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}.tar.gz"
|
||||
dest: "/tmp"
|
||||
creates: "/tmp/pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}/pushgateway"
|
||||
check_mode: false
|
||||
|
||||
- name: Link to pushgateway binaries directory
|
||||
become: false
|
||||
ansible.builtin.file:
|
||||
src: "/tmp/pushgateway-{{ pushgateway_version }}.linux-amd64"
|
||||
dest: "/tmp/pushgateway-linux-amd64"
|
||||
state: link
|
||||
check_mode: false
|
||||
|
||||
- name: Install pyOpenSSL for certificate generation
|
||||
ansible.builtin.pip:
|
||||
name: "pyOpenSSL"
|
||||
|
||||
- name: Create private key
|
||||
community.crypto.openssl_privatekey:
|
||||
path: "/tmp/tls.key"
|
||||
|
||||
- name: Create CSR
|
||||
community.crypto.openssl_csr:
|
||||
path: "/tmp/tls.csr"
|
||||
privatekey_path: "/tmp/tls.key"
|
||||
|
||||
- name: Create certificate
|
||||
community.crypto.x509_certificate:
|
||||
path: "/tmp/tls.cert"
|
||||
csr_path: "/tmp/tls.csr"
|
||||
privatekey_path: "/tmp/tls.key"
|
||||
provider: selfsigned
|
|
@ -0,0 +1,39 @@
|
|||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
import testinfra.utils.ansible_runner
|
||||
|
||||
testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
|
||||
os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')
|
||||
|
||||
|
||||
def test_directories(host):
|
||||
dirs = [
|
||||
"/etc/pushgateway"
|
||||
]
|
||||
for dir in dirs:
|
||||
d = host.file(dir)
|
||||
assert d.is_directory
|
||||
assert d.exists
|
||||
|
||||
|
||||
def test_service(host):
|
||||
s = host.service("pushgateway")
|
||||
# assert s.is_enabled
|
||||
assert s.is_running
|
||||
|
||||
|
||||
def test_protecthome_property(host):
|
||||
s = host.service("pushgateway")
|
||||
p = s.systemd_properties
|
||||
assert p.get("ProtectHome") == "yes"
|
||||
|
||||
|
||||
def test_socket(host):
|
||||
sockets = [
|
||||
"tcp://127.0.0.1:8080"
|
||||
]
|
||||
for socket in sockets:
|
||||
s = host.socket(socket)
|
||||
assert s.is_listening
|
8
roles/pushgateway/molecule/default/converge.yml
Normal file
8
roles/pushgateway/molecule/default/converge.yml
Normal file
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
- name: Converge
|
||||
hosts: all
|
||||
any_errors_fatal: true
|
||||
roles:
|
||||
- prometheus.prometheus.pushgateway
|
||||
vars:
|
||||
pushgateway_web_listen_address: "127.0.0.1:9091"
|
1
roles/pushgateway/molecule/default/molecule.yml
Normal file
1
roles/pushgateway/molecule/default/molecule.yml
Normal file
|
@ -0,0 +1 @@
|
|||
---
|
72
roles/pushgateway/molecule/default/tests/test_default.py
Normal file
72
roles/pushgateway/molecule/default/tests/test_default.py
Normal file
|
@ -0,0 +1,72 @@
|
|||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
import testinfra.utils.ansible_runner
|
||||
|
||||
testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
|
||||
os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')
|
||||
|
||||
|
||||
def test_directories(host):
|
||||
dirs = [
|
||||
"/etc/pushgateway"
|
||||
]
|
||||
for dir in dirs:
|
||||
d = host.file(dir)
|
||||
assert d.is_directory
|
||||
assert d.exists
|
||||
|
||||
|
||||
def test_files(host):
|
||||
files = [
|
||||
"/etc/systemd/system/pushgateway.service",
|
||||
"/usr/local/bin/pushgateway"
|
||||
]
|
||||
for file in files:
|
||||
f = host.file(file)
|
||||
assert f.exists
|
||||
assert f.is_file
|
||||
|
||||
|
||||
def test_permissions_didnt_change(host):
|
||||
dirs = [
|
||||
"/etc",
|
||||
"/root",
|
||||
"/usr",
|
||||
"/var"
|
||||
]
|
||||
for file in dirs:
|
||||
f = host.file(file)
|
||||
assert f.exists
|
||||
assert f.is_directory
|
||||
assert f.user == "root"
|
||||
assert f.group == "root"
|
||||
|
||||
|
||||
def test_user(host):
|
||||
assert host.group("pushgateway").exists
|
||||
assert "pushgateway" in host.user("pushgateway").groups
|
||||
assert host.user("pushgateway").shell == "/usr/sbin/nologin"
|
||||
assert host.user("pushgateway").home == "/"
|
||||
|
||||
|
||||
def test_service(host):
|
||||
s = host.service("pushgateway")
|
||||
# assert s.is_enabled
|
||||
assert s.is_running
|
||||
|
||||
|
||||
def test_protecthome_property(host):
|
||||
s = host.service("pushgateway")
|
||||
p = s.systemd_properties
|
||||
assert p.get("ProtectHome") == "yes"
|
||||
|
||||
|
||||
def test_socket(host):
|
||||
sockets = [
|
||||
"tcp://127.0.0.1:9091"
|
||||
]
|
||||
for socket in sockets:
|
||||
s = host.socket(socket)
|
||||
assert s.is_listening
|
8
roles/pushgateway/molecule/latest/converge.yml
Normal file
8
roles/pushgateway/molecule/latest/converge.yml
Normal file
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
- name: Run role
|
||||
hosts: all
|
||||
any_errors_fatal: true
|
||||
roles:
|
||||
- prometheus.prometheus.pushgateway
|
||||
vars:
|
||||
pushgateway_version: latest
|
1
roles/pushgateway/molecule/latest/molecule.yml
Normal file
1
roles/pushgateway/molecule/latest/molecule.yml
Normal file
|
@ -0,0 +1 @@
|
|||
---
|
36
roles/pushgateway/molecule/latest/tests/test_alternative.py
Normal file
36
roles/pushgateway/molecule/latest/tests/test_alternative.py
Normal file
|
@ -0,0 +1,36 @@
|
|||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
import testinfra.utils.ansible_runner
|
||||
import pytest
|
||||
|
||||
testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
|
||||
os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')
|
||||
|
||||
|
||||
@pytest.mark.parametrize("files", [
|
||||
"/etc/systemd/system/pushgateway.service",
|
||||
"/usr/local/bin/pushgateway"
|
||||
])
|
||||
def test_files(host, files):
|
||||
f = host.file(files)
|
||||
assert f.exists
|
||||
assert f.is_file
|
||||
|
||||
|
||||
def test_service(host):
|
||||
s = host.service("pushgateway")
|
||||
# assert s.is_enabled
|
||||
assert s.is_running
|
||||
|
||||
|
||||
def test_protecthome_property(host):
|
||||
s = host.service("pushgateway")
|
||||
p = s.systemd_properties
|
||||
assert p.get("ProtectHome") == "yes"
|
||||
|
||||
|
||||
def test_socket(host):
|
||||
s = host.socket("tcp://0.0.0.0:9091")
|
||||
assert s.is_listening
|
36
roles/pushgateway/tasks/configure.yml
Normal file
36
roles/pushgateway/tasks/configure.yml
Normal file
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
- name: Copy the pushgateway systemd service file
|
||||
ansible.builtin.template:
|
||||
src: pushgateway.service.j2
|
||||
dest: /etc/systemd/system/pushgateway.service
|
||||
owner: root
|
||||
group: root
|
||||
mode: 0644
|
||||
notify: restart pushgateway
|
||||
|
||||
- name: Create pushgateway config directory
|
||||
ansible.builtin.file:
|
||||
path: "/etc/pushgateway"
|
||||
state: directory
|
||||
owner: root
|
||||
group: root
|
||||
mode: u+rwX,g+rwX,o=rX
|
||||
|
||||
- name: Copy the pushgateway config file
|
||||
ansible.builtin.template:
|
||||
src: web_config.yml.j2
|
||||
dest: /etc/pushgateway/web_config.yml
|
||||
owner: root
|
||||
group: root
|
||||
mode: 0644
|
||||
notify: restart pushgateway
|
||||
|
||||
- name: Allow pushgateway port in SELinux on RedHat OS family
|
||||
community.general.seport:
|
||||
ports: "{{ pushgateway_web_listen_address.split(':')[-1] }}"
|
||||
proto: tcp
|
||||
setype: http_port_t
|
||||
state: present
|
||||
when:
|
||||
- ansible_version.full is version_compare('2.4', '>=')
|
||||
- ansible_selinux.status == "enabled"
|
69
roles/pushgateway/tasks/install.yml
Normal file
69
roles/pushgateway/tasks/install.yml
Normal file
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
- name: Create the pushgateway group
|
||||
ansible.builtin.group:
|
||||
name: "{{ pushgateway_system_group }}"
|
||||
state: present
|
||||
system: true
|
||||
when: pushgateway_system_group != "root"
|
||||
|
||||
- name: Create the pushgateway user
|
||||
ansible.builtin.user:
|
||||
name: "{{ pushgateway_system_user }}"
|
||||
groups: "{{ pushgateway_system_group }}"
|
||||
append: true
|
||||
shell: /usr/sbin/nologin
|
||||
system: true
|
||||
create_home: false
|
||||
home: /
|
||||
when: pushgateway_system_user != "root"
|
||||
|
||||
- name: Discover latest version
|
||||
when:
|
||||
- pushgateway_binary_local_dir | length == 0
|
||||
- not pushgateway_skip_install
|
||||
block:
|
||||
|
||||
- name: Download pushgateway binary to local folder
|
||||
become: false
|
||||
ansible.builtin.get_url:
|
||||
url: "{{ pushgateway_binary_url }}"
|
||||
dest: "/tmp/pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}.tar.gz"
|
||||
checksum: "sha256:{{ __pushgateway_checksum }}"
|
||||
mode: '0644'
|
||||
register: _download_binary
|
||||
until: _download_binary is succeeded
|
||||
retries: 5
|
||||
delay: 2
|
||||
delegate_to: localhost
|
||||
check_mode: false
|
||||
|
||||
- name: Unpack pushgateway binary
|
||||
become: false
|
||||
ansible.builtin.unarchive:
|
||||
src: "/tmp/pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}.tar.gz"
|
||||
dest: "/tmp"
|
||||
creates: "/tmp/pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}/pushgateway"
|
||||
delegate_to: localhost
|
||||
check_mode: false
|
||||
|
||||
- name: Propagate pushgateway binaries
|
||||
ansible.builtin.copy:
|
||||
src: "/tmp/pushgateway-{{ pushgateway_version }}.linux-{{ go_arch }}/pushgateway"
|
||||
dest: "{{ pushgateway_binary_install_dir }}/pushgateway"
|
||||
mode: 0755
|
||||
owner: root
|
||||
group: root
|
||||
notify: restart pushgateway
|
||||
when: not ansible_check_mode
|
||||
|
||||
- name: Propagate locally distributed pushgateway binary
|
||||
ansible.builtin.copy:
|
||||
src: "{{ pushgateway_binary_local_dir }}/pushgateway"
|
||||
dest: "{{ pushgateway_binary_install_dir }}/pushgateway"
|
||||
mode: 0755
|
||||
owner: root
|
||||
group: root
|
||||
when:
|
||||
- pushgateway_binary_local_dir | length > 0
|
||||
- not pushgateway_skip_install
|
||||
notify: restart pushgateway
|
63
roles/pushgateway/tasks/main.yml
Normal file
63
roles/pushgateway/tasks/main.yml
Normal file
|
@ -0,0 +1,63 @@
|
|||
---
|
||||
- name: Preflight
|
||||
ansible.builtin.include_tasks:
|
||||
file: preflight.yml
|
||||
apply:
|
||||
tags:
|
||||
- pushgateway_install
|
||||
- pushgateway_configure
|
||||
- pushgateway_run
|
||||
tags:
|
||||
- pushgateway_install
|
||||
- pushgateway_configure
|
||||
- pushgateway_run
|
||||
|
||||
- name: Install
|
||||
ansible.builtin.include_tasks:
|
||||
file: install.yml
|
||||
apply:
|
||||
become: true
|
||||
tags:
|
||||
- pushgateway_install
|
||||
when:
|
||||
( not __pushgateway_is_installed.stat.exists ) or
|
||||
( (__pushgateway_current_version_output.stderr_lines | length > 0)
|
||||
and (__pushgateway_current_version_output.stderr_lines[0].split(" ")[2] != pushgateway_version) ) or
|
||||
( (__pushgateway_current_version_output.stdout_lines | length > 0)
|
||||
and (__pushgateway_current_version_output.stdout_lines[0].split(" ")[2] != pushgateway_version) ) or
|
||||
( pushgateway_binary_local_dir | length > 0 )
|
||||
tags:
|
||||
- pushgateway_install
|
||||
|
||||
- name: SELinux
|
||||
ansible.builtin.include_tasks:
|
||||
file: selinux.yml
|
||||
apply:
|
||||
become: true
|
||||
tags:
|
||||
- pushgateway_configure
|
||||
when: ansible_selinux.status == "enabled"
|
||||
tags:
|
||||
- pushgateway_configure
|
||||
|
||||
- name: Configure
|
||||
ansible.builtin.include_tasks:
|
||||
file: configure.yml
|
||||
apply:
|
||||
become: true
|
||||
tags:
|
||||
- pushgateway_configure
|
||||
tags:
|
||||
- pushgateway_configure
|
||||
|
||||
- name: Ensure Pushgateway is enabled on boot
|
||||
become: true
|
||||
ansible.builtin.systemd:
|
||||
daemon_reload: true
|
||||
name: pushgateway
|
||||
enabled: true
|
||||
state: started
|
||||
when:
|
||||
- not ansible_check_mode
|
||||
tags:
|
||||
- pushgateway_run
|
99
roles/pushgateway/tasks/preflight.yml
Normal file
99
roles/pushgateway/tasks/preflight.yml
Normal file
|
@ -0,0 +1,99 @@
|
|||
---
|
||||
- name: Assert usage of systemd as an init system
|
||||
ansible.builtin.assert:
|
||||
that: ansible_service_mgr == 'systemd'
|
||||
msg: "This role only works with systemd"
|
||||
|
||||
- name: Install package fact dependencies
|
||||
become: true
|
||||
ansible.builtin.package:
|
||||
name: "{{ _pkg_fact_req }}"
|
||||
state: present
|
||||
when: (_pkg_fact_req)
|
||||
vars:
|
||||
_pkg_fact_req: "{% if (ansible_pkg_mgr == 'apt') %}\
|
||||
{{ ('python-apt' if ansible_python_version is version('3', '<') else 'python3-apt') }}
|
||||
{% else %}\
|
||||
{% endif %}"
|
||||
|
||||
- name: Gather package facts
|
||||
ansible.builtin.package_facts:
|
||||
when: "not 'packages' in ansible_facts"
|
||||
|
||||
- name: Naive assertion of proper listen address
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- "':' in pushgateway_web_listen_address"
|
||||
|
||||
- name: Assert that TLS config is correct
|
||||
when: pushgateway_tls_server_config | length > 0
|
||||
block:
|
||||
- name: Assert that TLS key and cert path are set
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- "pushgateway_tls_server_config.cert_file is defined"
|
||||
- "pushgateway_tls_server_config.key_file is defined"
|
||||
|
||||
- name: Check existence of TLS cert file
|
||||
ansible.builtin.stat:
|
||||
path: "{{ pushgateway_tls_server_config.cert_file }}"
|
||||
register: __pushgateway_cert_file
|
||||
|
||||
- name: Check existence of TLS key file
|
||||
ansible.builtin.stat:
|
||||
path: "{{ pushgateway_tls_server_config.key_file }}"
|
||||
register: __pushgateway_key_file
|
||||
|
||||
- name: Assert that TLS key and cert are present
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- "{{ __pushgateway_cert_file.stat.exists }}"
|
||||
- "{{ __pushgateway_key_file.stat.exists }}"
|
||||
|
||||
- name: Check if pushgateway is installed
|
||||
ansible.builtin.stat:
|
||||
path: "{{ pushgateway_binary_install_dir }}/pushgateway"
|
||||
register: __pushgateway_is_installed
|
||||
check_mode: false
|
||||
tags:
|
||||
- pushgateway_install
|
||||
|
||||
- name: Gather currently installed pushgateway version (if any)
|
||||
ansible.builtin.command: "{{ pushgateway_binary_install_dir }}/pushgateway --version"
|
||||
changed_when: false
|
||||
register: __pushgateway_current_version_output
|
||||
check_mode: false
|
||||
when: __pushgateway_is_installed.stat.exists
|
||||
tags:
|
||||
- pushgateway_install
|
||||
|
||||
- name: Discover latest version
|
||||
ansible.builtin.set_fact:
|
||||
pushgateway_version: "{{ (lookup('url', 'https://api.github.com/repos/prometheus/pushgateway/releases/latest', headers=_github_api_headers,
|
||||
split_lines=False) | from_json).get('tag_name') | replace('v', '') }}"
|
||||
run_once: true
|
||||
until: pushgateway_version is version('0.0.0', '>=')
|
||||
retries: 10
|
||||
when:
|
||||
- pushgateway_version == "latest"
|
||||
- pushgateway_binary_local_dir | length == 0
|
||||
- not pushgateway_skip_install
|
||||
|
||||
- name: Get pushgateway binary checksum
|
||||
when:
|
||||
- pushgateway_binary_local_dir | length == 0
|
||||
- not pushgateway_skip_install
|
||||
block:
|
||||
- name: Get checksum list from github
|
||||
ansible.builtin.set_fact:
|
||||
__pushgateway_checksums: "{{ lookup('url', pushgateway_checksums_url, headers=_github_api_headers, wantlist=True) | list }}"
|
||||
run_once: true
|
||||
until: __pushgateway_checksums is search('linux-' + go_arch + '.tar.gz')
|
||||
retries: 10
|
||||
|
||||
- name: "Get checksum for {{ go_arch }}"
|
||||
ansible.builtin.set_fact:
|
||||
__pushgateway_checksum: "{{ item.split(' ')[0] }}"
|
||||
with_items: "{{ __pushgateway_checksums }}"
|
||||
when:
|
||||
- "('linux-' + go_arch + '.tar.gz') in item"
|
23
roles/pushgateway/tasks/selinux.yml
Normal file
23
roles/pushgateway/tasks/selinux.yml
Normal file
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
- name: Install selinux python packages [RedHat]
|
||||
ansible.builtin.package:
|
||||
name: "{{ ['libselinux-python', 'policycoreutils-python']
|
||||
if ansible_python_version is version('3', '<') else
|
||||
['python3-libselinux', 'python3-policycoreutils'] }}"
|
||||
state: present
|
||||
register: _install_selinux_packages
|
||||
until: _install_selinux_packages is success
|
||||
retries: 5
|
||||
delay: 2
|
||||
when: ansible_os_family | lower == "redhat"
|
||||
|
||||
- name: Install selinux python packages [clearlinux]
|
||||
ansible.builtin.package:
|
||||
name: sysadmin-basic
|
||||
state: present
|
||||
register: _install_selinux_packages
|
||||
until: _install_selinux_packages is success
|
||||
retries: 5
|
||||
delay: 2
|
||||
when:
|
||||
- ansible_distribution | lower == "clearlinux"
|
44
roles/pushgateway/templates/pushgateway.service.j2
Normal file
44
roles/pushgateway/templates/pushgateway.service.j2
Normal file
|
@ -0,0 +1,44 @@
|
|||
{{ ansible_managed | comment }}
|
||||
|
||||
[Unit]
|
||||
Description=Prometheus Pushgateway
|
||||
After=network-online.target
|
||||
|
||||
[Service]
|
||||
Type=simple
|
||||
User={{ pushgateway_system_user }}
|
||||
Group={{ pushgateway_system_group }}
|
||||
ExecStart={{ pushgateway_binary_install_dir }}/pushgateway \
|
||||
{% if pushgateway_tls_server_config | length > 0 or pushgateway_http_server_config | length > 0 or pushgateway_basic_auth_users | length > 0 %}
|
||||
{% if pushgateway_version is version('1.5.0', '>=') %}
|
||||
'--web.config.file=/etc/pushgateway/web_config.yml' \
|
||||
{% else %}
|
||||
'--web.config=/etc/pushgateway/web_config.yml' \
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
'--web.listen-address={{ pushgateway_web_listen_address }}' \
|
||||
'--web.telemetry-path={{ pushgateway_web_telemetry_path }}'
|
||||
|
||||
SyslogIdentifier=pushgateway
|
||||
Restart=always
|
||||
RestartSec=1
|
||||
StartLimitInterval=0
|
||||
|
||||
{% set ns = namespace(protect_home = 'yes') %}
|
||||
{% for m in ansible_mounts if m.mount.startswith('/home') %}
|
||||
{% set ns.protect_home = 'read-only' %}
|
||||
{% endfor %}
|
||||
ProtectHome={{ ns.protect_home }}
|
||||
NoNewPrivileges=yes
|
||||
|
||||
{% if (ansible_facts.packages.systemd | first).version is version('232', '>=') %}
|
||||
ProtectSystem=strict
|
||||
ProtectControlGroups=true
|
||||
ProtectKernelModules=true
|
||||
ProtectKernelTunables=yes
|
||||
{% else %}
|
||||
ProtectSystem=full
|
||||
{% endif %}
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
18
roles/pushgateway/templates/web_config.yml.j2
Normal file
18
roles/pushgateway/templates/web_config.yml.j2
Normal file
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
{{ ansible_managed | comment }}
|
||||
{% if pushgateway_tls_server_config | length > 0 %}
|
||||
tls_server_config:
|
||||
{{ pushgateway_tls_server_config | to_nice_yaml | indent(2, true) }}
|
||||
{% endif %}
|
||||
|
||||
{% if pushgateway_http_server_config | length > 0 %}
|
||||
http_server_config:
|
||||
{{ pushgateway_http_server_config | to_nice_yaml | indent(2, true) }}
|
||||
{% endif %}
|
||||
|
||||
{% if pushgateway_basic_auth_users | length > 0 %}
|
||||
basic_auth_users:
|
||||
{% for k, v in pushgateway_basic_auth_users.items() %}
|
||||
{{ k }}: {{ v | string | password_hash('bcrypt', ('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890' | shuffle(seed=inventory_hostname) | join)[:22], rounds=9) }}
|
||||
{% endfor %}
|
||||
{% endif %}
|
1
roles/pushgateway/test-requirements.txt
Normal file
1
roles/pushgateway/test-requirements.txt
Normal file
|
@ -0,0 +1 @@
|
|||
bcrypt
|
11
roles/pushgateway/vars/main.yml
Normal file
11
roles/pushgateway/vars/main.yml
Normal file
|
@ -0,0 +1,11 @@
|
|||
---
|
||||
go_arch_map:
|
||||
i386: '386'
|
||||
x86_64: 'amd64'
|
||||
aarch64: 'arm64'
|
||||
armv7l: 'armv7'
|
||||
armv6l: 'armv6'
|
||||
|
||||
go_arch: "{{ go_arch_map[ansible_architecture] | default(ansible_architecture) }}"
|
||||
_pushgateway_repo: "prometheus/pushgateway"
|
||||
_github_api_headers: "{{ {'GITHUB_TOKEN': lookup('ansible.builtin.env', 'GITHUB_TOKEN')} if (lookup('ansible.builtin.env', 'GITHUB_TOKEN')) else {} }}"
|
4
tests/integration/targets/molecule-pushgateway-alternative/runme.sh
Executable file
4
tests/integration/targets/molecule-pushgateway-alternative/runme.sh
Executable file
|
@ -0,0 +1,4 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
collection_root=$(pwd | grep -oP ".+\/ansible_collections\/\w+?\/\w+")
|
||||
source "$collection_root/tests/integration/molecule.sh"
|
4
tests/integration/targets/molecule-pushgateway-default/runme.sh
Executable file
4
tests/integration/targets/molecule-pushgateway-default/runme.sh
Executable file
|
@ -0,0 +1,4 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
collection_root=$(pwd | grep -oP ".+\/ansible_collections\/\w+?\/\w+")
|
||||
source "$collection_root/tests/integration/molecule.sh"
|
4
tests/integration/targets/molecule-pushgateway-latest/runme.sh
Executable file
4
tests/integration/targets/molecule-pushgateway-latest/runme.sh
Executable file
|
@ -0,0 +1,4 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
collection_root=$(pwd | grep -oP ".+\/ansible_collections\/\w+?\/\w+")
|
||||
source "$collection_root/tests/integration/molecule.sh"
|
Loading…
Reference in a new issue