Nazwa roli

Tutaj znajduje się krótki opis roli.

Wymagania

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

Zmienne roli

Tutaj powinien znajdować się opis zmiennych, które można ustawić dla tej roli, w tym wszelkich zmiennych znajdujących się w defaults/main.yml, vars/main.yml oraz zmiennych, które można powinno się ustawiać przez parametry roli. Wszelkie zmienne, które są odczytywane z innych ról i/lub z zakresu globalnego (np. hostvars, group vars itp.) również powinny być tutaj wymienione.

Zależności

Lista innych ról dostępnych na Galaxy powinna znajdować się tutaj, a także wszelkie szczegóły dotyczące parametrów, które mogą wymagać ustawienia dla innych ról lub zmiennych, które są używane z innych ról.

Przykładowy Playbook

Warto dołączyć przykład użycia swojej roli (na przykład, z przekazanymi zmiennymi jako parametry), co będzie miłe dla użytkowników:

- hosts: serwery
  roles:
     - { role: nazwa_użytkownika.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 dozwolony).