Nazwa roli

Tutaj znajduje się krótki opis roli.

Wymagania

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

Zmienne roli

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

Zależności

Lista innych ról dostępnych na Galaxy powinna znajdować się tutaj, wraz ze wszelkimi szczegółami dotyczącymi parametrów, które mogą być wymagane dla innych ról, lub zmiennych używanych z innych ról.

Przykładowy plan

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

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

Licencja

BSD

Informacje o autorze

Opcjonalna sekcja dla autorów ról, aby podać informacje kontaktowe lub stronę internetową (HTML nie jest dozwolone).