Gérer les API et les bibliothèques Cloud dans Cloud Code pour IntelliJ

Vous pouvez accéder aux produits et services Google Cloud à partir de votre code à l'aide des API Cloud. Ces API Cloud présentent une interface REST JSON simple que vous pouvez appeler via des bibliothèques clientes.

Ce document explique comment activer les API Cloud et ajouter des bibliothèques clientes Cloud à votre projet.

Remarque :Pour les projets qui n'utilisent pas à la fois Java et Maven, Cloud Code n'ajoute pas automatiquement les bibliothèques clientes Cloud à votre build. Il est toutefois compatible avec les autres fonctionnalités décrites ici et fournit des extraits de compilation pour votre système de compilation.

Parcourir les API Cloud

Remarque :La liste des API et des bibliothèques de Cloud Code couvre la plupart des API, mais pas toutes. D'autres seront bientôt disponibles.

Pour explorer toutes les API Google Cloud disponibles dans votre IDE, procédez comme suit:

1. Dans le menu Tools (Outils), sélectionnez Cloud Code > API Cloud.
2. Développez l'arborescence de l'explorateur des API Google Cloud pour afficher toutes les API disponibles. L'explorateur regroupe les API Cloud par catégorie. Vous pouvez également rechercher une API spécifique à l'aide de la barre de recherche API Search.

3. Cliquez sur une API pour afficher plus de détails, tels que son état, les instructions d'installation par langage des bibliothèques clientes correspondantes et la documentation correspondante.

Activer les API Cloud

Pour activer rapidement les API Cloud pour un projet à l'aide des détails de l'API, procédez comme suit :

1. Dans la vue Détails de l'API Cloud, choisissez un projet Google Cloud pour lequel vous souhaitez activer l'API Cloud.
2. Cliquez sur Activer l'API.

   Une fois l'API activée, un message confirme cette modification.

Ajouter des bibliothèques clientes Google Cloud

Pour ajouter des bibliothèques à votre projet dans IntelliJ, procédez comme suit :

Pour les projets Java Maven

1. Dans le menu Tools (Outils), sélectionnez Cloud Code > API Cloud.

La boîte de dialogue Add Google Cloud Libraries (Ajouter des bibliothèques Google Cloud) affiche les bibliothèques prises en charge.


2. Sélectionnez le type de bibliothèque de votre choix parmi la bibliothèque cliente Google Cloud (recommandée pour la plupart des projets) ou Java Spring Google Cloud (recommandé si votre projet utilise Java Spring).
3. Dans le menu déroulant Module, sélectionnez le module auquel vous souhaitez ajouter la bibliothèque.
Remarque:Google Cloud Java résout les conflits de version entre les bibliothèques en ajoutant la nomenclature Java Google Cloud au fichier pom.xml de vos projets.
4. Cliquez sur Ajouter une dépendance Maven pour ajouter un BOM et une bibliothèque cliente à votre projet.

Pour tous les autres projets

1. Dans le menu Tools (Outils), sélectionnez Cloud Code > API Cloud.

La boîte de dialogue Add Google Cloud Libraries (Ajouter des bibliothèques Google Cloud) affiche les bibliothèques prises en charge.


2. Installez l'API en suivant les instructions d'installation indiquées sur la page des détails de l'API correspondant à la langue de votre choix.
   Si vous développez une application Java, vous devez également spécifier vos préférences en termes de bibliothèque, la bibliothèque cliente Google Cloud (recommandée) ou la bibliothèque cliente Java Spring de Google Cloud.

Utiliser des exemples d'API

Pour rechercher et utiliser des exemples de code pour chaque API dans l'explorateur d'API, procédez comme suit:

1. Dans le menu Tools (Outils), sélectionnez Cloud Code > API Cloud.

2. Pour ouvrir la vue détaillée, cliquez sur le nom d'une API.

3. Pour afficher des exemples de code pour l'API, cliquez sur l'onglet Exemples de code.

4. Pour filtrer la liste des exemples, saisissez du texte à rechercher ou choisissez un langage de programmation dans le menu déroulant Langage.

Configurer l'authentification

Une fois que vous avez activé les API et ajouté les bibliothèques clientes nécessaires, vous devez configurer votre application pour qu'elle puisse s'authentifier. La configuration à effectuer dépend du type de développement et de la plate-forme sur laquelle vous exécutez l'application.

Une fois les étapes d'authentification effectuées, votre application peut s'authentifier et est prête à être déployée.

Développement local

Ordinateur local

Cloud Code s'assure que les identifiants par défaut de votre application (ADC) sont définis si vous vous êtes connecté à Google Cloud via votre IDE. Si vous ne vous connectez pas avec Cloud Code, exécutez gcloud auth application-default login manuellement.

Minikube

1. Cloud Code s'assure que les identifiants par défaut de votre application (ADC) sont définis si vous vous êtes connecté à Google Cloud via votre IDE. Si vous ne vous connectez pas avec Cloud Code, exécutez gcloud auth application-default login manuellement.
2. Démarrez Minikube à l'aide de la commande minikube start --addons gcp-auth. Cette opération installe dans vos pods les identifiants par défaut de votre application. Pour un guide d'authentification détaillé de Minikube pour Google Cloud, reportez-vous à la documentation gcp-auth de Minikube.

Autres clusters K8s locaux

1. Cloud Code s'assure que les identifiants par défaut de votre application (ADC) sont définis si vous vous êtes connecté à Google Cloud via votre IDE. Si vous ne vous connectez pas avec Cloud Code, exécutez gcloud auth application-default login manuellement.
2. Installez le répertoire local gcloud dans vos pods Kubernetes en modifiant la spécification de pod dans le fichier manifeste de pod ou de déploiement afin que les bibliothèques clientes Google Cloud puissent trouver les identifiants. Exemple de configuration de pod Kubernetes :

   apiVersion: v1
   kind: Pod
   metadata:
     name: my-app
     labels:
       name: my-app
   spec:
     containers:
     - name: my-app
       image: gcr.io/google-containers/busybox
       ports:
         - containerPort: 8080
       volumeMounts:
         - mountPath: /root/.config/gcloud
           name: gcloud-volume
     volumes:
       - name: gcloud-volume
         hostPath:
           path: /path/to/home/.config/gcloud

Cloud Run

Cloud Code s'assure que les identifiants par défaut de votre application (ADC) sont définis si vous vous êtes connecté à Google Cloud via votre IDE. Si vous ne vous connectez pas avec Cloud Code, exécutez gcloud auth application-default login manuellement.

Développement à distance

Google Kubernetes Engine

Selon le champ d'application de votre projet, vous pouvez choisir la manière dont vous authentifiez les services Google Cloud sur GKE:

• (Développement uniquement)
  Remarque : Les paramètres du niveau d'accès et du compte de service du cluster GKE sont définitifs. Une fois le cluster créé, ces paramètres ne peuvent plus être modifiés. Spécifiez les paramètres comme recommandé ci-dessous.
  1. Créez un cluster GKE avec les paramètres suivants :
     • Vérifiez que vous utilisez le compte de service utilisé par GKE et le compte de service Compute Engine par défaut, et que le champ Niveaux d'accès est défini sur Autoriser l'accès complet à toutes les API Cloud (les deux paramètres sont accessibles dans la section Pools de nœuds > Sécurité).
       Le compte de service Compute Engine étant partagé par toutes les charges de travail déployées sur votre nœud, cette méthode surprovisionne les autorisations et doit être utilisée uniquement pour le développement.
     • Assurez-vous que Workload Identity n'est pas activé sur votre cluster (dans la section Cluster > Sécurité).
  2. Attribuez les rôles nécessaires au compte de service Compute Engine par défaut :
     • Si vous essayez d'accéder à un secret, suivez cette procédure spécifique à Secret Manager pour configurer les rôles requis pour votre compte de service.
     • Si le compte de service Compute Engine par défaut est utilisé, il est possible que les rôles IAM appropriés soient déjà appliqués.

     • Pour obtenir la liste des types de rôles IAM et des rôles prédéfinis que vous pouvez attribuer aux identités, consultez le guide Comprendre les rôles.

       Pour connaître les étapes à suivre pour attribuer les rôles, consultez la page Accorder, modifier et révoquer les accès à des ressources.

• (Recommandé pour la production)
  1. Configurez votre cluster et votre application GKE avec Workload Identity afin d'authentifier les services Google Cloud sur GKE. Cette opération associe votre compte de service Kubernetes à votre compte de service Google.
  2. Dans le fichier YAML de votre déploiement Kubernetes, définissez le champ .spec.serviceAccountName afin que votre déploiement référence le compte de service Kubernetes.
     Si vous travaillez sur une application créée à partir d'un modèle Cloud Code, ce fichier se trouve dans le dossier "kubernetes-manifests".
  3. Si le service Google Cloud auquel vous essayez d'accéder nécessite des rôles supplémentaires, attribuez-les au compte de service Google que vous utilisez pour développer votre application :
     • Si vous essayez d'accéder à un secret, suivez cette procédure spécifique à Secret Manager pour configurer les rôles requis pour votre compte de service.

     • Pour obtenir la liste des types de rôles IAM et des rôles prédéfinis que vous pouvez attribuer aux identités, consultez le guide Comprendre les rôles.

       Pour connaître les étapes à suivre pour attribuer les rôles, consultez la page Accorder, modifier et révoquer les accès à des ressources.

Cloud Run

1. Pour créer un compte de service unique pour le déploiement de votre application Cloud Run, sélectionnez le projet dans lequel votre secret est stocké sur la page "Comptes de service".

   Accéder à la page Comptes de service

2. Cliquez sur Créer un compte de service.
3. Dans la boîte de dialogue Créer un compte de service, indiquez un nom descriptif pour le compte de service.
4. Remplacez l'ID du compte de service par une valeur unique et reconnaissable, puis cliquez sur Créer.
5. Si le service Google Cloud auquel vous essayez d'accéder nécessite des rôles supplémentaires, accordez-les, cliquez sur Continuer, puis sur OK.
6. Pour ajouter votre compte de service Kubernetes à votre configuration de déploiement, accédez à votre configuration d'exécution Cloud Run: Deploy, développez la section Paramètres de révision avancés, puis spécifiez votre compte de service dans le champ Compte de service.
   

Cloud Run

Selon le champ d'application de votre projet, vous pouvez choisir la manière dont vous authentifiez les services Google Cloud sur GKE:

• (Développement uniquement)
  Remarque : Les paramètres du niveau d'accès et du compte de service du cluster GKE sont définitifs. Une fois le cluster créé, ces paramètres ne peuvent plus être modifiés. Spécifiez les paramètres comme recommandé ci-dessous.
  1. Créez un cluster GKE avec les paramètres suivants :
     • Vérifiez que vous utilisez le compte de service utilisé par GKE et le compte de service Compute Engine par défaut, et que le champ Niveaux d'accès est défini sur Autoriser l'accès complet à toutes les API Cloud (les deux paramètres sont accessibles dans la section Pools de nœuds > Sécurité).
       Le compte de service Compute Engine étant partagé par toutes les charges de travail déployées sur votre nœud, cette méthode surprovisionne les autorisations et doit être utilisée uniquement pour le développement.
       
     • Assurez-vous que Workload Identity n'est pas activé sur votre cluster (dans la section Cluster > Sécurité).
  2. Attribuez les rôles nécessaires au compte de service Compute Engine par défaut :
     • Si vous essayez d'accéder à un secret, suivez cette procédure spécifique à Secret Manager pour configurer les rôles requis pour votre compte de service.
     • Si le compte de service Compute Engine par défaut est utilisé, il est possible que les rôles IAM appropriés soient déjà appliqués.

     • Pour obtenir la liste des types de rôles IAM et des rôles prédéfinis que vous pouvez attribuer aux identités, consultez le guide Comprendre les rôles.

       Pour connaître les étapes à suivre pour attribuer les rôles, consultez la page Accorder, modifier et révoquer les accès à des ressources.

• (Recommandé pour la production)
  1. Configurez votre cluster et votre application GKE avec Workload Identity afin d'authentifier les services Google Cloud sur GKE. Cette opération associe votre compte de service Kubernetes à votre compte de service Google.
  2. Pour ajouter votre compte de service Kubernetes à votre configuration de déploiement, accédez à votre configuration d'exécution Cloud Run:Deploy, développez la section Paramètres de révision avancés, puis spécifiez votre compte de service Kubernetes dans le champ Compte de service.
     
  3. Si le service Google Cloud auquel vous essayez d'accéder nécessite des rôles supplémentaires, attribuez-les au compte de service Google que vous utilisez pour développer votre application :
     • Si vous essayez d'accéder à un secret, suivez cette procédure spécifique à Secret Manager pour configurer les rôles requis pour votre compte de service.

     • Pour obtenir la liste des types de rôles IAM et des rôles prédéfinis que vous pouvez attribuer aux identités, consultez le guide Comprendre les rôles.

       Pour connaître les étapes à suivre pour attribuer les rôles, consultez la page Accorder, modifier et révoquer les accès à des ressources.

Développement à distance avec le gestionnaire de secrets activé

Si vous développez votre application à distance, que vous utilisez un compte de service pour l'authentification et que votre application utilise des secrets, vous devez effectuer quelques étapes supplémentaires après avoir suivi les instructions pour le développement à distance. Ces étapes ont pour objectif d'attribuer à votre compte de service Google le rôle requis pour accéder à un secret spécifique du gestionnaire de secrets :

1. Ouvrez le panneau "Secret Manager" (Gestionnaire de secrets) en cliquant sur l'onglet "Secret Manager" (Gestionnaire de secrets) dans la barre latérale droite de Cloud Code.

2. Sélectionnez le secret auquel vous souhaitez accéder depuis votre code.

3. Accédez à l'onglet "Autorisations", puis configurez les autorisations de votre secret en cliquant sur edit Modifier l'autorisation. La page de configuration de Secret Manager pour le secret s'ouvre dans votre navigateur Web.

   

4. Dans la console Google Cloud, cliquez sur Afficher le panneau d'informations, puis sur Ajouter un compte principal.

5. Attribuez le rôle Accesseur de secrets de Secret Manager à votre compte de service.

   Votre compte de service est autorisé à accéder à ce secret.

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.