Criar e implantar uma função HTTP do Cloud Run usando Python (1ª geração)

Este guia explica o processo de criação de uma função do Cloud Run usando o ambiente de execução do Python. Há dois tipos de funções do Cloud Run:

• Uma função HTTP, que você invoca a partir de solicitações HTTP padrão.
• Uma função direcionada a eventos, que você usa para processar eventos da infraestrutura do Cloud, como mensagens em um tópico do Pub/Sub ou alterações em um bucket do Cloud Storage.

O exemplo mostra como criar uma função HTTP simples.

Saiba mais: para mais detalhes, leia sobre funções HTTP e funções orientadas a eventos.

Antes de começar

Faça login na sua Google Cloud conta do. Se você não conhece o Google Cloud, crie uma conta para avaliar o desempenho dos nossos produtos em cenários reais. Clientes novos também recebem US $300 em créditos para executar, testar e implantar cargas de trabalho.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Functions and Cloud Build APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

1. Instale e inicialize a CLI gcloud.
2. Atualize e instale os componentes gcloud:

   gcloud components update

Observação: precisa de um prompt de comando? Use o Google Cloud Shell. O Google Cloud Shell é um ambiente de linha de comando que já inclui a Google Cloud CLI. Portanto, não é necessário instalá-lo. A Google Cloud CLI também vem pré-instalado em máquinas virtuais do Google Compute Engine.
3. Prepare seu ambiente de desenvolvimento.

   Acessar o guia de configuração do Python

crie uma função

1. Crie um diretório no seu sistema local para o código de função:

   Linux ou macOS

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

2. Crie um arquivo main.py no diretório helloworld com o seguinte conteúdo:

   
   import functions_framework
   
   
   from markupsafe import escape
   
   @functions_framework.http
   def hello_http(request):
       """HTTP Cloud Function.
       Args:
           request (flask.Request): The request object.
           <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
       Returns:
           The response text, or any set of values that can be turned into a
           Response object using `make_response`
           <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
       """
       request_json = request.get_json(silent=True)
       request_args = request.args
   
       if request_json and "name" in request_json:
           name = request_json["name"]
       elif request_args and "name" in request_args:
           name = request_args["name"]
       else:
           name = "World"
       return f"Hello {escape(name)}!"
   
   

   Esse exemplo de função recebe um nome fornecido na solicitação HTTP e retorna uma saudação, ou "Hello World!", quando nenhum nome é fornecido.

   Observação: o Cloud Run functions procura funções implantáveis no main.py por padrão. Use a sinalização --source quando implantar a função pelo gcloud para especificar um diretório diferente que contenha um arquivo main.py.

Especificar as dependências

Dependências no Python são gerenciadas com pip e expressas em um arquivo de metadados chamado requirements.txt. O arquivo precisa estar no mesmo diretório que o arquivo main.py que contém o código da função.

Não é necessário criar um requirements.txt para executar essa amostra específica, mas suponhamos que você queira adicionar suas próprias dependências. Veja como fazer isso:

1. Crie um arquivo requirements.txt no diretório helloworld.

2. Adicione a dependência da função ao arquivo requirements.txt, por exemplo:

   # An example requirements file, add your dependencies below
   sampleproject==2.0.0
   

Saiba mais: para mais detalhes, leia sobre como especificar dependências.

Implantar a função

Para implantar a função com um gatilho HTTP, execute o seguinte comando no diretório helloworld:

gcloud functions deploy hello_http --no-gen2 --runtime python314 --trigger-http --allow-unauthenticated

A flag --allow-unauthenticated permite que você atinja a função sem autenticação. Para exigir autenticação, omita a sinalização.

Saiba mais: para ver mais detalhes, leia sobre Como implantar Cloud Run functions.

Testar a função

1. Quando a implantação da função estiver concluída, anote a propriedade httpsTrigger.url ou encontre-a usando o seguinte comando:

   gcloud functions describe hello_http
   

   A aparência será semelhante a esta:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http

2. Visite este URL no navegador. Você verá uma mensagem "Hello World!".

   Tente passar um nome na solicitação HTTP, por exemplo, usando este URL:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http?name=NAME

   Você verá uma mensagem "Hello NAME!"

Ver registros

Os registros do Cloud Run functions são visíveis usando a CLI do Google Cloud e na interface do Cloud Logging.

Usar a ferramenta de linha de comando

Para ver os registros da função com a ferramenta gcloud CLI, use o comando logs read, seguido pelo nome da função:

gcloud functions logs read hello_http

A saída será semelhante a esta:

LEVEL  NAME        EXECUTION_ID  TIME_UTC                 LOG
D      hello_http  pdb5ys2t022n  2019-09-18 23:29:09.791  Function execution started
D      hello_http  pdb5ys2t022n  2019-09-18 23:29:09.798  Function execution took 7 ms, finished with status code: 200

Observação: normalmente há um pequeno atraso entre o momento em que as entradas de registro são criadas e quando elas são exibidas no Cloud Logging.

Usar o painel do Logging

Também é possível ver os registros do Cloud Run functions no Google Cloud console.

Saiba mais: para ver mais detalhes, leia sobre como gravar, ver e responder a registros.