Rollenbezeichnung

Hier steht eine kurze Beschreibung der Rolle.

Anforderungen

Hier sollten alle Voraussetzungen erwähnt werden, die möglicherweise nicht durch Ansible selbst oder die Rolle abgedeckt sind. Wenn die Rolle beispielsweise das EC2-Modul verwendet, ist es eine gute Idee, in diesem Abschnitt zu erwähnen, dass das Paket boto erforderlich ist.

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 und allen Variablen enthalten sind, die über Parameter an die Rolle übergeben werden können/sollten. Alle Variablen, die aus anderen Rollen und/oder dem globalen Kontext (d.h. hostvars, Gruppenvariablen usw.) gelesen werden, sollten hier ebenfalls erwähnt werden.

Abhängigkeiten

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

Beispiel-Playbook

Es ist immer hilfreich für die Nutzer, ein Beispiel dafür zu haben, wie man die Rolle verwendet (zum Beispiel mit Variablen, die als Parameter übergeben werden):

- 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).