Aller au contenu

Ajouter une variable ou un secret

Alimenter le pool d'un environnement avec une variable en clair ou un secret stocké dans le coffre, et retirer une entrée devenue inutile.

GuideDéveloppeur
Accès requis
Droit « Gérer les variables » ou « Gérer les secrets », et « Accès infrastructure en production » pour un environnement prod
Durée
3 min
Voir en Markdown

Le pool d'un environnement contient les valeurs que ses services peuvent consommer. Vous y ajoutez vos propres entrées : des variables, stockées en clair, et des secrets, chiffrés dans le coffre de l'application. Une entrée ajoutée n'est utilisée par aucun service tant que vous ne la reliez pas dans la configuration d'un service.

Avant de commencer

  • Choisissez le type : tout ce qui donne un accès (mot de passe, clé API, jeton, clé privée) est un secret. Le reste peut être une variable.
  • Choisissez un nom unique dans l'environnement, au format UPPER_SNAKE_CASE. Évitez les noms des entrées fournies par la plateforme (SVC_…, ROUTE_…, <BASE>_URL…).

Ajouter une entrée

  1. Dans le menu, sous le nom de votre application, cliquez sur Environnements, ouvrez l'environnement, puis l'onglet Configuration.
  2. Cliquez sur Ajouter. Le dialogue Nouvelle entrée s'ouvre.
  3. Dans Nom, saisissez le nom, par exemple STRIPE_API_KEY.
  4. Choisissez le type avec l'interrupteur : Variable (valeur en clair stockée en base) ou Secret (valeur chiffrée stockée dans le coffre de secrets).
  5. Pour un secret, choisissez Saisir une valeur (« La valeur sera stockée telle quelle. ») ou Uploader un fichier (« Le fichier sera encodé en base64 »).
  6. Dans Valeur, saisissez la valeur ou choisissez le fichier (900 Ko au plus).
  7. Optionnel : dans Description, indiquez l'usage et la personne à contacter pour la renouveler.
  8. Cliquez sur Créer.

Résultat : le message Entrée créée s'affiche. L'entrée apparaît dans le tableau avec sa source utilisateur ou secret. La valeur d'un secret reste masquée.

Conseil

Si vous saisissez une variable dont la valeur ressemble à un secret, la console vous le signale (« Cette valeur ressemble à un secret… ») et propose Activer le mode Secret. Suivez cette proposition plutôt que de cocher l'attestation.

Consulter le pool

Le tableau de l'onglet Configuration liste toutes les entrées disponibles (Nom, Valeur, Description, Source). Les filtres Toutes, Utilisateur, Secret, Plateforme, Auto, Base, Stockage et Harbor isolent chaque origine. Les entrées fournies par la plateforme portent la mention Lecture seule (auto-générée).

Les identifiants d'une base ou d'un bucket apparaissent dès que la ressource existe dans l'environnement : vous n'avez pas à les recopier.

Supprimer une entrée

  1. Avant de supprimer, retirez l'entrée de la Configuration du service de chaque service qui l'utilise.
  2. Dans le tableau, cliquez sur l'icône Supprimer de la ligne.
  3. Confirmez dans Supprimer cette entrée du pool ?.

Résultat : le message Entrée supprimée s'affiche. Une variable en clair encore reliée disparaît des services qui l'utilisaient, qui redémarrent. Un secret est retiré du coffre en arrière-plan, sans redémarrage des services.

Le nom d'une variable en clair supprimée reste réservé dans l'environnement : pour la remplacer, créez-en une sous un nouveau nom.

Changer la valeur d'une entrée

  • Secret : cliquez sur l'icône Modifier de la ligne. Voir Faire tourner un secret.
  • Variable en clair : sa valeur ne se modifie pas. Créez une nouvelle variable, reliez-la à la place de l'ancienne dans la configuration des services, puis supprimez l'ancienne. Pour une valeur propre à un service et susceptible de changer, préférez une valeur libre dans sa configuration : elle se modifie à tout moment.

Vérifier le résultat

Ouvrez un service de l'environnement, onglet Configuration du service, et ouvrez la liste d'une variable : la nouvelle entrée y figure avec son badge.

Dépannage

  • Variable with key "…" already exists in this environment ou Secret with key "…", type "VAR" and field "value" already exists in this environment : le nom est déjà pris ; choisissez-en un autre.
  • OpenbaoSecretEngine for app … is not provisioned : le coffre de l'application n'est pas encore prêt. Voir le dépannage.

Voir aussi