Etapa 2: criar o serviço de proxy (Google Cloud API Gateway) no console¶

Etapa anterior¶

Etapa 1: criar o serviço remoto (Google Cloud Function) no Console

Links para a documentação relacionada do Google¶

Para obter mais informações detalhadas sobre o uso do Google Cloud Console para realizar as tarefas descritas neste tópico, consulte as seguintes seções no Guia de início rápido: implantar uma API no gateway de API usando o Google Cloud Console:

• Como criar uma definição de API

• Como criar um gateway

Se você preferir usar a linha de comando em vez do Google Cloud Console, consulte as seguintes seções no Guia de início rápido: implantar uma API no gateway de API com a ferramenta de linha de comando gcloud:

• Como criar uma API

• Como criar uma configuração de API

• Como implantar uma API em um gateway

Se você usar a documentação do Google, lembre-se de copiar as informações necessárias (por exemplo, URL do gateway) para sua planilha de rastreamento.

Criar uma definição de API¶

Em seu sistema de arquivo local, crie e personalize um arquivo de configuração com formato YAML que especifique a API que você está criando. O arquivo deve ter a extensão .yaml ou .yml.

Modelo de arquivo de configuração:

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

Preencha ou atualize os seguintes campos:

1. Substitua <PATH> por um nome único. Isto será incorporado a URLs, portanto, use somente caracteres válidos em URLs. Por exemplo, digite demo-func-resource.

   Observe que, ao contrário dos outros campos neste arquivo de configuração, você deve digitar o valor <PATH> antes dos dois pontos, em vez de depois dos dois pontos. Por exemplo, o seguinte é correto:

   paths:
     /demo-func-resource:
   

   Copy

   O nome do caminho não deve conter parâmetros de caminho. O Google oferece suporte a parâmetros de caminho quando define o caminho para uma URL. Entretanto, o Snowflake não oferece suporte a parâmetros de caminho na URL correspondente especificada na instrução CREATE EXTERNAL FUNCTION.

2. Copie o caminho (por exemplo, demo-func-resource) da etapa imediatamente anterior para o campo Path Suffix em sua planilha de rastreamento.

3. Encontre o campo address no campo x-google-backend e substitua <HTTP ENDPOINT TO ROUTE REQUEST TO> pelo valor do campo Cloud Function Trigger URL em sua planilha de rastreamento. O resultado deve ser parecido com:

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

   Copy

   A URL não deve ser colocada entre aspas.

   A URL não precisa ser um ponto de extremidade hospedado pelo Google; ela pode ser o caminho para qualquer ponto de extremidade HTTP.

   Se você selecionou Require HTTPS em Etapa 1: criar o serviço remoto (Google Cloud Function) no Console, então assegure-se de que a URL inserida no campo address comece com https.

4. Opcionalmente, você pode atualizar qualquer um dos seguintes valores:

   • title na seção info.

   • description na seção info.

   • operationId na subseção post da seção paths.

   • summary na subseção post da seção paths.

5. Revise seu arquivo de configuração de amostra. Deve ser semelhante ao seguinte:

   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

   Nota

   Esta configuração deixará seu gateway aberto ao público até que você o proteja na Etapa 5: criar uma política de segurança do GCP para o serviço de proxy no console deste tutorial.

6. Opcionalmente, para garantir que ninguém use seu gateway enquanto isso, adicione uma definição de segurança ao arquivo de configuração que usa um nome de conta de serviço temporário e inválido (google_service_account), conforme descrito nesta etapa opcional. Adicionar esta definição de segurança nesta etapa significa que você não pode testar sua função externa até que termine de configurar a segurança em Etapa 5: criar uma política de segurança do GCP para o serviço de proxy no console. Especificamente, a instrução para testar sua função externa em Etapa 4: criar a função externa para o GCP no Snowflake ainda não funcionará.

   1. Adicionar a seguinte seção securityDefinitions imediatamente acima da seção schemes do arquivo de configuração e no mesmo nível de recuo.

      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

      • Substitua <security-def-name> por um nome de definição de segurança único (por exemplo, snowflakeAccess01).

      • Registre esse nome no campo Security Definition Name da sua planilha de rastreamento.

   2. Atualize a seção post: do arquivo de configuração para fazer referência à definição de segurança que você criou acima. Abaixo do campo operationId, adicione:

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

      Copy

      • Certifique-se o recuo esteja no mesmo nível que o campo operationId.

      • Substitua <security-def-name> pelo valor do campo Security Definition Name da sua planilha de rastreamento.

      • Certifique-se de incluir um hífen e um espaço em branco antes do nome da definição de segurança, como mostrado acima.

      • Certifique-se de incluir os colchetes vazios ([]) após os dois pontos.

      Por exemplo:

      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. Salve o arquivo de configuração.

8. Registre o caminho e o nome do arquivo no campo Configuration File Name da sua planilha de rastreamento.

Para saber mais sobre o arquivo de configuração de API, consulte a seguinte documentação do GCP:

• Visão geral da OpenAPI .

• Como criar uma definição de API .

Criar um gateway de API¶

Para criar um gateway de API:

1. Crie uma GCP API.

2. Crie uma configuração de API.

3. Crie um gateway com a configuração de API.

Próxima etapa¶

Etapa 3: criar a integração de API para GCP no Snowflake