rougail-output-ansible/tests/results-doc/test_namespace_read_write/00_7help.sh

64 lines
12 KiB
Bash
Raw 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
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃ Type  ┃ Access control  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
var1 │ The first variable. │  string   mandatory  │  basic  │
│ │ Multi line │ │ │
│ │ │ │ │
│ │ Help │ │ │
│ │ │ │ │
│ │ With useful information. │ │ │
├──────────────────────────────────────────────┼──────────────────────────────────────────────┼─────────────────────────────────────────────┼──────────────────────────────────────────────┤
var2 │ The second variable. │  string   mandatory  │  basic  │
│ │ Multi line │ │ │
│ │ Help │ │ │
│ │ With useful information. │ │ │
└──────────────────────────────────────────────┴──────────────────────────────────────────────┴─────────────────────────────────────────────┴──────────────────────────────────────────────┘
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 
 var1: example 
 var2: example 
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 
 var1: example # The first variable 
 var2: example # The second variable