misc/ansible-base
0
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

[mod] readme

Browse source
This commit is contained in:
roydfalk 2024-06-15 10:47:06 +02:00
parent 9d1f829cd7
commit 156c4023b3
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -14,6 +14,10 @@ Sammlung von allgemeinen, wiederverwendbaren Ansible-Rollen
### Rollen
- sollen jeweils eine Info-Datei enthalten (`roles/<rollen-name>/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/<rollen-name>/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_<rollen-name>_<bezeichnung>`, wobei `<bezeichnung>` 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