Schritt 2: Proxydienst (Google Cloud API Gateway) über die Konsole erstellen¶

Vorheriger Schritt¶

Schritt 1: Remotedienst (Google Cloud Function) über die Konsole erstellen

Links zu verwandten Google-Dokumentationen¶

Ausführliche Informationen zur Verwendung der Google Cloud Console für die unter diesem Thema beschriebenen Aufgaben finden Sie in den folgenden Abschnitten der Kurzanleitung: Bereitstellen einer API auf API Gateway unter Verwendung der Google Cloud Console:

• API-Definition erstellen

• Gateway erstellen

Wenn Sie es vorziehen, die Befehlszeile anstelle der Google Cloud Console zu verwenden, lesen Sie die folgenden Abschnitte der Kurzanleitung: Bereitstellen einer API auf API Gateway mit gcloud:

• API erstellen

• API-Konfiguration erstellen

• API auf einem Gateway bereitstellen

Wenn Sie die Google-Dokumentation verwenden, denken Sie daran, die erforderlichen Informationen (z. B. Gateway URL) in Ihr Arbeitsblatt zu kopieren.

API-Definition erstellen¶

Erstellen Sie in Ihrem lokalen Dateisystem eine YAML-formatierte Konfigurationsdatei, die die zu erstellenden API spezifiziert. Die Datei sollte die Erweiterung .yaml oder .yml haben.

Vorlage für die Konfigurationsdatei:

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

Füllen Sie die folgenden Felder aus, oder aktualisieren Sie diese:

1. Ersetzen Sie <PATH> durch einen eindeutigen Namen. Dieser Wert wird in URLs übernommen, verwenden Sie also nur Zeichen, die in URLs gültig sind. Geben Sie zum Beispiel demo-func-resource ein.

   Beachten Sie, dass Sie im Gegensatz zu den anderen Feldern in dieser Konfigurationsdatei den Wert für <PATH> vor dem Doppelpunkt und nicht nach dem Doppelpunkt eingeben müssen. Beispielsweise ist Folgendes korrekt:

   paths:
     /demo-func-resource:
   

   Copy

   Der Pfadname darf keine Pfadparameter enthalten. Google unterstützt Pfadparameter beim Einstellen des Pfades auf eine URL. Snowflake unterstützt jedoch keine Pfadparameter in der entsprechenden URL, die in der CREATE EXTERNAL FUNCTION-Anweisung angegeben wird.

2. Kopieren Sie den Pfad (z. B. demo-func-resource) aus dem unmittelbar vorangegangenen Schritt in das Feld Path Suffix Ihres Arbeitsblatts.

3. Suchen Sie das Feld address unter dem Feld x-google-backend, und ersetzen Sie <HTTP ENDPOINT TO ROUTE REQUEST TO> durch den Wert aus dem Feld Cloud Function Trigger URL Ihres Arbeitsblatts. Das Ergebnis sollte in etwa wie folgt aussehen:

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

   Copy

   Die URL darf nicht in Anführungszeichen gesetzt werden.

   Die URL muss kein von Google gehosteter Endpunkt sein, sondern kann der Pfad zu einem beliebigen HTTP-Endpunkt sein.

   Wenn Sie in Schritt 1: Remotedienst (Google Cloud Function) über die Konsole erstellen die Option Require HTTPS ausgewählt haben, müssen Sie sicherstellen, dass die URL, die Sie in das Feld address eingeben, mit https beginnt.

4. Optional können Sie jeden der folgenden Werte aktualisieren:

   • title im Abschnitt info

   • description im Abschnitt info

   • operationId im Unterabschnitt post des Abschnitts paths

   • summary im Unterabschnitt post des Abschnitts paths

5. Überprüfen Sie Ihre Beispielkonfigurationsdatei. Diese sollte ungefähr wir folgt aussehen:

   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

   Bemerkung

   Mit dieser Konfiguration bleibt Ihr Gateway für die Öffentlichkeit zugänglich, bis Sie es in Schritt 5: GCP-Sicherheitsrichtlinie für Proxydienst über die Konsole erstellen diese Tutorials sichern.

6. Um sicherzustellen, dass niemand Ihr Gateway in der Zwischenzeit verwenden kann, fügen Sie optional eine Sicherheitsdefinition in die Konfigurationsdatei ein, die einen temporären, ungültigen Dienstkontonamen (google_service_account) verwendet, wie in diesem optionalen Schritt beschrieben. Das Hinzufügen dieser Sicherheitsdefinition in diesem Schritt bedeutet, dass Sie Ihre externe Funktion erst testen können, wenn Sie die Konfiguration der Sicherheit in Schritt 5: GCP-Sicherheitsrichtlinie für Proxydienst über die Konsole erstellen abgeschlossen haben. Insbesondere wird die Anleitung zum Testen Ihrer externen Funktion in Schritt 4: Externe Funktion für GCP in Snowflake erstellen noch nicht funktionieren.

   1. Fügen Sie den folgenden securityDefinitions-Abschnitt direkt über dem Abschnitt schemes der Konfigurationsdatei und auf der gleichen Einrückungsebene hinzu.

      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

      • Ersetzen Sie <security-def-name> durch einen eindeutigen Namen für die Sicherheitsdefinition (z. B. snowflakeAccess01).

      • Notieren Sie sich diesen Namen auf dem Arbeitsblatt unter Security Definition Name.

   2. Aktualisieren Sie in der Konfigurationsdatei den Abschnitt post:, um auf die oben erstellte Sicherheitsdefinition zu verweisen. Fügen Sie unterhalb des Feldes operationId Folgendes hinzu:

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

      Copy

      • Achten Sie darauf, dass es auf der gleichen Ebene wie das Feld operationId eingerückt ist.

      • Ersetzen Sie <security-def-name> durch den Wert aus dem Feld Security Definition Name Ihres Arbeitsblatts.

      • Stellen Sie sicher, dass vor dem Namen der Sicherheitsdefinition ein Bindestrich und ein Leerzeichen stehen, wie oben gezeigt.

      • Achten Sie darauf, dass die leeren eckigen Klammern ([]) nach dem Doppelpunkt enthalten sind.

      Beispiel:

      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. Speichern Sie die Konfigurationsdatei.

8. Notieren Sie sich Dateipfad und Dateiname auf dem Arbeitsblatt unter Configuration File Name.

Wenn Sie mehr über die API-Konfigurationsdatei erfahren möchten, lesen Sie die folgende GCP-Dokumentation:

• Übersicht zu OpenAPI

• API-Definition erstellen

API-Gateway erstellen¶

So erstellen Sie ein API-Gateway:

1. Erstellen Sie eine GCP API.

2. Erstellen Sie eine API-Konfigurationsdatei.

3. Erstellen Sie mit der API-Konfigurationsdatei ein Gateway.

Nächster Schritt¶

Schritt 3: API-Integration für GCP in Snowflake erstellen