rougail.rougail - Rougail

This repository contains the  rougail.rougail  Ansible collection.

This family is a namespace

  Variables

    The group variables "rougail" - Rougail

▌ 🛈 Informations                                                              
▌                                                                             
▌  standard                                                                   

┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃            ┃            ┃ Default    ┃            ┃ Access      ┃            ┃
┃ Variable   ┃ Descripti… ┃ value      ┃ Type       ┃ control     ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ var1       │ A suffix   │ • val1     │  string    │  standard   │  unique    │
│            │ variable.  │ • val2     │ multiple   │             │            │
│            │            │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ var2       │ A suffix   │ val1       │  string    │  standard   │            │
│            │ variable2. │            │ mandatory  │ hidden      │            │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

      dynval1 or dynval2

▌ 🛈 Informations                                                              
▌                                                                             
▌ This family builds families dynamically.                                    
▌ Path:                                                                       
▌  • dynval1                                                                  
▌  • dynval2                                                                  
▌  standard                                                                   
▌ Identifiers: the value of the variable "A suffix variable" (var1).          

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃               ┃               ┃               ┃              ┃ Access        ┃
┃ Variable      ┃ Description   ┃ Default value ┃ Type         ┃ control       ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ dynval1.var   │ A dynamic     │ the value of  │  string      │  standard     │
│ dynval2.var   │ variable.     │ the           │ mandatory    │               │
│               │               │ identifier.   │              │               │
└───────────────┴───────────────┴───────────────┴──────────────┴───────────────┘

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃               ┃               ┃               ┃              ┃ Access        ┃
┃ Variable      ┃ Description   ┃ Default value ┃ Type         ┃ control       ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ var3          │ A variable    │               │  string      │  standard     │
│               │ calculated.   │ • the value   │ mandatory    │               │
│               │               │ of the        │              │               │
│               │               │ variable "A   │              │               │
│               │               │ dynamic       │              │               │
│               │               │ variable"     │              │               │
│               │               │ (var)         │              │               │
│               │               │ • the value   │              │               │
│               │               │ of the        │              │               │
│               │               │ variable "A   │              │               │
│               │               │ dynamic       │              │               │
│               │               │ variable"     │              │               │
│               │               │ (var)         │              │               │
└───────────────┴───────────────┴───────────────┴──────────────┴───────────────┘

▌ 🛈 Informations                                                              
▌                                                                             
▌ Hidden variables can only be modified within a structure file.              

  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                                                                 
  var2: val1                                                                    
...                                                                             

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

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: {}                                                                      
  ansible.builtin.import_playbook: rougail.rougail.install