rougail.rougail - Rougail

This repository contains the  rougail.rougail  Ansible Collection.

This family is a namespace

  Variables

    The group variable "rougail" - Rougail

▌ 🛈 Informations                                                              
▌                                                                             
▌  basic                                                                      

┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃            ┃            ┃ Default    ┃            ┃ Access      ┃            ┃
┃ Variable   ┃ Descripti… ┃ value      ┃ Type       ┃ control     ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ var1       │ The first  │            │  string    │  basic      │            │
│            │ variable.  │            │ mandatory  │             │            │
│            │ Example:   │            │            │             │            │
│            │ test       │            │            │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var2       │ The second │ value      │  string    │  standard   │            │
│            │ variable.  │            │ mandatory  │             │            │
│            │ Example:   │            │            │             │            │
│            │ test       │            │            │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var3       │ The third  │            │  string    │  basic      │            │
│            │ variable.  │            │ mandatory  │             │            │
│            │ Examples:  │            │            │             │            │
│            │ • test1    │            │            │             │            │
│            │ • test2    │            │            │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var4       │ The forth  │            │  string    │  standard   │            │
│            │ variable.  │            │            │             │            │
│            │ Examples:  │            │            │             │            │
│            │ • null     │            │            │             │            │
│            │ • test1    │            │            │             │            │
│            │ • test2    │            │            │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var5       │ The fifth  │ true       │  boolean   │  standard   │            │
│            │ variable.  │            │ mandatory  │             │            │
│            │ Example:   │            │            │             │            │
│            │ false      │            │            │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var6       │ The sixth  │            │  string    │  basic      │  unique    │
│            │ variable.  │            │ multiple   │             │            │
│            │ Examples:  │            │ mandatory  │             │            │
│            │ • test1    │            │            │             │            │
│            │ • test2    │            │            │             │            │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

  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: test                            # The first variable                    
  var3: test1                           # The third variable                    
  var6:                                 # The sixth variable                    
    - test1                                                                     
    - test2                                                                     

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: test                      # The first variable                      
      var3: test1                     # The third variable                      
      var6:                           # The sixth variable                      
        - test1                                                                 
        - test2                                                                 
  ansible.builtin.import_playbook: rougail.rougail.install