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  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ variable1  │ A port     │            │  port      │  basic      │ •          │
│            │ variable.  │            │ mandatory  │             │ well-known │
│            │            │            │            │             │ ports (1   │
│            │            │            │            │             │ to 1023)   │
│            │            │            │            │             │ are        │
│            │            │            │            │             │ allowed    │
│            │            │            │            │             │ •          │
│            │            │            │            │             │ registred  │
│            │            │            │            │             │ ports      │
│            │            │            │            │             │ (1024 to   │
│            │            │            │            │             │ 49151) are │
│            │            │            │            │             │ allowed    │
│            │            │            │            │             │ • private  │
│            │            │            │            │             │ ports      │
│            │            │            │            │             │ (greater   │
│            │            │            │            │             │ than       │
│            │            │            │            │             │ 49152) are │
│            │            │            │            │             │ allowed.   │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ variable2  │ A port     │ 8080       │  port      │  standard   │ •          │
│            │ variable   │            │ mandatory  │             │ well-known │
│            │ with       │            │            │             │ ports (1   │
│            │ default    │            │            │             │ to 1023)   │
│            │ value.     │            │            │             │ are        │
│            │            │            │            │             │ allowed    │
│            │            │            │            │             │ •          │
│            │            │            │            │             │ registred  │
│            │            │            │            │             │ ports      │
│            │            │            │            │             │ (1024 to   │
│            │            │            │            │             │ 49151) are │
│            │            │            │            │             │ allowed    │
│            │            │            │            │             │ • private  │
│            │            │            │            │             │ ports      │
│            │            │            │            │             │ (greater   │
│            │            │            │            │             │ than       │
│            │            │            │            │             │ 49152) are │
│            │            │            │            │             │ allowed.   │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ variable3  │ A port     │ 8080       │  port      │  standard   │ •          │
│            │ variable   │            │ mandatory  │             │ well-known │
│            │ with       │            │            │             │ ports (1   │
│            │ integer    │            │            │             │ to 1023)   │
│            │ default    │            │            │             │ are        │
│            │ value.     │            │            │             │ allowed    │
│            │            │            │            │             │ •          │
│            │            │            │            │             │ registred  │
│            │            │            │            │             │ ports      │
│            │            │            │            │             │ (1024 to   │
│            │            │            │            │             │ 49151) are │
│            │            │            │            │             │ allowed    │
│            │            │            │            │             │ • private  │
│            │            │            │            │             │ ports      │
│            │            │            │            │             │ (greater   │
│            │            │            │            │             │ than       │
│            │            │            │            │             │ 49152) are │
│            │            │            │            │             │ allowed.   │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

  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: '80'                       # A port variable                       
  variable2: '80'                       # A port variable with default value    
  variable3: '80'                       # A port variable with integer default v

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: '80'                 # A port variable                         
      variable2: '80'                 # A port variable with default value      
      variable3: '80'                 # A port variable with integer default val
  ansible.builtin.import_playbook: rougail.rougail.install