rougail-output-ansible/tests/results-doc/test_namespace_mandatory/00_7help.sh

82 lines
9.4 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 
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃ Type  ┃ Access control  ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩
var1 │ The first │  string    │  basic  │
│ │ variable. │ mandatory  │ │
│ │ Multi line │ │ │
│ │ │ │ │
│ │ Help │ │ │
│ │ │ │ │
│ │ With useful │ │ │
│ │ information. │ │ │
├───────────────────┼───────────────────┼───────────────────┼──────────────────┤
var2 │ The second │  string    │  basic  │
│ │ variable. │ mandatory  │ │
│ │ Multi line │ │ │
│ │ Help │ │ │
│ │ With useful │ │ │
│ │ information. │ │ │
└───────────────────┴───────────────────┴───────────────────┴──────────────────┘
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: 
 var1: string1 # The first variable 
 var2: string1 # The second 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: 
 var1: string1 # The first variable 
 var2: string1 # The second variable 
 ansible.builtin.import_playbook: rougail.rougail.install