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  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ condition  │ A          │ no         │  string    │  standard   │            │
│            │ condition… │            │ mandatory  │             │            │
│            │ variable.  │            │            │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ variable1  │ A first    │            │  string    │  basic      │  unique    │
│            │ variable.  │            │ multiple   │ disabled    │            │
│            │            │            │ mandatory  │ Disabled:   │            │
│            │            │            │            │ if          │            │
│            │            │            │            │ condition   │            │
│            │            │            │            │ is egal to  │            │
│            │            │            │            │ "yes".      │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ variable2  │ A second   │            │  string    │  basic      │  unique    │
│            │ variable.  │            │ multiple   │ disabled    │            │
│            │            │            │ mandatory  │ Disabled:   │            │
│            │            │            │            │ if          │            │
│            │            │            │            │ condition   │            │
│            │            │            │            │ is egal to  │            │
│            │            │            │            │ "yes".      │            │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

  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:                                                                     
  variable1:                            # A first variable                      
    - string1                                                                   
    - string2                                                                   
    - string3                                                                   
  variable2:                            # A second variable                     
    - string1                                                                   
    - string2                                                                   
    - string3                                                                   

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:                                                                    
      variable1:                      # A first variable                        
        - string1                                                               
        - string2                                                               
        - string3                                                               
      variable2:                      # A second variable                       
        - string1                                                               
        - string2                                                               
        - string3                                                               
  ansible.builtin.import_playbook: rougail.rougail.install