Wapi format

Description

Le format wapi va vous permettre de rajouter des information a votre playbook qui seront automatiquement interprété dans les pages wapi de vos playbooks.

Pour faire quoi

• Ajouter des metadata dans votre playbook
• Définir les extra vars, ce qui permet la génération automatique d'un formulaire pour lancer le playbook
• Définir des configuration. Voir Wapi format : configurations

Comment

Il vous suffit de rajouter le premier play de votre playbook, une clef wapi dans les variables.

Cette clef va contenir dans un dictionnaire les informations. Le format du dictionnaire est le suivant.

La section metadata

Ici on les informations générales sur le playbook que sont d'ordre informative.

Dans WAPI, elles seront affichées dans la partie doc de la page de votre playbook

Champs attendus:

• author, la personne en charge du playbook
• state, l'état d'écriture du playbook, par exemple dev, test, prod.
• description, une description au format markdown

Si d'autre clef sont ajoutées metadata elle sont affichées comme telles. Ca permet d'avoir des informations customs.

La section launch

C'est ici que l'on va définir les extra vars et les autres information qui seront nécessaire pour générer le formulaire. Les clef attendues sont trois et autres seront ignorée

• options, (string) les options à utiliser lancer votre playbook, par exemple -v --diff
• inventories, (list) les inventaires ansible à utiliser pour votre playbook si vous n'utiliser pas les inventaires par défaut définie dans la configuration ansible.
• extra_vars, (dict) la définitions des extra vars attendues par votre playbook. Voir le détail dans la page TODO

La section configurations

Permet de définir des configurations de lancement. Voir les détail dans la page Wapi format : configurations

Example

• Playbook d'exemple sous git test.yml