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

rougail.rougail - Rougail

This repository contains the  rougail.rougail  Ansible Collection.

This family is a namespace

  Variables

    The group variable "rougail" - Rougail

▌ 🛈 Informations                                                              
▌                                                                             
▌  standard                                                                   

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃               ┃               ┃               ┃ Access       ┃               ┃
┃ Variable      ┃ Description   ┃ Type          ┃ control      ┃ Validator     ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ var           │ A suffix      │  string       │  standard    │  unique       │
│               │ variable.     │ multiple      │              │               │
│               │ Examples:     │               │              │               │
│               │ • val1        │               │              │               │
│               │ • val2        │               │              │               │
└───────────────┴───────────────┴───────────────┴──────────────┴───────────────┘

      A dynamic family

▌ 🛈 Informations                                                              
▌                                                                             
▌ This family builds families dynamically.                                    
▌ Path:                                                                       
▌  • val1_dyn                                                                 
▌  • val2_dyn                                                                 
▌  standard                                                                   
▌ Identifiers: the value of the variable "a suffix variable" (var).           

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃               ┃               ┃               ┃              ┃ Access        ┃
┃ Variable      ┃ Description   ┃ Default value ┃ Type         ┃ control       ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ val1_dyn.var1 │ Value is      │ the value of  │  string      │  standard     │
│ val2_dyn.var1 │ suffix.       │ the           │ mandatory    │               │
│               │               │ identifier.   │              │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ val1_dyn.var2 │ Value is      │ the value of  │  string      │  standard     │
│ val2_dyn.var2 │ first         │ the variable  │ mandatory    │               │
│               │ variable.     │ "value is     │              │               │
│               │               │ suffix" (var1 │              │               │
│               │               │ or            │              │               │
│               │               │ val2_dyn.var… │              │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ val1_dyn.var3 │ Value is      │ the value of  │  string      │  standard     │
│ val2_dyn.var3 │ relative      │ the variable  │ mandatory    │               │
│               │ first         │ "value is     │              │               │
│               │ variable.     │ suffix" (var1 │              │               │
│               │               │ or            │              │               │
│               │               │ val2_dyn.var… │              │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ val1_dyn.var4 │ Value is      │ the value of  │  string      │  standard     │
│ val2_dyn.var4 │ first         │ the variable  │ mandatory    │               │
│               │ variable of   │ "value is     │              │               │
│               │ val1.         │ suffix"       │              │               │
│               │               │ (var1)        │              │               │
└───────────────┴───────────────┴───────────────┴──────────────┴───────────────┘

  Usage

    Example playbook with Rougail

Add to your structural file something like:

%YAML 1.2                                                                       
---                                                                             
version: 1.1                                                                    
my_rougail:                                                                     
  type: rougail                                                                 
...                                                                             

▌ 🛈 Informations                                                              
▌                                                                             
▌ Do not forget to add Rougail structural file as Rougail types.              

Add to your play:

---                                                                             
- name: Rougail                                                                 
  hosts: servers                                                                
  vars:                                                                         
    rougail: '{{ my_rougail }}'                                                 
  ansible.builtin.import_playbook: rougail.rougail.install                      

    Example playbook without Rougail

▌ 🛈 Informations                                                              
▌                                                                             
▌ The variables will not be properly validated without Rougail.               

---                                                                             
- name: Rougail                                                                 
  hosts: servers                                                                
  vars: {}                                                                      
  ansible.builtin.import_playbook: rougail.rougail.install