Rougail

• is a delicious cooked dish from the Mauritius and Reunion Islands,

• it is also a tool which enables us to conveniently load variables in YAML file format in such a way that the end user consumer can handle them consistently (that is, against an user-defined consistency).

What is it all about

• Abstract presentation
• Variables as Code

Structured data

• The structure file and data
  • The structure file
  • Data documentation
  • Data integrity
    • Typing
    • Validation
    • Mode
    • Properties
• The Rougail format
  • The variables
  • The families
  • Full or relative path
  • Redefine a variable
  • Calculated default values
  • Calculated properties
  • Value validations
• Tutorial with a real world sample
  • Getting started
  • A variable with possible values
  • Group variables inside families
  • Some suitable types
  • Calculated default value for a variable
  • Define access to variable or family
  • A dynamically built family
  • Playing with Jinja
  • Custom type
  • Nullable variable
  • A web_address variable
  • Variable with multiple values
  • A full documented variable
  • Practice
  • The Jinja propertyerror test
  • Modes
  • Practice
  • Validating a variable’s value
  • Namespaces
  • Homogeneous elements sequence
  • Regexp type with calculation
  • Auto save value
  • Name and parameter conflict
  • Variable calculation with propertyerror
  • Redefine variable

User data

• Prerequisites
• User data modules
  • Load user data from YAML file
  • Load user data from Ansible compatible file
  • Load user data from environment variables
  • Load user data secrets from Bitwarden
  • Load user data from commandline parser
  • Define user data interactively in the console

Output

• Output modules
  • Display variables and values
  • Displays the data in a table
  • Generate documentation from structural files
  • Reformat the structure files
  • Generate Ansible inventory
  • Export variables and values to JSON

The library and the tools

• Customizing Rougail’s configuration
• The Rougail Command Line Interface
• Rougail’s library description
  • Load user data
  • Display the result
  • Retrieve all variables and families
  • Use tag informations
  • Load Rougail configuration from Rougail command line informations
  • Let’s convert an extra namespace structural file
  • Let’s create a custom function
  • Create your own type
  • Upgrade dictionnaries to upper version
• Link between Rougail and Tiramisu

Developper notes

• Release procedure
• Developer notes
• Documentation Writing Guide

Index page

• Index