From 156c4023b3c40c03cc6c911c57c8c6dc6b3e1226 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Fra=C3=9F?= Date: Sat, 15 Jun 2024 10:47:06 +0200 Subject: [PATCH] [mod] readme --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 556c231..7dcacdf 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ Sammlung von allgemeinen, wiederverwendbaren Ansible-Rollen ### Rollen - sollen jeweils eine Info-Datei enthalten (`roles//info.md`), in welcher kurz der Zweck der Rolle beschrieben, mögliche Besonderheiten für die Verwendung erklärt und nützliche Angaben wie Netz-Verweise aufgeführt werden +- sollen jeweils eine Variablen-Deklarations-Datei enthalten (`roles//vardef.json`), in welcher für alle verfügbaren Variablen folgende Angaben festgehalten werden sollen: + - Typ in [JSON-Schema](https://json-schema.org/)-Syntax + - bei Aufzählungs-Typen: die zulässigen Werte + - optional: Erläuterung #### Namen @@ -28,7 +32,7 @@ Sammlung von allgemeinen, wiederverwendbaren Ansible-Rollen - sollen nach folgendem Muster benannt sein: `var__`, wobei `` aussagekräftig sein soll (z.B. `server_port` statt `x1`) - sollen mit sinnvollen Standard-Werten belegt werden -- sollen aufgelistet/angekündigt/deklariert +- sollen aufgelistet/angekündigt/deklariert werden (`vardef.json`) - sollen möglichst primitiv sein, d.h. nur Wahrheits-Werte, Zahlen und (einfache) Zeichenketten @@ -48,3 +52,4 @@ Sammlung von allgemeinen, wiederverwendbaren Ansible-Rollen ## ToDo - [Blocks](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_blocks.html) verwenden +- [Handlers](https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html) verwenden