Secrets

Les secrets de Vonage Cloud Runtime vous permettent de stocker des informations sensibles à utiliser dans vos projets, telles que les clés API pour les services tiers. Les secrets sont gérés par l'intermédiaire de la CLI de Vonage Cloud Runtime.

Création d'un secret

Pour créer un secret, vous pouvez utiliser la commande secrets create de la CLI de Vonage Cloud Runtime.

vcr secret create --name $NAME --value $VALUE

Pour créer un secret FOO avec la valeur bar:

vcr secret create --name FOO --value bar

Vous pouvez également ajouter des fichiers en tant que secrets :

vcr secret create --name $NAME --filename $FILE_PATH

Accéder à vos secrets

Pour accéder à un secret dans votre instance, vous devez l'ajouter à votre fichier de configuration pour l'exposer. Ajouter un environment à votre fichier de configuration avec une liste des secrets que vous voulez exposer et un nom pour les désigner :

project:
    name: app
instance:
    name: dev
    runtime: nodejs18
    region: aws.euw1
    application-id: fcd08ece-f3c2-4adf-bf84-5ba8a1c86e0e
    capabilities: [voice, messages-v1]
    entrypoint: [node, index.js]
    environment:
        - name: FOO_SECRET
          secret: FOO
        - name: BAZ_SECRET
          secret: BAZ

Maintenant que le secret se trouve dans votre fichier de configuration, ils seront injectés dans votre instance lorsque vous exécutez le débogueur Vonage Cloud Runtime ou déployez votre projet. Donc, pour utiliser l'exemple de FOO dans votre application, vous écririez :

Mise à jour des secrets

La mise à jour des secrets fonctionne de la même manière que la création de secrets, mais pour la mise à jour, vous utilisez vcr secrets update:

vcr secret update --name $NAME --value $NEW_VALUE

Pour mettre à jour le FOO exemple :

vcr secret update --name FOO --value baz

Lever les secrets

Les secrets peuvent être supprimés en utilisant vcr secrets remove:

vcr secret remove $NAME

Pour retirer le FOO exemple :

vcr secret remove FOO

Travailler avec des secrets au niveau local

Lorsque vous déboguez votre projet localement, vous n'aurez pas accès aux secrets stockés sur la plateforme Vonage Cloud Runtime. Il est recommandé de créer un .env dans le répertoire de votre projet et ajoutez-y vos secrets de développement :

export FOO=BAR
export BAZ=BAT
export X=Y

Ensuite, avant de commencer le débogage, exécutez :

source .env

Les variables d'environnement doivent être définies dans le même processus shell que celui dans lequel vous exécutez le débogueur Vonage Cloud Runtime.

Cela exportera les secrets de développement dans votre processus terminal shell actuel, permettant au débogueur d'y accéder.