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  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ var        │ A suffix   │ • val1     │  string    │  standard   │  unique    │
│            │ variable.  │ • val2     │ multiple   │             │            │
│            │            │            │ mandatory  │             │            │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

      A dynamic family

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

┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
┃ Variable          ┃ Description       ┃ Type              ┃ Access control   ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
│ dynval1.var       │ A dynamic         │  string           │  basic           │
│ dynval2.var       │ variable.         │ mandatory         │                  │
└───────────────────┴───────────────────┴───────────────────┴──────────────────┘

  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:                                                                     
  dynval1:                              # A dynamic family                      
    var: example                        # A dynamic variable                    
  dynval2:                              # A dynamic family                      
    var: example                        # A dynamic variable                    

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:                                                                    
      dynval1:                        # A dynamic family                        
        var: example                  # A dynamic variable                      
      dynval2:                        # A dynamic family                        
        var: example                  # A dynamic variable                      
  ansible.builtin.import_playbook: rougail.rougail.install