Rollenname

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, wäre es gut, 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 und alle Variablen, die über Parameter an die Rolle übergeben werden können/sollten, befinden. Auch Variablen, die aus anderen Rollen und/oder dem globalen Bereich (z. B. hostvars, Gruppenvariablen usw.) gelesen werden, sollten hier erwähnt werden.

Abhängigkeiten

Hier sollte eine Liste anderer Rollen, die auf Galaxy gehostet sind, stehen, sowie alle Einzelheiten 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 dafür, wie man die Rolle verwendet (zum Beispiel mit übergebenen Variablen als Parameter), einzuschließen:

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

Lizenz

BSD

Autorinformationen

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