rougail-output-ansible/tests/results-doc/test_namespace_mandatory/20_7help_family.sh

87 lines
14 KiB
Bash
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Ansible role: Rougail
▌ 🛈 Informations
▌ 
▌  basic 
Role variables
The first family
▌ 🛈 Informations
▌ 
▌ Multi line.
▌ 
▌ Help.
▌ 
▌ With useful information.
▌ Path: family1
▌  basic 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Type  ┃ Access control  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
family1.var │  string   mandatory  │  basic  │
└─────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────┴──────────────────────────────────────────────────────────────┘
The second family
▌ 🛈 Informations
▌ 
▌ Multi line.
▌ Help.
▌ With useful information.
▌ Path: family2
▌  basic 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Type  ┃ Access control  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
family2.var │  string   mandatory  │  basic  │
└─────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────┴──────────────────────────────────────────────────────────────┘
Example playbook with Rougail
▌ 🛈 Informations
▌ 
▌ Do not forget to add Rougail structural file as Rougail types
Add to your structural file something like:
--- 
path: 
 to: 
 my_rougail: 
 type: rougail 
 family1: 
 var: string1 
 family2: 
 var: string1 
Add to your playbook:
--- 
- name: Rougail 
 hosts: server 
 roles: 
 - role: <author>.rougail 
 vars: path.to.rougail 
Example playbook
--- 
- name: Rougail 
 hosts: server 
 roles: 
 - role: <author>.rougail 
 vars: 
 rougail: # Rougail 
 family1: # The first family 
 var: string1 
 family2: # The second family 
 var: string1