Skip to content

Commit 820a640

Browse files
committed
fix(roles/mailx,policycoreutils,yum_utils): fix grammar, sort params, rewrite READMEs
Fix grammar in task names (mailx: "make" -> "makes", policycoreutils: "are" -> "is"). Sort template module parameters alphabetically in mailx. Rewrite all three READMEs from table format to structured bullet format with skip variables section.
1 parent 86d1645 commit 820a640

6 files changed

Lines changed: 81 additions & 15 deletions

File tree

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1515
* Update pre-commit hooks to latest versions
1616
* Unify CONTRIBUTING and convert from reStructuredText to Markdown
1717

18+
### Fixed
19+
20+
* **role:apache_httpd**: Fix `apache_httpd__mod_security_coreruleset_version` default value in README (4.4.0 -> 4.24.1), fix prefork variable names in README (`spare_threads` -> `spare_servers`), fix various typos ("best practise", "Tipp")
21+
* **role:mailx**: Fix grammar in task name ("make" -> "makes"), sort template module parameters alphabetically
22+
* **role:policycoreutils**: Fix grammar in task name ("are" -> "is")
23+
1824
### Breaking Changes
1925

2026
* **role:nfs_server**: Rework `nfs_server__exports` from a list of strings to a list of dictionaries with new `path`, `clients`, `owner`, `group`, and `mode` subkeys
@@ -23,6 +29,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2329

2430
### Added
2531

32+
* Add `playbooks/README.md` documenting all playbooks with their roles in execution order and available skip variables
33+
* **role:apache_httpd**: Add platform-specific behavior section, wsgi example, and document localhost endpoints in README
34+
* **role:apache_httpd**: Add skip variables section to README linking to relevant playbooks
35+
* **role:mailx**: Add skip variables section to README linking to relevant playbooks
36+
* **role:policycoreutils**: Add skip variables section to README linking to relevant playbooks
37+
* **role:yum_utils**: Add skip variables section to README linking to relevant playbooks
2638
* **plugin:bitwarden_item**: Add file-based item cache to reduce `bw serve` API calls, preventing crashes under load. Cache is stored in `$XDG_RUNTIME_DIR` (RAM-backed tmpfs) with `/tmp` fallback. After create/edit operations, the cache is updated inline to avoid expensive full re-syncs, with a 1-second sleep as rate limit to prevent Bitwarden API errors. Convert `is_unlocked` to a property to fix it never being called.
2739
* **role:freeipa_server**: Add `--diff` support for all FreeIPA modules and add `freeipa_server:configure` tag
2840
* **role:mariadb_server**: Add `mariadb_server__cnf_wsrep_log_conflicts` and `mariadb_server__cnf_wsrep_retry_autocommit` variables

roles/mailx/README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
11
# Ansible Role linuxfabrik.lfops.mailx
22

3-
This role installs [mailx](http://heirloom.sourceforge.net/mailx.html) and deploys a bash wrapper script that make sending mail easier to `/root/send-mail`.
3+
This role installs [mailx](http://heirloom.sourceforge.net/mailx.html) and deploys a bash wrapper script that makes sending mail easier to `/root/send-mail`.
44

55

66
## Tags
77

8-
| Tag | What it does | Reload / Restart |
9-
| --- | ------------ | ---------------- |
10-
| `mailx` | Installs mailx and deploys wrapper script | - |
8+
`mailx`
9+
10+
* Installs the mailx package.
11+
* Deploys a bash wrapper script to `/root/send-mail`.
12+
* Triggers: none.
13+
14+
15+
## Skip Variables
16+
17+
This role is used in several playbooks that provide skip variables to disable specific dependencies. See the playbooks documentation for details:
18+
19+
* [mailto_root.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#mailto_rootyml)
20+
* [postfix.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#postfixyml)
21+
* [setup_basic.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_basicyml)
22+
* [system_update.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#system_updateyml)
1123

1224

1325
## License

roles/mailx/tasks/main.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
name: '{{ mailx__package }}'
1111
state: 'present'
1212

13-
- name: 'Deploy bash wrapper script that make sending mail easier to /root/send-mail'
13+
- name: 'Deploy bash wrapper script that makes sending mail easier to /root/send-mail'
1414
ansible.builtin.template:
1515
backup: true
16-
src: 'root/send-mail.j2'
1716
dest: '/root/send-mail'
18-
owner: 'root'
1917
mode: 0o755
18+
owner: 'root'
19+
src: 'root/send-mail.j2'
2020

2121
tags:
2222
- 'mailx'

roles/policycoreutils/README.md

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,34 @@ This role installs the SELinux policy core python utilities.
55

66
## Tags
77

8-
| Tag | What it does | Reload / Restart |
9-
| --- | ------------ | ---------------- |
10-
| `policycoreutils` | Installs SELinux policy core python utilities | - |
8+
`policycoreutils`
9+
10+
* Installs the `policycoreutils-python-utils` package.
11+
* Triggers: none.
12+
13+
14+
## Skip Variables
15+
16+
This role is used in several playbooks that provide skip variables to disable specific dependencies. See the playbooks documentation for details:
17+
18+
* [apache_httpd.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#apache_httpdyml)
19+
* [apache_tomcat.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#apache_tomcatyml)
20+
* [clamav.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#clamavyml)
21+
* [fail2ban.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#fail2banyml)
22+
* [mariadb_server.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#mariadb_serveryml)
23+
* [openvpn_server.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#openvpn_serveryml)
24+
* [selinux.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#selinexyml)
25+
* [setup_basic.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_basicyml)
26+
* [setup_grav.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_gravyml)
27+
* [setup_graylog_datanode.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_graylog_datanodeyml)
28+
* [setup_graylog_server.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_graylog_serveryml)
29+
* [setup_icinga2_master.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_icinga2_masteryml)
30+
* [setup_keycloak.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_keycloakyml)
31+
* [setup_librenms.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_librenmsyml)
32+
* [setup_mastodon.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_mastodonyml)
33+
* [setup_moodle.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_moodleyml)
34+
* [setup_nextcloud.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_nextcloudyml)
35+
* [setup_wordpress.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_wordpressyml)
1136

1237

1338
## License

roles/policycoreutils/tasks/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
name: 'shared'
66
tasks_from: 'platform-variables.yml'
77

8-
- name: 'Make sure SELinux {{ policycoreutils__package }} are installed'
8+
- name: 'Make sure SELinux {{ policycoreutils__package }} is installed'
99
ansible.builtin.package:
1010
name: '{{ policycoreutils__package }}'
1111
state: 'present'

roles/yum_utils/README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,30 @@
11
# Ansible Role linuxfabrik.lfops.yum_utils
22

3-
This role simply installs `yum-utils` package.
3+
This role installs the `yum-utils` or `dnf-utils` package.
44

55

66
## Tags
77

8-
| Tag | What it does | Reload / Restart |
9-
| --- | ------------ | ---------------- |
10-
| `yum_utils` | Installs yum-utils or dnf-utils package | - |
8+
`yum_utils`
9+
10+
* Installs the `yum-utils` or `dnf-utils` package.
11+
* Triggers: none.
12+
13+
14+
## Skip Variables
15+
16+
This role is used in several playbooks that provide skip variables to disable specific dependencies. See the playbooks documentation for details:
17+
18+
* [icingaweb2.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#icingaweb2yml)
19+
* [mirror.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#mirroryml)
20+
* [php.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#phpyml)
21+
* [setup_basic.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_basicyml)
22+
* [setup_grav.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_gravyml)
23+
* [setup_icinga2_master.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_icinga2_masteryml)
24+
* [setup_librenms.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_librenmsyml)
25+
* [setup_nextcloud.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_nextcloudyml)
26+
* [setup_wordpress.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#setup_wordpressyml)
27+
* [system_update.yml](https://github.com/Linuxfabrik/lfops/blob/main/playbooks/README.md#system_updateyml)
1128

1229

1330
## License

0 commit comments

Comments
 (0)