Gérer les secrets avec le gestionnaire de secrets

L'intégration du 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.


Pour obtenir des conseils détaillés sur cette tâche directement dans l'éditeur Cloud Shell, cliquez sur Visite guidée:

VISITE GUIDÉE


La procédure décrite dans les sections suivantes, est la même que si vous cliquez sur Visite guidée.

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. Pour lancer Secret Manager, cliquez sur la vue Secret Manager Icône de Secret Manager dans la barre d'activité.

  2. Si vous n'avez pas activé l'API Secret Manager, Cloud Code vous invite à l'activer dans le panneau "Secret Manager".

    Votre secret doit également se trouver dans le même projet que le code de votre application. Assurez-vous que le bon projet est sélectionné. Si ce n'est pas le cas, cliquez sur "Switch project" dans le panneau "Secret Manager" pour changer de projet.

    Lien "Activer l'API" dans le panneau "Secret Manager"

Créer et afficher des secrets

Créer des secrets

Utilisez l'une des méthodes suivantes pour créer un secret :

Utiliser le panneau Secret Manager

  1. Sélectionnez le panneau Secret Manager Icône de Secret Manager.

  2. Cliquez sur l'icône Ajouter.

    Cette opération ouvre la boîte de dialogue "Create Secret" (Créer un secret) où vous pouvez définir le projet, le nom et la valeur de votre secret, puis choisir une région où le stocker et des libellés permettant de bien organiser vos secrets.

    Boîte de dialogue "Créer un secret" ouverte avec le champ "Nom" renseigné avec la valeur "test-secret-2" et le champ "Valeur du secret" est renseigné avec la valeur "42"

À l'aide de l'éditeur

  1. Ouvrez dans l'éditeur le fichier contenant le texte que vous souhaitez stocker en tant que secret.
  2. Sélectionnez le texte et effectuez un clic droit.

    Dans le menu, sélectionnez l'élément de menu Créer un secret dans Secret Manager. La boîte de dialogue "Create Secret" (Créer un secret) s'ouvre, dans laquelle le champ "Secret Value" (Valeur du secret) est pré-rempli avec le texte que vous avez sélectionné. Vous pouvez personnaliser le projet, le nom, la valeur, la région et les libellés du secret.

Créer des versions de secrets

Si vous avez déjà un secret et que vous souhaitez le mettre à jour, vous pouvez le faire à partir du panneau Secret Manager :

  1. Effectuez un clic droit sur un secret existant et choisissez Create Secret Version (Créer une version de secret).

    La boîte de dialogue "Ajouter une version" s'ouvre, dans laquelle vous pouvez définir la nouvelle valeur de votre secret, soit en renseignant le champ "Valeur du secret", soit 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"

  2. Si vous souhaitez supprimer toutes les versions précédentes de votre secret et ne conserver que la nouvelle version, cochez la case Désactiver toutes les versions précédentes.

  3. Une fois que vous avez cliqué sur Créer une version et que votre version est ajoutée, vous pouvez afficher votre dernière version de secret, ainsi que toutes les versions de votre secret, répertoriées sous Versions. .

Sinon, pour lancer la boîte de dialogue "Créer une version" à l'aide de l'éditeur, ouvrez un fichier et mettez en surbrillance le texte que vous souhaitez stocker en tant que secret dans l'éditeur. Effectuez un clic droit sur le texte en surbrillance et choisissez l'option de menu Add Version to Secret in Secret Manager (Ajouter une version au secret dans Secret Manager).

Gérer les secrets

Pour afficher les secrets, dans la vue du gestionnaire de secrets, sélectionnez un secret dans la liste affichée. Les détails tels que le nom, la règle de réplication, l'horodatage de création et l'ID de ressource sont répertoriés dans la liste déroulante Propriétés.

Dans cette vue, vous pouvez également effectuer un clic droit sur un secret, et activer, désactiver ou détruire la version du secret. Pour les versions de secrets activées, vous pouvez également afficher la valeur de la version.

Pour afficher et gérer le secret dans votre navigateur, vous pouvez également effectuer un clic droit sur le secret, puis sélectionner Ouvrir dans Cloud Console.

Effectuez un clic droit dans Secret Manager pour afficher l'option "Ouvrir dans 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 votre code et configurer l'authentification.

Pour accéder depuis votre application au secret que vous venez de créer, procédez comme suit :

  1. Installez la bibliothèque cliente Secret Manager.

    Cliquez sur l'icône Cloud Code - API Cloud.Icône Cloud Code - API Cloud Dans la barre d'activité et dans l'arborescence de l'explorateur des API Google Cloud, sélectionnezSecret Manager >API Secret Manager ... Suivez les instructions spécifiques au langage indiquées dans la section "Installer la bibliothèque cliente".

  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. Enfin, pour terminer la configuration de l'authentification, vous devez suivre le guide d'authentification des bibliothèques clientes :

    • Développement local : Si vous développez sur un cluster local (comme Minikube, Docker Desktop) ou un émulateur local, vous devez suivre la procédure illustrée dans la section Développement local en rapport avec 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.

Assistance

Pour envoyer vos commentaires, signalez tout problème sur GitHub ou posez une question sur Stack Overflow.