From f817ed54a45926bd4eeac3c1a6ff86f31d4a1776 Mon Sep 17 00:00:00 2001 From: Alexander Gorelyshev Date: Thu, 18 Dec 2025 17:21:37 +0400 Subject: [PATCH] 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 -------