Nazwa Roli

Tutaj znajduje się krótki opis roli.

Wymagania

Wszelkie wstępne wymagania, które mogą nie być objęte Ansible lub rolą, powinny być tutaj wspomniane. Na przykład, jeśli rola używa modułu EC2, warto zaznaczyć w tej sekcji, że potrzebny jest pakiet boto.

Zmienne Roli

Opis zmiennych, które można ustawić dla tej roli, powinien znaleźć się tutaj, w tym zmienne, które znajdują się w defaults/main.yml, vars/main.yml oraz zmienne, które mogą/ powinny być ustawiane poprzez parametry roli. Tutaj należy także wspomnieć o zmiennych odczytywanych z innych ról i/lub ze zasięgu globalnego (tj. hostvars, group vars itp.).

Zależności

Tutaj powinna znaleźć się lista innych ról hostowanych na Galaxy oraz wszelkie szczegóły dotyczące parametrów, które mogą potrzebować być ustawione dla innych ról, lub zmiennych używanych z innych ról.

Przykładowy Playbook

Zamieszczenie przykładu, jak używać swojej roli (na przykład, z przekazanymi zmiennymi jako parametry), jest również miłe dla użytkowników:

- hosts: serwery
  roles:
     - { role: username.nazwa_roli, x: 42 }

Licencja

BSD

Informacje o Autorze

Opcjonalna sekcja dla autorów roli, aby umieścić informacje kontaktowe lub stronę internetową (HTML nie jest dozwolone).