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 --------------