Aller au contenu

Déclarer les variables d'un service

Lister dans la définition d'un service les variables d'environnement et les fichiers qu'il attend, avec leur valeur par défaut.

GuideDéveloppeur
Accès requis
Administrateur client avec le droit « Infra Client » (profil Infra)
Durée
5 min
Voir en Markdown

Les variables consommées forment le contrat d'un service : la liste de ce qu'il lit au démarrage. Elles se déclarent une fois, dans la définition du service, et valent pour tous les environnements.

Avant de commencer

  • La définition du service existe dans l'architecture (voir Services).
  • Vous connaissez les variables que lit votre code, par exemple dans votre fichier .env.example.

Attention

Une valeur par défaut est stockée en clair et partagée par tous les environnements. N'y mettez jamais un secret : déclarez la variable sans valeur par défaut, puis fournissez le secret environnement par environnement.

Ajouter une variable

  1. Dans le menu, sous le nom de votre application, cliquez sur Architecture, puis sur Services, et ouvrez le service.
  2. Ouvrez l'onglet Variables consommées.
  3. Cliquez sur Ajouter une variable.
  4. Dans Mode de consommation, gardez Variable d'environnement.
  5. Dans Nom de variable, saisissez le nom au format UPPER_SNAKE_CASE, par exemple LOG_LEVEL.
  6. Optionnel : dans Valeur par défaut, saisissez la valeur utilisée quand aucun environnement n'en fournit d'autre, par exemple info.
  7. Optionnel : dans Description, expliquez à quoi sert la variable.
  8. Cliquez sur Créer.

Résultat : la variable apparaît dans le tableau (Mode, Nom de variable / Chemin, Description, Valeur par défaut). Les services déployés à partir de cette définition redémarrent : ceux qui n'ont pas encore de source pour la variable reçoivent sa valeur par défaut.

Pour un certificat ou une clé à déposer en fichier, choisissez Fichier monté à l'étape 4 : voir Monter un fichier secret.

Saisir plusieurs variables d'un coup

  1. Dans l'onglet Variables consommées, cliquez sur Mode éditeur.

  2. Dans Variables (format KEY=valeur), saisissez une variable par ligne, avec sa valeur par défaut après le =. La valeur peut être vide. Les lignes qui commencent par # sont ignorées.

    Texte
    LOG_LEVEL=info
    NODE_ENV=production
    DATABASE_URL=
    STRIPE_API_KEY=
  3. Vérifiez le résumé des changements (ajouts, modifications, suppressions).

  4. Cliquez sur Appliquer les changements.

Résultat : le message Changements appliqués s'affiche avec le nombre de variables ajoutées, modifiées et supprimées. Une ligne retirée de l'éditeur supprime la variable correspondante. L'éditeur ne gère pas les fichiers montés.

Modifier ou supprimer une variable

  • Pour modifier : cliquez sur l'icône Modifier la variable de la ligne, changez les champs, puis cliquez sur Enregistrer.
  • Pour supprimer : cliquez sur l'icône Supprimer la variable, puis confirmez. La variable disparaît des services, et sa source est retirée de leur configuration dans tous les environnements.

Changer le nom, la valeur par défaut ou le mode redémarre les services de la définition ; changer seulement la description ne les redémarre pas.

Vérifier le résultat

Ouvrez un service déployé à partir de cette définition, onglet Configuration du service : la nouvelle variable y figure, avec Valeur par défaut utilisée si vous en avez saisi une.

Voir aussi