Rollenname

Eine kurze Beschreibung der Rolle gehört hierhin.

Anforderungen

Alle Voraussetzungen, die möglicherweise nicht von Ansible selbst oder der Rolle abgedeckt sind, sollten hier erwähnt werden. Wenn die Rolle beispielsweise das EC2-Modul verwendet, ist es sinnvoll, 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 enthalten sind, sowie sämtlicher Variablen, die über Parameter an die Rolle übergeben werden können/sollen. Alle Variablen, die aus anderen Rollen und/oder dem globalen Bereich (z. B. hostvars, group vars usw.) gelesen werden, sollten ebenfalls hier erwähnt werden.

Abhängigkeiten

Eine Liste anderer Rollen, die in Galaxy gehostet werden, sollte hier stehen, sowie alle Details zu Parametern, die möglicherweise 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 Benutzer, ein Beispiel zu haben, wie man Ihre Rolle verwendet (zum Beispiel mit übergebenen Variablen als Parameter):

- 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 anzugeben (HTML ist nicht erlaubt).