rougail-output-ansible/tests/results-doc/test_namespace/60_5family_dynamic_calc_description.sh

rougail.rougail - Rougail

This repository contains the  rougail.rougail  Ansible Collection.

This family is a namespace

  Variables

    The group variable "rougail" - Rougail

▌ 🛈 Informations                                                              
▌                                                                             
▌  basic                                                                      

      A dynamic famify for val1 or val2

▌ 🛈 Informations                                                              
▌                                                                             
▌ This family builds families dynamically.                                    
▌ Path:                                                                       
▌  • dynval1                                                                  
▌  • dynval2                                                                  
▌  basic                                                                      
▌ Identifiers:                                                                
▌  • val1                                                                     
▌  • val2                                                                     

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

┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
┃               ┃               ┃               ┃              ┃ Access        ┃
┃ Variable      ┃ Description   ┃ Default value ┃ Type         ┃ control       ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
│ var1          │ A new         │               │  string      │  basic        │
│               │ variable.     │               │ mandatory    │ disabled      │
│               │               │               │              │ Disabled:     │
│               │               │               │              │ when the      │
│               │               │               │              │ variable "a   │
│               │               │               │              │ dynamic       │
│               │               │               │              │ variable for  │
│               │               │               │              │ val1" (var)   │
│               │               │               │              │ has the value │
│               │               │               │              │ "val".        │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
│ var2          │ A new         │               │  string      │  standard     │
│               │ variable.     │ • the value   │ multiple     │               │
│               │               │ of the        │ mandatory    │               │
│               │               │ variable "a   │              │               │
│               │               │ dynamic       │              │               │
│               │               │ variable for  │              │               │
│               │               │ val1" (var)   │              │               │
│               │               │ • the value   │              │               │
│               │               │ of the        │              │               │
│               │               │ variable "a   │              │               │
│               │               │ dynamic       │              │               │
│               │               │ variable for  │              │               │
│               │               │ val2" (var)   │              │               │
└───────────────┴───────────────┴───────────────┴──────────────┴───────────────┘

  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 famify for val1             
    var: string1                        # A dynamic variable for val1           
  dynval2:                              # A dynamic famify for val2             
    var: string1                        # A dynamic variable for val2           
  var1: string1                         # A new 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 famify for val1               
        var: string1                  # A dynamic variable for val1             
      dynval2:                        # A dynamic famify for val2               
        var: string1                  # A dynamic variable for val2             
      var1: string1                   # A new variable                          
  ansible.builtin.import_playbook: rougail.rougail.install