Rollenname

Hier steht eine kurze Beschreibung der Rolle.

Anforderungen

Hier sollten alle Voraussetzungen erwähnt werden, die möglicherweise nicht von Ansible selbst oder der Rolle abgedeckt sind. Wenn die Rolle beispielsweise das EC2-Modul verwendet, ist es sinnvoll, hier zu erwähnen, dass das boto-Paket erforderlich ist.

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, sowie aller Variablen, die über Parameter an die Rolle übergeben werden können/sollten. Auch Variablen, die aus anderen Rollen und/oder dem globalen Umfang (z. B. hostvars, group vars usw.) gelesen werden, sollten hier erwähnt werden.

Abhängigkeiten

Hier sollte eine Liste anderer Rollen, die auf Galaxy gehostet sind, sowie alle Details zu den Parametern angegeben werden, die für andere Rollen gesetzt werden müssen, oder Variablen, die von anderen Rollen verwendet werden.

Beispiel-Playbook

Ein Beispiel, wie man deine Rolle verwendet (zum Beispiel mit übergebenen Variablen), ist ebenfalls 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 Kontaktinformationen oder eine Website anzugeben (HTML ist nicht erlaubt).