Rollenname

Hier steht eine kurze Beschreibung der Rolle.

Voraussetzungen

Hier sollten alle Voraussetzungen erwähnt werden, die möglicherweise nicht durch Ansible selbst oder die Rolle abgedeckt sind. Zum Beispiel, wenn die Rolle das EC2-Modul verwendet, könnte 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 alle Variablen, die über Parameter an die Rolle übergeben werden können/sollten. Alle Variablen, die aus anderen Rollen und/oder dem globalen Bereich (d.h. hostvars, group vars usw.) gelesen werden, sollten ebenfalls hier erwähnt werden.

Abhängigkeiten

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

Beispiel-Playbook

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

- hosts: servers
  roles:
     - { role: username.rolename, x: 42 }

Lizenz

BSD

Autoreninformation

Ein optionaler Abschnitt, in dem die Autoren der Rolle Kontaktdaten oder eine Website einfügen können (HTML ist nicht erlaubt).