Aller au contenu

GUIDE TECHNIQUE · PUPPET

Puppet : Hiera : gérer les données par environnement

Séparer le code Puppet des paramètres d'environnement avec Hiera, hiérarchiser les données YAML et vérifier la résolution des valeurs sans stocker de secrets en clair.

Niveau Intermédiaire4 min de lecture— vuesPuppet

L’ESSENTIEL EN BREF

Les étapes clés

Ce guide présente 3 étapes, de « Créer un projet local complet » à « Démontrer le changement de données ».

Avant de commencer : Module de laboratoire avec classe paramétrée.

01 · CADRAGE

Périmètre et résultat visé

Résultat attendu : Le lookup utilise explicitement le hiera.yaml du projet.

Public concerné : Équipes plateformes, administrateurs Puppet et responsables de standards de configuration

Environnement et versions

Puppet et Hiera 5 intégré ; les conventions de hierarchy et les chemins de données dépendent du projet et de son environnement Puppet.

02 · AVANT DE COMMENCER

Prérequis et points de contrôle

Puppet et une configuration Hiera connue ; définir explicitement le répertoire data et le contexte d’environnement utilisé par lookup.

  • Module de laboratoire avec classe paramétrée.
  • Répertoires data/ et manifests/ versionnés dans une branche de recette.
  • Une convention d'environnements (recette, intégration, production) et un coffre-fort dédié aux secrets.

Votre environnement de départ

Environnement
Puppet CLI installé sur une machine de recette ; PDK installé pour le guide de tests.
Outils
Puppet, Bash, éditeur ; PDK pour tests et packaging.
Comptes et droits
Droits d’écriture sur le répertoire du projet et sur les chemins de fichiers gérés ; éviter un apply global non ciblé.
Réseau et accès
Aucun Puppet Server requis pour les exercices puppet apply ; accès aux dépendances de PDK si celui-ci en télécharge.

Contrôles avant de commencer

Où effectuer le contrôle : Terminal Puppet

Commandes et configuration
puppet --version
puppet config print modulepath
puppet config print hiera_config

Résultat attendu : Puppet répond et les chemins effectifs sont connus avant le lookup ou apply.

03 · VUE D’ENSEMBLE

Comprendre l’architecture et les flux

ARCHITECTURE TECHNIQUEComprendre la chaîne de bout en bout
01Code de classe
02hiera.yaml
03Données common
04Données environnement
05Lookup
06Catalogue
Une clé Hiera est recherchée selon la hiérarchie active ; les données ne changent pas le catalogue tant qu'une classe ou un lookup ne les consomme.

04 · TUTORIEL

Procédure complète, étape par étape

Suivez les étapes dans l’ordre et contrôlez chaque résultat avant de poursuivre. Renseignez les paramètres adaptés à votre environnement.

01

ÉTAPE 1 / 3

Créer un projet local complet

Un chemin Hiera explicite évite de dépendre du contexte global de la machine.

  1. Créer un nouveau dossier avec data et modules/site_profile/manifests. Les commandes suivantes s’exécutent à sa racine.
  2. Créer hiera.yaml, data/common.yaml, le manifeste de classe et site.pp avec les contenus indiqués. La sortie de test est un notice ; elle n’écrit pas dans une configuration système.
Commandes et configuration
mkdir -p adn-hiera-lab/data adn-hiera-lab/modules/site_profile/manifests
cd adn-hiera-lab
# hiera.yaml
version: 5
defaults:
  datadir: data
  data_hash: yaml_data
hierarchy:
  - name: Commun
    path: common.yaml
# data/common.yaml (fichier distinct)
site_profile::message: 'pilotage-recette'
# modules/site_profile/manifests/init.pp (fichier distinct)
class site_profile(String $message) { notice($message) }
# site.pp (fichier distinct)
include site_profile
Ce qui se passe à cette étape
1Préparer
2Créer un projet local complet
3Contrôler

À vérifier : Les quatre fichiers existent aux chemins indiqués ; aucun fichier de l’installation Puppet globale n’est modifié.

Point de vigilance : Arrêter cette étape si le contrôle échoue ; diagnostiquer avant de poursuivre.

02

ÉTAPE 2 / 3

Vérifier le lookup dans ce contexte

lookup doit utiliser le même fichier Hiera que apply.

  1. Exécuter lookup avec --hiera_config sur le chemin absolu du fichier créé. --explain montre la source de la valeur.
  2. Confirmer pilotage-recette, puis appliquer site.pp avec le même contexte et le modulepath du projet.
Commandes et configuration
puppet lookup site_profile::message --hiera_config "$PWD/hiera.yaml" --explain
puppet apply --noop --hiera_config "$PWD/hiera.yaml" --modulepath "$PWD/modules" site.pp
puppet apply --hiera_config "$PWD/hiera.yaml" --modulepath "$PWD/modules" site.pp
Ce qui se passe à cette étape
1Préparer
2Vérifier le lookup dans ce contexte
3Contrôler

À vérifier : Le lookup désigne data/common.yaml et apply affiche pilotage-recette.

Point de vigilance : Arrêter cette étape si le contrôle échoue ; diagnostiquer avant de poursuivre.

03

ÉTAPE 3 / 3

Démontrer le changement de données

La valeur doit évoluer sans modifier le code de classe.

  1. Modifier seulement data/common.yaml pour définir site_profile::message: integration.
  2. Relancer lookup et apply : la nouvelle valeur doit être retrouvée. Retirer ensuite ce dossier de recette si vous n’en avez plus besoin. Pour plusieurs environnements, créer des contextes et hiérarchies explicites au lieu de supposer qu’un nom d’environnement active automatiquement ces fichiers.
Commandes et configuration
puppet lookup site_profile::message --hiera_config "$PWD/hiera.yaml"
puppet apply --hiera_config "$PWD/hiera.yaml" --modulepath "$PWD/modules" site.pp
Ce qui se passe à cette étape
1Préparer
2Démontrer le changement de données
3Contrôler

À vérifier : La valeur devient integration ; le manifeste de classe reste inchangé.

Point de vigilance : Arrêter cette étape si le contrôle échoue ; diagnostiquer avant de poursuivre.

RÉFÉRENCES TECHNIQUES

Documentation officielle

Retrouvez les fonctionnalités, les paramètres et les matrices de compatibilité de Puppet.

Consulter la documentation officielle

05 · RECETTE

Comment vérifier que tout fonctionne ?

Résultat attenduContrôles avant de considérer la procédure terminée
01

Le lookup utilise explicitement le hiera.yaml du projet.

02

La classe reçoit la valeur common.yaml par son paramètre typé.

03

Modifier uniquement les données change le résultat du run suivant.

06 · DIAGNOSTIC

Problèmes fréquents et résolution

No such key

Cause probable : Fichier YAML non chargé ou clé mal orthographiée

Que faire : Vérifier hiera.yaml, datadir et le contexte de l'environnement.

Valeur inattendue

Cause probable : Un niveau plus prioritaire surcharge common.yaml

Que faire : Inspecter l'ordre de la hiérarchie et l'explication de lookup.

YAML syntax error

Cause probable : Indentation ou quoting incorrect

Que faire : Valider la syntaxe YAML et relancer le lookup avant compilation.

07 · QUESTIONS PRATIQUES

Questions fréquentes

Hiera remplace-t-il les classes ?

Non, Hiera fournit des données ; les manifests définissent les ressources.

Peut-on mettre des secrets dans common.yaml ?

Pas en clair. Employer un backend chiffré approprié ou un gestionnaire de secrets autorisé.

Pourquoi tester --explain ?

Pour comprendre quelle source et quelle priorité fournissent réellement chaque valeur.

AUTRES TECHNOLOGIES

Guides complémentaires

Tous les guides Puppet

VOTRE ENVIRONNEMENT

Besoin d’aller plus loin sur votre environnement ?

Automatisation, sécurité et exploitation : échangeons sur vos pratiques Puppet.

Découvrir notre accompagnement IT

Échanger avec ADN Consulting

Pour aller plus loin