rougail-output-ansible/tests/results-doc/test_namespace_read_write/20_7help_family.sh

rougail.rougail - Rougail

This repository contains the  rougail.rougail  Ansible Collection.

This family is a namespace

  Variables

    The group variable "rougail" - Rougail

▌ 🛈 Informations                                                              
▌                                                                             
▌  basic                                                                      

      The first family

▌ 🛈 Informations                                                              
▌                                                                             
▌ Multi line.                                                                 
▌                                                                             
▌ Help.                                                                       
▌                                                                             
▌ With useful information.                                                    
▌ Path: family1                                                               
▌  basic                                                                      

┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Variable                ┃ Type                     ┃ Access control          ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ family1.var             │  string   mandatory      │  basic                  │
└─────────────────────────┴──────────────────────────┴─────────────────────────┘

      The second family

▌ 🛈 Informations                                                              
▌                                                                             
▌ Multi line.                                                                 
▌ Help.                                                                       
▌ With useful information.                                                    
▌ Path: family2                                                               
▌  basic                                                                      

┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Variable                ┃ Type                     ┃ Access control          ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ family2.var             │  string   mandatory      │  basic                  │
└─────────────────────────┴──────────────────────────┴─────────────────────────┘

  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.              

For example you can add an YAML user data with something like:

---                                                                             
my_rougail:                                                                     
  family1:                              # The first family                      
    var: example                                                                
  family2:                              # The second family                     
    var: example                                                                

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:                                                                         
    rougail:                                                                    
      family1:                        # The first family                        
        var: example                                                            
      family2:                        # The second family                       
        var: example                                                            
  ansible.builtin.import_playbook: rougail.rougail.install