rougail-output-ansible/tests/results-doc/test_namespace/24_7validators_variable_optional.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: general                                                               
▌  basic                                                                      

┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃            ┃            ┃ Default    ┃            ┃ Access      ┃            ┃
┃ Variable   ┃ Descripti… ┃ value      ┃ Type       ┃ control     ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ general.i… │ A first    │            │  integer   │  basic      │ • int and  │
│            │ integer.   │            │ mandatory  │             │ int2 must  │
│            │ Example: 5 │            │            │             │ be         │
│            │            │            │            │             │ different  │
│            │            │            │            │             │ • int and  │
│            │            │            │            │             │ int3 must  │
│            │            │            │            │             │ be         │
│            │            │            │            │             │ different. │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ general.i… │ A second   │ 1          │  integer   │  standard   │            │
│            │ integer.   │            │ 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:                                                                     
  general:                              # A family                              
    int: 5                              # A first integer                       

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:                                                                    
      general:                        # A family                                
        int: 5                        # A first integer                         
  ansible.builtin.import_playbook: rougail.rougail.install