rougail.rougail - Rougail

This repository contains the  rougail.rougail  Ansible Collection.

This family is a namespace

  Variables

    The group variable "rougail" - Rougail

▌ 🛈 Informations                                                              
▌                                                                             
▌  standard                                                                   

      A leadership

▌ 🛈 Informations                                                              
▌                                                                             
▌ This family contains lists of variable blocks.                              
▌ Path: leader                                                                
▌  standard                                                                   

┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃            ┃            ┃ Default    ┃            ┃ Access      ┃            ┃
┃ Variable   ┃ Descripti… ┃ value      ┃ Type       ┃ control     ┃ Validator  ┃
┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ leader.le… │ A leader.  │ • value1   │  string    │  standard   │  unique    │
│            │            │ • value2   │ multiple   │             │            │
│            │            │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ leader.fo… │ A          │ val11      │  string    │  standard   │            │
│            │ follower.  │            │ mandatory  │             │            │
├────────────┼────────────┼────────────┼────────────┼─────────────┼────────────┤
│ leader.fo… │ An other   │ val21      │  string    │  standard   │            │
│            │ follower.  │            │ mandatory  │             │            │
└────────────┴────────────┴────────────┴────────────┴─────────────┴────────────┘

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃               ┃               ┃               ┃              ┃ Access        ┃
┃ Variable      ┃ Description   ┃ Default value ┃ Type         ┃ control       ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ calculate     │ A calculated  │ depends on a  │  string      │  standard     │
│               │ variable.     │ calculation.  │ 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:                                                                     
  leader:                               # A leadership                          
    - leader: string1                   # A leader                              
      follower1: string1                # A follower                            
      follower2: string1                # An other follower                     
    - leader: string2                   # A leader                              
      follower1: string2                # A follower                            
      follower2: string2                # An other follower                     
    - leader: string3                   # A leader                              
      follower1: string3                # A follower                            
      follower2: string3                # An other follower                     
  calculate: string1                    # A calculated 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:                                                                    
      leader:                         # A leadership                            
        - leader: string1             # A leader                                
          follower1: string1          # A follower                              
          follower2: string1          # An other follower                       
        - leader: string2             # A leader                                
          follower1: string2          # A follower                              
          follower2: string2          # An other follower                       
        - leader: string3             # A leader                                
          follower1: string3          # A follower                              
          follower2: string3          # An other follower                       
      calculate: string1              # A calculated variable                   
  ansible.builtin.import_playbook: rougail.rougail.install