rougail-output-ansible/tests/results-doc/test_namespace/44_4leadership_mandatory.sh

86 lines
11 KiB
Bash
Raw Normal View History

2026-05-04 12:17:56 +02:00
rougail.rougail - Rougail
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
This repository contains the  rougail.rougail  Ansible Collection.
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
This family is a namespace
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
Variables
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
The group variable "rougail" - Rougail
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
▌ 🛈 Informations
▌ 
▌  basic 
A leadership
▌ 🛈 Informations
▌ 
▌ This family contains lists of variable blocks.
▌ Path: leader
▌  basic 
2026-01-14 14:25:35 +01:00
2026-02-21 21:31:34 +01:00
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
 ┃ ┃ ┃ Access  ┃ ┃
 Variable  ┃ Description  ┃ Type  ┃ control  ┃ Validator  ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
leader.leader │ A leader. │  string    │  basic  │  unique  │
│ │ │ multiple    │ │ │
│ │ │ mandatory  │ │ │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
leader.follo… │ A follower. │  string  │  standard  │ │
└───────────────┴───────────────┴───────────────┴──────────────┴───────────────┘
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
Usage
2026-01-14 14:25:35 +01:00
2026-05-04 12:17:56 +02:00
Example playbook with Rougail
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
Add to your structural file something like:
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
%YAML 1.2 
--- 
version: 1.1 
my_rougail: 
 type: rougail 
... 
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
▌ 🛈 Informations
▌ 
▌ Do not forget to add Rougail structural file as Rougail types.
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
For example you can add an YAML user data with something like:
2026-01-21 08:55:24 +01:00
2026-02-21 21:31:34 +01:00
--- 
2026-05-04 12:17:56 +02:00
my_rougail: 
 leader: # A leadership 
 - leader: string1 # A leader 
 - leader: string2 # A leader 
 - leader: string3 # A leader 
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
Add to your play:
2026-01-21 08:55:24 +01:00
2026-02-21 21:31:34 +01:00
--- 
- name: Rougail 
2026-05-04 12:17:56 +02:00
 hosts: servers 
 vars: 
 rougail: '{{ my_rougail }}' 
 ansible.builtin.import_playbook: rougail.rougail.install 
2026-01-21 08:55:24 +01:00
2026-05-04 12:17:56 +02:00
Example playbook without Rougail
▌ 🛈 Informations
▌ 
▌ The variables will not be properly validated without Rougail.
2026-01-14 14:25:35 +01:00
2026-02-21 21:31:34 +01:00
--- 
- name: Rougail 
2026-05-04 12:17:56 +02:00
 hosts: servers 
2026-02-21 21:31:34 +01:00
 vars: 
2026-05-04 12:17:56 +02:00
 rougail: 
 leader: # A leadership 
 - leader: string1 # A leader 
 - leader: string2 # A leader 
 - leader: string3 # A leader 
 ansible.builtin.import_playbook: rougail.rougail.install