Passer au contenu principal

Ansible Approfondissement

Bonnes pratiques des rôles

Documenter son rôle et le versionner avec Git

Vidéo suivante

Cette vidéo est réservée aux abonnés. Voir les abonnements

Documenter son rôle et le versionner avec Git
Bonnes pratiques des rôles
00:02:41

Objectif

Documenter un rôle Ansible et versionner le projet avec Git pour le partager proprement.

Points clés

  • Chaque rôle, même interne, possède un README.md : objectif, utilisation, variables, dépendances, licence et auteur.
  • Le dépôt s'initialise avec git init ou en un clic depuis VS Code, qui intègre la gestion de Git.
  • Un fichier .gitignore exclut les fichiers locaux ou sensibles, en particulier le fichier contenant le mot de passe du Vault.
  • Chaque commit porte un message explicite (git commit -m "Ajout du rôle webserver") qui décrit le changement.
  • Le dépôt local se pousse ensuite (git push) vers GitHub ou vers le GitLab de l'entreprise pour travailler en équipe.

À retenir

Un rôle sans README est difficile à réutiliser : documentez-le, versionnez-le et commentez chaque commit.