Crea e implementa una función de Cloud Run de HTTP con Python (1ª gen.)

En esta guía, se explica el proceso para escribir una función de Cloud Run con el entorno de ejecución de Python. Existen dos tipos de funciones de Cloud Run:

• Una función de HTTP, que se invoca a partir de solicitudes HTTP estándar
• Una función controlada por eventos, que se usa para manejar los eventos desde tu infraestructura de nube, como mensajes en un tema de Pub/Sub o cambios en un bucket de Cloud Storage

En el ejemplo, se muestra cómo crear una función de HTTP simple.

Más información: Para obtener más detalles, lee sobre las funciones de HTTP y las funciones controladas por eventos.

Antes de comenzar

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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. Instala e inicializa gcloud CLI.
2. Instala y actualiza los componentes de gcloud:

   gcloud components update

Nota: ¿Necesitas un símbolo del sistema? Puedes usar Google Cloud Shell. Google Cloud Shell es un entorno de línea de comandos que incluye la Google Cloud CLI, por lo que no es necesario que la instales. Google Cloud CLI también viene preinstalada en las máquinas virtuales de Google Compute Engine.
3. Prepara tu entorno de desarrollo.

   Ir a la guía de configuración de Python

Crea una función

1. Crea un directorio en tu sistema local para el código de función:

   Linux o MacOS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

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

2. Crea un archivo main.py en el directorio helloworld con el siguiente contenido:

   
   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)}!"
   
   

   Esta función de ejemplo toma un nombre proporcionado en la solicitud HTTP y muestra un saludo o "Hello World!" cuando no se proporciona ningún nombre.

   Nota: Cloud Run Functions busca funciones que se puedan implementar en main.py de forma predeterminada. Usa la marca --source cuando implementes la función a través degcloud para especificar un directorio diferente que contenga un archivo main.py.

Especifica las dependencias

Las dependencias en Python se administran con pip y se expresan en un archivo de metadatos llamado requirements.txt. Este archivo debe estar en el mismo directorio que el archivo main.py que contiene el código de tu función.

No necesitas crear un requirements.txt para ejecutar esta muestra en particular, pero supongamos que deseas agregar tus propias dependencias. Así puedes hacerlo:

1. Crea un archivo requirements.txt en el directorio helloworld.

2. Agrega la dependencia de la función a tu archivo requirements.txt, por ejemplo:

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

Más información: Para obtener más detalles, lee acerca de cómo especificar dependencias.

Implementa la función

Ejecuta el siguiente comando en el directorio helloworld para implementar la función con un activador HTTP:

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

La marca --allow-unauthenticated te permite acceder a la función sin autenticación. Para solicitar la autenticación, omite la marca.

Más información: Para obtener más detalles, lee acerca de la implementación de Cloud Run Functions.

Prueba la función

1. Cuando la función termine de implementarse, toma nota de la propiedad httpsTrigger.url o búscala con el siguiente comando:

   gcloud functions describe hello_http
   

   Se verá de la siguiente manera:

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

2. Visita esta URL en tu navegador. Deberías ver el mensaje "Hello, World!".

   Intenta pasar un nombre en la solicitud HTTP, por ejemplo, mediante la siguiente URL:

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

   Deberías ver el mensaje "Hello, NAME!"

Visualiza registros

Los registros de Cloud Run Functions pueden verse con Google Cloud CLI y en la IU de Cloud Logging.

Usa la herramienta de línea de comandos

Para visualizar los registros de tu función con gcloud CLI, usa el comando logs read seguido del nombre de la función:

gcloud functions logs read hello_http

El resultado debe parecerse al siguiente:

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

Nota: Por lo general, hay un ligero retraso entre el momento en que se crean las entradas de registro y el momento en que se muestran en Cloud Logging.

Usa el panel de Logging

También puedes ver los registros de Cloud Run Functions desde la consola deGoogle Cloud .

Más información: Para obtener más detalles, lee acerca de escribir, visualizar y responder a los registros.