rougail-output-ansible/tests/results-doc/test_namespace/60_5family_dynamic_calc_description.sh

87 lines
17 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
A dynamic famify for val1 or A dynamic famify for val2
▌ 🛈 Informations
▌ 
▌ This family builds families dynamically.
▌ Path:
▌  • dynval1
▌  • dynval2
▌  basic 
▌ Identifiers:
▌  • val1
▌  • val2
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃ Type  ┃ Access control  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
dynval1.var │ A dynamic variable for val1 or val2. │  string   mandatory  │  basic  │
dynval2.var │ │ │ │
└──────────────────────────────────────────────┴──────────────────────────────────────────────┴─────────────────────────────────────────────┴──────────────────────────────────────────────┘
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃ Default value  ┃ Type  ┃ Access control  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
var1 │ A new variable. │ │  string   mandatory  │  basic   disabled  │
│ │ │ │ │ Disabled: when the variable │
│ │ │ │ │ "dynval1.var" has the value "val"
├────────────────────────────────────┼────────────────────────────────────┼─────────────────────────────────────┼────────────────────────────────────┼─────────────────────────────────────┤
var2 │ A new variable. │ • the value of the variable │  string   multiple   mandatory  │  standard  │
│ │ │ "dynval1.var" │ │ │
│ │ │ • the value of the variable │ │ │
│ │ │ "dynval2.var" │ │ │
└────────────────────────────────────┴────────────────────────────────────┴─────────────────────────────────────┴────────────────────────────────────┴─────────────────────────────────────┘
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 
 dynval1: 
 var: string1 # A dynamic variable for {{ identifier }} 
 dynval2: 
 var: string1 # A dynamic variable for {{ identifier }} 
 var1: 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 
 dynval1: # A dynamic famify for {{ identifier }} 
 var: string1 # A dynamic variable for {{ identifier }} 
 dynval2: # A dynamic famify for {{ identifier }} 
 var: string1 # A dynamic variable for {{ identifier }} 
 var1: string1 # A new variable