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

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃               ┃               ┃               ┃              ┃ Access        ┃
┃ Variable      ┃ Description   ┃ Default value ┃ Type         ┃ control       ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ var1          │ The first     │ true          │  boolean     │  standard     │
│               │ variable.     │               │ mandatory    │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ var2          │ The second    │ true          │  boolean     │  standard     │
│               │ variable.     │               │ mandatory    │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ var3          │ The third     │ true          │  boolean     │  standard     │
│               │ variable.     │               │ mandatory    │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ var4          │ The forth     │ false         │  boolean     │  standard     │
│               │ variable.     │               │ mandatory    │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ var5          │ The fifth     │ false         │  boolean     │  standard     │
│               │ variable.     │               │ mandatory    │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ var6          │ The sixth     │ false         │  boolean     │  standard     │
│               │ 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:                                                                     
  var1: true                            # The first variable                    
  var2: true                            # The second variable                   
  var3: true                            # The third variable                    
  var4: true                            # The forth variable                    
  var5: true                            # The fifth variable                    
  var6: true                            # The sixth 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:                                                                    
      var1: true                      # The first variable                      
      var2: true                      # The second variable                     
      var3: true                      # The third variable                      
      var4: true                      # The forth variable                      
      var5: true                      # The fifth variable                      
      var6: true                      # The sixth variable                      
  ansible.builtin.import_playbook: rougail.rougail.install