Rollenname

Hier steht eine kurze Beschreibung der Rolle.

Anforderungen

Hier sollten alle Voraussetzungen aufgeführt werden, die möglicherweise nicht durch Ansible selbst oder die Rolle abgedeckt sind. Wenn die Rolle zum Beispiel das EC2-Modul verwendet, ist es eine gute Idee, in diesem Abschnitt 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 in defaults/main.yml, vars/main.yml enthalten sind und aller Variablen, die über Parameter an die Rolle gesetzt werden können/sollen. Alle Variablen, die von anderen Rollen und/oder dem globalen Bereich (z.B. Hostvars, Gruppenvariablen usw.) gelesen werden, sollten ebenfalls hier erwähnt werden.

Abhängigkeiten

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

Beispiel-Playbook

Es ist immer hilfreich für die Benutzer, ein Beispiel zu haben, wie man die Rolle verwendet (zum Beispiel mit übergebener Parameter):

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

Lizenz

BSD

Autoreninformation

Ein optionaler Abschnitt, in dem die Autoren der Rolle Kontaktinformationen oder eine Website angeben können (HTML ist nicht erlaubt).