rougail-output-ansible/tests/results-doc/test_namespace_mandatory/01_6boolean_multi.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  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ var1       │ The first  │ • true     │  boolean   │  standard   │  unique    │
│            │ variable.  │            │ multiple   │             │            │
│            │            │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var2       │ The second │ • true     │  boolean   │  standard   │  unique    │
│            │ variable.  │            │ multiple   │             │            │
│            │            │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var3       │ The third  │ • true     │  boolean   │  standard   │  unique    │
│            │ variable.  │            │ multiple   │             │            │
│            │            │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var4       │ The forth  │ • false    │  boolean   │  standard   │  unique    │
│            │ variable.  │            │ multiple   │             │            │
│            │            │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var5       │ The fifth  │ • false    │  boolean   │  standard   │  unique    │
│            │ variable.  │            │ multiple   │             │            │
│            │            │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var6       │ The sixth  │ • false    │  boolean   │  standard   │  unique    │
│            │ variable.  │            │ multiple   │             │            │
│            │            │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var7       │ The        │ • true     │  boolean   │  standard   │  unique    │
│            │ seventh    │            │ multiple   │             │            │
│            │ variable.  │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var8       │ The eighth │ • true     │  boolean   │  standard   │  unique    │
│            │ variable.  │            │ multiple   │             │            │
│            │            │            │ 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:                                                                     
  var1:                                 # The first variable                    
    - true                                                                      
  var2:                                 # The second variable                   
    - true                                                                      
  var3:                                 # The third variable                    
    - true                                                                      
  var4:                                 # The forth variable                    
    - true                                                                      
  var5:                                 # The fifth variable                    
    - true                                                                      
  var6:                                 # The sixth variable                    
    - true                                                                      
  var7:                                 # The seventh variable                  
    - true                                                                      
  var8:                                 # The eighth variable                   
    - true                                                                      

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:                                                                    
      var1:                           # The first variable                      
        - true                                                                  
      var2:                           # The second variable                     
        - true                                                                  
      var3:                           # The third variable                      
        - true                                                                  
      var4:                           # The forth variable                      
        - true                                                                  
      var5:                           # The fifth variable                      
        - true                                                                  
      var6:                           # The sixth variable                      
        - true                                                                  
      var7:                           # The seventh variable                    
        - true                                                                  
      var8:                           # The eighth variable                     
        - true                                                                  
  ansible.builtin.import_playbook: rougail.rougail.install