YAML pour débutants : Guide complet pour maîtriser la syntaxe et écrire vos premiers fichiers YAML

Par

YAML pour débutants : Guide complet pour maîtriser la syntaxe et écrire vos premiers fichiers YAML

You are currently viewing YAML pour débutants : Guide complet pour maîtriser la syntaxe et écrire vos premiers fichiers YAML

YAML (Yet Another Markup Language) est un format de fichier très populaire et facile à lire, utilisé principalement pour configurer des applications, automatiser des tâches, et gérer des infrastructures informatiques. Que vous soyez développeur, administrateur système, ou passionné d’automatisation, apprendre YAML est une compétence essentielle, notamment pour travailler avec des outils comme Ansible, Kubernetes ou Docker Compose.

Dans cet article, je vous propose un guide pas à pas pour comprendre la syntaxe YAML, apprendre ses bonnes pratiques, éviter les erreurs courantes, et créer vos premiers fichiers YAML efficaces.

1. Qu’est-ce que YAML ?

YAML est un format de données en texte simple, conçu pour être facilement lisible par les humains et facilement analysable par les machines. Contrairement à JSON ou XML, YAML est plus souple et permet une syntaxe plus claire, idéale pour la configuration.

2. Syntaxe de base YAML

Clé – Valeur

La base d’un fichier YAML est constituée de paires clé-valeur, séparées par deux-points :. Il est important de respecter la syntaxe :

  • Pas d’espace avant les deux-points
  • Toujours un espace après les deux-points

Exemple :

nom: Jean
âge: 34

Listes

Pour définir une liste, on utilise un tiret - suivi d’un espace puis de l’élément.

langues:
  - français
  - anglais
  - idaasha
  - fon

Indentation

L’indentation est essentielle en YAML. Elle sert à indiquer la hiérarchie. Utilisez de préférence 2 espaces par niveau d’indentation. N’utilisez jamais de tabulations.

3. Bonnes pratiques

  • Commencez votre fichier YAML par --- (trois tirets) pour marquer le début du document. C’est optionnel mais recommandé.
  • N’ajoutez pas d’espaces avant les deux-points.
  • Après le tiret - pour une liste, mettez toujours un espace.
  • Respectez l’indentation : 2 espaces, pas de tabulations.
  • Commentez vos fichiers avec le caractère #.

4. Exemples pratiques

Exemple 1 : Fiche utilisateur simple

---
nom: John
âge: 34
ville: Bohicon
langues_parlees:
  - français
  - anglais
  - fon

Exemple 2 : Liste de serveurs

---
serveurs:
  - nom: web01
    ip: 192.168.10.10
    role: web
  - nom: db01
    ip: 192.168.10.20
    role: base de données
  - nom: proxy01
    ip: 192.168.10.11
    role: serveur proxy

5. Erreurs courantes à éviter

  • Oublier l’espace après le tiret - dans une liste :
# Mauvais
langues:
  -français  # Pas d'espace après '-'

# Bon
langues:
  - français
  • Ajouter un espace avant les deux-points : :
# Mauvais
nom : Ayena  # espace avant les deux-points

# Bon
nom: Ayena
  • Mauvaise indentation ou mélange d’espaces et tabulations

6. Conclusion

YAML est un format simple mais puissant. Avec un peu de pratique, vous saurez écrire des fichiers clairs et efficaces pour automatiser vos tâches et configurer vos applications. Gardez toujours en tête l’importance de l’indentation, des espaces, et des bonnes pratiques présentées dans cet article.

7. Ressources complémentaires

Laisser un commentaire