For the complete documentation index, see llms.txt. This page is also available as Markdown.

Remplir un fichier de configuration à partir d’un modèle

Certains outils ne lisent leurs paramètres que dans un fichier, comme appsettings.json, une configuration YAML ou un .npmrc. Avec devo secret inject, vous gardez dans votre dépôt un modèle avec des références devo://, et vous générez le vrai fichier quand vous en avez besoin.

Écrire le modèle

Placez une référence partout où va un secret. Entourez-la de {{ }} pour que Devolutions CLI sache exactement où elle commence et où elle se termine :

{
  "Database": {
    "User": "{{ devo://ws/<workspace-id>/vault/<vault-id>/entry/<entry-id>/field/username }}",
    "Password": "{{ devo://ws/<workspace-id>/vault/<vault-id>/entry/<entry-id>/field/password }}"
  }
}

Une référence sans {{ }} fonctionne aussi. Elle se termine au premier espace, guillemet, <, >, ), ] ou }.

Dans une référence, $NAME, ${NAME} et ${NAME:-default} sont remplacés par la valeur d’une variable d’environnement avant que la référence soit résolue. Utilisez cela pour partager un modèle entre des environnements, par exemple devo://ws/${WORKSPACE_ID}/vault/….

Générer le fichier

devo secret inject --in-file appsettings.template.json --out-file appsettings.json
OPTION
CE QU’IL FAIT

--in-file, -i

Le modèle à lire. Sans cette option, Devolutions CLI lit le modèle depuis l’entrée standard.

--out-file, -f

Le fichier à écrire. Sans lui, le résultat va sur la sortie standard.

--force

Remplace le fichier de sortie s’il existe déjà. Sans cette option, la commande s’arrête avant de lire un secret.

Vous pouvez aussi travailler avec des tubes, par exemple pour passer le résultat directement à un autre programme :

Ce sur quoi vous pouvez compter

  • Tout ou rien. Si une référence ne peut pas être résolue, Devolutions CLI n’écrit aucun fichier et rien du modèle. Il liste les erreurs sur la sortie d’erreur, affiche une ligne de résumé comme References: 1/2 resolved sur la sortie standard, et se termine avec le code 1.

  • Fichier privé. Le fichier de sortie est créé avec des permissions privées : sur macOS et Linux, seul votre compte d’utilisateur peut le lire ; sur Windows, votre compte, le compte système et les administrateurs.

  • Aucun fichier à moitié écrit. Devolutions CLI écrit dans un fichier temporaire du même dossier, puis le met en place.

  • Chaque référence est lue une fois. Une référence utilisée plusieurs fois dans le modèle n’est résolue qu’une fois.

Avec --output json, la commande renvoie un résumé au lieu du contenu : combien de références elle a trouvées et résolues. Les valeurs n’y figurent pas.

Bon à savoir

  • Avec la sortie standard, les valeurs apparaissent dans votre terminal ou dans ce qui lit le tube. Préférez --out-file quand vous n’avez pas besoin d’un tube.

  • Les références se résolvent par le contexte actuel. Ajoutez --context <context-name> pour utiliser un autre espace de travail. Les références canoniques se résolvent toujours par rapport à l’espace de travail qui les possède.

  • Une référence ne se résout pas : consultez Une référence de secret ne se résout pas.

Suivant

Mis à jour

Ce contenu vous a-t-il été utile ?