stove/rougail-output-ansible
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat: add doc

Browse source
This commit is contained in:
egarette@silique.fr 2025-12-23 21:32:53 +01:00
parent 0bdff61b37
commit c246b355aa
6 changed files with 114 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.fr.md Normal file
View file

@ -0,0 +1,21 @@
---
gitea: none
include_toc: true
---
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
## Génère un inventaire Ansible
> [!NOTE]
>
> **Chemin** : ansible\
> *`désactivé`*\
> **Désactivé** : lorsque la variable "[Sélection pour sortie](#step.output)" est accessible et n'a pas la valeur "ansible"
| Variable | Description | Valeur par défaut | Type |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|
| **<a id="ansible.host_namespace" name="ansible.host_namespace">ansible.host_namespace</a>**<br/>**Ligne de commande** : --ansible.host_namespace<br/>**Variable d'environnement** : ANSIBLE.HOST_NAMESPACE | Espace de nom avec les valeurs de l&#x27;hôte. | hosts | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="ansible.no_namespace_in_vars" name="ansible.no_namespace_in_vars">ansible.no_namespace_in_vars</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--ansible.no_namespace_in_vars<br/>•&nbsp;--ansible.no-no_namespace_in_vars<br/>**Variable d'environnement** : ANSIBLE.NO_NAMESPACE_IN_VARS | Supprime le nom de l&#x27;espace de nom dans les vars de l&#x27;hôte. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="ansible.export_warnings" name="ansible.export_warnings">ansible.export_warnings</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--ansible.export_warnings<br/>•&nbsp;--ansible.no-export_warnings<br/>**Variable d'environnement** : ANSIBLE.EXPORT_WARNINGS | Affiche les avertissements dans les données d&#x27;exportation Ansible. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |

21
README.md
View file

@ -1,2 +1,21 @@
# rougail-output-ansible ---
gitea: none
include_toc: true
---
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)
## Generate Ansible inventory
> [!NOTE]
>
> **Path**: ansible\
> *`disabled`*\
> **Disabled**: when the variable "[Select for output](#step.output)" is accessible and hasn't the value "ansible"
| Variable | Description | Default value | Type |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|
| **<a id="ansible.host_namespace" name="ansible.host_namespace">ansible.host_namespace</a>**<br/>**Command line**: --ansible.host_namespace<br/>**Environment variable**: ANSIBLE.HOST_NAMESPACE | Namespace with host values. | hosts | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="ansible.no_namespace_in_vars" name="ansible.no_namespace_in_vars">ansible.no_namespace_in_vars</a>**<br/>**Command line**: <br/>•&nbsp;--ansible.no_namespace_in_vars<br/>•&nbsp;--ansible.no-no_namespace_in_vars<br/>**Environment variable**: ANSIBLE.NO_NAMESPACE_IN_VARS | Remove namespace name in host vars. | false | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="ansible.export_warnings" name="ansible.export_warnings">ansible.export_warnings</a>**<br/>**Command line**: <br/>•&nbsp;--ansible.export_warnings<br/>•&nbsp;--ansible.no-export_warnings<br/>**Environment variable**: ANSIBLE.EXPORT_WARNINGS | Displays warnings inside Ansible exportation datas. | true | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |

48
locale/fr/LC_MESSAGES/rougail_output_ansible.po
View file

@ -5,8 +5,8 @@
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: \n" "Project-Id-Version: \n"
"POT-Creation-Date: 2025-11-21 08:24+0100\n" "POT-Creation-Date: 2025-12-23 21:31+0100\n"
"PO-Revision-Date: 2025-11-21 08:24+0100\n" "PO-Revision-Date: 2025-12-23 21:33+0100\n"
"Last-Translator: \n" "Last-Translator: \n"
"Language-Team: \n" "Language-Team: \n"
"Language: fr\n" "Language: fr\n"
@ -16,21 +16,21 @@ msgstr ""
"Generated-By: pygettext.py 1.5\n" "Generated-By: pygettext.py 1.5\n"
"X-Generator: Poedit 3.8\n" "X-Generator: Poedit 3.8\n"
#: src/rougail/output_ansible/__init__.py:59 #: src/rougail/output_ansible/__init__.py:66
msgid "no namespace configured" msgid "no namespace configured"
msgstr "aucun espace de nom configuré" msgstr "aucun espace de nom configuré"
#: src/rougail/output_ansible/__init__.py:68 #: src/rougail/output_ansible/__init__.py:76
msgid "cannot find host namespace \"{0}\"" msgid "cannot find host namespace \"{0}\""
msgstr "ne peut trouve l'espace de nom de l'hôte \"{0}\"" msgstr "ne peut trouve l'espace de nom de l'hôte \"{0}\""
#: src/rougail/output_ansible/__init__.py:75 #: src/rougail/output_ansible/__init__.py:83
msgid "malformated host namespace \"{0}\", should have the \"hostnames\" key" msgid "malformated host namespace \"{0}\", should have the \"hostnames\" key"
msgstr "" msgstr ""
"l'espace de nom de l'hôte \"{0}\" est mal formaté, devrait avoir la clé " "l'espace de nom de l'hôte \"{0}\" est mal formaté, devrait avoir la clé "
"\"hostnames\"" "\"hostnames\""
#: src/rougail/output_ansible/__init__.py:105 #: src/rougail/output_ansible/__init__.py:114
msgid "cannot find \"hostnames\" in \"{0}\" namespace" msgid "cannot find \"hostnames\" in \"{0}\" namespace"
msgstr "ne peut trouve \"hostnames\" dans l'espace de nom \"{0}\"" msgstr "ne peut trouve \"hostnames\" dans l'espace de nom \"{0}\""
@ -38,26 +38,44 @@ msgstr "ne peut trouve \"hostnames\" dans l'espace de nom \"{0}\""
msgid "parameter added only to be compatible with Ansible" msgid "parameter added only to be compatible with Ansible"
msgstr "paramètre ajouté seulement pour être compatible avec Ansible" msgstr "paramètre ajouté seulement pour être compatible avec Ansible"
#: src/rougail/output_ansible/config.py:53 #: src/rougail/output_ansible/config.py:36
msgid "Configuration of user data or output Ansible" msgid "if ansible is not set in \"step.output\""
msgstr "Configuration de Ansible comme donnée utilisateur ou sortie" msgstr "si ansible n'est pas défini dans \"step.output\""
#: src/rougail/output_ansible/config.py:65 #: src/rougail/output_ansible/config.py:43
msgid "Configuration of output Ansible" msgid "if ansible or json are not set in \"step.output\""
msgstr "Configuration de la sortie Ansible" msgstr "si ansible ou json ne sont pas définis dans \"step.output\""
#: src/rougail/output_ansible/config.py:77 #: src/rougail/output_ansible/config.py:50
msgid "Load Ansible encrypt inventory or generate Ansible inventory"
msgstr "Charge un inventaire chiffré Ansible ou génère un inventaire Ansible"
#: src/rougail/output_ansible/config.py:55
msgid "if ansible is not in \"step.output\" and not in \"step.user_data\""
msgstr "si ansible n'est pas dans \"step.output\" ni dans \"step.user_data\""
#: src/rougail/output_ansible/config.py:61
msgid "Generate Ansible inventory"
msgstr "Génère un inventaire Ansible"
#: src/rougail/output_ansible/config.py:72
msgid "Namespace with host values" msgid "Namespace with host values"
msgstr "Espace de nom avec les valeurs de l'hôte" msgstr "Espace de nom avec les valeurs de l'hôte"
#: src/rougail/output_ansible/config.py:81 #: src/rougail/output_ansible/config.py:74
msgid "Remove namespace name in host vars" msgid "Remove namespace name in host vars"
msgstr "Supprime le nom de l'espace de nom dans les vars de l'hôte" msgstr "Supprime le nom de l'espace de nom dans les vars de l'hôte"
#: src/rougail/output_ansible/config.py:85 #: src/rougail/output_ansible/config.py:76
msgid "Displays warnings inside Ansible exportation datas" msgid "Displays warnings inside Ansible exportation datas"
msgstr "Affiche les avertissements dans les données d'exportation Ansible" msgstr "Affiche les avertissements dans les données d'exportation Ansible"
#~ msgid "Configuration of user data or output Ansible"
#~ msgstr "Configuration de Ansible comme donnée utilisateur ou sortie"
#~ msgid "Configuration of output Ansible"
#~ msgstr "Configuration de la sortie Ansible"
#~ msgid "Only variables in host namespace is available by a host" #~ msgid "Only variables in host namespace is available by a host"
#~ msgstr "" #~ msgstr ""
#~ "Seules les variables de l'espace de nom de l'hôte est valable pour un hôte" #~ "Seules les variables de l'espace de nom de l'hôte est valable pour un hôte"

36
locale/rougail_output_ansible.pot
View file

@ -5,7 +5,7 @@
msgid "" msgid ""
msgstr "" msgstr ""
"Project-Id-Version: PACKAGE VERSION\n" "Project-Id-Version: PACKAGE VERSION\n"
"POT-Creation-Date: 2025-11-21 08:24+0100\n" "POT-Creation-Date: 2025-12-23 21:34+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n" "Language-Team: LANGUAGE <LL@li.org>\n"
@ -15,19 +15,19 @@ msgstr ""
"Generated-By: pygettext.py 1.5\n" "Generated-By: pygettext.py 1.5\n"
#: src/rougail/output_ansible/__init__.py:59 #: src/rougail/output_ansible/__init__.py:66
msgid "no namespace configured" msgid "no namespace configured"
msgstr "" msgstr ""
#: src/rougail/output_ansible/__init__.py:68 #: src/rougail/output_ansible/__init__.py:76
msgid "cannot find host namespace \"{0}\"" msgid "cannot find host namespace \"{0}\""
msgstr "" msgstr ""
#: src/rougail/output_ansible/__init__.py:75 #: src/rougail/output_ansible/__init__.py:83
msgid "malformated host namespace \"{0}\", should have the \"hostnames\" key" msgid "malformated host namespace \"{0}\", should have the \"hostnames\" key"
msgstr "" msgstr ""
#: src/rougail/output_ansible/__init__.py:105 #: src/rougail/output_ansible/__init__.py:114
msgid "cannot find \"hostnames\" in \"{0}\" namespace" msgid "cannot find \"hostnames\" in \"{0}\" namespace"
msgstr "" msgstr ""
@ -35,23 +35,35 @@ msgstr ""
msgid "parameter added only to be compatible with Ansible" msgid "parameter added only to be compatible with Ansible"
msgstr "" msgstr ""
#: src/rougail/output_ansible/config.py:53 #: src/rougail/output_ansible/config.py:36
msgid "Configuration of user data or output Ansible" msgid "if ansible is not set in \"step.output\""
msgstr "" msgstr ""
#: src/rougail/output_ansible/config.py:65 #: src/rougail/output_ansible/config.py:43
msgid "Configuration of output Ansible" msgid "if ansible or json are not set in \"step.output\""
msgstr "" msgstr ""
#: src/rougail/output_ansible/config.py:77 #: src/rougail/output_ansible/config.py:50
msgid "Load Ansible encrypt inventory or generate Ansible inventory"
msgstr ""
#: src/rougail/output_ansible/config.py:55
msgid "if ansible is not in \"step.output\" and not in \"step.user_data\""
msgstr ""
#: src/rougail/output_ansible/config.py:61
msgid "Generate Ansible inventory"
msgstr ""
#: src/rougail/output_ansible/config.py:72
msgid "Namespace with host values" msgid "Namespace with host values"
msgstr "" msgstr ""
#: src/rougail/output_ansible/config.py:81 #: src/rougail/output_ansible/config.py:74
msgid "Remove namespace name in host vars" msgid "Remove namespace name in host vars"
msgstr "" msgstr ""
#: src/rougail/output_ansible/config.py:85 #: src/rougail/output_ansible/config.py:76
msgid "Displays warnings inside Ansible exportation datas" msgid "Displays warnings inside Ansible exportation datas"
msgstr "" msgstr ""

42
src/rougail/output_ansible/config.py
View file

@ -30,39 +30,35 @@ list:
description: {_('parameter added only to be compatible with Ansible')} description: {_('parameter added only to be compatible with Ansible')}
default: false default: false
disabled: disabled:
type: jinja jinja: |-
jinja: | {{{{ step.output is propertyerror or step.output != 'ansible' }}}}
{{% if step.output is propertyerror or step.output != 'ansible' %}} return_type: boolean
disabled description: {_('if ansible is not set in "step.output"')}
{{% endif %}}
json: json:
redefine: true redefine: true
disabled: disabled:
type: jinja jinja: |-
jinja: | {{{{ step.output is propertyerror or (step.output != 'json' and step.output != 'ansible') }}}}
{{% if step.output is propertyerror or (step.output != 'json' and step.output != 'ansible') %}} description: {_('if ansible or json are not set in "step.output"')}
disabled
{{% endif %}}
""", """,
f""" f"""
ansible: ansible:
exists: true exists: true
redefine: true redefine: true
description: {_('Configuration of user data or output Ansible')} description: {_('Load Ansible encrypt inventory or generate Ansible inventory')}
disabled: disabled:
type: jinja jinja: |-
jinja: | {{{{ step.output is propertyerror or (step.output != 'ansible' and (step.user_data is propertyerror or 'ansible' not in step.user_data)) }}}}
{{% if step.output is propertyerror or (step.output != 'ansible' and (step.user_data is propertyerror or 'ansible' not in step.user_data)) %}} return_type: boolean
disabled description: {_('if ansible is not in "step.output" and not in "step.user_data"')}
{{% endif %}}
""", """,
f""" f"""
ansible: ansible:
type: family type: family
description: {_('Configuration of output Ansible')} description: {_('Generate Ansible inventory')}
exists: false exists: false
disabled: disabled:
variable: step.output variable: step.output
@ -73,17 +69,11 @@ ansible:
f""" f"""
ansible: ansible:
host_namespace: host_namespace: hosts # {_('Namespace with host values')}
description: {_('Namespace with host values')}
default: "hosts"
no_namespace_in_vars: no_namespace_in_vars: false # {_('Remove namespace name in host vars')}
description: {_('Remove namespace name in host vars')}
default: false
export_warnings: export_warnings: true # {_('Displays warnings inside Ansible exportation datas')}
description: {_('Displays warnings inside Ansible exportation datas')}
default: true
""", """,
] ]
return { return {

BIN
src/rougail/output_ansible/locale/fr/LC_MESSAGES/rougail_output_ansible.mo
View file

Binary file not shown.