rougail-output-ansible/tests/results-doc/test_namespace/00_8test.sh

83 lines
19 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  ┃ Default value  ┃ Type  ┃ Access control  ┃ Validator  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
var1 │ The first variable. │ │  string   mandatory  │  basic  │ │
│ │ Example: test │ │ │ │ │
├──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼───────────────────────────────┤
var2 │ The second variable. │ value │  string   mandatory  │  standard  │ │
│ │ Example: test │ │ │ │ │
├──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼───────────────────────────────┤
var3 │ The third variable. │ │  string   mandatory  │  basic  │ │
│ │ Examples: │ │ │ │ │
│ │ • test1 │ │ │ │ │
│ │ • test2 │ │ │ │ │
├──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼───────────────────────────────┤
var4 │ The forth variable. │ │  string  │  standard  │ │
│ │ Examples: │ │ │ │ │
│ │ • null │ │ │ │ │
│ │ • test1 │ │ │ │ │
│ │ • test2 │ │ │ │ │
├──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼───────────────────────────────┤
var5 │ The fifth variable. │ true boolean   mandatory  │  standard  │ │
│ │ Example: false │ │ │ │ │
├──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼───────────────────────────────┤
var6 │ The sixth variable. │ │  string   multiple    │  basic  │  unique  │
│ │ Examples: │ │ mandatory  │ │ │
│ │ • test1 │ │ │ │ │
│ │ • test2 │ │ │ │ │
└──────────────────────────────┴──────────────────────────────┴──────────────────────────────┴──────────────────────────────┴──────────────────────────────┴───────────────────────────────┘
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: test 
 var3: test1 
 var6: 
 - test1 
 - test2 
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: test # The first variable 
 var3: test1 # The third variable 
 var6: # The sixth variable 
 - test1 
 - test2