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.

Parcourir les API Cloud

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

  1. Accédez à Tools > Google Cloud Code > Cloud APIs (Outils > Google Cloud Code > API Cloud).

  2. La fenêtre Manage Google Cloud APIs (Gérer les API Google Cloud) regroupe les API Cloud par catégorie. Vous pouvez également utiliser la barre de recherche Search APIs pour rechercher des API spécifiques.

    Explorateur d'APIs Cloud affichant la liste des APIs Cloud.

  3. Cliquez sur une API pour afficher plus de détails, tels que son état, les instructions d'installation spécifiques à la langue pour les bibliothèques clientes correspondantes, ainsi que la documentation correspondante.

Activer API Cloud

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

  1. Dans la vue détaillée de l'API Cloud, sélectionnez un projet Google Cloud pour lequel vous souhaitez activer l'API Cloud.

  2. Cliquez sur Activer l'API.

    Lorsque l'API est activée, un message s'affiche pour confirmer la modification.

Ajouter les bibliothèques clientes Cloud

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

Pour les projets Java Maven

  1. Accédez à Tools > Google Cloud Code > Cloud APIs (Outils > Google Cloud Code > API Cloud).

    2. La section Installer la bibliothèque cliente de la boîte de dialogue Gérer les API Google Cloud affiche les bibliothèques compatibles.

  2. Sélectionnez votre type de bibliothèque préféré : Bibliothèque cliente Google Cloud (recommandé pour la plupart des projets) ou Java Spring Google Cloud (recommandé si votre projet utilise Java Spring).
  3. Suivez le reste des instructions de la section Installer la bibliothèque cliente dans votre IDE, le cas échéant.
  4. Lorsque vous avez terminé, cliquez sur Fermer.

Pour tous les autres projets

  1. Accédez à Tools > Google Cloud Code > Cloud APIs (Outils > Google Cloud Code > API Cloud).

    2. La section Installer la bibliothèque cliente de la boîte de dialogue Gérer les API Google Cloud affiche les bibliothèques compatibles.

  2. Pour installer l'API, suivez les instructions d'installation figurant sur la page des détails de l'API pour la langue de votre choix.

    Si vous développez une application Java, vous devez également spécifier vos préférences de bibliothèque : Bibliothèque cliente Google Cloud (recommandée) ou Java Spring Google Cloud.

  3. Lorsque vous avez terminé, cliquez sur Fermer.

Utiliser des exemples de code d'API

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

  1. Accédez à Tools > Google Cloud Code > Cloud APIs (Outils > Google 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 le texte à rechercher ou sélectionnez 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 garantit 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 garantit 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 garantit 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 garantit 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


En fonction du champ d'application de votre projet, vous pouvez choisir la manière dont vous authentifiez les services Google Cloud sur GKE :
  • (Développement uniquement)
    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 :
  • (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, accordez-les pour le compte de service Google que vous utilisez pour développer votre application :

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 ensuite sur Continuer, puis sur OK.
  6. Pour ajouter votre compte de service Kubernetes à votre configuration de déploiement, accédez à Exécuter > Modifier les configurations, puis spécifiez votre compte de service dans le champ Nom du service.

Cloud Run


En fonction du champ d'application de votre projet, vous pouvez choisir la manière dont vous authentifiez les services Google Cloud sur GKE :
  • (Développement uniquement)
    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 :
  • (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 à Exécuter > Modifier les configurations, puis spécifiez votre compte de service Kubernetes dans le champ Nom du service.
    3. Si le service Google Cloud auquel vous essayez d'accéder nécessite des rôles supplémentaires, accordez-les pour le compte de service Google que vous utilisez pour développer votre application :

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. Pour ouvrir la fenêtre de l'outil Secret Manager, accédez à Outils > Google Cloud Code > Secret Manager.

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

  3. Cliquez sur l'onglet Autorisations, puis configurez les autorisations du secret en cliquant sur edit Modifier l'autorisation.

    Onglet "Permissions" (Autorisations) sélectionné dans "Secret Manager" (Gestionnaire de secrets). On a accentué la visibilité de l'icône permettant de modifier les autorisations.

    La console Google Cloud s'ouvre dans une nouvelle fenêtre de votre navigateur Web, affichant la page de configuration Secret Manager de votre secret.

  4. Dans la console Google Cloud, cliquez sur l'onglet Autorisations, puis sur Accorder l'accès.

  5. Dans le champ Nouveaux comptes principaux, saisissez votre compte de service.

  6. Dans le menu déroulant Sélectionner un rôle, choisissez le rôle Accesseur de secrets Secret Manager.

  7. Lorsque vous avez terminé, cliquez sur Save (Enregistrer).

    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.