rougail-output-ansible/tests/results-doc/test_namespace_mandatory/20_0family_append.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                                                                      

      A family

▌ 🛈 Informations                                                              
▌                                                                             
▌ Path: family                                                                
▌  basic                                                                      

┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
┃ Variable          ┃ Description       ┃ Type              ┃ Access control   ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
│ family.var1       │ The first         │  string           │  basic           │
│                   │ variable.         │ mandatory         │                  │
├───────────────────┼───────────────────┼───────────────────┼──────────────────┤
│ family.var2       │ The second        │  string           │  basic           │
│                   │ variable.         │ mandatory         │                  │
└───────────────────┴───────────────────┴───────────────────┴──────────────────┘

  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:                                                                     
  family:                               # A family                              
    var1: string1                       # The first variable                    
    var2: string1                       # The second variable                   

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:                                                                    
      family:                         # A family                                
        var1: string1                 # The first variable                      
        var2: string1                 # The second variable                     
  ansible.builtin.import_playbook: rougail.rougail.install