Rollenbezeichnung

Hier folgt eine kurze Beschreibung der Rolle.

Anforderungen

Alle Voraussetzungen, die möglicherweise nicht von Ansible selbst oder der Rolle abgedeckt sind, sollten hier erwähnt werden. Zum Beispiel, wenn die Rolle das EC2-Modul verwendet, wäre es sinnvoll, in diesem Abschnitt darauf hinzuweisen, dass das Boto-Paket erforderlich ist.

Rollenvariablen

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

Abhängigkeiten

Eine Liste von anderen Rollen, die auf Galaxy gehostet werden, sollte hier aufgeführt werden, sowie Details zu Parametern, die möglicherweise für andere Rollen gesetzt werden müssen, oder Variablen, die aus anderen Rollen verwendet werden.

Beispiel-Playbook

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

- hosts: server
  roles:
     - { role: benutzername.rollenbezeichnung, x: 42 }

Lizenz

BSD

Autoreninformationen

Ein optionaler Abschnitt für die Autoren der Rolle, um Kontaktinformationen oder eine Webseite anzugeben (HTML ist nicht erlaubt).