Enforce consistent role names in README

This commit is contained in:
Alexander Gorelyshev
2025-12-18 17:16:02 +04:00
parent 93720acd46
commit a50119d74e
23 changed files with 36 additions and 44 deletions

View File

@@ -1,4 +1,4 @@
genlab.alertmanager alertmanager
========= =========
The [Alertmanager](https://github.com/prometheus/alertmanager) handles alerts sent by client applications such as the Prometheus server. It takes care of deduplicating, grouping, and routing them to the correct receiver integration such as email, PagerDuty, or OpsGenie. It also takes care of silencing and inhibition of alerts. The [Alertmanager](https://github.com/prometheus/alertmanager) handles alerts sent by client applications such as the Prometheus server. It takes care of deduplicating, grouping, and routing them to the correct receiver integration such as email, PagerDuty, or OpsGenie. It also takes care of silencing and inhibition of alerts.

View File

@@ -1,4 +1,4 @@
ansible-borgmatic borgmatic
========= =========
This is a wrapper around the `borgmatic` role from the `maxhoesel.borgbackup` collection. This is a wrapper around the `borgmatic` role from the `maxhoesel.borgbackup` collection.

View File

@@ -1,4 +1,4 @@
curl-scheduled curl_scheduled
========= =========
Configure curl to run on schedule by deploying a systemd service + timer. Useful for sending heartbeats. Configure curl to run on schedule by deploying a systemd service + timer. Useful for sending heartbeats.

View File

@@ -1,4 +1,4 @@
ansible-dnsmasq dnsmasq
========= =========
Deploy dnsmasq on the target node. For now, supports only DNS functionality (DHCP and TFTP are not configuratble). Deploy dnsmasq on the target node. For now, supports only DNS functionality (DHCP and TFTP are not configuratble).

View File

@@ -1,4 +1,4 @@
genlab.grafana grafana
========= =========
This ansible role installs [Grafana](https://github.com/grafana/grafana) - the open-source platform for monitoring and observability. It can produce charts, graphs, and alerts for the web when connected to supported data sources. This ansible role installs [Grafana](https://github.com/grafana/grafana) - the open-source platform for monitoring and observability. It can produce charts, graphs, and alerts for the web when connected to supported data sources.

View File

@@ -1,4 +1,4 @@
genlab.ipmi_exporter ipmi_exporter
========= =========
This Ansible role installs ipmi_exporter on target host. This is a Prometheus exporter for Intelligent Platform Management Interface [metrics](https://github.com/prometheus-community/ipmi_exporter/blob/master/docs/metrics.md) This Ansible role installs ipmi_exporter on target host. This is a Prometheus exporter for Intelligent Platform Management Interface [metrics](https://github.com/prometheus-community/ipmi_exporter/blob/master/docs/metrics.md)

View File

@@ -1,4 +1,4 @@
genlab.karma karma
========= =========
This is the ansible role to install and configure Karma - alert dashboard for Prometheus Alertmanager (https://github.com/prymitive/karma) This is the ansible role to install and configure Karma - alert dashboard for Prometheus Alertmanager (https://github.com/prymitive/karma)

View File

@@ -1,5 +1,5 @@
loki loki
========= ====
Installs Loki as a `systemd` service. Installs Loki as a `systemd` service.

View File

@@ -1,5 +1,5 @@
Role Name mkfs
========= ====
Create a filesystem on the target device (thinly wraps `community.general.filesystem` module). Create a filesystem on the target device (thinly wraps `community.general.filesystem` module).

View File

@@ -1,5 +1,5 @@
ansible-mount-device mount_device
========= ============
Mount the given block device. Mount the given block device.

View File

@@ -1,5 +1,5 @@
ansible-nginx nginx
========= =====
Deploy NGINX with a minimal configuration. Deploy NGINX with a minimal configuration.

View File

@@ -1,5 +1,5 @@
Role Name node_exporter
========= =============
Deploy `prometheus/node_exporter` binary as a systemd unit. Deploy `prometheus/node_exporter` binary as a systemd unit.

View File

@@ -1,5 +1,5 @@
genlab.prometheus 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. 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.

View File

@@ -1,5 +1,5 @@
promtail promtail
========= ========
Installs promtail as systemd service. Installs promtail as systemd service.

View File

@@ -1,5 +1,5 @@
Role Name rclone_yandex
========= =============
A brief description of the role goes here. A brief description of the role goes here.

View File

@@ -1,5 +1,5 @@
Rustdesk Server rustdesk
========= ========
Rustdesk server role for ansible Rustdesk server role for ansible

View File

@@ -1,4 +1,4 @@
SFTP Share Ansible Role sftp_share
========= =========
Creates a user account and directories for secured SFTP data exchange (one user = one share). Creates a user account and directories for secured SFTP data exchange (one user = one share).

View File

@@ -1,5 +1,5 @@
genlab.smartctl-exporter smartctl_exporter
========= =================
```smartctl``` is a command-line utility used to control and monitor the Self-Monitoring, Analysis and Reporting Technology (SMART) system in hard disk drives (HDDs) and solid-state drives (SSDs). ```smartctl-exporter``` exports ```smartctl``` statistics to Prometheus. ```smartctl``` is a command-line utility used to control and monitor the Self-Monitoring, Analysis and Reporting Technology (SMART) system in hard disk drives (HDDs) and solid-state drives (SSDs). ```smartctl-exporter``` exports ```smartctl``` statistics to Prometheus.

View File

@@ -1,5 +1,5 @@
ansible-sshd sshd
========= ====
Deploy a hardened sshd server Deploy a hardened sshd server

View File

@@ -1,5 +1,5 @@
ansible-swapfile swapfile
========= ========
Create/destroy a swapfile and run swapon/-off on it. Create/destroy a swapfile and run swapon/-off on it.

View File

@@ -1,5 +1,5 @@
template ufw
========= ===
Whitelist network ports with UFW Whitelist network ports with UFW

View File

@@ -1,5 +1,5 @@
ansible-users users
========= =====
Create user accounts according to a YAML manifest. Create user accounts according to a YAML manifest.

View File

@@ -1,13 +1,5 @@
template wg_hub
========= ======
Template for Ansible role monorepos.
⚠️ Do not forget to update:
- `meta/main.yml`
- Conda/Mamba manifests
- this README =)
Requirements Requirements
------------ ------------