From a50119d74e57175efef7d8f2a9dbe96913a7ca0d Mon Sep 17 00:00:00 2001 From: Alexander Gorelyshev Date: Thu, 18 Dec 2025 17:16:02 +0400 Subject: [PATCH 1/5] Enforce consistent role names in README --- roles/alertmanager/README.md | 2 +- roles/borgmatic/README.md | 2 +- roles/curl_scheduled/README.md | 2 +- roles/dnsmasq/README.md | 2 +- roles/grafana/README.md | 2 +- roles/ipmi_exporter/README.md | 2 +- roles/karma/README.md | 2 +- roles/loki/README.md | 2 +- roles/mkfs/README.md | 4 ++-- roles/mount_device/README.md | 4 ++-- roles/nginx/README.md | 4 ++-- roles/node_exporter/README.md | 4 ++-- roles/prometheus/README.md | 4 ++-- roles/promtail/README.md | 2 +- roles/rclone_yandex/README.md | 4 ++-- roles/rustdesk/README.md | 4 ++-- roles/sftp_share/README.md | 2 +- roles/smartctl_exporter/README.md | 4 ++-- roles/sshd/README.md | 4 ++-- roles/swapfile/README.md | 4 ++-- roles/ufw/README.md | 4 ++-- roles/users/README.md | 4 ++-- roles/wg_hub/README.md | 12 ++---------- 23 files changed, 36 insertions(+), 44 deletions(-) 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 ------------ From 3e925c3a5481ec9bc1fe4e02ef60c609f03c46ff Mon Sep 17 00:00:00 2001 From: Alexander Gorelyshev Date: Thu, 18 Dec 2025 17:16:41 +0400 Subject: [PATCH 2/5] Remove `.gitignore` leftovers from individual roles --- roles/curl_scheduled/.gitignore | 2 -- roles/karma/.gitignore | 2 -- roles/nginx/.gitignore | 2 -- roles/rclone_yandex/.gitignore | 2 -- roles/smartctl_exporter/.gitignore | 2 -- 5 files changed, 10 deletions(-) delete mode 100644 roles/curl_scheduled/.gitignore delete mode 100644 roles/karma/.gitignore delete mode 100644 roles/nginx/.gitignore delete mode 100644 roles/rclone_yandex/.gitignore delete mode 100644 roles/smartctl_exporter/.gitignore diff --git a/roles/curl_scheduled/.gitignore b/roles/curl_scheduled/.gitignore deleted file mode 100644 index 8cd0df3..0000000 --- a/roles/curl_scheduled/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.vscode -.idea \ No newline at end of file diff --git a/roles/karma/.gitignore b/roles/karma/.gitignore deleted file mode 100644 index 8cd0df3..0000000 --- a/roles/karma/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.vscode -.idea \ No newline at end of file diff --git a/roles/nginx/.gitignore b/roles/nginx/.gitignore deleted file mode 100644 index 8cd0df3..0000000 --- a/roles/nginx/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.vscode -.idea \ No newline at end of file diff --git a/roles/rclone_yandex/.gitignore b/roles/rclone_yandex/.gitignore deleted file mode 100644 index 8cd0df3..0000000 --- a/roles/rclone_yandex/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.vscode -.idea \ No newline at end of file diff --git a/roles/smartctl_exporter/.gitignore b/roles/smartctl_exporter/.gitignore deleted file mode 100644 index 8cd0df3..0000000 --- a/roles/smartctl_exporter/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -.vscode -.idea \ No newline at end of file From e2aa20f36729f47930c664b0a79da0f359014f05 Mon Sep 17 00:00:00 2001 From: Alexander Gorelyshev Date: Thu, 18 Dec 2025 17:19:15 +0400 Subject: [PATCH 3/5] Drop declared support for Ubuntu 20.04 as it is EOL --- roles/alertmanager/meta/main.yml | 2 +- roles/borgmatic/meta/main.yml | 2 +- roles/curl_scheduled/meta/main.yml | 2 +- roles/dnsmasq/meta/main.yml | 2 +- roles/docker_ubuntu/meta/main.yml | 2 +- roles/grafana/meta/main.yml | 2 +- roles/ipmi_exporter/meta/main.yml | 2 +- roles/karma/meta/main.yml | 2 +- roles/loki/meta/main.yml | 2 +- roles/nginx/meta/main.yml | 2 +- roles/node_exporter/meta/main.yml | 2 +- roles/prometheus/meta/main.yml | 2 +- roles/promtail/meta/main.yml | 4 ++++ roles/rclone_yandex/meta/main.yml | 2 +- roles/rustdesk/meta/main.yml | 2 +- roles/sftp_share/meta/main.yml | 2 +- roles/smartctl_exporter/meta/main.yml | 2 +- roles/swapfile/meta/main.yml | 2 +- roles/ufw/meta/main.yml | 2 +- roles/wg_spoke/meta/main.yml | 2 +- 20 files changed, 23 insertions(+), 19 deletions(-) diff --git a/roles/alertmanager/meta/main.yml b/roles/alertmanager/meta/main.yml index 0cebb5a..3ef6eeb 100644 --- a/roles/alertmanager/meta/main.yml +++ b/roles/alertmanager/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/borgmatic/meta/main.yml b/roles/borgmatic/meta/main.yml index 868031b..fa0757f 100644 --- a/roles/borgmatic/meta/main.yml +++ b/roles/borgmatic/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/curl_scheduled/meta/main.yml b/roles/curl_scheduled/meta/main.yml index 894fc30..7fe79a2 100644 --- a/roles/curl_scheduled/meta/main.yml +++ b/roles/curl_scheduled/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/dnsmasq/meta/main.yml b/roles/dnsmasq/meta/main.yml index 03ddef7..321e3d2 100644 --- a/roles/dnsmasq/meta/main.yml +++ b/roles/dnsmasq/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/docker_ubuntu/meta/main.yml b/roles/docker_ubuntu/meta/main.yml index f6eca81..53afa6e 100644 --- a/roles/docker_ubuntu/meta/main.yml +++ b/roles/docker_ubuntu/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: ["docker"] diff --git a/roles/grafana/meta/main.yml b/roles/grafana/meta/main.yml index cec0dd3..c55e2cb 100644 --- a/roles/grafana/meta/main.yml +++ b/roles/grafana/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/ipmi_exporter/meta/main.yml b/roles/ipmi_exporter/meta/main.yml index 3c37e0c..74bd457 100644 --- a/roles/ipmi_exporter/meta/main.yml +++ b/roles/ipmi_exporter/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/karma/meta/main.yml b/roles/karma/meta/main.yml index 87eb400..448d473 100644 --- a/roles/karma/meta/main.yml +++ b/roles/karma/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [monitoring] diff --git a/roles/loki/meta/main.yml b/roles/loki/meta/main.yml index 2ca0728..5bf25f3 100644 --- a/roles/loki/meta/main.yml +++ b/roles/loki/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/nginx/meta/main.yml b/roles/nginx/meta/main.yml index b6e9df6..fd5573d 100644 --- a/roles/nginx/meta/main.yml +++ b/roles/nginx/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/node_exporter/meta/main.yml b/roles/node_exporter/meta/main.yml index 885b94c..443fec0 100644 --- a/roles/node_exporter/meta/main.yml +++ b/roles/node_exporter/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy"] + versions: ["jammy", "noble"] galaxy_tags: ["prometheus"] diff --git a/roles/prometheus/meta/main.yml b/roles/prometheus/meta/main.yml index b4335ec..1f7d415 100644 --- a/roles/prometheus/meta/main.yml +++ b/roles/prometheus/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/promtail/meta/main.yml b/roles/promtail/meta/main.yml index 79d6be3..92ff89a 100644 --- a/roles/promtail/meta/main.yml +++ b/roles/promtail/meta/main.yml @@ -9,6 +9,10 @@ galaxy_info: min_ansible_version: "2.1" + platforms: + - name: "Ubuntu" + versions: ["jammy", "noble"] + galaxy_tags: [] dependencies: [] diff --git a/roles/rclone_yandex/meta/main.yml b/roles/rclone_yandex/meta/main.yml index 2bb3f62..a18b453 100644 --- a/roles/rclone_yandex/meta/main.yml +++ b/roles/rclone_yandex/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/rustdesk/meta/main.yml b/roles/rustdesk/meta/main.yml index d396088..f14d282 100644 --- a/roles/rustdesk/meta/main.yml +++ b/roles/rustdesk/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/sftp_share/meta/main.yml b/roles/sftp_share/meta/main.yml index 9d3f7e1..69bb8bc 100644 --- a/roles/sftp_share/meta/main.yml +++ b/roles/sftp_share/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/smartctl_exporter/meta/main.yml b/roles/smartctl_exporter/meta/main.yml index cde1c90..a79680c 100644 --- a/roles/smartctl_exporter/meta/main.yml +++ b/roles/smartctl_exporter/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/swapfile/meta/main.yml b/roles/swapfile/meta/main.yml index fde50d8..35d5a9b 100644 --- a/roles/swapfile/meta/main.yml +++ b/roles/swapfile/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/ufw/meta/main.yml b/roles/ufw/meta/main.yml index 004334a..4ec0837 100644 --- a/roles/ufw/meta/main.yml +++ b/roles/ufw/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy"] + versions: ["jammy", "noble"] galaxy_tags: [] diff --git a/roles/wg_spoke/meta/main.yml b/roles/wg_spoke/meta/main.yml index 396d62a..636443c 100644 --- a/roles/wg_spoke/meta/main.yml +++ b/roles/wg_spoke/meta/main.yml @@ -10,7 +10,7 @@ galaxy_info: platforms: - name: "Ubuntu" - versions: ["focal", "jammy", "noble"] + versions: ["jammy", "noble"] galaxy_tags: [] From f817ed54a45926bd4eeac3c1a6ff86f31d4a1776 Mon Sep 17 00:00:00 2001 From: Alexander Gorelyshev Date: Thu, 18 Dec 2025 17:21:37 +0400 Subject: [PATCH 4/5] Change DRY-breaking invocation examples for links to converge files --- roles/alertmanager/README.md | 8 +------ roles/borgmatic/README.md | 2 +- roles/curl_scheduled/README.md | 2 +- roles/dnsmasq/README.md | 5 +---- roles/docker_ubuntu/README.md | 5 +---- roles/grafana/README.md | 37 +------------------------------ roles/ipmi_exporter/README.md | 7 +----- roles/karma/README.md | 9 +------- roles/loki/README.md | 6 +---- roles/nginx/README.md | 5 +---- roles/prometheus/README.md | 8 +------ roles/promtail/README.md | 5 +---- roles/rclone_yandex/README.md | 7 +----- roles/rustdesk/README.md | 5 +---- roles/sftp_share/README.md | 2 +- roles/smartctl_exporter/README.md | 8 +------ roles/sshd/README.md | 5 +---- roles/swapfile/README.md | 5 +---- roles/ufw/README.md | 5 +---- roles/wg_hub/README.md | 5 +---- roles/wg_spoke/README.md | 2 +- 21 files changed, 21 insertions(+), 122 deletions(-) diff --git a/roles/alertmanager/README.md b/roles/alertmanager/README.md index 120eeae..679d671 100644 --- a/roles/alertmanager/README.md +++ b/roles/alertmanager/README.md @@ -34,13 +34,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.template - config_source_dir: alertmanager - alertmanager_version: 0.28.1 - -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/borgmatic/README.md b/roles/borgmatic/README.md index 8c610a0..4255c07 100644 --- a/roles/borgmatic/README.md +++ b/roles/borgmatic/README.md @@ -27,7 +27,7 @@ None Example Playbook ---------------- -See `molecule/default/converge.yml` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/curl_scheduled/README.md b/roles/curl_scheduled/README.md index 3dd0863..1d35f6f 100644 --- a/roles/curl_scheduled/README.md +++ b/roles/curl_scheduled/README.md @@ -26,7 +26,7 @@ None Example Playbook ---------------- -See `molecule/default/converge.yml`. +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/dnsmasq/README.md b/roles/dnsmasq/README.md index 814340d..8590395 100644 --- a/roles/dnsmasq/README.md +++ b/roles/dnsmasq/README.md @@ -21,10 +21,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.dnsmasq -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/docker_ubuntu/README.md b/roles/docker_ubuntu/README.md index 8760978..153457b 100644 --- a/roles/docker_ubuntu/README.md +++ b/roles/docker_ubuntu/README.md @@ -25,10 +25,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.common.docker_ubuntu -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/grafana/README.md b/roles/grafana/README.md index 041ac62..88238c9 100644 --- a/roles/grafana/README.md +++ b/roles/grafana/README.md @@ -59,42 +59,7 @@ None Example Playbook ---------------- -```yaml ---- -- name: Converge - hosts: all - vars: - grafana_users: - - name: "test" - user_login: "test" - user_password: "test" - user_email: "test@mail.ru" - is_admin: false - grafana_plugins: - version: 2.1.8 - - name: aceiot-svg-panel - version: 0.1.5 - grafana_public_dashboards: - - name: Node Full Exporter - id: 1860 - revision: 36 - vars_files: - - secrets/admin_cred.yml - - roles: - - role: genlab.grafana - grafana_version: 11.5.0 - admin_api_username: "{{ grafana.admin_api_username }}" - admin_api_password: "{{ grafana.admin_api_password }}" - users: "{{ grafana_users }}" - plugins: "{{ grafana_plugins }}" - public_dashboards: "{{ grafana_public_dashboards }}" - dashboard_source_path: "molecule/default/dashboards" - datasource_source_path: "molecule/default/datasources" - grafana_log_dir: "/opt/grafana/data" - grafana_data_dir: "/opt/grafana/lib" - -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/ipmi_exporter/README.md b/roles/ipmi_exporter/README.md index 8472f82..89691b4 100644 --- a/roles/ipmi_exporter/README.md +++ b/roles/ipmi_exporter/README.md @@ -43,12 +43,7 @@ None Example Playbook ---------------- -```yaml - roles: - - role: genlab.ipmi_exporter - ipmi_exp_version: "1.10.1" - ipmi_exp_source_dir: "molecule/default/" -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/karma/README.md b/roles/karma/README.md index 9e3e39b..9ba88c9 100644 --- a/roles/karma/README.md +++ b/roles/karma/README.md @@ -33,14 +33,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.karma - karma_version: "0.121" - config_source_dir: "karma/" - karma_dir: "/etc/karma" - karma_config_dir: "/etc/karma/config" -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/loki/README.md b/roles/loki/README.md index b406f2a..b261aac 100644 --- a/roles/loki/README.md +++ b/roles/loki/README.md @@ -23,11 +23,7 @@ No Example Playbook ---------------- -```yaml -roles: - - role: loki - loki_version: 2.7.3 -``` +See: [converge.yml](molecule/default/converge.yml) License diff --git a/roles/nginx/README.md b/roles/nginx/README.md index 43bfd11..ec40043 100644 --- a/roles/nginx/README.md +++ b/roles/nginx/README.md @@ -21,10 +21,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.nginx -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/prometheus/README.md b/roles/prometheus/README.md index 08ce557..29a6ed7 100644 --- a/roles/prometheus/README.md +++ b/roles/prometheus/README.md @@ -31,13 +31,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.prometheus - prometheus_config_source_dir: mydir/configs - prometheus_alertrules_source_dir: mydir/configs/rules - prometheus_version: 3.2.1 -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/promtail/README.md b/roles/promtail/README.md index ee18ce2..8795934 100644 --- a/roles/promtail/README.md +++ b/roles/promtail/README.md @@ -24,10 +24,7 @@ No Example Playbook ---------------- - - hosts: servers - roles: - - role: promtail - promtail_version: 2.7.3 +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/rclone_yandex/README.md b/roles/rclone_yandex/README.md index f197776..a399587 100644 --- a/roles/rclone_yandex/README.md +++ b/roles/rclone_yandex/README.md @@ -23,12 +23,7 @@ A list of other roles hosted on Galaxy should go here, plus any details in regar Example Playbook ---------------- -```yaml -roles: - - role: rclone_yandex - rclone_mountpoint: /mnt/yandex-disk - rclone_group: yandex -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/rustdesk/README.md b/roles/rustdesk/README.md index c790ab0..92b3cdd 100644 --- a/roles/rustdesk/README.md +++ b/roles/rustdesk/README.md @@ -26,10 +26,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.rustdesk_server -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/sftp_share/README.md b/roles/sftp_share/README.md index b470d55..325bde5 100644 --- a/roles/sftp_share/README.md +++ b/roles/sftp_share/README.md @@ -60,7 +60,7 @@ None Example Playbook ---------------- -See `molecule/default/converge.yml` for an example role invocation. +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/smartctl_exporter/README.md b/roles/smartctl_exporter/README.md index 7bb6b3a..cb38291 100644 --- a/roles/smartctl_exporter/README.md +++ b/roles/smartctl_exporter/README.md @@ -37,13 +37,7 @@ None Example Playbook ---------------- -```yaml -roles: -- role: genlab.smartctl_exporter - smartctl_exp_version: "0.14.0" - smartctl_exp_dir: "/etc/exporters" - smartctl_exp_config_dir: "/etc/exporters/config" -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/sshd/README.md b/roles/sshd/README.md index 42b285a..e62e184 100644 --- a/roles/sshd/README.md +++ b/roles/sshd/README.md @@ -21,10 +21,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.common.sshd -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/swapfile/README.md b/roles/swapfile/README.md index db76963..e656d92 100644 --- a/roles/swapfile/README.md +++ b/roles/swapfile/README.md @@ -23,10 +23,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.swapfile -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/ufw/README.md b/roles/ufw/README.md index 69cc8c6..2b7b162 100644 --- a/roles/ufw/README.md +++ b/roles/ufw/README.md @@ -21,10 +21,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.ufw -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/wg_hub/README.md b/roles/wg_hub/README.md index 4b29158..451e486 100644 --- a/roles/wg_hub/README.md +++ b/roles/wg_hub/README.md @@ -19,10 +19,7 @@ None Example Playbook ---------------- -```yaml -roles: - - role: genlab.template -``` +See: [converge.yml](molecule/default/converge.yml) License ------- diff --git a/roles/wg_spoke/README.md b/roles/wg_spoke/README.md index c0ba380..19896ff 100644 --- a/roles/wg_spoke/README.md +++ b/roles/wg_spoke/README.md @@ -33,7 +33,7 @@ None Example Playbook ---------------- -See `molecule/default/converge.yml`. +See: [converge.yml](molecule/default/converge.yml) License ------- From 708d3c67d8f1f4efc198b68fd127a3b6fc8ec70c Mon Sep 17 00:00:00 2001 From: Alexander Gorelyshev Date: Thu, 18 Dec 2025 17:23:33 +0400 Subject: [PATCH 5/5] Fix minor README issues --- roles/borgmatic/README.md | 2 +- roles/curl_scheduled/README.md | 4 +--- roles/dnsmasq/README.md | 2 +- roles/docker_ubuntu/README.md | 4 ---- roles/karma/README.md | 7 +------ roles/prometheus/README.md | 5 ++++- roles/promtail/README.md | 6 ++---- roles/rclone_yandex/README.md | 8 ++++---- roles/rustdesk/README.md | 12 ++++++------ roles/sftp_share/README.md | 2 +- roles/smartctl_exporter/README.md | 8 ++++---- roles/sshd/README.md | 2 +- roles/users/README.md | 7 ++++--- roles/wg_spoke/README.md | 4 ++-- 14 files changed, 32 insertions(+), 41 deletions(-) diff --git a/roles/borgmatic/README.md b/roles/borgmatic/README.md index 4255c07..17eafc7 100644 --- a/roles/borgmatic/README.md +++ b/roles/borgmatic/README.md @@ -12,7 +12,7 @@ In the case of Borgmatic we are installing it via `pipx`, as recommended by thei Requirements ------------ -- `maxhoesel.borgbackup` collection installed (see `requirements.yml`); +- `maxhoesel.borgbackup` collection installed; Role Variables -------------- diff --git a/roles/curl_scheduled/README.md b/roles/curl_scheduled/README.md index 1d35f6f..5a4d24c 100644 --- a/roles/curl_scheduled/README.md +++ b/roles/curl_scheduled/README.md @@ -1,7 +1,7 @@ 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. Requirements ------------ @@ -12,9 +12,7 @@ Role Variables -------------- - `args`: arguments to the curl command - - `url`: address to be accessed by curl - - `schedule`: string compatible with systemd timer `OnSchedule` option (default: `minutely`) diff --git a/roles/dnsmasq/README.md b/roles/dnsmasq/README.md index 8590395..d16f7ea 100644 --- a/roles/dnsmasq/README.md +++ b/roles/dnsmasq/README.md @@ -1,7 +1,7 @@ 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 configurable). Requirements ------------ diff --git a/roles/docker_ubuntu/README.md b/roles/docker_ubuntu/README.md index 153457b..5d1f725 100644 --- a/roles/docker_ubuntu/README.md +++ b/roles/docker_ubuntu/README.md @@ -3,10 +3,6 @@ docker_ubuntu Install Docker ecosystem on Ubuntu. -[![lint](https://github.com/corvus-migratorius/ansible-docker-ubuntu/actions/workflows/lint.yaml/badge.svg)](https://github.com/corvus-migratorius/ansible-docker-ubuntu/actions/workflows/lint.yaml) - -[![molecule](https://github.com/corvus-migratorius/ansible-docker-ubuntu/actions/workflows/molecule.yaml/badge.svg)](https://github.com/corvus-migratorius/ansible-docker-ubuntu/actions/workflows/molecule.yaml) - Requirements ------------ diff --git a/roles/karma/README.md b/roles/karma/README.md index 9ba88c9..cc98ca1 100644 --- a/roles/karma/README.md +++ b/roles/karma/README.md @@ -1,13 +1,8 @@ karma ========= -This is the ansible role to install and configure Karma - alert dashboard for Prometheus Alertmanager (https://github.com/prymitive/karma) ------------- -⚠️ Do not forget to update: +Install and configure Karma - an alert dashboard for Prometheus Alertmanager (https://github.com/prymitive/karma) -- `meta/main.yml` -- Conda/Mamba manifests -- this README =) including *the name at the top* and *maintainers*. Requirements ------------ diff --git a/roles/prometheus/README.md b/roles/prometheus/README.md index 29a6ed7..49e0571 100644 --- a/roles/prometheus/README.md +++ b/roles/prometheus/README.md @@ -1,7 +1,9 @@ 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. +Install [Prometheus](https://github.com/prometheus/prometheus) binary from GitHub. + +Prometheus 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 @@ -42,3 +44,4 @@ Author Information ------------------ corvus-migratorius@proton.me +sayganova@genlab.llc diff --git a/roles/promtail/README.md b/roles/promtail/README.md index 8795934..7984179 100644 --- a/roles/promtail/README.md +++ b/roles/promtail/README.md @@ -1,7 +1,7 @@ promtail ======== -Installs promtail as systemd service. +Installs `promtail` as a systemd service. Requirements ------------ @@ -19,7 +19,7 @@ Role Variables Dependencies ------------ -No +None Example Playbook ---------------- @@ -36,6 +36,4 @@ Author Information Alexander Gorelyshev and Danilkin Danila (MIPT) -Genlab LLC - corvus-migratorius@proton.me diff --git a/roles/rclone_yandex/README.md b/roles/rclone_yandex/README.md index a399587..9ee8fd2 100644 --- a/roles/rclone_yandex/README.md +++ b/roles/rclone_yandex/README.md @@ -1,12 +1,12 @@ rclone_yandex ============= -A brief description of the role goes here. +Mount a Yandex Disk share via `rclone`. Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +None Role Variables -------------- @@ -18,7 +18,7 @@ Role Variables Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +None Example Playbook ---------------- @@ -33,4 +33,4 @@ BSD Author Information ------------------ -corvus-migratorius@proton.me \ No newline at end of file +corvus-migratorius@proton.me diff --git a/roles/rustdesk/README.md b/roles/rustdesk/README.md index 92b3cdd..879087f 100644 --- a/roles/rustdesk/README.md +++ b/roles/rustdesk/README.md @@ -1,22 +1,22 @@ rustdesk ======== -Rustdesk server role for ansible +Deploy a Rustdesk server Requirements ------------ Ports: -``` -tcp 21115, 21116, 21117, 21118, 21119 -udp 21116 + +- `tcp`: `21115, 21116, 21117, 21118, 21119` +- `udp`: `21116` ``` Role Variables -------------- -``` rustdesk_server_version ``` — contains rustdesk-server version to be installed -``` rustdesk_client_version ``` — contains rustdesk-client version for executable to be configured +`rustdesk_server_version`: contains rustdesk-server version to be installed +`rustdesk_client_version`: contains rustdesk-client version for executable to be configured Dependencies ------------ diff --git a/roles/sftp_share/README.md b/roles/sftp_share/README.md index 325bde5..f30718f 100644 --- a/roles/sftp_share/README.md +++ b/roles/sftp_share/README.md @@ -1,7 +1,7 @@ sftp_share ========= -Creates a user account and directories for secured SFTP data exchange (one user = one share). +Creates a user account and directories for a secured SFTP data exchange (one user = one share). The role creates a dedicated SSH config under `/etc/ssh/sshd_config.d/`, configuring: diff --git a/roles/smartctl_exporter/README.md b/roles/smartctl_exporter/README.md index cb38291..c18951b 100644 --- a/roles/smartctl_exporter/README.md +++ b/roles/smartctl_exporter/README.md @@ -1,18 +1,18 @@ 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. Requirements ------------ -smartctl +- `smartctl` Role Variables -------------- -The exporter will scan the system for available devices if no ```--smartctl.device``` flags are used. The format of web.config file id described [here](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md). If ```smartctl_exp_source_web_config_dir``` is defined, role searches for ```web_smartctl.conf``` file and copy it to target host to ```smartctl_exp_web_config_dir``` directory +The exporter will scan the system for available devices if no `--smartctl.device` flags are used. The format of web.config file id described [here](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md). If `smartctl_exp_source_web_config_dir` is defined, role searches for `web_smartctl.conf` file and copy it to target host to `smartctl_exp_web_config_dir` directory + ```yaml ---- smartctl_exp_port: "localhost:9633" # Addresses on which to expose metrics and web interface. Repeatable for multiple addresses. smartctl_exp_version: "0.14.0" # exporter version to install smartctl_exp_dir: "/etc/exporters" # where to download and unarchive expoter diff --git a/roles/sshd/README.md b/roles/sshd/README.md index e62e184..6702986 100644 --- a/roles/sshd/README.md +++ b/roles/sshd/README.md @@ -1,7 +1,7 @@ sshd ==== -Deploy a hardened sshd server +Deploy a hardened `sshd` server Requirements ------------ diff --git a/roles/users/README.md b/roles/users/README.md index 4e101ee..4b6116d 100644 --- a/roles/users/README.md +++ b/roles/users/README.md @@ -4,6 +4,7 @@ users Create user accounts according to a YAML manifest. Controls: + - username and UID - groupname and GID - homedir creation @@ -20,8 +21,8 @@ Requirements Target node: -- systemd -- openssh +- `systemd` +- openssh client library Controller: @@ -58,4 +59,4 @@ Author Information ------------------ corvus-migratorius@proton.me -masayganova@gmail.com +sayganova@genlab.llc diff --git a/roles/wg_spoke/README.md b/roles/wg_spoke/README.md index 19896ff..14c782c 100644 --- a/roles/wg_spoke/README.md +++ b/roles/wg_spoke/README.md @@ -1,12 +1,12 @@ wg_spoke ========= -Configure the host as a Spoke in Wireguard Spoke&Hub topology. +Configure the host as a Spoke in the Wireguard Spoke-and-Hub topology. Requirements ------------ -Ubuntu 20.04, 22.04 or 24.04. +Ubuntu 22.04 or 24.04. Role Variables --------------