add prometheus role
This commit is contained in:
17
roles/prometheus/.ansible-lint
Normal file
17
roles/prometheus/.ansible-lint
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
profile: production
|
||||
strict: true
|
||||
|
||||
# Enable checking of loop variable prefixes in roles
|
||||
loop_var_prefix: "^(__|{role}_)"
|
||||
|
||||
skip_list:
|
||||
- var-naming[no-role-prefix]
|
||||
|
||||
warn_list:
|
||||
- role-name[path]
|
||||
- var-naming[no-role-prefix]
|
||||
|
||||
exclude_paths:
|
||||
- .github/
|
||||
- molecule/default/prometheus/
|
||||
2
roles/prometheus/.gitignore
vendored
Normal file
2
roles/prometheus/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
.vscode
|
||||
.idea
|
||||
8
roles/prometheus/.yamllint
Normal file
8
roles/prometheus/.yamllint
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
rules:
|
||||
brackets:
|
||||
forbid: false
|
||||
min-spaces-inside: 0
|
||||
max-spaces-inside: 2
|
||||
min-spaces-inside-empty: -1
|
||||
max-spaces-inside-empty: 2
|
||||
50
roles/prometheus/README.md
Normal file
50
roles/prometheus/README.md
Normal file
@@ -0,0 +1,50 @@
|
||||
genlab.prometheus
|
||||
=========
|
||||
|
||||
This ansible role installs [Prometheus](https://github.com/prometheus/prometheus) from binary distribution. Prometheus is a systems and service monitoring system. It collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts when specified conditions are observed.
|
||||
|
||||
Prometheus configuration files and rules should be placed in separate directories in the source. They must have a `*.yml` suffix. You'll need to manually specify the paths to your rule files in the main Prometheus configuration file (prometheus.yml) on the target machine
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
None
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
```
|
||||
prometheus_version: 3.2.1 # prometheus version
|
||||
prometheus_dir: "/etc/prometheus" # where to install prometheus
|
||||
prometheus_user: prometheus # user name
|
||||
prometheus_group: prometheus # groups name
|
||||
config_dir: "/etc/prometheus/conf" # where to place prometheus config
|
||||
db_dir: "/var/lib/prometheus" # where to store prometheus db
|
||||
config_source_dir: prometheus # path to config files on source
|
||||
alertrules_source_dir: prometheus/rules # path to rule files on source
|
||||
```
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
None
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
```yaml
|
||||
roles:
|
||||
- role: genlab.prometheus
|
||||
config_source_dir: mydir/configs
|
||||
alertrules_source_dir: mydir/configs/rules
|
||||
prometheus_version: 3.2.1
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
BSD
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
corvus-migratorius@proton.me
|
||||
11
roles/prometheus/conda.dev.yml
Normal file
11
roles/prometheus/conda.dev.yml
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
name: ansible-role-template
|
||||
channels:
|
||||
- conda-forge
|
||||
dependencies:
|
||||
- python~=3.12.0
|
||||
- pip>=24.2
|
||||
- actionlint
|
||||
- pip:
|
||||
- -r requirements.txt
|
||||
- -r requirements.ci.txt
|
||||
9
roles/prometheus/conda.prod.yml
Normal file
9
roles/prometheus/conda.prod.yml
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
name: ansible-role-template
|
||||
channels:
|
||||
- conda-forge
|
||||
dependencies:
|
||||
- python~=3.12.0
|
||||
- pip>=24.2
|
||||
- pip:
|
||||
- -r requirements.txt
|
||||
7
roles/prometheus/defaults/main.yml
Normal file
7
roles/prometheus/defaults/main.yml
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
prometheus_version: 3.2.1
|
||||
prometheus_dir: "/etc/prometheus"
|
||||
prometheus_user: prometheus
|
||||
prometheus_group: prometheus
|
||||
config_dir: "/etc/prometheus/conf"
|
||||
db_dir: "/var/lib/prometheus"
|
||||
8
roles/prometheus/handlers/main.yml
Normal file
8
roles/prometheus/handlers/main.yml
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
- name: "(Re)start Prometheus service"
|
||||
become: true
|
||||
ansible.builtin.systemd:
|
||||
name: prometheus.service
|
||||
state: restarted
|
||||
enabled: true
|
||||
daemon_reload: true
|
||||
17
roles/prometheus/meta/main.yml
Normal file
17
roles/prometheus/meta/main.yml
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
galaxy_info:
|
||||
role_name: "prometheus"
|
||||
namespace: genlab
|
||||
author: "Alexander Gorelyshev"
|
||||
company: "Genlab, LLC"
|
||||
description: ""
|
||||
license: "MIT"
|
||||
min_ansible_version: "2.1"
|
||||
|
||||
platforms:
|
||||
- name: "Ubuntu"
|
||||
versions: [ "focal", "jammy", "noble" ]
|
||||
|
||||
galaxy_tags: [ ]
|
||||
|
||||
dependencies: []
|
||||
8
roles/prometheus/molecule/default/converge.yml
Normal file
8
roles/prometheus/molecule/default/converge.yml
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
- name: Converge
|
||||
hosts: all
|
||||
|
||||
roles:
|
||||
- role: genlab.prometheus
|
||||
config_source_dir: prometheus
|
||||
alertrules_source_dir: prometheus/rules
|
||||
27
roles/prometheus/molecule/default/molecule.yml
Normal file
27
roles/prometheus/molecule/default/molecule.yml
Normal file
@@ -0,0 +1,27 @@
|
||||
---
|
||||
dependency:
|
||||
name: galaxy
|
||||
|
||||
driver:
|
||||
name: docker
|
||||
|
||||
platforms:
|
||||
- name: ubuntu
|
||||
image: geerlingguy/docker-${MOLECULE_DISTRO:-ubuntu2404}-ansible:latest
|
||||
pre_build_image: true
|
||||
command: ${MOLECULE_DOCKER_COMMAND:-""}
|
||||
volumes:
|
||||
- /sys/fs/cgroup:/sys/fs/cgroup:rw
|
||||
cgroupns_mode: host
|
||||
privileged: true
|
||||
|
||||
provisioner:
|
||||
name: ansible
|
||||
|
||||
verifier:
|
||||
name: ansible
|
||||
|
||||
lint: |
|
||||
set -e
|
||||
yamllint .
|
||||
ansible-lint .
|
||||
14
roles/prometheus/molecule/default/prometheus/prometheus.yml
Normal file
14
roles/prometheus/molecule/default/prometheus/prometheus.yml
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
global:
|
||||
scrape_interval: 15s
|
||||
evaluation_interval: 15s
|
||||
|
||||
rule_files:
|
||||
- /etc/prometheus/conf/alertules.yml
|
||||
# - "first.rules"
|
||||
# - "second.rules"
|
||||
|
||||
scrape_configs:
|
||||
- job_name: prometheus
|
||||
static_configs:
|
||||
- targets: ['localhost:9090']
|
||||
@@ -0,0 +1,13 @@
|
||||
groups:
|
||||
- name: example
|
||||
labels:
|
||||
team: myteam
|
||||
rules:
|
||||
- alert: HighRequestLatency
|
||||
expr: job:request_latency_seconds:mean5m{job="myjob"} > 0.5
|
||||
for: 10m
|
||||
keep_firing_for: 5m
|
||||
labels:
|
||||
severity: page
|
||||
annotations:
|
||||
summary: High request latency
|
||||
55
roles/prometheus/molecule/default/verify.yml
Normal file
55
roles/prometheus/molecule/default/verify.yml
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
- name: Verify
|
||||
hosts: all
|
||||
gather_facts: false
|
||||
any_errors_fatal: true
|
||||
|
||||
tasks:
|
||||
|
||||
- name: "Include default vars"
|
||||
ansible.builtin.include_vars:
|
||||
dir: "{{ lookup('env', 'MOLECULE_PROJECT_DIRECTORY') }}/defaults/"
|
||||
extensions: [ 'yml' ]
|
||||
|
||||
- name: "Check if Prometheus is installed"
|
||||
changed_when: false
|
||||
ansible.builtin.command: "prometheus --version"
|
||||
register: prom_installed_version
|
||||
|
||||
- name: "Check Prometheus version"
|
||||
ansible.builtin.assert:
|
||||
that: "prom_installed_version.stdout is regex('{{ prometheus_version }}')"
|
||||
success_msg: "Prometheus version {{ prometheus_version }} is installed and working"
|
||||
fail_msg: "Prometheus version {{ prometheus_version }} is not installed or not working correctly"
|
||||
|
||||
# kics-scan ignore-block
|
||||
- name: "Check if Prometheus is reachable"
|
||||
ansible.builtin.uri:
|
||||
url: "http://localhost:9090/-/healthy"
|
||||
return_content: true
|
||||
status_code: 200
|
||||
method: GET
|
||||
body_format: json
|
||||
register: prom_health
|
||||
|
||||
- name: "Debug Prometheus health status"
|
||||
ansible.builtin.assert:
|
||||
that: "prom_health.content | trim == 'Prometheus Server is Healthy.'"
|
||||
success_msg: "Prometheus is healthy"
|
||||
fail_msg: "Prometheus is not healthy"
|
||||
|
||||
# kics-scan ignore-block
|
||||
- name: "Check if Prometheus is ready"
|
||||
ansible.builtin.uri:
|
||||
url: "http://localhost:9090/-/ready"
|
||||
return_content: true
|
||||
status_code: 200
|
||||
method: GET
|
||||
body_format: json
|
||||
register: prom_ready
|
||||
|
||||
- name: "Debug Prometheus readiness status"
|
||||
ansible.builtin.assert:
|
||||
that: "prom_ready.content | trim == 'Prometheus Server is Ready.'"
|
||||
success_msg: "Prometheus is ready"
|
||||
fail_msg: "Prometheus is not ready"
|
||||
6
roles/prometheus/renovate.json
Normal file
6
roles/prometheus/renovate.json
Normal file
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": [
|
||||
"config:recommended"
|
||||
]
|
||||
}
|
||||
6
roles/prometheus/requirements.ci.txt
Normal file
6
roles/prometheus/requirements.ci.txt
Normal file
@@ -0,0 +1,6 @@
|
||||
ansible-lint
|
||||
molecule==24.12.0
|
||||
molecule-plugins[docker]
|
||||
docker~=7.1.0
|
||||
requests==2.31.0 # pinned to the latest version not breaking Docker SDK
|
||||
yamllint
|
||||
1
roles/prometheus/requirements.txt
Normal file
1
roles/prometheus/requirements.txt
Normal file
@@ -0,0 +1 @@
|
||||
ansible~=11.3.0
|
||||
3
roles/prometheus/requirements.yml
Normal file
3
roles/prometheus/requirements.yml
Normal file
@@ -0,0 +1,3 @@
|
||||
# requirements file
|
||||
---
|
||||
collections: []
|
||||
23
roles/prometheus/tasks/configure.yml
Normal file
23
roles/prometheus/tasks/configure.yml
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
- name: "Copy config file"
|
||||
notify: "(Re)start Prometheus service"
|
||||
ansible.builtin.copy:
|
||||
src: "{{ item }}"
|
||||
dest: "{{ config_dir }}/{{ item | basename }}"
|
||||
owner: "{{ prometheus_user }}"
|
||||
group: "{{ prometheus_group }}"
|
||||
mode: "0660"
|
||||
with_fileglob:
|
||||
- "{{ config_source_dir }}/*.yml"
|
||||
|
||||
- name: "Copy alert rules"
|
||||
notify: "(Re)start Prometheus service"
|
||||
when: alertrules_source_dir is defined
|
||||
ansible.builtin.copy:
|
||||
src: "{{ item }}"
|
||||
dest: "{{ config_dir }}/{{ item | basename }}"
|
||||
owner: "{{ prometheus_user }}"
|
||||
group: "{{ prometheus_group }}"
|
||||
mode: "0660"
|
||||
with_fileglob:
|
||||
- "{{ alertrules_source_dir }}/*.yml"
|
||||
84
roles/prometheus/tasks/install.yml
Normal file
84
roles/prometheus/tasks/install.yml
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
- name: "Create Prometheus system group"
|
||||
ansible.builtin.group:
|
||||
name: "{{ prometheus_group }}"
|
||||
system: true
|
||||
state: present
|
||||
|
||||
- name: "Create Prometheus system user"
|
||||
ansible.builtin.user:
|
||||
name: "{{ prometheus_user }}"
|
||||
group: "{{ prometheus_group }}"
|
||||
system: true
|
||||
shell: "/sbin/nologin"
|
||||
create_home: false
|
||||
state: present
|
||||
|
||||
- name: "Install prometheus from binary"
|
||||
block:
|
||||
- name: "Check Prometheus version"
|
||||
changed_when: false
|
||||
ansible.builtin.command:
|
||||
cmd: "prometheus --version"
|
||||
register: prometheus_ver
|
||||
|
||||
- name: "Assert version correctness"
|
||||
ansible.builtin.assert:
|
||||
that: "prometheus_ver.stdout is regex('{{ prometheus_version }}')"
|
||||
success_msg: "prometheus version {{ prometheus_version }} is installed and working"
|
||||
fail_msg: "prometheus version {{ prometheus_version }} is not installed or not working correctly"
|
||||
|
||||
rescue:
|
||||
- name: "Create prometheus directories {{ item }}"
|
||||
ansible.builtin.file:
|
||||
path: "{{ item }}"
|
||||
state: directory
|
||||
owner: "{{ prometheus_user }}"
|
||||
group: "{{ prometheus_group }}"
|
||||
mode: "0755"
|
||||
with_items:
|
||||
- "{{ config_dir }}"
|
||||
- "{{ prometheus_dir }}"
|
||||
- "{{ db_dir }}"
|
||||
|
||||
- name: "Download Prometheus binary"
|
||||
ansible.builtin.get_url:
|
||||
url: "https://github.com/prometheus/prometheus/releases/download/v{{ prometheus_version }}/prometheus-{{ prometheus_version }}.linux-amd64.tar.gz"
|
||||
dest: "/tmp/prometheus-{{ prometheus_version }}.linux-amd64.tar.gz"
|
||||
owner: "{{ prometheus_user }}"
|
||||
group: "{{ prometheus_group }}"
|
||||
mode: "0644"
|
||||
|
||||
- name: "Unpack Prometheus binaries"
|
||||
notify: "(Re)start Prometheus service"
|
||||
ansible.builtin.unarchive:
|
||||
src: "/tmp/prometheus-{{ prometheus_version }}.linux-amd64.tar.gz"
|
||||
dest: "{{ prometheus_dir }}"
|
||||
creates: "{{ prometheus_dir }}/prometheus-{{ prometheus_version }}.linux-amd64"
|
||||
remote_src: true
|
||||
|
||||
- name: "Cleanup downloaded file"
|
||||
ansible.builtin.file:
|
||||
path: "/tmp/prometheus-{{ prometheus_version }}.linux-amd64.tar.gz"
|
||||
state: absent
|
||||
|
||||
- name: "Move official prometheus and promtool binaries"
|
||||
ansible.builtin.copy:
|
||||
src: "{{ prometheus_dir }}/prometheus-{{ prometheus_version }}.linux-amd64/{{ item }}"
|
||||
dest: "/usr/local/bin/{{ item }}"
|
||||
mode: "0755"
|
||||
owner: "{{ prometheus_user }}"
|
||||
group: "{{ prometheus_group }}"
|
||||
remote_src: true
|
||||
with_items:
|
||||
- prometheus
|
||||
- promtool
|
||||
|
||||
- name: "Create systemd service unit"
|
||||
notify: "(Re)start Prometheus service"
|
||||
ansible.builtin.template:
|
||||
src: prometheus.service.j2
|
||||
dest: /etc/systemd/system/prometheus.service
|
||||
owner: "{{ prometheus_user }}"
|
||||
group: "{{ prometheus_group }}"
|
||||
mode: "0660"
|
||||
9
roles/prometheus/tasks/main.yml
Normal file
9
roles/prometheus/tasks/main.yml
Normal file
@@ -0,0 +1,9 @@
|
||||
---
|
||||
- name: "Install Prometheus from binary"
|
||||
ansible.builtin.include_tasks: install.yml
|
||||
|
||||
- name: "Configure and add alert rules"
|
||||
ansible.builtin.include_tasks: configure.yml
|
||||
|
||||
- name: "Flush handlers"
|
||||
ansible.builtin.meta: "flush_handlers"
|
||||
28
roles/prometheus/templates/prometheus.service.j2
Normal file
28
roles/prometheus/templates/prometheus.service.j2
Normal file
@@ -0,0 +1,28 @@
|
||||
[Unit]
|
||||
Description=Prometheus
|
||||
Wants=network-online.target
|
||||
After=network-online.target
|
||||
Documentation="https://prometheus.io/"
|
||||
|
||||
[Service]
|
||||
User=prometheus
|
||||
Group=prometheus
|
||||
Type=simple
|
||||
ExecStart=/usr/local/bin/prometheus \
|
||||
--config.file {{ config_dir }}/prometheus.yml \
|
||||
--storage.tsdb.path {{ db_dir }} \
|
||||
--storage.tsdb.retention.time=30d
|
||||
|
||||
# Security hardening
|
||||
ReadWritePaths={{ db_dir }}
|
||||
ProtectSystem=strict
|
||||
NoNewPrivileges=true
|
||||
PrivateTmp=true
|
||||
ProtectKernelModules=true
|
||||
ProtectControlGroups=true
|
||||
ProtectKernelTunables=true
|
||||
ProtectClock=yes
|
||||
RestrictSUIDSGID=true
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
1
roles/prometheus/vars/main.yml
Normal file
1
roles/prometheus/vars/main.yml
Normal file
@@ -0,0 +1 @@
|
||||
---
|
||||
Reference in New Issue
Block a user