Ansible : écrire des rôles qu’on peut encore maintenir dans deux ans

Par Hamza Mechtaly · · 3 min de lecture

Idempotence, variables, tests avec Molecule, mode check : mes règles pour des rôles Ansible lisibles et sûrs, avec des exemples concrets.

Ansible : des rôles maintenables

Ansible a un défaut qui est aussi sa qualité : on peut écrire un playbook qui marche en dix minutes. Le problème arrive six mois plus tard, quand plus personne n’ose le relancer en production. Voici les habitudes qui m’évitent d’en arriver là.

Un rôle fait une chose

Un rôle apache installe et configure Apache. Il ne déploie pas l’application, ne crée pas les utilisateurs métier et ne touche pas au pare-feu « parce que c’était pratique ». Quand un rôle fait tout, on ne peut plus le réutiliser, et chaque modification devient risquée.

La structure standard suffit largement :

roles/apache/
  defaults/main.yml   # valeurs par défaut, documentées
  tasks/main.yml
  handlers/main.yml
  templates/vhost.conf.j2
  meta/main.yml

L’idempotence n’est pas négociable

Un rôle doit pouvoir tourner dix fois de suite : la deuxième exécution ne doit rien changer. C’est ce qui permet de le relancer sans trembler, par exemple pour corriger une dérive de configuration.

Le piège classique, ce sont les modules command et shell. Ils ne savent pas si le travail est déjà fait, donc ils annoncent toujours un changement. Quand je ne peux pas faire autrement, je leur donne au moins une condition :

- name: Initialiser le schéma de la base
  ansible.builtin.command: /opt/app/bin/init-db.sh
  args:
    creates: /opt/app/.db-initialized

Et je préfère toujours un module dédié (ansible.builtin.lineinfile, ansible.builtin.template, community.postgresql.postgresql_db…) à une commande shell.

Des variables préfixées et documentées

Ansible a plus de vingt niveaux de priorité pour les variables. Personne ne les retient, alors on évite les collisions : toutes les variables d’un rôle sont préfixées par son nom (apache_port, apache_modules), et toutes ont une valeur par défaut commentée dans defaults/main.yml. Le jour où quelqu’un se demande d’où vient une valeur, il a au moins un point de départ.

Les handlers pour redémarrer

On ne redémarre pas un service à chaque exécution. On notifie un handler quand la configuration change vraiment :

- name: Déployer la configuration du virtual host
  ansible.builtin.template:
    src: vhost.conf.j2
    dest: /etc/httpd/conf.d/app.conf
    validate: httpd -t -f %s
  notify: Recharger Apache

Le validate vérifie la syntaxe avant d’écraser le fichier. Une erreur de frappe ne coupe plus le site.

Tester avant la production

Deux outils m’ont fait gagner beaucoup de temps :

  • ansible-lint, dans le pipeline, qui attrape les mauvaises pratiques avant la revue de code ;
  • Molecule, qui lance le rôle dans un conteneur, vérifie le résultat et le relance une seconde fois pour contrôler l’idempotence.

Et avant chaque exécution en production, un passage en mode vérification :

ansible-playbook site.yml --limit prod --check --diff

Le --diff montre exactement ce qui va changer dans chaque fichier. C’est la meilleure relecture qui existe.

Les secrets hors du dépôt en clair

Les mots de passe ne vont jamais en clair dans Git. Ansible Vault suffit pour commencer ; à plus grande échelle, je préfère lire les secrets depuis HashiCorp Vault ou le coffre de la plateforme au moment de l’exécution. Et no_log: true sur les tâches qui les manipulent, pour qu’ils n’apparaissent pas dans les journaux.

Pour finir

Un bon rôle Ansible ressemble à un bon code : court, avec un seul objectif, testé, et sans surprise à la deuxième exécution. Le reste, c’est de la discipline d’équipe, et ça se règle mieux avec une checklist de revue qu’avec un outil de plus.

À lire aussi