Rollenname

Hier befindet sich eine kurze Beschreibung der Rolle.

Anforderungen

Alle Voraussetzungen, die möglicherweise nicht von Ansible selbst oder der Rolle abgedeckt werden, sollten hier erwähnt werden. Wenn die Rolle beispielsweise das EC2-Modul verwendet, ist es eine gute Idee, 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 in defaults/main.yml, vars/main.yml und Variablen, die über Parameter an die Rolle gesetzt werden können/sollten, enthalten sind. Alle Variablen, die aus anderen Rollen und/oder dem globalen Bereich (d.h. hostvars, group vars usw.) gelesen werden, sollten hier ebenfalls erwähnt werden.

Abhängigkeiten

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

Beispiel-Playbook

Ein Beispiel, wie man Ihre Rolle benutzt (zum Beispiel mit Variablen, die als Parameter übergeben werden), ist ebenfalls immer hilfreich für die Benutzer:

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

Lizenz

BSD

Autoreninformationen

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