Gérer les secrets avec Secret Manager dans Cloud Code pour VS Code

L'intégration de Secret Manager (gestionnaire de secrets) à Cloud Code permet de créer, d'afficher, de mettre à jour et d'utiliser des secrets depuis votre IDE sans les stocker dans votre codebase.

Cette page explique comment accéder au gestionnaire de secret depuis votre IDE et comment s'y prendre pour créer et gérer des secrets.

Activer le gestionnaire de secrets

Lorsque vous gérez des secrets avec Cloud Code, ceux-ci sont stockés de manière sécurisée dans le gestionnaire de secrets. Ils peuvent être récupérés de manière automatisée lorsque vous en avez besoin. Les deux seuls prérequis sont l'activation de l'API Secret Manager et l'obtention des autorisations appropriées pour gérer les secrets :

  1. Assurez-vous que vous travaillez dans le projet où se trouve votre code d'application. Votre secret doit se trouver dans le même projet que le code de votre application.

  2. Cliquez sur Cloud Code, puis développez la section Secret Manager.

  3. Si vous n'avez pas activé l'API Secret Manager, cliquez sur Activer l'API Secret Manager dans la section "Secret Manager".

Créer des secrets à l'aide du panneau "Secret Manager"

  1. Cliquez sur Cloud Code, puis développez la section Secret Manager.

  2. Cliquez sur Créer un secret dans la section Secret Manager.

    Dans la boîte de dialogue "Create Secret" (Créer un secret), définissez le projet, le nom, la valeur et la région de votre secret, puis spécifiez des libellés pour organiser vos secrets.

Créer des secrets avec la vue Éditeur

  1. Dans l'éditeur, ouvrez un fichier contenant le texte que vous souhaitez stocker en tant que secret.
  2. Mettez en surbrillance le texte à stocker en tant que secret, effectuez un clic droit, puis cliquez sur Créer un secret dans Secret Manager.
  3. Dans la boîte de dialogue Créer un secret, personnalisez le projet, le nom, la valeur, la région et les libellés du secret.

Créer des versions de secrets à l'aide de Secret Manager

Pour mettre à jour un secret existant, vous pouvez créer une nouvelle version du secret :

  1. Effectuez un clic droit sur un secret existant, puis choisissez Créer une version de secret.

  2. Dans la boîte de dialogue "Créer une version", définissez la nouvelle valeur de votre secret existant à l'aide du champ "Valeur du secret" ou en important un fichier.

    Boîte de dialogue "Créer une version de secret" ouverte avec le champ de valeur du secret pour "test-secret" mis à jour avec la valeur "bar"

  3. Pour supprimer toutes les versions précédentes de votre secret et ne conserver que la nouvelle version que vous êtes en train de créer, sélectionnez Désactiver toutes les versions précédentes.

  4. Cliquez sur Créer une version. Votre version est ajoutée et vous pouvez afficher la dernière version du secret ainsi que les versions précédentes répertoriées dans les listes déroulantes des Versions.

Créer des versions de secrets à l'aide de l'éditeur

Pour mettre à jour un secret existant, vous pouvez créer une nouvelle version du secret :

  1. Dans l'éditeur, ouvrez un fichier et mettez en surbrillance le texte à stocker en tant que secret.
  2. Effectuez un clic droit sur le texte en surbrillance, puis choisissez Ajouter une version au secret.

Afficher les secrets

  1. Cliquez sur Cloud Code, puis développez la section Kubernetes.
  2. Développez votre cluster, puis les secrets.
  3. Développez le secret pour en afficher les détails.

Supprimer des secrets

Pour supprimer un secret à l'aide de Secret Manager dans Cloud Code, procédez comme suit:

  1. Cliquez sur Cloud Code, puis développez la section Secret Manager.

  2. Effectuez un clic droit sur un secret existant, puis sélectionnez Ouvrir dans Cloud Console.

  3. Sur la page Détails du secret, cliquez sur SUPPRIMER et suivez les instructions pour supprimer le secret.

Afficher les secrets

Pour afficher les secrets, sélectionnez-les dans la liste de la section "Secret Manager". Les détails du secret, tels que le nom, la règle de réplication, l'horodatage de création, et l'ID de ressource, figurent sous le nom du secret.

Gérer les versions secrètes

Pour activer, désactiver ou détruire une version d'un secret, effectuez un clic droit sur le secret, puis choisissez la commande correspondant à l'action que vous souhaitez effectuer. Pour les versions de secrets activées, vous pouvez également afficher la valeur de la version.

Gérer les secrets dans Google Cloud Console

Pour afficher et gérer un secret dans votre navigateur, vous pouvez également effectuer un clic droit sur celui-ci, puis cliquer sur Ouvrir dans Cloud Console.

Effectuez un clic droit sur le secret dans Secret Manager pour afficher l'option "Ouvrir dans Google Cloud Console". La liste déroulante des propriétés est également visible dans le panneau Secret Manager.

Accéder aux secrets depuis votre application

Une fois le secret créé, vous pouvez l'inclure dans le code et configurer l'authentification.

Pour accéder à un secret depuis votre application:

  1. Installez la bibliothèque cliente Secret Manager.

    1. Cliquez sur Cloud Code, puis développez la section API Cloud.

    2. Développez Secret Manager > Secret Manager API, puis suivez les instructions de la section "Installer la bibliothèque cliente" pour le langage que vous utilisez.

  2. Personnalisez et incluez l'extrait de code approprié dans le code de votre application.

    Pour obtenir le nom de la version du secret à utiliser dans le code, sélectionnez le secret dans le panneau Secret Manager, effectuez un clic droit, puis choisissez Copier l'ID de ressource.

  3. Pour terminer la configuration de l'authentification, suivez le guide d'authentification des bibliothèques clientes :

    • Développement local: si vous développez sur un cluster local (comme Minikube ou Docker Desktop) ou un émulateur local, suivez les étapes décrites dans la section Développement local adaptée à votre workflow.
    • Développement à distance : Si vous utilisez un cluster GKE ou un service Cloud Run dans votre application, vous devez suivre la procédure illustrée dans la section Développement à distance en rapport avec votre workflow, y compris les instructions propres à Secret Manager pour configurer les rôles requis sur votre compte de service.

Ajouter un secret en tant que variable d'environnement

Pour ajouter un secret Kubernetes existant au déploiement en tant que variable d'environnement, procédez comme suit :

  1. Cliquez sur Cloud Code, puis développez la section Kubernetes.
  2. Développez votre cluster Minikube, puis les secrets.
  3. Effectuez un clic droit sur un secret représentant un objet de déploiement, puis cliquez sur Add Secret as Environment Variable (Ajouter un secret en tant que variable d'environnement).

Installer un secret en tant que volume

Pour installer un secret Kubernetes existant en tant que volume dans le conteneur de déploiement, procédez comme suit :

  1. Cliquez sur Cloud Code, puis développez la section Kubernetes.
  2. Développez votre cluster Minikube, puis les secrets.
  3. Effectuez un clic droit sur un secret représentant un objet de déploiement, puis cliquez sur Mount Secret as Volume (Installer un secret en tant que volume).

Obtenir de l'aide

Pour envoyer des commentaires, signalez des problèmes sur GitHub ou posez une question sur Stack Overflow.