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

94 lines
12 KiB
Bash
Raw Normal View History

2026-01-14 14:25:35 +01:00
Ansible role: Rougail
▌ 🛈 Informations
▌ 
▌  basic 
Role variables
2026-02-21 21:31:34 +01:00
┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
 ┃ ┃ Default  ┃ ┃ Access  ┃ ┃
 Variable  ┃ Descripti… ┃ value  ┃ Type  ┃ control  ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
var1 │ The first │ │  string    │  basic  │ │
│ │ variable. │ │ mandatory  │ │ │
│ │ Example: │ │ │ │ │
│ │ test │ │ │ │ │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
var2 │ The second │ value │  string    │  standard  │ │
│ │ variable. │ │ mandatory  │ │ │
│ │ Example: │ │ │ │ │
│ │ test │ │ │ │ │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
var3 │ The third │ │  string    │  basic  │ │
│ │ variable. │ │ mandatory  │ │ │
│ │ Examples: │ │ │ │ │
│ │ • test1 │ │ │ │ │
│ │ • test2 │ │ │ │ │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
var4 │ The forth │ │  string  │  standard  │ │
│ │ variable. │ │ │ │ │
│ │ Examples: │ │ │ │ │
│ │ • null │ │ │ │ │
│ │ • test1 │ │ │ │ │
│ │ • test2 │ │ │ │ │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
var5 │ The fifth │ true boolean  │  standard  │ │
│ │ variable. │ │ mandatory  │ │ │
│ │ Example: │ │ │ │ │
│ │ false │ │ │ │ │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
var6 │ The sixth │ │  string    │  basic  │  unique  │
│ │ variable. │ │ multiple  │ │ │
│ │ Examples: │ │ mandatory  │ │ │
│ │ • test1 │ │ │ │ │
│ │ • test2 │ │ │ │ │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘
2026-01-14 14:25:35 +01:00
2026-01-21 08:55:24 +01:00
Example playbook with Rougail
▌ 🛈 Informations
▌ 
2026-02-21 21:44:55 +01:00
▌ Do not forget to add Rougail structural file as Rougail types.
2026-01-21 08:55:24 +01:00
Add to your structural file something like:
2026-02-21 21:31:34 +01:00
--- 
path: 
 to: 
 my_rougail: 
 type: rougail 
 var1: test 
 var3: test1 
 var6: 
 - test1 
 - test2 
2026-01-21 08:55:24 +01:00
Add to your playbook:
2026-02-21 21:31:34 +01:00
--- 
- name: Rougail 
 hosts: server 
 roles: 
 - role: <author>.rougail 
 vars: path.to.rougail 
2026-01-21 08:55:24 +01:00
2026-01-14 14:25:35 +01:00
Example playbook
2026-02-21 21:31:34 +01:00
--- 
- 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