Les noms des commandes ansible
Quelle commande de Volant remplace chaque programme d'ansible-core, ce qui est identique, ce qui diffère, et comment garder vos lignes de commande.
Volant exécute les neuf programmes d’ansible-core 2.19.12. Chacun est une sous-commande de volant, et sous Linux et macOS il peut aussi être lancé sous son nom ansible. Windows n’est pris en charge ni pour les noms de programme ni pour les liens.
Ce qui remplace quoi
Section intitulée « Ce qui remplace quoi »| Programme d’ansible-core | Commande de Volant | S’exécute dans | Runtime géré |
|---|---|---|---|
ansible |
volant adhoc |
Volant | inutile pour les modules natifs |
ansible-playbook |
volant playbook, volant-playbook |
Volant | installé à la première utilisation qui a besoin de Python |
ansible-vault |
volant vault |
Volant | inutile |
ansible-inventory |
volant inventory |
Volant | inutile, sauf pour les plugins d’inventaire des collections |
ansible-doc |
volant doc |
l’outil propre d’ansible-core | installé à la première utilisation |
ansible-config |
volant config |
l’outil propre d’ansible-core | installé à la première utilisation |
ansible-galaxy |
volant galaxy |
Volant, en cours d’écriture : les sous-commandes sont refusées tant qu’elles ne sont pas natives | pas nécessaire |
ansible-pull |
volant pull |
Volant | inutile pour un checkout git |
ansible-console |
volant console |
Volant | inutile pour les modules natifs |
Le runtime géré s’installe lui-même la première fois qu’une commande en a besoin, comme pour un playbook, et affiche une ligne sur l’erreur standard quand il le fait. Le runtime géré le décrit. Vous n’avez pas besoin d’installer ansible, mais deux des neuf commandes exécutent le code propre d’ansible-core depuis ce runtime.
Garder vos lignes de commande
Section intitulée « Garder vos lignes de commande »Les liens ne sont pas créés si vous ne le demandez pas. Lancez le script d’installation avec --shims, ou lancez volant shims install :
curl -fsSL https://volant.sh/install.sh | sh -s -- --shimsvolant shims installChaque nom est un lien symbolique vers volant. Volant lit le nom de fichier sous lequel il a été lancé, si bien que le lien ansible-vault lance volant vault. Les deux commandes prennent les mêmes arguments et donnent la même sortie et les mêmes codes de sortie. Une erreur d’usage sort avec 2 et nomme le programme tel qu’il a été lancé, ansible-vault: error: .... Comme ansible-core, un lien vérifie la locale avant de lire ses arguments. Une locale qu’il ne peut pas appliquer, ou qui n’est pas en UTF-8, sort avec 1 et ERROR: Ansible could not initialize the preferred locale ou ERROR: Ansible requires the locale encoding to be UTF-8. LC_ALL=C est refusé ; sans aucune variable de locale, la locale C compte comme C.UTF-8. volant lui-même ne vérifie rien.
install ne remplace pas un fichier ou un lien qu’il n’a pas créé, sauf avec --force. Quand un autre programme de ce nom se trouve dans votre PATH, il le dit : note: /usr/bin/ansible-vault is hidden by this link, DIR comes first in PATH quand le lien l’emporte, ou note: ... still runs first, DIR comes later in PATH sinon. Pour supprimer les liens :
volant shims removeremove ne supprime que les liens qui pointent vers un fichier appelé volant, et laisse tout le reste.
Un script de CI comme celui-ci s’exécute tel quel une fois les liens en place, sans ansible sur la machine :
ansible-inventory -i hosts.ini --list > inventory.jsonansible-vault view group_vars/all/secrets.yml --vault-password-file ci-passansible-playbook -i hosts.ini site.ymlCe qui est identique
Section intitulée « Ce qui est identique »Pour ansible, ansible-vault et ansible-inventory, la sortie, les options listées sur les pages des commandes et les codes de sortie ont été mesurés contre ansible-core 2.19.12. Chaque affirmation a un test derrière elle.
| Affirmation | Où elle est vérifiée |
|---|---|
volant adhoc affiche les octets du callback minimal, le bloc [ERROR] et les formes -o et -t, avec les codes de sortie de la référence |
les goldens de scénario adhoc-* et crates/volant/tests/adhoc_cli.rs |
Le nom ansible lance volant adhoc |
the_ansible_name_runs_adhoc |
Le nom ansible-playbook lance volant playbook |
a_link_named_ansible_playbook_behaves_as_the_playbook_subcommand |
volant vault donne les messages, les codes de sortie, les modes de fichier et les fichiers d’ansible-vault |
crates/volant/tests/vault_cli.rs, et les goldens de scénario vault-* pour les données vault qu’un playbook lit |
| Un fichier que l’un des outils chiffre, l’autre le déchiffre, pour l’id par défaut et pour un label | a_file_one_tool_encrypts_the_other_decrypts |
volant inventory affiche les octets JSON et YAML d’ansible-inventory : ordre des clés, indentation de quatre espaces, ancres PyYAML |
crates/volant/tests/inventory_golden.rs sur golden/inventories/cases.yml, et inventory_cli.rs |
volant config affiche ce qu’affiche l’outil |
crates/volant/tests/tools_cli.rs |
volant galaxy accepte les options d’ansible-galaxy et fait ses premières vérifications avec les mêmes messages |
crates/volant/src/galaxy/tests.rs, et galaxy_golden.rs contre un faux serveur Galaxy |
volant pull affiche l’exécution du playbook et la ligne de -o comme ansible-pull, et fait le checkout sans Python |
a_pull_prints_what_the_reference_pull_prints et a_pull_checks_out_and_runs_without_python dans console_pull.rs |
volant console affiche sur un tube ce qu’affiche ansible-console pour ses commandes, ses modules et ses lignes shell, et n’a pas besoin de Python pour les modules natifs |
the_console_reads_its_commands_from_a_pipe et the_console_runs_without_python dans console_pull.rs |
Les liens que crée install, les lignes qu’il affiche et ce que remove laisse |
crates/volant/tests/shims.rs |
| Quels noms correspondent à quelle commande, et aucun autre | les tests de crates/volant/src/cli/program.rs |
Les options que chaque commande native accepte sont listées sur sa propre page : volant adhoc, volant vault, volant inventory et volant pull. Une option qui n’y figure pas est refusée, jamais ignorée.
Ce qui diffère
Section intitulée « Ce qui diffère »- Le texte d’aide est celui de Volant. Il n’est jamais comparé à la référence.
--versionafficheansible [core 2.19.12](ou le nom du programme) et les chemins. Les lignes Python, Jinja et PyYAML sont omises quand Volant ne trouve aucun interpréteur avec ansible-core, parce que--versionn’installe rien. Voirvolant adhoc.executable locationdans--versionest le programme tel qu’il a été lancé :volant, ou le lien. Voirvolant doc.ansible-inventory --tomln’a besoin d’aucun paquet Python, là où la référence demandetomli-w, et une valeurnulldonne une ligne[ERROR]au lieu d’une trace Python (les deux sortent avec 250). Voirvolant inventory.volant pullaffiche ses deux premières lignes avant ce qu’affichent ses étapes, et son checkout ne lance pas Python. Voirvolant pull.volant config dumpmontreCOLLECTIONS_PATHScomme fixé par l’environnement dès que le runtime a un répertoirecollections/. Voirvolant config.ansible-vault viewpasse par un pager seulement sur un terminal, avecPAGER, puisANSIBLE_PAGER, puis[defaults] pager, puisless. Voir Vault.volant adhocetvolant playbookutilisent le moteur de Volant : les différences listées dans Mon playbook va-t-il s’exécuter ? et survolant adhocs’appliquent.
Codes de sortie
Section intitulée « Codes de sortie »| Commande | 0 | 1 | 2 | 4 | 5 | 250 |
|---|---|---|---|---|---|---|
volant adhoc |
chaque hôte a réussi ou a été ignoré | aucun hôte à cibler, ou une mauvaise action meta |
un hôte a échoué, ou une erreur d’usage | un hôte était injoignable, ou quelque chose que cette version ne prend pas encore en charge | un réglage invalide, ou aucun argument pour command |
un argument qui n’est pas du JSON valide |
volant vault |
terminé | une erreur de fichier, comme create sur un fichier existant |
une erreur d’usage | une mauvaise option, comme deux fichiers avec --output |
||
volant inventory |
affiché | une erreur d’usage | aucune action ou deux actions, ou une mauvaise cible de --host ou --graph |
volant playbook utilise les codes de Codes de sortie. Les trois outils qui s’exécutent dans le runtime d’ansible-core renvoient le code propre de l’outil, ou 1 avec une ligne [ERROR]: quand l’interpréteur ne peut pas être démarré. volant pull sort avec 2 quand le checkout échoue, avec 5 pour une erreur d’options ou quand aucun playbook n’est trouvé, et sinon avec le code du playbook.