Nazwa roli

Tutaj znajduje się krótki opis roli.

Wymagania

Wszelkie wstępne wymagania, które mogą nie być zawarte w Ansible lub w roli, powinny być tutaj wymienione. Na przykład, jeśli rola używa modułu EC2, warto wspomnieć w tej sekcji, że wymagany jest pakiet boto.

Zmienne roli

Tutaj powinien znaleźć się opis zmiennych, które można ustawić dla tej roli, łącznie z wszelkimi zmiennymi, które znajdują się w plikach defaults/main.yml, vars/main.yml oraz wszelkimi zmiennymi, które można powinno ustawić jako parametry roli. Wszelkie zmienne odczytywane z innych ról i/lub z globalnego zakresu (tj. hostvars, group vars itp.) również powinny być tutaj wymienione.

Zależności

Lista innych ról dostępnych w Galaxy powinna być tutaj umieszczona, oraz 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

Zaleca się dołączenie przykładu użycia roli (np. z przekazywaniem zmiennych jako parametry), co będzie pomocne dla użytkowników:

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

Licencja

BSD

Informacje o autorze

Opcjonalna sekcja dla autorów roli, aby dołączyć informacje kontaktowe lub stronę internetową (HTML nie jest dozwolony).