From 998a09119eec53b129be88e28ca6eb47d5949750 Mon Sep 17 00:00:00 2001 From: Sergei Petrosian Date: Fri, 8 Sep 2023 15:13:59 +0200 Subject: [PATCH] docs(changelog): version 1.0.2 [citest skip] Update changelog and .README.html for version 1.0.2 Signed-off-by: Sergei Petrosian --- .README.html | 262 +++++++++++++++++++++++++++++++++++++++++++++++++++ CHANGELOG.md | 34 +++++++ 2 files changed, 296 insertions(+) create mode 100644 .README.html diff --git a/.README.html b/.README.html new file mode 100644 index 0000000..3eb471f --- /dev/null +++ b/.README.html @@ -0,0 +1,262 @@ + + + + + + + + systemd + + + + + + +
+
+

systemd

+
+
+ +
+

+

Ansible role that can be used to deploy unit files and manage systemd +units. Role is a convenience wrapper around systemd and template Ansible +Core modules.

+

Role Variables

+

List of variables consumed by the role follows, note that none of +them is mandatory.

+

systemd_unit_files

+

List of systemd unit file names that should be deployed to managed +nodes.

+

systemd_unit_file_templates

+

List of systemd unit file names that should be deployed to managed +nodes. Each name should correspond to Jinja template file that will be +templated out to managed nodes, e.g. for unit foo.service +the respective foo.service.j2 will be templated and copied +over to managed nodes. If the local file has a .j2 suffix +it will be stripped to form the service name.

+

systemd_dropins

+

List of systemd drop in files that will be templated out to managed +hosts and will extend respective systemd unit files. Name of the unit +file that given entry extends is encoded in the name of the entry +itself. For example, for entry foo.service.conf it is +expected that foo.service.conf.j2 Jinja template exists and +resulting dropin file will extend foo.service unit file. If +the local file has a .j2 suffix it will be stripped to form +the service name.

+

systemd_started_units

+

List of unit names that shall be started via systemd.

+

systemd_stopped_units

+

List of unit names that shall be stopped via systemd.

+

systemd_restarted_units

+

List of unit names that shall be restarted via systemd.

+

systemd_reloaded_units

+

List of unit names that shall be reloaded via systemd.

+

systemd_enabled_units

+

List of unit files that shall be enabled via systemd.

+

systemd_disabled_units

+

List of unit files that shall be disabled via systemd.

+

systemd_masked_units

+

List of unit files that shall be masked via systemd.

+

systemd_unmasked_units

+

List of unit files that shall be unmasked via systemd.

+

Example of setting the variables:

+
systemd_unit_files:
+  - foo.service
+  - bar.service
+systemd_dropins:
+  - cups.service.conf.j2
+  - avahi-daemon.service.conf.j2
+systemd_started_units:
+  - foo.service
+  - bar.service
+systemd_enabled_units:
+  - foo.service
+  - bar.service
+

Variables Exported by the +Role

+

systemd_units

+

Variable shall contain a list of dictionaries where each entry +describes state of one systemd unit present on the managed host.

+

Example Playbook

+

Including an example of how to use your role (for instance, with +variables passed in as parameters) is always nice for users too:

+
- name: Deploy and start systemd unit
+  hosts: all
+  vars:
+    systemd_unit_files:
+      - foo.service
+    systemd_started_units:
+      - foo.service
+    systemd_enabled_units:
+      - foo.service
+  roles:
+    - linux-system-roles.systemd
+

License

+

MIT

+

Author

+

Michal Sekletar msekleta@redhat.com

+
+ + diff --git a/CHANGELOG.md b/CHANGELOG.md index 7cfde25..6ff7454 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,40 @@ Changelog ========= +[1.0.2] - 2023-09-08 +-------------------- + +### Other Changes + +- ci: Add markdownlint, test_converting_readme, and build_docs workflows (#15) + + - markdownlint runs against README.md to avoid any issues with + converting it to HTML + - test_converting_readme converts README.md > HTML and uploads this test + artifact to ensure that conversion works fine + - build_docs converts README.md > HTML and pushes the result to the + docs branch to publish dosc to GitHub pages site. + - Fix markdown issues in README.md + + Signed-off-by: Sergei Petrosian + +- docs: Make badges consistent, run markdownlint on all .md files (#16) + + - Consistently generate badges for GH workflows in README RHELPLAN-146921 + - Run markdownlint on all .md files + - Add custom-woke-action if not used already + - Rename woke action to Woke for a pretty badge + + Signed-off-by: Sergei Petrosian + +- ci: Remove badges from README.md prior to converting to HTML (#17) + + - Remove thematic break after badges + - Remove badges from README.md prior to converting to HTML + + Signed-off-by: Sergei Petrosian + + [1.0.1] - 2023-07-26 --------------------