Configurer Cloud Endpoints gRPC pour Cloud Run avec ESPv2

Réserver un nom d'hôte Cloud Run

Vous devez réserver un nom d'hôte Cloud Run pour le service ESPv2 afin de configurer le document OpenAPI ou la configuration du service gRPC. Pour réserver un nom d'hôte, vous devez déployer un exemple de conteneur dans Cloud Run. Vous déploierez par la suite le conteneur ESPv2 sur le même service Cloud Run.

1. Assurez-vous que gcloud CLI est autorisée à accéder à vos données et services.
   1. Connectez-vous.

      gcloud auth login

   2. Dans le nouvel onglet de navigateur qui s'ouvre, choisissez un compte auquel a été attribué le rôle Éditeur ou Propriétaire dans le projet Google Cloud que vous avez créé pour déployer ESPv2 dans Cloud Run.
2. Définissez la région.

   gcloud config set run/region us-central1

3. Déployez l'exemple d'image gcr.io/cloudrun/hello dans Cloud Run. Remplacez CLOUD_RUN_SERVICE_NAME par le nom que vous souhaitez utiliser pour le service.

   gcloud run deploy CLOUD_RUN_SERVICE_NAME \
       --image="gcr.io/cloudrun/hello" \
       --allow-unauthenticated \
       --platform managed \
       --project=ESP_PROJECT_ID
   

   Si elle réussit, la commande affiche un message semblable à celui-ci :

   Service [CLOUD_RUN_SERVICE_NAME] revision [CLOUD_RUN_SERVICE_NAME-REVISION_NUM] has been deployed and is serving traffic at CLOUD_RUN_SERVICE_URL

   Par exemple, si vous définissez CLOUD_RUN_SERVICE_NAME sur gateway :

   Service [gateway] revision [gateway-00001] has been deployed and is serving traffic at https://gateway-12345-uc.a.run.app

   Dans cet exemple, https://gateway-12345-uc.a.run.app correspond à CLOUD_RUN_SERVICE_URL et gateway-12345-uc.a.run.app à CLOUD_RUN_HOSTNAME.

4. Notez CLOUD_RUN_SERVICE_NAME et CLOUD_RUN_HOSTNAME. Vous déploierez par la suite ESPv2 sur le service Cloud Run CLOUD_RUN_SERVICE_NAME. Spécifiez CLOUD_RUN_HOSTNAME dans le champ host du document OpenAPI.

Configurer Endpoints

L'exemple bookstore-grpc contient les fichiers que vous devez copier localement puis configurer.

1. Créez un fichier descripteur protobuf autonome à partir de votre fichier de service .proto :
   1. Enregistrez dans votre répertoire de travail actuel une copie du fichier bookstore.proto à partir de l'exemple de dépôt. Ce fichier définit l'API du service Bookstore.
   2. Créez le répertoire suivant dans votre répertoire de travail : mkdir generated_pb2
   3. Créez le fichier descripteur api_descriptor.pb à l'aide du compilateur de tampons de protocole protoc. Exécutez la commande suivante dans le répertoire où vous avez enregistré bookstore.proto :

      python3 -m grpc_tools.protoc \
          --include_imports \
          --include_source_info \
          --proto_path=. \
          --descriptor_set_out=api_descriptor.pb \
          --python_out=generated_pb2 \
          --grpc_python_out=generated_pb2 \
          bookstore.proto

      Dans la commande ci-dessus, --proto_path est défini sur le répertoire de travail actuel. Dans votre environnement de compilation gRPC, si vous utilisez un autre répertoire pour les fichiers d'entrée .proto, modifiez --proto_path pour que le compilateur recherche le répertoire dans lequel vous avez enregistré votre fichier bookstore.proto.

2. Créez un fichier texte appelé api_config.yaml dans votre répertoire de travail actuel (le même répertoire que celui contenant bookstore.proto). Pour plus de commodité, cette page utilise ce nom de fichier pour désigner le document de configuration de l'API gRPC, mais vous pouvez lui donner un autre nom si vous préférez. Ajoutez le contenu suivant au fichier :

   # The configuration schema is defined by the service.proto file.
   # https://github.com/googleapis/googleapis/blob/master/google/api/service.proto
   
   type: google.api.Service
   config_version: 3
   name: CLOUD_RUN_HOSTNAME
   title: Cloud Endpoints + Cloud Run gRPC
   apis:
     - name: endpoints.examples.bookstore.Bookstore
   usage:
     rules:
     # ListShelves methods can be called without an API Key.
     - selector: endpoints.examples.bookstore.Bookstore.ListShelves
       allow_unregistered_calls: true
   backend:
     rules:
       - selector: "*"
         address: grpcs://BACKEND_HOST_NAME
   

   La mise en retrait est importante pour le format YAML. Par exemple, le champ name doit se trouver au même niveau que type.

3. Dans le champ name, spécifiez CLOUD_RUN_HOSTNAME, c'est-à-dire la partie nom d'hôte de l'URL réservée, comme indiqué ci-dessus dans la section Réserver un nom d'hôte Cloud Run. N'incluez pas l'identifiant de protocole, tel que https:// ou grpcs://.

4. Dans le champ address de la section backend.rules, remplacez BACKEND_HOST_NAME par le service Cloud Run gRPC Bookstore réel créé dans la section Avant de commencer.

5. Notez la valeur de la propriété title dans le fichier api_config.yaml :

   title: Cloud Endpoints + Cloud Run gRPC

   La valeur de la propriété title devient le nom du service Endpoints après le déploiement de la configuration.

6. Enregistrez le document de configuration de votre API gRPC.

Pour en savoir plus, consultez la page Configurer Endpoints.

Déployer la configuration Endpoints

Pour déployer la configuration Endpoints, exécutez la commande gcloud endpoints services deploy. Cette commande crée un service géré à l'aide de Service Management.

1. Vérifiez que vous êtes bien dans le répertoire contenant les fichiers api_descriptor.pb et api_config.yaml.
2. Vérifiez que le projet par défaut actuellement utilisé par l'outil de ligne de commande gcloud est bien le projet Google Cloud vers lequel vous souhaitez déployer la configuration Endpoints. Validez l'ID de projet renvoyé par la commande suivante, afin de vous assurer que le service est créé dans le bon projet.

   gcloud config list project
   

   Si vous devez modifier le projet par défaut, exécutez la commande suivante :

   gcloud config set project YOUR_PROJECT_ID
   

3. Déployez le fichier proto descriptor et le fichier de configuration à l'aide de Google Cloud CLI:

   gcloud endpoints services deploy api_descriptor.pb api_config.yaml
   

   Lors de la création et de la configuration du service, Service Management envoie des informations au terminal. Une fois le déploiement terminé, un message semblable au suivant s'affiche :

   Service Configuration [CONFIG_ID] uploaded for service [bookstore.endpoints.example-project.cloud.goog]

   CONFIG_ID correspond à l'ID unique de configuration du service Endpoints créé par le déploiement. Exemple :

   Service Configuration [2017-02-13r0] uploaded for service [bookstore.endpoints.example-project.cloud.goog]
   

   Dans l'exemple précédent, 2017-02-13r0 correspond à l'ID de configuration du service et bookstore.endpoints.example-project.cloud.goog au nom du service. L'ID de configuration du service se compose d'un horodatage suivi d'un numéro de révision. Si vous déployez à nouveau la configuration Endpoints le même jour, le numéro de révision est incrémenté dans l'ID de configuration du service.

Vérifier les services requis

Dans la plupart des cas, la commande gcloud endpoints services deploy permet d'activer ces services requis. Toutefois, bien que la commande gcloud ait abouti, elle n'active pas les services requis dans les cas suivants :

• Vous avez utilisé une application tierce telle que Terraform et vous n'incluez pas ces services.

• Vous avez déployé la configuration Endpoints dans un projet Google Cloud existant dans lequel ces services étaient explicitement désactivés.

Utilisez la commande suivante pour vérifier que les services nécessaires sont activés :

gcloud services list

Si les services requis ne sont pas répertoriés, activez-les :

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

Activez également votre service Endpoints :

gcloud services enable ENDPOINTS_SERVICE_NAME

Pour déterminer la valeur de ENDPOINTS_SERVICE_NAME, vous pouvez effectuer l'une des opérations suivantes :

• Après avoir déployé la configuration Endpoints, accédez à la page Endpoints de Cloud Console. La liste des valeurs ENDPOINTS_SERVICE_NAME possibles s'affiche dans la colonne Nom du service.

• Pour OpenAPI, ENDPOINTS_SERVICE_NAME correspond à ce que vous avez spécifié dans le champ host de votre spécification OpenAPI. Pour gRPC, ENDPOINTS_SERVICE_NAME correspond à ce que vous avez spécifié dans le champ name de votre configuration Endpoints gRPC.

Pour en savoir plus sur les commandes gcloud, consultez la page Services gcloud.

Si vous recevez un message d'erreur, consultez la page Dépannage du déploiement de la configuration Cloud Endpoints.

Pour en savoir plus, consultez la page Déployer la configuration Endpoints.

Créer une image ESPv2

Créez la configuration du service Endpoints dans une nouvelle image ESPv2 pour Docker. Vous déploierez par la suite cette image sur le service Cloud Run réservé.

Pour créer la configuration de service dans une nouvelle image ESPv2 pour Docker, procédez comme suit :

1. Téléchargez ce script sur la machine locale où la gcloud CLI est installée.

2. Exécutez le script avec la commande suivante :

   chmod +x gcloud_build_image
   
   ./gcloud_build_image -s CLOUD_RUN_HOSTNAME \
       -c CONFIG_ID -p ESP_PROJECT_ID

   Pour le paramètre CLOUD_RUN_HOSTNAME, spécifiez le nom d'hôte de l'URL que vous avez réservé, comme indiqué ci-dessus dans la section Réserver un nom d'hôte Cloud Run. N'incluez pas l'identifiant du protocole https://.

   Exemple :

   chmod +x gcloud_build_image
   
   ./gcloud_build_image -s gateway-12345-uc.a.run.app \
       -c 2019-02-01r0 -p your-project-id

3. Le script utilise la commande gcloud pour télécharger la configuration de service, la compiler dans une nouvelle image ESPv2, puis importer la nouvelle image dans le registre de conteneurs de votre projet. Le script utilise automatiquement la dernière version d'ESPv2, désignée par ESP_VERSION dans le nom de l'image de sortie. L'image de sortie est importée dans l'emplacement suivant :

   gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID

   Exemple :

   gcr.io/your-project-id/endpoints-runtime-serverless:2.14.0-gateway-12345-uc.a.run.app-2019-02-01r0"

Déployer le conteneur ESPv2

1. Déployez le service ESPv2 pour Cloud Run avec la nouvelle image créée ci-dessus. Remplacez CLOUD_RUN_SERVICE_NAME par le nom du service Cloud Run utilisé lors de la réservation initiale du nom d'hôte, comme indiqué ci-dessus dans la section Réserver un nom d'hôte Cloud Run :

   gcloud run deploy CLOUD_RUN_SERVICE_NAME \
     --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID" \
     --allow-unauthenticated \
     --platform managed \
     --project=ESP_PROJECT_ID

2. Si vous souhaitez configurer Endpoints afin d'utiliser d'autres options de démarrage d'ESPv2, telles que l'activation de CORS, vous pouvez transmettre les arguments dans la variable d'environnement ESPv2_ARGS :

   gcloud run deploy CLOUD_RUN_SERVICE_NAME \
     --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:ESP_VERSION-CLOUD_RUN_HOSTNAME-CONFIG_ID" \
     --set-env-vars=ESPv2_ARGS=--cors_preset=basic \
     --allow-unauthenticated \
     --platform managed \
     --project ESP_PROJECT_ID

   Pour en savoir plus et obtenir des exemples de définition de la variable d'environnement ESPv2_ARGS, y compris la liste des options disponibles et des informations sur la manière de spécifier plusieurs options, reportez-vous à la page sur les options d'Extensible Service Proxy V2.

3. Accordez à ESPv2 l'autorisation d'appeler vos services Cloud Run. Exécutez la commande ci-dessous pour chaque service. Dans la commande suivante :
   • Remplacez BACKEND_SERVICE_NAME par le nom du service Cloud Run appelé. Si vous utilisez le service créé en déployant "gcr.io/endpointsv2/python-grpc-bookstore-server:2", utilisez python-grpc-bookstore-server comme valeur.
   • Remplacez ESP_PROJECT_NUMBER par le numéro du projet que vous avez créé pour ESPv2. Pour ce faire, vous pouvez accéder à la page IAM de la console Google Cloud et rechercher le compte de service Compute par défaut, qui correspond au compte de service utilisé dans l'indicateur "member".

   gcloud run services add-iam-policy-binding BACKEND_SERVICE_NAME \
     --member "serviceAccount:ESP_PROJECT_NUMBER-compute@developer.gserviceaccount.com" \
     --role "roles/run.invoker" \
     --platform managed \
     --project BACKEND_PROJECT_ID

Pour en savoir plus, consultez la page Gérer les accès à l'aide d'IAM.

Envoyer des requêtes à l'API

Pour envoyer des requêtes à l'exemple d'API, vous pouvez utiliser un exemple de client gRPC écrit en Python.

1. Clonez le dépôt Git dans lequel le code client gRPC est hébergé :

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

2. Modifiez votre répertoire de travail :

   cd python-docs-samples/endpoints/bookstore-grpc/

3. Installez les dépendances :

   pip3 install virtualenv
   virtualenv env
   source env/bin/activate
   pip3 install -r requirements.txt

4. Envoyez une requête à l'exemple d'API :

   python3 bookstore_client.py --host CLOUD_RUN_HOSTNAME --port 443 --use_tls true

   Spécifiez le nom d'hôte de votre service Cloud Run ESPv2 dans CLOUD_RUN_HOSTNAME, sans l'identifiant de protocole. Exemple :

   python3 bookstore_client.py --host espv2-grpc-HASH-uc.a.run.app --port 443 --use_tls true

   • Consultez les graphiques d'activité de votre API sur la page Endpoints > Services.

     Accédez à la page Services Endpoints

     Il peut s'écouler quelques instants avant que la requête ne soit reflétée dans les graphiques.

   • Consultez les journaux de requêtes de votre API sur la page de l'explorateur de journaux.

     Accéder à la page "Explorateur de journaux"

Si vous ne recevez pas de réponse positive, consultez la page Dépanner des erreurs de réponse.

Vous venez de déployer et de tester une API dans Endpoints.

Suivre l'activité de l'API

1. Consultez les graphiques d'activité de votre API sur la page Endpoints > Service de la console Google Cloud.

   Afficher les graphiques d'activité Endpoints

   Il peut s'écouler quelques instants avant que la requête ne soit reflétée dans les graphiques.

2. Consultez les journaux de requêtes de votre API sur la page de l'explorateur de journaux.

   Afficher les journaux de requête Endpoints

Créer un portail développeur pour l'API

Vous pouvez utiliser le portail Cloud Endpoints pour créer un portail des développeurs, c'est-à-dire un site Web qui vous permet d'interagir avec l'exemple d'API. Pour en savoir plus, consultez la page Présentation du portail Cloud Endpoints.