Étape 2 : Créer le service proxy (Google Cloud API Gateway) dans la console¶

Étape précédente¶

Étape 1 : créer le service distant (fonction Google Cloud) dans la console

Liens vers la documentation connexe de Google¶

Pour obtenir des informations plus détaillées sur l’utilisation de la Google Cloud Console pour effectuer les tâches décrites dans cette rubrique, consultez les sections suivantes du document Démarrage rapide du déploiement d’une API/API Gateway à l’aide de la Google Cloud Console :

• Création d’une définition d’API

• Création d’une passerelle

Si vous préférez utiliser la ligne de commande plutôt que la console Google Cloud, consultez les sections suivantes du document Démarrage rapide pour le déploiement d’une API/API Gateway à l’aide de gcloud :

• Créer une API

• Créer une configuration API

• Déployer une API sur une passerelle

Si vous utilisez la documentation Google, n’oubliez pas de copier les informations requises (par exemple, URL de Gateway) dans votre feuille de calcul de suivi.

Créer une définition API¶

Sur votre système de fichiers local, créez et personnalisez un fichier de configuration au format YAML qui spécifie l’API que vous êtes en train de créer. Le fichier doit avoir l’extension .yaml ou .yml.

Modèle de fichier de configuration :

swagger: '2.0'
info:
  title: API Gateway config for Snowflake external function.
  description: This configuration file connects the API Gateway resource to the remote service (Cloud Function).
  version: 1.0.0
schemes:
  - https
produces:
  - application/json
paths:
  /<PATH>:
    post:
      summary: Echo the input.
      operationId: echo
      x-google-backend:
        address: <HTTP ENDPOINT TO ROUTE REQUEST TO>
        protocol: h2
      responses:
        '200':
          description: <DESCRIPTION>
          schema:
            type: string

Remplissez ou mettez à jour les champs suivants :

1. Remplacez <PATH> par un nom unique. Il sera incorporé dans les URLs, donc n’utilisez que des caractères valides dans les URLs. Par exemple, entrez demo-func-resource.

   Notez que, contrairement aux autres champs de ce fichier de configuration, vous devez saisir la valeur <PATH> avant les deux-points, plutôt qu’après les deux-points. Par exemple, ce qui suit est correct :

   paths:
     /demo-func-resource:
   

   Copy

   Le nom du chemin ne doit pas contenir de paramètres de chemin . Google prend en charge les paramètres de chemin lorsque vous définissez le chemin d’accès à une URL . Cependant, Snowflake ne prend pas en charge les paramètres de chemin dans l’URL correspondante spécifiée dans l’instruction CREATE EXTERNAL FUNCTION.

2. Copiez le chemin (par exemple, demo-func-resource) de l’étape précédente dans le champ Path Suffix de votre feuille de calcul de suivi.

3. Trouvez le champ address sous le champ x-google-backend et remplacez <HTTP ENDPOINT TO ROUTE REQUEST TO> par la valeur du champ Cloud Function Trigger URL de votre feuille de calcul de suivi. Le résultat devrait ressembler à ceci :

   x-google-backend:
     address: https:// ...
   

   Copy

   L’URL ne doit pas être placée entre guillemets.

   L’URL ne doit pas nécessairement être un point de terminaison hébergé par Google ; elle peut être le chemin d’accès à n’importe quel point de terminaison HTTP.

   Si vous avez sélectionné Require HTTPS dans Étape 1 : créer le service distant (fonction Google Cloud) dans la console, assurez-vous que l’URL que vous entrez dans le champ address commence par https.

4. En option, vous pouvez mettre à jour l’une des valeurs suivantes :

   • title dans la section info.

   • description dans la section info.

   • operationId dans la sous-section post de la section paths.

   • summary dans la sous-section post de la section paths.

5. Examinez votre exemple de fichier de configuration Cela devrait ressembler à ce qui suit :

   swagger: '2.0'
   info:
     title: "API Gateway config for Snowflake external function"
     description: "This configuration file connects the API Gateway resource to the remote service (Cloud Function)."
     version: 1.0.0
   schemes:
     - https
   produces:
     - application/json
   paths:
     /demo-func-resource:
       post:
         summary: "echo the input"
         operationId: echo
         x-google-backend:
           address: https://my_dev.cloudfunctions.net/demo-cloud-function-01
           protocol: h2
         responses:
           '200':
             description: echo result
             schema:
               type: string
   

   Copy

   Note

   Cette configuration laissera votre passerelle ouverte au public jusqu’à ce que vous la sécurisiez dans Étape 5 : Créez une politique de sécurité GCP pour le proxy de service dans la Console de ce tutoriel.

6. En option, pour vous assurer que personne ne peut utiliser votre passerelle pendant ce temps, ajoutez une définition de sécurité au fichier de configuration qui utilise un nom de compte de service temporaire et non valide (google_service_account) comme décrit dans cette étape facultative. L’ajout de cette définition de sécurité à cette étape signifie que vous ne pouvez pas tester votre fonction externe tant que vous n’avez pas fini de configurer la sécurité dans Étape 5 : Créez une politique de sécurité GCP pour le proxy de service dans la Console. Plus précisément, l’instruction de tester votre fonction externe dans Étape 4 : Créer la fonction externe pour GCP dans Snowflake ne fonctionnera pas encore.

   1. Ajoutez la section securityDefinitions suivante immédiatement au-dessus de la section schemes du fichier de configuration et au même niveau d’indentation.

      securityDefinitions:
        <security-def-name>:
          authorizationUrl: ""
          flow: "implicit"
          type: "oauth2"
          x-google-issuer: "google_service_account"
          x-google-jwks_uri: "https://www.googleapis.com/robot/v1/metadata/x509/google_service_account"
      

      Copy

      • Remplacez <nom-def-securite> par un nom de définition de sécurité unique (par exemple, snowflakeAccess01).

      • Enregistrez ce nom dans le champ Security Definition Name de votre feuille de calcul de suivi.

   2. Mettez à jour la section post: du fichier de configuration pour faire référence à la définition de sécurité que vous avez créée ci-dessus. Sous le champ operationId, ajoutez :

      security:
        - <security-def-name>: []
      

      Copy

      • Assurez-vous que l’indentation est au même niveau que le champ operationId.

      • Remplacez <security-def-name> par la valeur du champ Security Definition Name de votre feuille de calcul de suivi.

      • Veillez à inclure un trait d’union et un blanc avant le nom de la définition de sécurité, comme indiqué ci-dessus.

      • Veillez à inclure les accolades vides ([]) après les deux-points.

      Par exemple :

      paths:
        /demo-func-resource:
          post:
            summary: "echo the input"
            operationId: echo
            security:
              - snowflakeAccess01: []
            x-google-backend:
              address: https://my_dev.cloudfunctions.net/demo-cloud-function-01
              protocol: h2
      

      Copy

7. Enregistrez le fichier de configuration.

8. Enregistrez le chemin et le nom du fichier dans le champ Configuration File Name de votre feuille de calcul de suivi.

Pour en savoir plus sur le fichier de configuration API, consultez la documentation GCP suivante :

• Vue d’ensemble OpenAPI.

• Créer une définition API .

Créer une passerelle API Gateway¶

Pour créer une passerelle API Gateway :

1. Créer une API GCP.

2. Créer une configuration API.

3. Créer une passerelle avec la configuration API.

Étape suivante¶

Étape 3 : Créer l’intégration API pour GCP dans Snowflake