Rollenname

Hier steht eine kurze Beschreibung der Rolle.

Anforderungen

Hier sollten alle Voraussetzungen erwähnt werden, die möglicherweise nicht von Ansible selbst oder der Rolle abgedeckt sind. Zum Beispiel, wenn die Rolle das EC2-Modul verwendet, könnte es hilfreich sein, 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 sich in defaults/main.yml, vars/main.yml befinden und aller Variablen, die über Parameter an die Rolle gesetzt werden können/sollten. Alle Variablen, die von anderen Rollen und/oder dem globalen Bereich (d. h. Host-Variablen, Gruppen-Variablen 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 Details zu Parametern, die für andere Rollen gesetzt werden müssen, oder Variablen, die aus anderen Rollen verwendet werden.

Beispiel-Playbook

Es ist immer schön, ein Beispiel für die Verwendung Ihrer Rolle (zum Beispiel mit als Parameter übergebenen Variablen) hinzuzufügen:

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

Lizenz

BSD

Autoreninformation

Ein optionaler Abschnitt, in dem die Autoren der Rolle Kontaktinformationen oder eine Website angeben können (HTML ist nicht erlaubt).