rougail/README.fr.md

Table of Contents

• Le gestionnaire de secret
• Load and exporter steps
• Paramètre par défaut pour le type d'option
• UNIX filename
• IP
• CIDR
• Network
• Network CIDR
• Netbios
• Domainname
• Hostname
• Web address
• Port

🇬🇧 (EN) - 🇫🇷 (FR)

Variable	Description	Valeur par défaut	Type	Contrôle des accès	Validateur
default_structural_format_version Ligne de commande : -v, --default_structural_format_version Variable d'environnement : DEFAULT_STRUCTURAL_FORMAT_VERSION	Version par défaut du format des fichiers de structure. Cette valeur n'est utilisée que si la version n'est pas définie dans le fichier de structure.		choice	standard	Choix : • 1.0 • 1.1 • null
functions_files Ligne de commande : -c, --functions_files Variable d'environnement : FUNCTIONS_FILES	Fichier avec les fonctions. Ce fichier contient des filtres et des fonctions Jinja2 supplémentaires utilisables dans les fichiers de structure.		UNIX filename multiple	standard	unique • le nom de fichier peut être une chemin relatif • le fichier doit exister • type de fichier autorisé: "file".
modes_level Ligne de commande : --modes_level Variable d'environnement : MODES_LEVEL	Tous les niveaux de modes valides.		string multiple	standard	unique
default_family_mode Variable d'environnement : DEFAULT_FAMILY_MODE	Mode par défaut pour une famille.	le premier défini dans "Tous les niveaux de modes valides"	string	standard	Ce mode doit être disponible dans "Tous les niveaux de modes valides".
default_variable_mode Variable d'environnement : DEFAULT_VARIABLE_MODE	Mode par défaut pour une variable.	si la variable "Tous les niveaux de modes valides" est définit, la valeur par défaut est le second élément disponible, sinon, le premier	string	standard	Ce mode doit être disponible dans "Tous les niveaux de modes valides".
base_option_name Variable d'environnement : BASE_OPTION_NAME	Nom de l'option pour l'option de base.	baseoption	string	standard
export_with_import Variable d'environnement : EXPORT_WITH_IMPORT	Dans le fichier de cache, ne pas importer Tiramisu et autres dépendances.	true	boolean	standard
tiramisu_cache Ligne de commande : -t, --tiramisu_cache Variable d'environnement : TIRAMISU_CACHE	Store Tiramisu cache filename. Ce fichier contient les instructions Tiramisu utilisé en interne pour charger les variables. Ce fichier peut être utilisé pour le débogage.		UNIX filename	standard	• le nom de fichier peut être une chemin relatif • type de fichier autorisé: "file".
internal_functions Variable d'environnement : INTERNAL_FUNCTIONS	Nom des fonctions internes qu'il est possible d'utiliser comme fonction.		string multiple	standard
extra_annotators Variable d'environnement : EXTRA_ANNOTATORS	Nom des annotators supplémentaires.		string multiple	standard
suffix Variable d'environnement : SUFFIX	Suffix ajouté pour généré le nom des options.		string	standard
force_optional Ligne de commande : • --force_optional • --no-force_optional Variable d'environnement : FORCE_OPTIONAL	Toutes les variables dans un calcul sont optionnelles.	false	boolean obligatoire	standard
load_unexist_redefine Variable d'environnement : LOAD_UNEXIST_REDEFINE	Charger les variables redéfinis même si elles n'existe pas.	false	boolean	standard

Le gestionnaire de secret

Note

Chemin : secret_manager
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès
secret_manager.pattern Ligne de commande : --secret_manager.pattern Variable d'environnement : SECRET_MANAGER.PATTERN	Le modèle de secret permettant de construire le nom de l'élément recherché dans le gestionnaire de secrets. Le modèle est au format Jinja2.	{{ project }} - {{ environment }} - {{ service }} - {{ user }}	string obligatoire	standard

Load and exporter steps

Note

Chemin : step
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès	Validateur
step.structural Variable d'environnement : STEP.STRUCTURAL	Sélection pour structure.	• directory	choice multiple	standard	Choix : • directory • string • commandline • risotto • bitwarden
step.user_data Ligne de commande : -u, --step.user_data Variable d'environnement : STEP.USER_DATA	Sélection pour données utilisateur.		choice multiple	standard désactivé Désactivé : _('cannot load user data for doc output')	unique Choix : • yaml • environment • commandline • ansible • questionary • risotto • bitwarden
step.output Ligne de commande : -o, --step.output Variable d'environnement : STEP.OUTPUT	Sélection pour sortie.	display	choice obligatoire	standard	Choix : • display • json • doc • table • ansible

Variable	Description	Valeur par défaut	Type	Contrôle des accès
define_default_params Ligne de commande : • --define_default_params • --no-define_default_params Variable d'environnement : DEFINE_DEFAULT_PARAMS	Sur charger les paramètre par défaut pour le type d'option.	false	boolean obligatoire	standard

Paramètre par défaut pour le type d'option

Note

Chemin : default_params
standard désactivé
Désactivé : lorsque la variable "Sur charger les paramètre par défaut pour le type d'option" a la valeur "false"

UNIX filename

Note

Chemin : default_params.unix_filename
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès	Validateur
default_params.unix_filename.allow_relative Ligne de commande : • --default_params.unix_filename.allow_relative • --default_params.unix_filename.no-allow_relative Variable d'environnement : DEFAULT_PARAMS.UNIX_FILENAME.ALLOW_RELATIVE	Le nom de fichier peut être une chemin relatif.	false	boolean	standard
default_params.unix_filename.test_existence Ligne de commande : • --default_params.unix_filename.test_existence • --default_params.unix_filename.no-test_existence Variable d'environnement : DEFAULT_PARAMS.UNIX_FILENAME.TEST_EXISTENCE	Le fichier doit exister.	false	boolean	standard
default_params.unix_filename.types Ligne de commande : --default_params.unix_filename.types Variable d'environnement : DEFAULT_PARAMS.UNIX_FILENAME.TYPES	Type de fichier autorisé.	• file • directory	choice multiple	standard	unique Choix : • file • directory

IP

Note

Chemin : default_params.ip
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès
default_params.ip.private_only Ligne de commande : • --default_params.ip.private_only • --default_params.ip.no-private_only Variable d'environnement : DEFAULT_PARAMS.IP.PRIVATE_ONLY	Les IP privées sont autorisées.	false	boolean	standard
default_params.ip.allow_reserved Ligne de commande : • --default_params.ip.allow_reserved • --default_params.ip.no-allow_reserved Variable d'environnement : DEFAULT_PARAMS.IP.ALLOW_RESERVED	Les IP réservées sont autorisés.	true	boolean	standard
default_params.ip.cidr Ligne de commande : • --default_params.ip.cidr • --default_params.ip.no-cidr Variable d'environnement : DEFAULT_PARAMS.IP.CIDR	L'IP doit être au format CIDR.	false	boolean	standard

CIDR

Note

Chemin : default_params.cidr
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès
default_params.cidr.private_only Ligne de commande : • --default_params.cidr.private_only • --default_params.cidr.no-private_only Variable d'environnement : DEFAULT_PARAMS.CIDR.PRIVATE_ONLY	Les IP privées sont autorisées.	false	boolean	standard
default_params.cidr.allow_reserved Ligne de commande : • --default_params.cidr.allow_reserved • --default_params.cidr.no-allow_reserved Variable d'environnement : DEFAULT_PARAMS.CIDR.ALLOW_RESERVED	Les IP réservées sont autorisés.	false	boolean	standard
default_params.cidr.cidr Ligne de commande : • --default_params.cidr.cidr • --default_params.cidr.no-cidr Variable d'environnement : DEFAULT_PARAMS.CIDR.CIDR	L'IP doit être au format CIDR.	true	boolean	standard

Network

Note

Chemin : default_params.network
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès
default_params.network.private_only Ligne de commande : • --default_params.network.private_only • --default_params.network.no-private_only Variable d'environnement : DEFAULT_PARAMS.NETWORK.PRIVATE_ONLY	Les réseaux privés sont autorisés.	false	boolean	standard
default_params.network.allow_reserved Ligne de commande : • --default_params.network.allow_reserved • --default_params.network.no-allow_reserved Variable d'environnement : DEFAULT_PARAMS.NETWORK.ALLOW_RESERVED	Les réseaux réservés sont autorisés.	false	boolean	standard
default_params.network.cidr Ligne de commande : • --default_params.network.cidr • --default_params.network.no-cidr Variable d'environnement : DEFAULT_PARAMS.NETWORK.CIDR	Le réseau doit être au format CIDR.	false	boolean	standard

Network CIDR

Note

Chemin : default_params.network_cidr
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès
default_params.network_cidr.private_only Ligne de commande : • --default_params.network_cidr.private_only • --default_params.network_cidr.no-private_only Variable d'environnement : DEFAULT_PARAMS.NETWORK_CIDR.PRIVATE_ONLY	Les réseaux privés sont autorisés.	false	boolean	standard
default_params.network_cidr.allow_reserved Ligne de commande : • --default_params.network_cidr.allow_reserved • --default_params.network_cidr.no-allow_reserved Variable d'environnement : DEFAULT_PARAMS.NETWORK_CIDR.ALLOW_RESERVED	Les réseaux réservés sont autorisés.	false	boolean	standard
default_params.network_cidr.cidr Ligne de commande : • --default_params.network_cidr.cidr • --default_params.network_cidr.no-cidr Variable d'environnement : DEFAULT_PARAMS.NETWORK_CIDR.CIDR	Le réseau doit être au format CIDR.	true	boolean	standard

Netbios

Note

Chemin : default_params.netbios
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès	Validateur
default_params.netbios.type Ligne de commande : --default_params.netbios.type Variable d'environnement : DEFAULT_PARAMS.NETBIOS.TYPE	Type de nom de domaine.	netbios	choice	standard	Choix : • domainname • netbios • hostname • null
default_params.netbios.allow_without_dot Ligne de commande : • --default_params.netbios.allow_without_dot • --default_params.netbios.no-allow_without_dot Variable d'environnement : DEFAULT_PARAMS.NETBIOS.ALLOW_WITHOUT_DOT	Le nom de domaine peut être un nom d'hôte.	false	boolean	standard
default_params.netbios.test_existence Ligne de commande : • --default_params.netbios.test_existence • --default_params.netbios.no-test_existence Variable d'environnement : DEFAULT_PARAMS.NETBIOS.TEST_EXISTENCE	Le nom de domaine doit exister.	false	boolean	standard
default_params.netbios.allow_ip Ligne de commande : • --default_params.netbios.allow_ip • --default_params.netbios.no-allow_ip Variable d'environnement : DEFAULT_PARAMS.NETBIOS.ALLOW_IP	Le nom de domaine peut être une IP.	false	boolean	standard
default_params.netbios.allow_cidr_network Ligne de commande : • --default_params.netbios.allow_cidr_network • --default_params.netbios.no-allow_cidr_network Variable d'environnement : DEFAULT_PARAMS.NETBIOS.ALLOW_CIDR_NETWORK	Le nom de domaine peut être un réseau au format CIDR.	false	boolean	standard
default_params.netbios.allow_startswith_dot Ligne de commande : • --default_params.netbios.allow_startswith_dot • --default_params.netbios.no-allow_startswith_dot Variable d'environnement : DEFAULT_PARAMS.NETBIOS.ALLOW_STARTSWITH_DOT	Le nom de domaine peut démarré par un point.	false	boolean	standard

Domainname

Note

Chemin : default_params.domainname
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès	Validateur
default_params.domainname.type Ligne de commande : --default_params.domainname.type Variable d'environnement : DEFAULT_PARAMS.DOMAINNAME.TYPE	Type de nom de domaine.	domainname	choice	standard	Choix : • domainname • netbios • hostname • null
default_params.domainname.allow_without_dot Ligne de commande : • --default_params.domainname.allow_without_dot • --default_params.domainname.no-allow_without_dot Variable d'environnement : DEFAULT_PARAMS.DOMAINNAME.ALLOW_WITHOUT_DOT	Le nom de domaine peut être un nom d'hôte.	false	boolean	standard
default_params.domainname.test_existence Ligne de commande : • --default_params.domainname.test_existence • --default_params.domainname.no-test_existence Variable d'environnement : DEFAULT_PARAMS.DOMAINNAME.TEST_EXISTENCE	Le nom de domaine doit exister.	false	boolean	standard
default_params.domainname.allow_ip Ligne de commande : • --default_params.domainname.allow_ip • --default_params.domainname.no-allow_ip Variable d'environnement : DEFAULT_PARAMS.DOMAINNAME.ALLOW_IP	Le nom de domaine peut être une IP.	false	boolean	standard
default_params.domainname.allow_cidr_network Ligne de commande : • --default_params.domainname.allow_cidr_network • --default_params.domainname.no-allow_cidr_network Variable d'environnement : DEFAULT_PARAMS.DOMAINNAME.ALLOW_CIDR_NETWORK	Le nom de domaine peut être un réseau au format CIDR.	false	boolean	standard
default_params.domainname.allow_startswith_dot Ligne de commande : • --default_params.domainname.allow_startswith_dot • --default_params.domainname.no-allow_startswith_dot Variable d'environnement : DEFAULT_PARAMS.DOMAINNAME.ALLOW_STARTSWITH_DOT	Le nom de domaine peut démarré par un point.	false	boolean	standard

Hostname

Note

Chemin : default_params.hostname
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès	Validateur
default_params.hostname.type Ligne de commande : --default_params.hostname.type Variable d'environnement : DEFAULT_PARAMS.HOSTNAME.TYPE	Type de nom de domaine.	hostname	choice	standard	Choix : • domainname • netbios • hostname • null
default_params.hostname.allow_without_dot Ligne de commande : • --default_params.hostname.allow_without_dot • --default_params.hostname.no-allow_without_dot Variable d'environnement : DEFAULT_PARAMS.HOSTNAME.ALLOW_WITHOUT_DOT	Le nom de domaine peut être un nom d'hôte.	false	boolean	standard
default_params.hostname.test_existence Ligne de commande : • --default_params.hostname.test_existence • --default_params.hostname.no-test_existence Variable d'environnement : DEFAULT_PARAMS.HOSTNAME.TEST_EXISTENCE	Le nom de domaine doit exister.	false	boolean	standard
default_params.hostname.allow_ip Ligne de commande : • --default_params.hostname.allow_ip • --default_params.hostname.no-allow_ip Variable d'environnement : DEFAULT_PARAMS.HOSTNAME.ALLOW_IP	Le nom de domaine peut être une IP.	false	boolean	standard
default_params.hostname.allow_cidr_network Ligne de commande : • --default_params.hostname.allow_cidr_network • --default_params.hostname.no-allow_cidr_network Variable d'environnement : DEFAULT_PARAMS.HOSTNAME.ALLOW_CIDR_NETWORK	Le nom de domaine peut être un réseau au format CIDR.	false	boolean	standard
default_params.hostname.allow_startswith_dot Ligne de commande : • --default_params.hostname.allow_startswith_dot • --default_params.hostname.no-allow_startswith_dot Variable d'environnement : DEFAULT_PARAMS.HOSTNAME.ALLOW_STARTSWITH_DOT	Le nom de domaine peut démarré par un point.	false	boolean	standard

Web address

Note

Chemin : default_params.web_address
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès	Validateur
default_params.web_address.type Ligne de commande : --default_params.web_address.type Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.TYPE	Type de nom de domaine.	domainname	choice	standard	Choix : • domainname • netbios • hostname • null
default_params.web_address.allow_without_dot Ligne de commande : • --default_params.web_address.allow_without_dot • --default_params.web_address.no-allow_without_dot Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_WITHOUT_DOT	Le nom de domaine peut être un nom d'hôte.	true	boolean	standard
default_params.web_address.test_existence Ligne de commande : • --default_params.web_address.test_existence • --default_params.web_address.no-test_existence Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.TEST_EXISTENCE	Le nom de domaine doit exister.	false	boolean	standard
default_params.web_address.allow_ip Ligne de commande : • --default_params.web_address.allow_ip • --default_params.web_address.no-allow_ip Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_IP	Le nom de domaine peut être une IP.	false	boolean	standard
default_params.web_address.allow_cidr_network Ligne de commande : • --default_params.web_address.allow_cidr_network • --default_params.web_address.no-allow_cidr_network Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_CIDR_NETWORK	Le nom de domaine peut être un réseau au format CIDR.	false	boolean	standard
default_params.web_address.allow_startswith_dot Ligne de commande : • --default_params.web_address.allow_startswith_dot • --default_params.web_address.no-allow_startswith_dot Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_STARTSWITH_DOT	Le nom de domaine peut démarré par un point.	false	boolean	standard
default_params.web_address.allow_range Ligne de commande : • --default_params.web_address.allow_range • --default_params.web_address.no-allow_range Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_RANGE	Peut être une plage de port.	false	boolean	standard
default_params.web_address.allow_protocol Ligne de commande : • --default_params.web_address.allow_protocol • --default_params.web_address.no-allow_protocol Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_PROTOCOL	Peut avoir le protocole.	false	boolean	standard
default_params.web_address.allow_zero Ligne de commande : • --default_params.web_address.allow_zero • --default_params.web_address.no-allow_zero Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_ZERO	Port 0 est autorisé.	false	boolean	standard
default_params.web_address.allow_wellknown Ligne de commande : • --default_params.web_address.allow_wellknown • --default_params.web_address.no-allow_wellknown Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_WELLKNOWN	Les ports connus (1 à 1023) sont autorisés.	true	boolean	standard
default_params.web_address.allow_registred Ligne de commande : • --default_params.web_address.allow_registred • --default_params.web_address.no-allow_registred Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_REGISTRED	Les ports enregistrés (1024 à 49151) sont autorisés.	true	boolean	standard
default_params.web_address.allow_private Ligne de commande : • --default_params.web_address.allow_private • --default_params.web_address.no-allow_private Variable d'environnement : DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_PRIVATE	Les ports privés (supérieur à 49152) sont autorisés.	false	boolean	standard

Port

Note

Chemin : default_params.port
standard

Variable	Description	Valeur par défaut	Type	Contrôle des accès
default_params.port.allow_range Ligne de commande : • --default_params.port.allow_range • --default_params.port.no-allow_range Variable d'environnement : DEFAULT_PARAMS.PORT.ALLOW_RANGE	Peut être une plage de port.	false	boolean	standard
default_params.port.allow_protocol Ligne de commande : • --default_params.port.allow_protocol • --default_params.port.no-allow_protocol Variable d'environnement : DEFAULT_PARAMS.PORT.ALLOW_PROTOCOL	Peut avoir le protocole.	false	boolean	standard
default_params.port.allow_zero Ligne de commande : • --default_params.port.allow_zero • --default_params.port.no-allow_zero Variable d'environnement : DEFAULT_PARAMS.PORT.ALLOW_ZERO	Port 0 est autorisé.	false	boolean	standard
default_params.port.allow_wellknown Ligne de commande : • --default_params.port.allow_wellknown • --default_params.port.no-allow_wellknown Variable d'environnement : DEFAULT_PARAMS.PORT.ALLOW_WELLKNOWN	Les ports connus (1 à 1023) sont autorisés.	true	boolean	standard
default_params.port.allow_registred Ligne de commande : • --default_params.port.allow_registred • --default_params.port.no-allow_registred Variable d'environnement : DEFAULT_PARAMS.PORT.ALLOW_REGISTRED	Les ports enregistrés (1024 à 49151) sont autorisés.	true	boolean	standard
default_params.port.allow_private Ligne de commande : • --default_params.port.allow_private • --default_params.port.no-allow_private Variable d'environnement : DEFAULT_PARAMS.PORT.ALLOW_PRIVATE	Les ports privés (supérieur à 49152) sont autorisés.	true	boolean	standard