rougail-output-ansible/tests/results-doc/test_namespace/40_1leadership_append_follower.sh

110 lines
18 KiB
Bash
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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 leadership
▌ 🛈 Informations
▌ 
▌ This family contains lists of variable blocks.
▌ Path: leader
▌  basic 
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓
 ┃ ┃ ┃ Access  ┃ ┃
 Variable  ┃ Description  ┃ Type  ┃ control  ┃ Validator  ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩
leader.leader │ The leader. │  string    │  basic  │  unique  │
│ │ │ multiple    │ │ │
│ │ │ mandatory  │ │ │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
leader.follo… │ The │  string    │  basic  │ │
│ │ follower1. │ mandatory  │ │ │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
leader.follo… │ The │  string    │  basic  │ │
│ │ follower2. │ mandatory  │ │ │
├───────────────┼───────────────┼───────────────┼──────────────┼───────────────┤
leader.follo… │ The │  string    │  basic  │ │
│ │ follower3. │ 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 # The leader 
 follower1: string1 # The follower1 
 follower2: string1 # The follower2 
 follower3: string1 # The follower3 
 - leader: string2 # The leader 
 follower1: string2 # The follower1 
 follower2: string2 # The follower2 
 follower3: string2 # The follower3 
 - leader: string3 # The leader 
 follower1: string3 # The follower1 
 follower2: string3 # The follower2 
 follower3: string3 # The follower3 
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 # The leader 
 follower1: string1 # The follower1 
 follower2: string1 # The follower2 
 follower3: string1 # The follower3 
 - leader: string2 # The leader 
 follower1: string2 # The follower1 
 follower2: string2 # The follower2 
 follower3: string2 # The follower3 
 - leader: string3 # The leader 
 follower1: string3 # The follower1 
 follower2: string3 # The follower2 
 follower3: string3 # The follower3 
 ansible.builtin.import_playbook: rougail.rougail.install