rougail-output-ansible/tests/results-doc/test_namespace/60_6family_dynamic_sub_dynamic.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                                                                   

┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃            ┃            ┃ Default    ┃            ┃ Access      ┃            ┃
┃ Variable   ┃ Descripti… ┃ value      ┃ Type       ┃ control     ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ var        │ A          │ • val1     │  string    │  standard   │  unique    │
│            │ identifier │ • val2     │ multiple   │             │            │
│            │ variable.  │            │ mandatory  │             │            │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

      A dynamic family

▌ 🛈 Informations                                                              
▌                                                                             
▌ This family builds families dynamically.                                    
▌ Path:                                                                       
▌  • dynval1                                                                  
▌  • dynval2                                                                  
▌  standard                                                                   
▌ Identifiers: the value of the variable "A identifier variable" (var).       

┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃            ┃            ┃ Default    ┃            ┃ Access      ┃            ┃
┃ Variable   ┃ Descripti… ┃ value      ┃ Type       ┃ control     ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ dynval1.v… │ A dynamic  │ add 't' to │  string    │  standard   │  unique    │
│ dynval2.v… │ variable.  │ each var   │ multiple   │             │            │
│            │            │ value.     │ mandatory  │             │            │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

        A Second dynamic variable

▌ 🛈 Informations                                                              
▌                                                                             
▌ This family builds families dynamically.                                    
▌ Path:                                                                       
▌  • dynval1.dyn_tval1                                                        
▌  • dynval1.dyn_tval2                                                        
▌  • dynval2.dyn_tval1                                                        
▌  • dynval2.dyn_tval2                                                        
▌  standard                                                                   
▌ Identifiers: the value of the variable "A dynamic variable" (var or         
▌ dynval2.var)                                                                

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃               ┃               ┃               ┃              ┃ Access        ┃
┃ Variable      ┃ Description   ┃ Default value ┃ Type         ┃ control       ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ dynval1.dyn_… │ A variable    │ the value of  │  string      │  standard     │
│ dynval1.dyn_… │ dynamic.      │ the           │ mandatory    │               │
│ dynval2.dyn_… │               │ identifier.   │              │               │
│ dynval2.dyn_… │               │               │              │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ dynval1.dyn_… │ Identifier    │ the value of  │  string      │  standard     │
│ dynval1.dyn_… │ from first    │ the           │ mandatory    │               │
│ dynval2.dyn_… │ family.       │ identifier.   │              │               │
│ dynval2.dyn_… │               │               │              │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ dynval1.dyn_… │ Merge         │ join          │  string      │  standard     │
│ dynval1.dyn_… │ identifiers.  │ identifier 1  │ mandatory    │               │
│ dynval2.dyn_… │               │ and           │              │               │
│ dynval2.dyn_… │               │ identifier 2. │              │               │
└───────────────┴───────────────┴───────────────┴──────────────┴───────────────┘

  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