Rollenname

Hier steht eine kurze Beschreibung der Rolle.

Anforderungen

Alle Voraussetzungen, die möglicherweise nicht durch Ansible selbst oder die Rolle abgedeckt sind, sollten hier erwähnt werden. Wenn die Rolle zum Beispiel das EC2-Modul verwendet, wäre es sinnvoll zu erwähnen, dass das boto-Paket benötigt wird.

Rollenvariablen

Hier sollte eine Beschreibung der einstellbaren Variablen für diese Rolle stehen, einschließlich aller Variablen, die sich in defaults/main.yml, vars/main.yml befinden und solcher Variablen, die über Parameter an die Rolle übergeben werden können/sollen. Alle Variablen, die von anderen Rollen und/oder dem globalen Bereich (z. B. hostvars, group vars usw.) gelesen werden, sollten hier ebenfalls erwähnt werden.

Abhängigkeiten

Eine Liste von anderen Rollen, die auf Galaxy gehostet werden, sollte hier stehen, sowie alle Details hinsichtlich der Parameter, die möglicherweise für andere Rollen gesetzt werden müssen, oder Variablen, die von anderen Rollen verwendet werden.

Beispiel-Playbook

Ein Beispiel dafür, wie man seine Rolle verwendet (zum Beispiel mit übergebenen Variablen als Parameter) ist immer hilfreich für die Benutzer:

- hosts: servers
  roles:
     - { role: benutzername.rollenname, x: 42 }

Lizenz

BSD

Autoreninformationen

Ein optionaler Abschnitt für die Autoren der Rolle, um Kontaktdaten oder eine Website einzufügen (HTML ist nicht erlaubt).