Nazwa roli

Tutaj znajduje się krótki opis roli.

Wymagania

Wszystkie wymagania wstępne, które mogą nie być objęte Ansible lub rolą, powinny być wymienione tutaj. Na przykład, jeśli rola korzysta z modułu EC2, warto wspomnieć w tym punkcie, że wymagany jest pakiet boto.

Zmienne roli

Tutaj powinien się znaleźć opis zmiennych, które można ustawić dla tej roli, w tym wszelkie zmienne znajdujące się w defaults/main.yml, vars/main.yml oraz jakiekolwiek zmienne, które można lub należy ustawić jako parametry roli. Należy również wspomnieć o zmiennych odczytywanych z innych ról i/lub z globalnego zasięgu (np. hostvars, group vars itp.).

Zależności

Tutaj znajduje się lista innych ról hostowanych na Galaxy, a także wszelkie szczegóły dotyczące parametrów, które mogą być wymagane dla innych ról, lub zmiennych używanych z innych ról.

Przykładowy Playbook

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

- hosts: serwery
  roles:
     - { role: nazwa_użytkownika.nazwa_roli, x: 42 }

Licencja

BSD

Informacje o autorze

Opcjonalny dział dla autorów roli do zamieszczania informacji kontaktowych lub strony internetowej (HTML nie jest dozwolony).