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. Zum Beispiel, wenn die Rolle das EC2-Modul verwendet, kann es sinnvoll sein, in diesem Abschnitt 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 und aller Variablen, die über Parameter an die Rolle übergeben werden können/sollten. Alle Variablen, die von anderen Rollen und/oder dem globalen Umfang (z.B. hostvars, group vars usw.) gelesen werden, sollten ebenfalls hier erwähnt werden.

Abhängigkeiten

Eine Liste anderer Rollen, die auf Galaxy gehostet werden, sollte hier stehen, sowie alle Details zu Parametern, die für andere Rollen festgelegt werden müssen, oder Variablen, die von anderen Rollen verwendet werden.

Beispiel-Playbook

Ein Beispiel, wie man die Rolle verwendet (zum Beispiel mit übergebenen Variablen), ist auch für die Benutzer hilfreich:

- hosts: server
  roles:
     - { role: username.rolenname, x: 42 }

Lizenz

BSD

Autoreninformationen

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