Recherche de site Web

Gestion des erreurs dans les playbooks Ansible


Dans cet article, nous nous concentrerons sur l'un des sujets importants d'Ansible - "Gestion des erreurs dans les playbooks Ansible". À la fin de cet article, vous devriez avoir une bonne connaissance de la gestion des erreurs dans Ansible et de la manière de gérer différentes erreurs lors de l'exécution de playbooks dans Ansible sous Linux.

Gestion des erreurs dans les playbooks

Les erreurs et les bugs sont très courants sur n'importe quel logiciel que vous utilisez. Ansible ne fait pas exception. Lorsque vous commencez à travailler sur un projet réel avec Ansible, vous serez confronté à toutes sortes d'erreurs, qu'il s'agisse d'un bug produit ou d'une erreur humaine.

Certaines erreurs peuvent être évitées en mettant en œuvre les meilleures pratiques et en utilisant des outils qui disposent de fonctionnalités de linting et de débogage. Dans ce cas, ma suggestion est d'utiliser vscode qui possède un excellent écosystème de plugins pour soutenir le développement Ansible.

Jetez un œil aux extensions vscode suivantes qui vous permettent de mettre en œuvre les meilleures pratiques en appliquant certaines règles et en repérant les erreurs syntaxiques de base.

  • https://github.com/adrienverge/yamllint
  • https://marketplace.visualstudio.com/items?itemName=redhat.ansible

Voici une image exemple provenant du linter Ansible de VSCode.

Exemple de sortie du linter Ansible

Passons maintenant en revue quelques scénarios pour comprendre les différents types d’échecs et comment les gérer.

Comment gérer les erreurs de syntaxe dans Ansible

La première chose que vous devez vérifier avant d'exécuter un playbook est les erreurs de syntaxe. Vous pouvez utiliser l'option "--syntax-check" avec la commande ansible-playbook pour vérifier une erreur de syntaxe.

Jetez un œil au playbook ci-dessous. J'ai deux problèmes. Le mot-clé role n'est pas un mot-clé valide, il devrait être "roles". Le deuxième problème est que les deux rôles ne sont pas des rôles valides.

---
- name: Handle Failure
  hosts: localhost

  role:
   - sample-role1
   - sample-role2

Lorsque j'exécute le playbook avec --syntax-check, il détecte la première erreur dans le playbook.

$ ansible-playbook --syntax-check playbook.yml

Erreur de syntaxe Ansible 1

Une fois que je corrige l'erreur et que je soumets à nouveau le playbook, il m'affiche l'erreur suivante où le sample-role1 n'est trouvé nulle part dans les emplacements roles_path.

Erreur de syntaxe Ansible 2

Le problème avec cette approche est que lorsque vous avez quelques erreurs dans le playbook, il affichera seulement la première erreur et vous devrez corriger les erreurs et soumettre à nouveau la commande pour voir l'erreur suivante.

Comment gérer les échecs de tâches dans Ansible

Avant de savoir comment réparer une tâche échouée, vous devriez savoir comment Ansible soumet les tâches et ce qui se passe lorsqu'une tâche échoue.

Ansible soumet les tâches dans l'ordre défini par lots (forks=5). Lorsqu'une tâche particulière échoue sur un hôte, Ansible marquera l'hôte et arrêtera l'exécution des tâches suivantes sur cet hôte.

Vous pouvez gérer les échecs au niveau des tâches en utilisant l'une des approches ci-dessous.

  • Utilisation de la directive ignore_errors.
  • Regrouper les tâches sous la directive de bloc.

1. Gestion des échecs en utilisant la directive Ignore_errors

Considérez le playbook suivant qui comporte deux tâches pour télécharger et installer le paquet deb de Chrome.

---
- name: Handle Failure with ignore_erros
 hosts: localhost

 tasks:
   - name: Download chrome .deb file
     ansible.builtin.get_url:
       url: https://dl.google.com/linux/direct/google-chrome-stable_current_amd641.deb
       dest: /tmp/chrome.deb

   - name: Install from /tmp/chrome.deb
     ansible.builtin.apt:
       deb: /tmp/chrome.deb

J'ai délibérément donné l'URL incorrecte, ce qui fera échouer la première tâche. Comme cela a déjà été indiqué, une fois qu'une tâche échoue sur l'hôte, aucune autre tâche ne sera soumise sur cet hôte. Donc, la deuxième tâche n'est pas soumise.

fatal: [localhost]: FAILED! => {"changed": false, "dest": "/tmp/chrome.deb", "elapsed": 0, "msg": "Request failed", "response": "HTTP Error 404: Not Found", "status_code": 404, "url": "https://dl.google.com/linux/direct/google-chrome-stable_current_amd641.deb"}

Maintenant, laissez-moi exécuter le même playbook à nouveau mais avec "ignore_errors= true".

Ansible Ignorer les erreurs

Si vous regardez l'image ci-dessus, la première tâche s'est exécutée et a échoué mais l'échec est ignoré ce qui a permis à la deuxième tâche de s'exécuter.

À savoir : La directive ignore_errors peut être ajoutée au niveau de la tâche ou du play.

2. Gestion des erreurs avec les directives Bloc-Rescue-Always

Parfois, des groupes de tâches dépendent les uns des autres et si une seule tâche échoue, la tâche dépendante ne devrait pas s'exécuter seule au lieu d'arrêter toutes les tâches sous les hôtes particuliers.

Le playbook utilisé dans la section précédente sera un exemple parfait de ce scénario. La tâche d'installation dépend de la tâche de téléchargement, donc les deux tâches peuvent être regroupées sous la directive block.

---
- name: Handle Failure with ignore_erros
  hosts: localhost

  tasks:
   - name: Group the tasks
     block:
       - name: Download chrome .deb file
         ansible.builtin.get_url:
           url: https://dl.google.com/linux/direct/google-chrome-stable_current_amd641.deb
           dest: /tmp/chrome.deb

       - name: Install from /tmp/chrome.deb
         ansible.builtin.apt:
           deb: /tmp/chrome.deb
     ignore_errors: true

J'ai utilisé le même playbook mais déplacé les deux tâches sous la directive block et ajouté ignore_errors au niveau du bloc. Si vous regardez la sortie ci-dessous, les deux tâches ont automatiquement hérité de la directive ignore_errors.

Ignorer les erreurs au niveau du bloc

Vous pouvez également ajouter les directives "rescue" et "always" en plus de la directive "block". La tâche sous la directive rescue s'exécutera si l'une des tâches sous la directive block échoue. Cela est très utile pour les activités de nettoyage. La directive always s'exécute indépendamment de l'état des directives block et rescue.

J'ai ajouté les directives rescue et always avec des tâches qui affichent quelques messages.

tasks:
   - name: Group the tasks
     block:
       - name: Download chrome .deb file
         ansible.builtin.get_url:
           url: https://dl.google.com/linux/direct/google-chrome-stable_current_amd641.deb
           dest: /tmp/chrome.deb

       - name: Install from /tmp/chrome.deb
         ansible.builtin.apt:
           deb: /tmp/chrome.deb
     rescue:
       - name: Rescue task
         ansible.builtin.debug:
           msg: "Some cleanup activity..."
     always:
       - name: Task that always runs
         ansible.builtin.debug:
           msg: "Task that always run"  

La tâche rescue a été exécutée parce que la tâche sous la section du bloc a échoué. Enfin, les tâches always ont été exécutées.

Sauvetage & Directive de sortie toujours

Comment arrêter toutes les lectures en cas d'échec

Dans la dernière section, nous avons vu des façons d'exécuter les tâches même si une tâche a échoué. Dans certains cas, nous avons besoin que l'intégralité du playbook s'arrête même si une seule tâche a échoué. Cela peut être réalisé en définissant "any_errors_fatal: true".

Arrêter l'exécution du playbook en cas d'échec

Lorsque le playbook est soumis avec « any_errors_fatal » et si une tâche échoue, les tâches soumises dans le lot actuel seront exécutées et le play sera arrêté.

Attention : La directive any_errors_fatal peut être définie au niveau du play ou du niveau de la tâche.

Comment gérer l'erreur d'hôte inaccessible dans Ansible

Un autre type d'erreur dans ansible est "hôte inaccessible". Vous obtiendrez cette erreur lorsque ansible n'a pas pu se connecter à l'hôte géré défini dans le fichier d'inventaire. Cela se produit pour de nombreuses raisons. Soit vous avez donné une mauvaise définition d'hôte, soit il y a un problème avec l'hôte géré.

Si Ansible trouve qu'un nœud est inaccessible, il supprimera le nœud de la liste des hôtes actifs et ne soumettra aucune tâche supplémentaire sur le nœud.

Je suis en train d'exécuter le même playbook utilisé dans la section précédente mais avec un nom d'hôte aléatoire. La tâche a échoué avec "injoignable".

Hôtes Inaccessibles Ansible

Vous pouvez ajouter "ignore_unreachable: true" au niveau de la tâche ou du play, ce qui ignorera la tâche en cours et exécutera la tâche suivante sans retirer l'hôte de la liste active.

Ansible ignore les hôtes inaccessibles

Comment créer des échecs définis par l'utilisateur dans Ansible

À part les échecs définis par Ansible, les utilisateurs peuvent également créer leurs propres règles pour faire échouer la tâche en utilisant la directive "failed_when". En fait, le linter Ansible suggère d'utiliser failed_when au lieu de la directive ignore_errors.

Sortie du linter

Vous devez enregistrer la sortie de la tâche avant de faire certaines vérifications conditionnelles. Le nom de la variable enregistrée est "status".

Pour en savoir plus sur les registres Ansible, consultez le guide suivant.

  • Variable d'enregistrement Ansible

J'ai ajouté une condition pour vérifier le code d'état de la sortie enregistrée. Le code d'état 404 ne sera pas considéré comme un échec. Désormais, tout autre code de retour sera considéré comme un échec.

- name: Download chrome .deb file
 ansible.builtin.get_url:
   url: https://dl.google.com/linux/direct/google-chrome-stable_current_amd641.deb
   dest: /tmp/chrome.deb
 register: status
 failed_when: status.status_code != 404

Échec conditionnel dans Ansible

Vous pouvez également ajouter les opérateurs "ET" et "OU" pour vérifier plusieurs conditions.

failed_when: status.status_code != 404 or status.status_code != 401

Comment gérer les échecs des tâches de gestionnaire dans Ansible

Nous avons un article dédié aux gestionnaires. Consultez le lien suivant et repérez la section « Échecs de gestion » pour savoir comment gérer les échecs dans les tâches du gestionnaire.

  • Comment utiliser les handlers dans les playbooks Ansible

Conclusion

Dans cet article, nous avons discuté de la gestion des erreurs dans les Playbooks. Nous avons également vu quels sont les différents types de pannes que vous rencontrerez dans Ansible et certaines des façons de les corriger. Les retours sont les bienvenus dans la section des commentaires.

Ressource :

  • Gestion des erreurs dans les playbooks