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

      A dynamic family

▌ 🛈 Informations                                                              
▌                                                                             
▌ This family builds families dynamically.                                    
▌ Path:                                                                       
▌  • dynval1                                                                  
▌  • dynval2                                                                  
▌  standard   hidden                                                          
▌ Hidden: if suffix == 'val2'.                                                
▌ Identifiers:                                                                
▌  • val1                                                                     
▌  • val2                                                                     

┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
┃ Variable          ┃ Description       ┃ Type              ┃ Access control   ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
│ dynval1.var       │ A variable.       │  string           │  standard        │
│ dynval2.var       │                   │                   │                  │
└───────────────────┴───────────────────┴───────────────────┴──────────────────┘

        A family

▌ 🛈 Informations                                                              
▌                                                                             
▌ Path:                                                                       
▌  • dynval1.family                                                           
▌  • dynval2.family                                                           
▌  standard                                                                   

┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
┃ Variable          ┃ Description       ┃ Type              ┃ Access control   ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
│ dynval1.family.v… │ A new variable.   │  string           │  standard        │
│ dynval2.family.v… │                   │                   │                  │
└───────────────────┴───────────────────┴───────────────────┴──────────────────┘

▌ 🛈 Informations                                                              
▌                                                                             
▌ Hidden variables can only be modified within a structure file.              

  Usage

    Example playbook with Rougail

Add to your structural file something like:

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

Customizing hidden variable in structural files:

%YAML 1.2                                                                       
---                                                                             
version: 1.1                                                                    
my_rougail:                                                                     
  type: rougail                                                                 
  dynval2:                                                                      
    var: example                        # A variable                            
    family:                             # A family                              
      var: example                      # A new variable                        
...                                                                             

▌ 🛈 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