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

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.

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 accéder au gestionnaire de secrets, cliquez sur l'onglet "Secret Manager" (Gestionnaire de secrets) dans la barre latérale droite de Cloud Code.

    Onglet "Secret Manager" (Gestionnaire de secrets) de Cloud Code encadré en rouge dans la barre latérale droite, et panneau "Secret Manager" ouvert montrant trois secrets. Les informations détaillées concernant le secret "test" sont affichées dans le volet inférieur.

  2. Si vous n'avez pas activé l'API Secret Manager, Cloud Code vous invite à l'activer dans le panneau "Secret Manager" (Gestionnaire de secrets) en cliquant sur Enable API (Activer l'API).

    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.

    Présence du le lien "Enable API" (Activer l'API) dans le panneau "Secret Manager" (Gestionnaire de secrets)

Créer et afficher des secrets

Créer des secrets

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

À l'aide du panneau du gestionnaire de secrets

  1. Accédez au panneau "Secret Manager" (Gestionnaire de secrets).

  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 "Create Secret" (Créer un secret) où le champ "Name" (Nom) est renseigné avec la valeur "life" et où le champ "Secret Value" (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 Create Secret in Secret Manager... (Créer un secret dans le gestionnaire de secrets). 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.

À l'aide de l'explorateur de projet

  1. Dans l'explorateur de projets, effectuez un clic droit dans un espace libre.
  2. Dans le menu, sélectionnez l'élément de menu Create Secret in Secret Manager... (Créer un secret dans le gestionnaire de secrets). La boîte de dialogue "Create Secret" (Créer un secret) s'ouvre. Renseignez le projet, le nom, la valeur, la région et les libellés du secret, puis cliquez sur OK.

Créer de nouvelles versions de secrets

Si vous avez déjà un secret et que vous souhaitez le mettre à jour, accédez à l'onglet Versions du panneau "Secret Manager" (Gestionnaire de secrets) et procédez comme suit :

  1. Cliquez sur l'icône Add (Ajouter) dans l'onglet Versions.

    La boîte de dialogue "Add new version" (Ajouter une version) s'ouvre, dans laquelle vous pouvez définir la nouvelle valeur de votre secret, soit en renseignant le champ "Secret Value" (Valeur du secret), soit en important un fichier.

    Boîte de dialogue "Add new version" (Ajouter une version) où le champ "Secret Value" (Valeur du secret) du secret "test-secret" est 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. Lorsque vous cliquez sur OK, la version du secret est ajoutée et apparaît dans l'onglet Versions, éventuellement accompagnée de toutes les autres versions de votre secret.

Afficher les secrets

Pour afficher un secret, sélectionnez-le dans la liste de la section "Secret Name" (Nom du secret) dans le panneau "Secret Manager" (Gestionnaire de secrets). Le nom, la règle de réplication, l'horodatage de création, l'ID de ressource et d'autres informations concernant le secret s'affichent dans l'onglet Overview (Aperçu).

Vous pouvez également effectuer un clic droit sur le secret, puis choisir Ouvrir dans la console Cloud pour afficher et gérer le secret dans votre navigateur.

Afficher les versions de secrets

Pour afficher les versions d'un secret, sélectionnez un secret dans la liste affichée dans la section "Secret Name" (Nom du secret), puis sélectionnez l'onglet Versions.

Effectuez un clic droit sur la version du secret à utiliser et choisissez l'une des options disponibles : afficher la valeur du secret, copier l'ID de la version, activer ou désactiver la version, et détruire la version sélectionnée.

L'onglet "Version" sélectionné pour le secret "test" et les deux versions disponibles, "2" et "3" sont tabulés avec leur date de création Un clic droit sur "3" est effectué et "Enable Secret Version" (Activer la version du secret) est sélectionné

Accéder aux secrets depuis votre application

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

Onglet "Code" du panneau "Secret Manager" (Gestionnaire de secrets) où sont énumérées les étapes nécessaires pour accéder au secret depuis le code

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.

    Accédez à Tools > Cloud Code > Add Cloud Libraries and Manage Cloud APIs (Outils > Cloud Code > Ajouter des bibliothèques Cloud et gérer des API Cloud), puis sélectionnez Secret Manager > API Secret Manager (Gestionnaire de secrets > API Secret Manager) dans l'arborescence de l'explorateur d'API Google Cloud. 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.

  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.

Obtenir de l'aide

Pour envoyer des commentaires ou signaler un problème dans votre IDE IntelliJ, accédez à Outils > Cloud Code > Aide / À propos > Envoyer des commentaires ou signaler un problème pour signaler un problème sur GitHub, ou posez une question sur Stack Overflow.