Table of Contents

• The secret manager
• Load and exporter steps
• Default parameters for option type
• UNIX filename
• IP
• CIDR
• Network
• Network CIDR
• Netbios
• Domainname
• Hostname
• Web address
• Port

🇬🇧 (EN) - 🇫🇷 (FR)

Variable	Description	Default value	Type	Access control	Validator
default_structural_format_version Command line: -v, --default_structural_format_version Environment variable: DEFAULT_STRUCTURAL_FORMAT_VERSION	Default version of the structural file format. This value is only used if the version is not set in the structural file.		choice	standard	Choices: • 1.0 • 1.1 • null
functions_files Command line: -c, --functions_files Environment variable: FUNCTIONS_FILES	File with functions. This file contains filters and additional Jinja2 functions usable in structure files.		UNIX filename multiple	standard	unique • this filename could be a relative path • this file must exist • file type allowed: "file".
modes_level Command line: --modes_level Environment variable: MODES_LEVEL	All modes level available.		string multiple	standard	unique
default_family_mode Environment variable: DEFAULT_FAMILY_MODE	Default mode for a family.	the first one defined in "All modes level available"	string	standard	This mode must be available in "All modes level available".
default_variable_mode Environment variable: DEFAULT_VARIABLE_MODE	Default mode for a variable.	if the variable "All modes level available" is defined, the default value is the second available element, otherwise, the first	string	standard	This mode must be available in "All modes level available".
base_option_name Environment variable: BASE_OPTION_NAME	Option name for the base option.	baseoption	string	standard
export_with_import Environment variable: EXPORT_WITH_IMPORT	In cache file, do not importation of Tiramisu and other dependencies.	true	boolean	standard
tiramisu_cache Command line: -t, --tiramisu_cache Environment variable: TIRAMISU_CACHE	Store Tiramisu cache filename. This file contains the Tiramisu instructions used internally to load the variables. This file can be used for debugging.		UNIX filename	standard	• this filename could be a relative path • file type allowed: "file".
internal_functions Environment variable: INTERNAL_FUNCTIONS	Name of internal functions that we can use as a function.		string multiple	standard
extra_annotators Environment variable: EXTRA_ANNOTATORS	Name of extra annotators.		string multiple	standard
suffix Environment variable: SUFFIX	Suffix add to generated options name.		string	standard
force_optional Command line: • --force_optional • --no-force_optional Environment variable: FORCE_OPTIONAL	Every variables in calculation are optionals.	false	boolean mandatory	standard
load_unexist_redefine Environment variable: LOAD_UNEXIST_REDEFINE	Loads redefine variables even if there don't already exists.	false	boolean	standard

The secret manager

Note

Path: secret_manager
standard

Variable	Description	Default value	Type	Access control
secret_manager.pattern Command line: --secret_manager.pattern Environment variable: SECRET_MANAGER.PATTERN	The secret pattern to constructing the name of the item searched for in the secret manager. The pattern is in Jinja2 format.	{{ project }} - {{ environment }} - {{ service }} - {{ user }}	string mandatory	standard

Load and exporter steps

Note

Path: step
standard

Variable	Description	Default value	Type	Access control	Validator
step.structural Environment variable: STEP.STRUCTURAL	Select for structural.	• directory	choice multiple	standard	Choices: • directory • string • commandline • risotto • bitwarden
step.user_data Command line: -u, --step.user_data Environment variable: STEP.USER_DATA	Select for user datas.		choice multiple	standard disabled Disabled: _('cannot load user data for doc output')	unique Choices: • yaml • environment • commandline • ansible • questionary • risotto • bitwarden
step.output Command line: -o, --step.output Environment variable: STEP.OUTPUT	Select for output.	display	choice mandatory	standard	Choices: • display • json • doc • table • ansible

Variable	Description	Default value	Type	Access control
define_default_params Command line: • --define_default_params • --no-define_default_params Environment variable: DEFINE_DEFAULT_PARAMS	Override default parameters for option type.	false	boolean mandatory	standard

Default parameters for option type

Note

Path: default_params
standard disabled
Disabled: when the variable "Override default parameters for option type" has the value "false"

UNIX filename

Note

Path: default_params.unix_filename
standard

Variable	Description	Default value	Type	Access control	Validator
default_params.unix_filename.allow_relative Command line: • --default_params.unix_filename.allow_relative • --default_params.unix_filename.no-allow_relative Environment variable: DEFAULT_PARAMS.UNIX_FILENAME.ALLOW_RELATIVE	This filename could be a relative path.	false	boolean	standard
default_params.unix_filename.test_existence Command line: • --default_params.unix_filename.test_existence • --default_params.unix_filename.no-test_existence Environment variable: DEFAULT_PARAMS.UNIX_FILENAME.TEST_EXISTENCE	This file must exist.	false	boolean	standard
default_params.unix_filename.types Command line: --default_params.unix_filename.types Environment variable: DEFAULT_PARAMS.UNIX_FILENAME.TYPES	File type allowed.	• file • directory	choice multiple	standard	unique Choices: • file • directory

IP

Note

Path: default_params.ip
standard

Variable	Description	Default value	Type	Access control
default_params.ip.private_only Command line: • --default_params.ip.private_only • --default_params.ip.no-private_only Environment variable: DEFAULT_PARAMS.IP.PRIVATE_ONLY	Private IP are allowed.	false	boolean	standard
default_params.ip.allow_reserved Command line: • --default_params.ip.allow_reserved • --default_params.ip.no-allow_reserved Environment variable: DEFAULT_PARAMS.IP.ALLOW_RESERVED	Reserved IP are allowed.	true	boolean	standard
default_params.ip.cidr Command line: • --default_params.ip.cidr • --default_params.ip.no-cidr Environment variable: DEFAULT_PARAMS.IP.CIDR	IP must be in CIDR format.	false	boolean	standard

CIDR

Note

Path: default_params.cidr
standard

Variable	Description	Default value	Type	Access control
default_params.cidr.private_only Command line: • --default_params.cidr.private_only • --default_params.cidr.no-private_only Environment variable: DEFAULT_PARAMS.CIDR.PRIVATE_ONLY	Private IP are allowed.	false	boolean	standard
default_params.cidr.allow_reserved Command line: • --default_params.cidr.allow_reserved • --default_params.cidr.no-allow_reserved Environment variable: DEFAULT_PARAMS.CIDR.ALLOW_RESERVED	Reserved IP are allowed.	false	boolean	standard
default_params.cidr.cidr Command line: • --default_params.cidr.cidr • --default_params.cidr.no-cidr Environment variable: DEFAULT_PARAMS.CIDR.CIDR	IP must be in CIDR format.	true	boolean	standard

Network

Note

Path: default_params.network
standard

Variable	Description	Default value	Type	Access control
default_params.network.private_only Command line: • --default_params.network.private_only • --default_params.network.no-private_only Environment variable: DEFAULT_PARAMS.NETWORK.PRIVATE_ONLY	Private network are allowed.	false	boolean	standard
default_params.network.allow_reserved Command line: • --default_params.network.allow_reserved • --default_params.network.no-allow_reserved Environment variable: DEFAULT_PARAMS.NETWORK.ALLOW_RESERVED	Reserved network are allowed.	false	boolean	standard
default_params.network.cidr Command line: • --default_params.network.cidr • --default_params.network.no-cidr Environment variable: DEFAULT_PARAMS.NETWORK.CIDR	Network must be in CIDR format.	false	boolean	standard

Network CIDR

Note

Path: default_params.network_cidr
standard

Variable	Description	Default value	Type	Access control
default_params.network_cidr.private_only Command line: • --default_params.network_cidr.private_only • --default_params.network_cidr.no-private_only Environment variable: DEFAULT_PARAMS.NETWORK_CIDR.PRIVATE_ONLY	Private network are allowed.	false	boolean	standard
default_params.network_cidr.allow_reserved Command line: • --default_params.network_cidr.allow_reserved • --default_params.network_cidr.no-allow_reserved Environment variable: DEFAULT_PARAMS.NETWORK_CIDR.ALLOW_RESERVED	Reserved network are allowed.	false	boolean	standard
default_params.network_cidr.cidr Command line: • --default_params.network_cidr.cidr • --default_params.network_cidr.no-cidr Environment variable: DEFAULT_PARAMS.NETWORK_CIDR.CIDR	Network must be in CIDR format.	true	boolean	standard

Netbios

Note

Path: default_params.netbios
standard

Variable	Description	Default value	Type	Access control	Validator
default_params.netbios.type Command line: --default_params.netbios.type Environment variable: DEFAULT_PARAMS.NETBIOS.TYPE	Type of domainname.	netbios	choice	standard	Choices: • domainname • netbios • hostname • null
default_params.netbios.allow_without_dot Command line: • --default_params.netbios.allow_without_dot • --default_params.netbios.no-allow_without_dot Environment variable: DEFAULT_PARAMS.NETBIOS.ALLOW_WITHOUT_DOT	The domain name can be a hostname.	false	boolean	standard
default_params.netbios.test_existence Command line: • --default_params.netbios.test_existence • --default_params.netbios.no-test_existence Environment variable: DEFAULT_PARAMS.NETBIOS.TEST_EXISTENCE	The domain name must exist.	false	boolean	standard
default_params.netbios.allow_ip Command line: • --default_params.netbios.allow_ip • --default_params.netbios.no-allow_ip Environment variable: DEFAULT_PARAMS.NETBIOS.ALLOW_IP	The domain name can be an IP.	false	boolean	standard
default_params.netbios.allow_cidr_network Command line: • --default_params.netbios.allow_cidr_network • --default_params.netbios.no-allow_cidr_network Environment variable: DEFAULT_PARAMS.NETBIOS.ALLOW_CIDR_NETWORK	The domain name can be network in CIDR format.	false	boolean	standard
default_params.netbios.allow_startswith_dot Command line: • --default_params.netbios.allow_startswith_dot • --default_params.netbios.no-allow_startswith_dot Environment variable: DEFAULT_PARAMS.NETBIOS.ALLOW_STARTSWITH_DOT	The domain name can starts by a dot.	false	boolean	standard

Domainname

Note

Path: default_params.domainname
standard

Variable	Description	Default value	Type	Access control	Validator
default_params.domainname.type Command line: --default_params.domainname.type Environment variable: DEFAULT_PARAMS.DOMAINNAME.TYPE	Type of domainname.	domainname	choice	standard	Choices: • domainname • netbios • hostname • null
default_params.domainname.allow_without_dot Command line: • --default_params.domainname.allow_without_dot • --default_params.domainname.no-allow_without_dot Environment variable: DEFAULT_PARAMS.DOMAINNAME.ALLOW_WITHOUT_DOT	The domain name can be a hostname.	false	boolean	standard
default_params.domainname.test_existence Command line: • --default_params.domainname.test_existence • --default_params.domainname.no-test_existence Environment variable: DEFAULT_PARAMS.DOMAINNAME.TEST_EXISTENCE	The domain name must exist.	false	boolean	standard
default_params.domainname.allow_ip Command line: • --default_params.domainname.allow_ip • --default_params.domainname.no-allow_ip Environment variable: DEFAULT_PARAMS.DOMAINNAME.ALLOW_IP	The domain name can be an IP.	false	boolean	standard
default_params.domainname.allow_cidr_network Command line: • --default_params.domainname.allow_cidr_network • --default_params.domainname.no-allow_cidr_network Environment variable: DEFAULT_PARAMS.DOMAINNAME.ALLOW_CIDR_NETWORK	The domain name can be network in CIDR format.	false	boolean	standard
default_params.domainname.allow_startswith_dot Command line: • --default_params.domainname.allow_startswith_dot • --default_params.domainname.no-allow_startswith_dot Environment variable: DEFAULT_PARAMS.DOMAINNAME.ALLOW_STARTSWITH_DOT	The domain name can starts by a dot.	false	boolean	standard

Hostname

Note

Path: default_params.hostname
standard

Variable	Description	Default value	Type	Access control	Validator
default_params.hostname.type Command line: --default_params.hostname.type Environment variable: DEFAULT_PARAMS.HOSTNAME.TYPE	Type of domainname.	hostname	choice	standard	Choices: • domainname • netbios • hostname • null
default_params.hostname.allow_without_dot Command line: • --default_params.hostname.allow_without_dot • --default_params.hostname.no-allow_without_dot Environment variable: DEFAULT_PARAMS.HOSTNAME.ALLOW_WITHOUT_DOT	The domain name can be a hostname.	false	boolean	standard
default_params.hostname.test_existence Command line: • --default_params.hostname.test_existence • --default_params.hostname.no-test_existence Environment variable: DEFAULT_PARAMS.HOSTNAME.TEST_EXISTENCE	The domain name must exist.	false	boolean	standard
default_params.hostname.allow_ip Command line: • --default_params.hostname.allow_ip • --default_params.hostname.no-allow_ip Environment variable: DEFAULT_PARAMS.HOSTNAME.ALLOW_IP	The domain name can be an IP.	false	boolean	standard
default_params.hostname.allow_cidr_network Command line: • --default_params.hostname.allow_cidr_network • --default_params.hostname.no-allow_cidr_network Environment variable: DEFAULT_PARAMS.HOSTNAME.ALLOW_CIDR_NETWORK	The domain name can be network in CIDR format.	false	boolean	standard
default_params.hostname.allow_startswith_dot Command line: • --default_params.hostname.allow_startswith_dot • --default_params.hostname.no-allow_startswith_dot Environment variable: DEFAULT_PARAMS.HOSTNAME.ALLOW_STARTSWITH_DOT	The domain name can starts by a dot.	false	boolean	standard

Web address

Note

Path: default_params.web_address
standard

Variable	Description	Default value	Type	Access control	Validator
default_params.web_address.type Command line: --default_params.web_address.type Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.TYPE	Type of domainname.	domainname	choice	standard	Choices: • domainname • netbios • hostname • null
default_params.web_address.allow_without_dot Command line: • --default_params.web_address.allow_without_dot • --default_params.web_address.no-allow_without_dot Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_WITHOUT_DOT	The domain name can be a hostname.	true	boolean	standard
default_params.web_address.test_existence Command line: • --default_params.web_address.test_existence • --default_params.web_address.no-test_existence Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.TEST_EXISTENCE	The domain name must exist.	false	boolean	standard
default_params.web_address.allow_ip Command line: • --default_params.web_address.allow_ip • --default_params.web_address.no-allow_ip Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_IP	The domain name can be an IP.	false	boolean	standard
default_params.web_address.allow_cidr_network Command line: • --default_params.web_address.allow_cidr_network • --default_params.web_address.no-allow_cidr_network Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_CIDR_NETWORK	The domain name can be network in CIDR format.	false	boolean	standard
default_params.web_address.allow_startswith_dot Command line: • --default_params.web_address.allow_startswith_dot • --default_params.web_address.no-allow_startswith_dot Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_STARTSWITH_DOT	The domain name can starts by a dot.	false	boolean	standard
default_params.web_address.allow_range Command line: • --default_params.web_address.allow_range • --default_params.web_address.no-allow_range Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_RANGE	Can be range of port.	false	boolean	standard
default_params.web_address.allow_protocol Command line: • --default_params.web_address.allow_protocol • --default_params.web_address.no-allow_protocol Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_PROTOCOL	Can have the protocol.	false	boolean	standard
default_params.web_address.allow_zero Command line: • --default_params.web_address.allow_zero • --default_params.web_address.no-allow_zero Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_ZERO	Port 0 is allowed.	false	boolean	standard
default_params.web_address.allow_wellknown Command line: • --default_params.web_address.allow_wellknown • --default_params.web_address.no-allow_wellknown Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_WELLKNOWN	Well-known ports (1 to 1023) are allowed.	true	boolean	standard
default_params.web_address.allow_registred Command line: • --default_params.web_address.allow_registred • --default_params.web_address.no-allow_registred Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_REGISTRED	Registred ports (1024 to 49151) are allowed.	true	boolean	standard
default_params.web_address.allow_private Command line: • --default_params.web_address.allow_private • --default_params.web_address.no-allow_private Environment variable: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_PRIVATE	Private ports (greater than 49152) are allowed.	false	boolean	standard

Port

Note

Path: default_params.port
standard

Variable	Description	Default value	Type	Access control
default_params.port.allow_range Command line: • --default_params.port.allow_range • --default_params.port.no-allow_range Environment variable: DEFAULT_PARAMS.PORT.ALLOW_RANGE	Can be range of port.	false	boolean	standard
default_params.port.allow_protocol Command line: • --default_params.port.allow_protocol • --default_params.port.no-allow_protocol Environment variable: DEFAULT_PARAMS.PORT.ALLOW_PROTOCOL	Can have the protocol.	false	boolean	standard
default_params.port.allow_zero Command line: • --default_params.port.allow_zero • --default_params.port.no-allow_zero Environment variable: DEFAULT_PARAMS.PORT.ALLOW_ZERO	Port 0 is allowed.	false	boolean	standard
default_params.port.allow_wellknown Command line: • --default_params.port.allow_wellknown • --default_params.port.no-allow_wellknown Environment variable: DEFAULT_PARAMS.PORT.ALLOW_WELLKNOWN	Well-known ports (1 to 1023) are allowed.	true	boolean	standard
default_params.port.allow_registred Command line: • --default_params.port.allow_registred • --default_params.port.no-allow_registred Environment variable: DEFAULT_PARAMS.PORT.ALLOW_REGISTRED	Registred ports (1024 to 49151) are allowed.	true	boolean	standard
default_params.port.allow_private Command line: • --default_params.port.allow_private • --default_params.port.no-allow_private Environment variable: DEFAULT_PARAMS.PORT.ALLOW_PRIVATE	Private ports (greater than 49152) are allowed.	true	boolean	standard