rougail-output-ansible/tests/results-doc/test_namespace/24_7validators_variable_optional.sh

Ansible role: Rougail

▌ 🛈 Informations
▌ 
▌  basic 


  Role variables

    A family

▌ 🛈 Informations
▌ 
▌ Path: general
▌  basic 

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Variable                     ┃ Description                  ┃ Default value                ┃ Type                         ┃ Access control               ┃ Validator                     ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ general.int                  │ A first integer.             │                              │  integer   mandatory         │  basic                       │ • int and int2 must be        │
│                              │ Example: 5                   │                              │                              │                              │ different                     │
│                              │                              │                              │                              │                              │ • int and int3 must be        │
│                              │                              │                              │                              │                              │ different.                    │
├──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼──────────────────────────────┼───────────────────────────────┤
│ general.int2                 │ A second integer.            │ 1                            │  integer   mandatory         │  standard                    │                               │
└──────────────────────────────┴──────────────────────────────┴──────────────────────────────┴──────────────────────────────┴──────────────────────────────┴───────────────────────────────┘


  Example playbook with Rougail

▌ 🛈 Informations
▌ 
▌ Do not forget to add Rougail structural file as Rougail types


Add to your structural file something like:


---                                                                                                                                                                                         
path:                                                                                                                                                                                       
  to:                                                                                                                                                                                       
    my_rougail:                                                                                                                                                                             
      type: rougail                                                                                                                                                                         
      general:                                                                                                                                                                              
        int: 5  # A first integer                                                                                                                                                           

Add to your playbook:


---                                                                                                                                                                                         
- name: Rougail                                                                                                                                                                             
  hosts: server                                                                                                                                                                             
  roles:                                                                                                                                                                                    
    - role: <author>.rougail                                                                                                                                                                
  vars: path.to.rougail                                                                                                                                                                     

  Example playbook

---                                                                                                                                                                                         
- name: Rougail                                                                                                                                                                             
  hosts: server                                                                                                                                                                             
  roles:                                                                                                                                                                                    
    - role: <author>.rougail                                                                                                                                                                
  vars:                                                                                                                                                                                     
    rougail:  # Rougail                                                                                                                                                                     
      general:  # A family                                                                                                                                                                  
        int: 5  # A first integer