Primeiros passos com Endpoints para Cloud Run

Nesta página, mostramos como configurar o Cloud Endpoints para o Cloud Run. O Endpoints usa o Extensible Service Proxy V2 Beta (ESPv2 Beta) como um gateway de API (link em inglês). Para fornecer o gerenciamento de APIs para o Cloud Run, implante o contêiner pré-criado do ESPv2 Beta para Cloud Run. Em seguida, proteja seus serviços usando o IAM do Cloud Run para que o ESPv2 Beta possa invocá-los.

Com essa configuração, o ESPv2 Beta intercepta todas as solicitações e executa as verificações necessárias, como a autenticação, antes de invocar o serviço. Quando o serviço responde, a telemetria é coletada e relatada pelo ESPv2 Beta. É possível ver métricas do seu serviço na página Endpoints > Serviços no Console do Google Cloud.

Para uma visão geral do Cloud Endpoints, consulte Sobre o Endpoints e Arquitetura do Endpoints.

Lista de tarefas

Ao seguir o tutorial, use a lista de tarefas abaixo. Todas as tarefas são necessárias para concluir este tutorial.

  1. Crie um projeto do Google Cloud e, se você não tiver implantado seu próprio Cloud Run, implante um serviço de amostra. Consulte Antes de começar.
  2. Implante o contêiner do ESPv2 Beta no Cloud Run. Consulte Como implantar o ESPv2 Beta.
  3. Criar um documento da OpenAPI que descreva sua API e configure as rotas para o Cloud Run. Consulte Como configurar o Endpoints.
  4. Implante o documento do OpenAPI para criar um serviço gerenciado. Consulte Como implantar a configuração do Endpoints.
  5. Crie e implante uma nova imagem do Docker do ESPv2 Beta com a configuração do serviço do Endpoints. Em seguida, conceda ao ESPv2 Beta a permissão do Cloud Identity and Access Management (Cloud IAM) para invocar seu serviço. Consulte Como criar uma nova imagem do ESPv2 Beta.
  6. Chamar um serviço. Consulte Como enviar uma solicitação à API.
  7. Rastrear a atividade para seus serviços. Consulte Como rastrear a atividade da API.
  8. Evite cobranças na sua conta do Google Cloud. Consulte Fazer limpeza.

Antes de começar

Para configurar:

  1. No Console do Cloud, acesse a página Gerenciar recursos e crie um projeto.

    Acessar a página Gerenciar recursos

  2. Verifique se o faturamento foi ativado para o projeto.

    Saiba como ativar o faturamento

  3. Anote o ID do projeto, porque ele será necessário mais tarde. No restante desta página, esse ID de projeto é chamado de ESP_PROJECT_ID.

  4. Anote o número do projeto, porque ele será necessário mais tarde. No restante desta página, esse número de projeto é chamado de ESP_PROJECT_NUMBER.

  5. Faça o download do SDK do Cloud e instale-o.

    Fazer o download do SDK do Cloud

  6. Se você não tiver implantado seu próprio serviço Cloud Run, siga as etapas em Guia de início rápido: como usar a ferramenta de linha de comando gcloud para selecionar ou criar um projeto do Google Cloud e implantar um back-end de exemplo. Anote a região e o ID do projeto em que seu serviço está implantado. No restante desta página, esse ID do projeto é chamado de BACKEND_PROJECT_ID. O nome do serviço implantado é chamado de BACKEND_SERVICE_NAME.

Como implantar o ESPv2 Beta

Para implantar o contêiner do ESPv2 Beta no Cloud Run, siga estas etapas:

  1. Verifique se o SDK do Cloud tem autorização para acessar seus dados e serviços:
    1. Faça login.
      gcloud auth login
    2. Na nova guia do navegador que é aberta, escolha uma conta que tenha o papel Editor ou Proprietário no projeto do Google Cloud que você criou para implantar o ESPv2 Beta no Cloud Run.
  2. Defina a região.
    gcloud config set run/region us-central1
  3. Implante o ESPv2 Beta no Cloud Run. Substitua CLOUD_RUN_SERVICE_NAME pelo nome do serviço que você quer usar.
    gcloud run deploy CLOUD_RUN_SERVICE_NAME \
        --image="gcr.io/endpoints-release/endpoints-runtime-serverless:2" \
        --allow-unauthenticated \
        --platform managed \
        --project=ESP_PROJECT_ID
    

    Após a conclusão, o comando exibirá uma mensagem semelhante à seguinte:

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

    Por exemplo, se você definir CLOUD_RUN_SERVICE_NAME para gateway:

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

    Neste exemplo, https://gateway-12345-uc.a.run.app é o CLOUD_RUN_SERVICE_URL e gateway-12345-uc.a.run.app é o CLOUD_RUN_HOSTNAME.

  4. Anote o nome do host no URL. Especifique o nome do host no campo host do seu documento da OpenAPI.
  5. Seu serviço do Cloud Run é público na Internet. Se você quiser adicionar recursos de autenticação, recomendamos usar um dos métodos de autenticação aceitos pelo Endpoints.

Como configurar o Endpoints

É necessário ter um documento da OpenAPI baseado na especificação OpenAPI v2.0 (em inglês) que descreve a superfície do seu serviço de back-end e quaisquer requisitos de autenticação. Também é preciso adicionar um campo específico do Google que contenha o URL de cada serviço para que o ESPv2 Beta tenha as informações necessárias para invocar um serviço. Se você é novo na OpenAPI, consulte a visão geral da OpenAPI para mais informações.

  1. Crie um arquivo de texto chamado openapi-run.yaml. Por conveniência, esta página refere-se ao documento do OpenAPI por esse nome de arquivo, mas é possível usar outro nome se você preferir.
  2. Seu serviço de back-end do Cloud Run é definido na parte superior do arquivo openapi-run.yaml, em uma definição de x-google-backend. Por exemplo:
      swagger: '2.0'
      info:
        title: Cloud Endpoints + Cloud Run
        description: Sample API on Cloud Endpoints with a Cloud Run backend
        version: 1.0.0
      host: HOST
      schemes:
        - https
      produces:
        - application/json
      x-google-backend:
        address: https://hello-HASH-uc.a.run.app
      paths:
        /hello:
          get:
            summary: Greet a user
            operationId: hello
            responses:
              '200':
                description: A successful response
                schema:
                  type: string
    
    O recuo é importante para o formato yaml. Por exemplo, o campo host precisa estar no mesmo nível de info.
  3. No campo address, na seção x-google-backend, substitua https://hello-HASH-uc.a.run.app pelo URL real do seu serviço do Cloud Run, em que HASH é o código hash exclusivo gerado quando você criou o serviço.

    Neste exemplo, presumimos que você esteja usando o serviço hello criado em Guia de início rápido: como usar a ferramenta de linha de comando gcloud. Se necessário, substitua esse valor pelo URL do serviço Cloud Run.

  4. No campo host, especifique CLOUD_RUN_HOSTNAME, a parte do nome do host do URL que o Cloud Run criou quando você implantou o ESPv2 Beta acima em Como implantar o ESPv2 Beta. Não inclua o identificador de protocolo, https://. Por exemplo:

    swagger: '2.0'
      info:
        title: Cloud Endpoints + Cloud Run
        description: Sample API on Cloud Endpoints with a Cloud Run backend
        version: 1.0.0
      host: gateway-12345-uc.a.run.app
    
  5. Anote o valor da propriedade title no arquivo openapi-run.yaml:

    title: Cloud Endpoints + Cloud Run

    O valor da propriedade title se tornará o nome do serviço do Endpoints depois que você implantar a configuração.

  6. Salve o documento da OpenAPI.

Para mais informações sobre os campos no documento da OpenAPI exigido pelo Endpoints, consulte Como configurar o Endpoints.

Como implantar a configuração do Endpoints

Para implantar a configuração do Endpoints, use o comando gcloud endpoints services deploy. Ele utiliza o Service Management para criar um serviço gerenciado.

Para implantar a configuração do Endpoints:

  1. Verifique se você está no diretório que contém o documento do OpenAPI.
  2. Faça o upload da configuração e crie um serviço gerenciado.

    gcloud endpoints services deploy openapi-run.yaml \
      --project ESP_PROJECT_ID

    Isso cria um novo serviço do Endpoints com o nome especificado no campo host do arquivo openapi-run.yaml. O serviço é configurado de acordo com o documento da OpenAPI.

    Durante a criação e a configuração do serviço, o Service Management envia informações ao terminal. Quando a implantação for concluída, uma mensagem parecida com esta será exibida:

    Service Configuration [CONFIG_ID] uploaded for service [CLOUD_RUN_HOSTNAME]

    CONFIG_ID é o ID de configuração exclusivo do serviço do Endpoints criado pela implantação. Por exemplo:

    Service Configuration [2019-02-01-r0] uploaded for service [gateway-12345-uc.a.run.app]

    O ID de configuração do serviço consiste em um carimbo de data e um número de revisão. Se você implantar openapi-run.yaml novamente no mesmo dia, o número de revisão aumentará no ID de configuração do serviço. É possível ver a configuração do serviço e o histórico de implantação na página Endpoints > Serviços do Console do Cloud.

    Se você receber uma mensagem de erro, consulte Como solucionar problemas de implantação na configuração do Endpoints.

Como verificar os serviços obrigatórios

O Endpoints e o ESP exigem, no mínimo, os seguintes serviços:
Nome Título
servicemanagement.googleapis.com API Service Management
servicecontrol.googleapis.com API Service Control
endpoints.googleapis.com Google Cloud Endpoints

Na maioria dos casos, o comando gcloud endpoints services deploy ativa os serviços necessários. No entanto, o comando gcloud é concluído com êxito, mas não ativa os serviços necessários nas seguintes circunstâncias:

  • Você usou um aplicativo de terceiros, como o Terraform, e não incluiu esses serviços.

  • Você implantou a configuração do Endpoints em um projeto atual do Google Cloud em que esses serviços foram desativados explicitamente.

Para confirmar que os serviços obrigatórios estão ativados:

gcloud services list

Se você não encontrar os serviços obrigatórios listados, ative-os:

gcloud services enable SERVICE_NAME

Substitua SERVICE_NAME pelo nome do serviço a ser ativado.

Para mais informações sobre os comandos gcloud, consulte serviços .

Como criar uma nova imagem do ESPv2 Beta

Crie a configuração do serviço do Endpoints em uma nova imagem docker do ESPv2 Beta e reimplante o serviço Cloud Run do ESPv2 Beta com a imagem. Em seguida, conceda ao ESPv2 Beta a permissão do Cloud IAM para invocar seus serviços.

Para criar a configuração do serviço em uma nova imagem docker do ESPv2 Beta:

  1. Faça o download deste script (em inglês) para seu host local com o SDK da gcloud instalado e execute-o como:

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

    Para CLOUD_RUN_HOSTNAME, especifique o nome do host do CLOUD_RUN_SERVICE_URL, o URL que o Cloud Run criou quando você implementou o ESPv2 Beta acima em Como implementar o ESPv2 Beta. Não inclua o identificador de protocolo, https://.

    Por exemplo:

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

    O script usa o comando da gcloud para fazer o download da configuração do serviço, criar essa configuração em uma nova imagem do ESPv2 Beta e fazer upload da nova imagem para o registro de contêiner do projeto localizado aqui:

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

    Por exemplo:

    gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:gateway-12345-uc.a.run.app-2019-02-01-r0"
  2. Implante novamente o serviço Cloud Run do ESPv2 Beta com a nova imagem. Substitua CLOUD_RUN_SERVICE_NAME pelo mesmo nome de serviço do Cloud Run que você usou quando o implantou originalmente em Como implantar o ESPv2 Beta:

    gcloud run deploy CLOUD_RUN_SERVICE_NAME \
      --image="gcr.io/ESP_PROJECT_ID/endpoints-runtime-serverless:CLOUD_RUN_HOSTNAME-CONFIG_ID" \
      --allow-unauthenticated \
      --platform managed \
      --project=ESP_PROJECT_ID
  3. Se você quiser configurar o Endpoints para usar opções adicionais de inicialização do ESPv2 Beta, como ativar o CORS, por exemplo, passe os argumentos na variável de ambiente ESPv2_ARGS:

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

    Para mais informações e exemplos sobre como configurar a variável de ambiente ESPv2_ARGS, incluindo a lista de opções disponíveis e informações sobre como especificar várias opções, consulte Sinalizações do Extensible Service Proxy V2 Beta.

  4. Conceda permissão ao ESPv2 Beta para invocar seus serviços do Cloud Run. Execute o seguinte comando para cada serviço. Realize estas etapas no comando a seguir:
    • Substitua BACKEND_SERVICE_NAME pelo nome do serviço do Cloud Run que está sendo invocado. Se você estiver usando a função criada no Guia de início rápido: como usar a ferramenta de linha de comando gcloud, use hello como esse valor.
    • Substitua ESP_PROJECT_NUMBER pelo número do projeto criado para o ESPv2 Beta. Uma maneira de encontrá-lo é acessar o Console de IAM e procurar a conta de serviço de computação padrão, que é a conta de serviço usada na sinalização `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

Para mais informações, consulte Como gerenciar o acesso por meio do Cloud IAM.

Como enviar solicitações à API

Veja nesta seção como enviar solicitações para a API.

  1. Crie uma variável de ambiente para o nome do serviço do Endpoints. Este é o nome que você especificou no campo host do documento da OpenAPI. Por exemplo:
    • Linux ou macOS:

      export ENDPOINTS_HOST=gateway-12345-uc.a.run.app

    • Windows PowerShell:

      $Env: ENDPOINTS_HOST="gateway-12345-uc.a.run.app"

Linux ou Mac OS

Use curl para enviar uma solicitação HTTP usando a variável de ambiente ENDPOINTS_HOST definida na etapa anterior.

curl --request GET \
   --header "content-type:application/json" \
   "https://${ENDPOINTS_HOST}/hello"

PowerShell

Use Invoke-WebRequest para enviar uma solicitação HTTP usando a variável de ambiente ENDPOINTS_HOST definida na etapa anterior.

(Invoke-WebRequest -Method GET `
    -Headers @{"content-type"="application/json"} `
    -URI "https://$Env:ENDPOINTS_HOST/hello").Content

No exemplo acima, as duas primeiras linhas terminam em um acento grave. Quando você colar o exemplo no PowerShell, verifique se não há espaço após os acentos graves. Para informações sobre as opções usadas na solicitação de exemplo, consulte Invoke-WebRequest (em inglês) na documentação da Microsoft.

Aplicativo de terceiros

É possível usar um aplicativo de terceiros, como a solicitação da extensão Postman (em inglês) do navegador Google Chrome.

  • Selecione GET como o verbo HTTP.
  • Para o cabeçalho, selecione a chave content-type e o valor application/json.
  • Use o URL real em vez da variável de ambiente, por exemplo:

    https://gateway-12345-uc.a.run.app/hello
    

Se não receber uma resposta bem-sucedida, consulte Como solucionar problemas em erros de resposta.

Você acaba de implantar e testar uma API no Endpoints.

Como rastrear atividade da API

  1. Veja os gráficos de atividade para sua API na página Endpoints > Serviço no Console do Cloud.

    Ver gráficos de atividades do Endpoints

    Pode levar alguns instantes até a solicitação aparecer nos gráficos.

  2. Verifique os registros de solicitações da API na página "Visualizador de registros".

    Ver registros de solicitações do Endpoints

Como criar um portal do desenvolvedor para a API

É possível usar o Portal do Cloud Endpoints para criar um portal do desenvolvedor, um site para interagir com a API de amostra. Para saber mais, consulte Visão geral do Portal do Cloud Endpoints.

Fazer a limpeza

Para evitar cobranças na sua conta do Google Cloud pelos recursos usados neste guia de início rápido, execute as etapas a seguir.

Consulte Como excluir uma API e as instâncias relacionadas para mais informações sobre como interromper os serviços usados neste tutorial.

A seguir