rougail.rougail - Rougail

This repository contains the  rougail.rougail  Ansible Collection.

This family is a namespace

  Variables

    The group variable "rougail" - Rougail

▌ 🛈 Informations                                                              
▌                                                                             
▌  standard                                                                   

┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃            ┃            ┃ Default    ┃            ┃ Access      ┃            ┃
┃ Variable   ┃ Descripti… ┃ value      ┃ Type       ┃ control     ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ var        │ A suffix   │ • val1     │  string    │  standard   │  unique    │
│            │ variable.  │ • val2     │ multiple   │             │            │
│            │ Examples:  │            │ mandatory  │             │            │
│            │ • val1     │            │            │             │            │
│            │ • val2     │            │            │             │            │
│            │ • val3     │            │            │             │            │
│            │ • val4     │            │            │             │            │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

      A dynamic family

▌ 🛈 Informations                                                              
▌                                                                             
▌ This family builds families dynamically.                                    
▌ Path:                                                                       
▌  • val1_dyn                                                                 
▌  • val2_dyn                                                                 
▌  standard                                                                   
▌ Identifiers: the value of the variable "a suffix variable" (var).           

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃               ┃               ┃               ┃              ┃ Access        ┃
┃ Variable      ┃ Description   ┃ Default value ┃ Type         ┃ control       ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ val1_dyn.var1 │ A variable 1. │ the value of  │  string      │  standard     │
│ val2_dyn.var1 │               │ the           │ mandatory    │               │
│               │               │ identifier.   │              │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ val1_dyn.var2 │ A variable 2. │ the value of  │  string      │  standard     │
│ val2_dyn.var2 │               │ the variable  │ mandatory    │               │
│               │               │ "a variable   │              │               │
│               │               │ 1" (var1 or   │              │               │
│               │               │ val2_dyn.var… │              │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ val1_dyn.var3 │ A variable 3. │ the value of  │  string      │  standard     │
│ val2_dyn.var3 │               │ the variable  │ mandatory    │               │
│               │               │ "a variable   │              │               │
│               │               │ 1" (var1 or   │              │               │
│               │               │ val2_dyn.var… │              │               │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ val1_dyn.var4 │ A variable 4. │ the value of  │  string      │  standard     │
│ val2_dyn.var4 │               │ the variable  │ mandatory    │ disabled      │
│               │               │ "a variable   │              │ Disabled:     │
│               │               │ 1" (var1)     │              │ depends on a  │
│               │               │               │              │ calculation.  │
└───────────────┴───────────────┴───────────────┴──────────────┴───────────────┘

  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.              

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