diff --git a/roles/alertmanager/README.md b/roles/alertmanager/README.md index 7ef20e9..120eeae 100644 --- a/roles/alertmanager/README.md +++ b/roles/alertmanager/README.md @@ -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. diff --git a/roles/borgmatic/README.md b/roles/borgmatic/README.md index ce5f940..8c610a0 100644 --- a/roles/borgmatic/README.md +++ b/roles/borgmatic/README.md @@ -1,4 +1,4 @@ -ansible-borgmatic +borgmatic ========= This is a wrapper around the `borgmatic` role from the `maxhoesel.borgbackup` collection. diff --git a/roles/curl_scheduled/README.md b/roles/curl_scheduled/README.md index 285bbb0..3dd0863 100644 --- a/roles/curl_scheduled/README.md +++ b/roles/curl_scheduled/README.md @@ -1,4 +1,4 @@ -curl-scheduled +curl_scheduled ========= Configure curl to run on schedule by deploying a systemd service + timer. Useful for sending heartbeats. diff --git a/roles/dnsmasq/README.md b/roles/dnsmasq/README.md index 2e1d6b4..814340d 100644 --- a/roles/dnsmasq/README.md +++ b/roles/dnsmasq/README.md @@ -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). diff --git a/roles/grafana/README.md b/roles/grafana/README.md index a700863..041ac62 100644 --- a/roles/grafana/README.md +++ b/roles/grafana/README.md @@ -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. diff --git a/roles/ipmi_exporter/README.md b/roles/ipmi_exporter/README.md index 06d3620..8472f82 100644 --- a/roles/ipmi_exporter/README.md +++ b/roles/ipmi_exporter/README.md @@ -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) diff --git a/roles/karma/README.md b/roles/karma/README.md index 3282de9..9e3e39b 100644 --- a/roles/karma/README.md +++ b/roles/karma/README.md @@ -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) diff --git a/roles/loki/README.md b/roles/loki/README.md index 8a05ac1..b406f2a 100644 --- a/roles/loki/README.md +++ b/roles/loki/README.md @@ -1,5 +1,5 @@ loki -========= +==== Installs Loki as a `systemd` service. diff --git a/roles/mkfs/README.md b/roles/mkfs/README.md index cfa7a9b..3a1ab4f 100644 --- a/roles/mkfs/README.md +++ b/roles/mkfs/README.md @@ -1,5 +1,5 @@ -Role Name -========= +mkfs +==== Create a filesystem on the target device (thinly wraps `community.general.filesystem` module). diff --git a/roles/mount_device/README.md b/roles/mount_device/README.md index 0f6194d..b31db8a 100644 --- a/roles/mount_device/README.md +++ b/roles/mount_device/README.md @@ -1,5 +1,5 @@ -ansible-mount-device -========= +mount_device +============ Mount the given block device. diff --git a/roles/nginx/README.md b/roles/nginx/README.md index 9ce29f0..43bfd11 100644 --- a/roles/nginx/README.md +++ b/roles/nginx/README.md @@ -1,5 +1,5 @@ -ansible-nginx -========= +nginx +===== Deploy NGINX with a minimal configuration. diff --git a/roles/node_exporter/README.md b/roles/node_exporter/README.md index 0ff7a86..2ca20cf 100644 --- a/roles/node_exporter/README.md +++ b/roles/node_exporter/README.md @@ -1,5 +1,5 @@ -Role Name -========= +node_exporter +============= Deploy `prometheus/node_exporter` binary as a systemd unit. diff --git a/roles/prometheus/README.md b/roles/prometheus/README.md index 971b023..08ce557 100644 --- a/roles/prometheus/README.md +++ b/roles/prometheus/README.md @@ -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. diff --git a/roles/promtail/README.md b/roles/promtail/README.md index 7dac0b4..ee18ce2 100644 --- a/roles/promtail/README.md +++ b/roles/promtail/README.md @@ -1,5 +1,5 @@ promtail -========= +======== Installs promtail as systemd service. diff --git a/roles/rclone_yandex/README.md b/roles/rclone_yandex/README.md index 8e6f453..f197776 100644 --- a/roles/rclone_yandex/README.md +++ b/roles/rclone_yandex/README.md @@ -1,5 +1,5 @@ -Role Name -========= +rclone_yandex +============= A brief description of the role goes here. diff --git a/roles/rustdesk/README.md b/roles/rustdesk/README.md index 390a16c..c790ab0 100644 --- a/roles/rustdesk/README.md +++ b/roles/rustdesk/README.md @@ -1,5 +1,5 @@ -Rustdesk Server -========= +rustdesk +======== Rustdesk server role for ansible diff --git a/roles/sftp_share/README.md b/roles/sftp_share/README.md index 2a9c476..b470d55 100644 --- a/roles/sftp_share/README.md +++ b/roles/sftp_share/README.md @@ -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). diff --git a/roles/smartctl_exporter/README.md b/roles/smartctl_exporter/README.md index 1c1de90..7bb6b3a 100644 --- a/roles/smartctl_exporter/README.md +++ b/roles/smartctl_exporter/README.md @@ -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. diff --git a/roles/sshd/README.md b/roles/sshd/README.md index 3f3962d..42b285a 100644 --- a/roles/sshd/README.md +++ b/roles/sshd/README.md @@ -1,5 +1,5 @@ -ansible-sshd -========= +sshd +==== Deploy a hardened sshd server diff --git a/roles/swapfile/README.md b/roles/swapfile/README.md index 019f927..db76963 100644 --- a/roles/swapfile/README.md +++ b/roles/swapfile/README.md @@ -1,5 +1,5 @@ -ansible-swapfile -========= +swapfile +======== Create/destroy a swapfile and run swapon/-off on it. diff --git a/roles/ufw/README.md b/roles/ufw/README.md index 7207f41..69cc8c6 100644 --- a/roles/ufw/README.md +++ b/roles/ufw/README.md @@ -1,5 +1,5 @@ -template -========= +ufw +=== Whitelist network ports with UFW diff --git a/roles/users/README.md b/roles/users/README.md index 30fd61c..4e101ee 100644 --- a/roles/users/README.md +++ b/roles/users/README.md @@ -1,5 +1,5 @@ -ansible-users -========= +users +===== Create user accounts according to a YAML manifest. diff --git a/roles/wg_hub/README.md b/roles/wg_hub/README.md index fe551c0..4b29158 100644 --- a/roles/wg_hub/README.md +++ b/roles/wg_hub/README.md @@ -1,13 +1,5 @@ -template -========= - -Template for Ansible role monorepos. - -⚠️ Do not forget to update: - -- `meta/main.yml` -- Conda/Mamba manifests -- this README =) +wg_hub +====== Requirements ------------