rougail.rougail - Rougail

This repository contains the  rougail.rougail  Ansible collection.

This family is a namespace

  Variables

    The group variables "rougail" - Rougail

▌ 🛈 Informations                                                              
▌                                                                             
▌  basic                                                                      

┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃            ┃            ┃ Default    ┃            ┃ Access      ┃            ┃
┃ Variable   ┃ Descripti… ┃ value      ┃ Type       ┃ control     ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ variable1  │ A first    │ • a        │  string    │  standard   │  unique    │
│            │ variable.  │ • b        │ multiple   │             │            │
│            │            │ • c        │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ variable2  │ A second   │            │  choice    │  basic      │ Choices:   │
│            │ variable.  │            │ mandatory  │             │ the value  │
│            │            │            │            │             │ of the     │
│            │            │            │            │             │ variable   │
│            │            │            │            │             │ "a first   │
│            │            │            │            │             │ variable"  │
│            │            │            │            │             │ (variable… │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

  Usage

    Example Playbook with Rougail

Add to your structural file something like:

%YAML 1.2                                                                       
---                                                                             
version: 1.1                                                                    
my_rougail:                                                                     
  type: rougail                                                                 
...                                                                             

Customizing hidden variables in structure file:

%YAML 1.2                                                                       
---                                                                             
version: 1.1                                                                    
my_rougail:                                                                     
  type: rougail                                                                 
...                                                                             

▌ 🛈 Informations                                                              
▌                                                                             
▌ Do not forget to add Rougail structure file as Rougail types.               

For example you can add an YAML user data with something like:

---                                                                             
my_rougail:                                                                     
  variable2: a                          # A second variable                     

Add to your Play:

---                                                                             
- name: Collection | rougail.rougail.install                                    
  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: Collection | rougail.rougail.install                                    
  hosts: servers                                                                
  vars:                                                                         
    rougail:                                                                    
      variable2: a                    # A second variable                       
  ansible.builtin.import_playbook: rougail.rougail.install