Nazwa roli

Tutaj znajduje się krótki opis roli.

Wymagania

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

Zmienne roli

Tutaj należy opisać zmienne, które można ustawiać dla tej roli, w tym zmienne znajdujące się w defaults/main.yml, vars/main.yml oraz wszelkie zmienne, które można lub powinno ustawiać za pomocą parametrów roli. Należy również wspomnieć o zmiennych, które są odczytywane z innych ról i/lub z globalnego zakresu (np. hostvars, vars grup).

Zależności

Lista innych ról dostępnych w Galaxy powinna się tutaj znaleźć, wraz ze wszelkimi informacjami na temat parametrów, które mogą wymagać ustawienia 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 przekazanymi jako parametry zmiennymi), jest również miłym dodatkiem dla użytkowników:

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

Licencja

BSD

Informacje o autorze

Opcjonalna sekcja, w której autorzy roli mogą zamieścić informacje kontaktowe lub link do strony internetowej (HTML nie jest dozwolone).