Crear y desplegar una función HTTP de Cloud Run 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. Hay dos tipos de funciones de Cloud Run:

• Una función HTTP, que se invoca desde solicitudes HTTP estándar.
• Una función basada en eventos que se usa para gestionar eventos de tu infraestructura de Cloud, como mensajes de un tema de Pub/Sub o cambios en un segmento de Cloud Storage.

En el ejemplo se muestra cómo crear una función HTTP sencilla.

Más información: para obtener más detalles, consulta las funciones HTTP y las funciones basadas en eventos.

Antes de empezar

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 (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 (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. Actualiza e instala 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 ya incluye la CLI de Google Cloud, por lo que no necesitas instalarla. La CLI de Google Cloud también está 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

Crear una función

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

   Linux o Mac OS 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 devuelve un saludo o "Hello World!" si no se proporciona ningún nombre.

   Nota: Cloud Run Functions busca funciones desplegables en main.py de forma predeterminada. Usa la marca --source cuando despliegues tu función a través de gcloud para especificar otro directorio que contenga un archivo main.py
   .

Especificar dependencias

Las dependencias de Python se gestionan 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 es necesario que crees un requirements.txt para ejecutar este ejemplo en concreto, pero supongamos que quieres añadir tus propias dependencias. Para ello, sigue estos pasos:

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

2. Añade 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, consulte cómo especificar dependencias.

Desplegar la función

Para desplegar la función con un activador HTTP, ejecuta el siguiente comando en el directorio helloworld:

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

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

Más información: para obtener más detalles, consulta cómo desplegar funciones de Cloud Run.

Probar función

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

   gcloud functions describe hello_http
   

   Debería tener este aspecto:

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

2. Visita esta URL en tu navegador. Debería aparecer el mensaje "Hello World!".

   Prueba a enviar un nombre en la solicitud HTTP. Por ejemplo, puedes usar la siguiente URL:

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

   Debería aparecer el mensaje "Hola NAME".

Ver registros

Los registros de las funciones de Cloud Run se pueden ver con la CLI de Google Cloud y en la interfaz de usuario de Cloud Logging.

Usar la herramienta de línea de comandos

Para ver 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

La salida debería ser similar a la 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: Normalmente, hay un pequeño retraso entre el momento en que se crean las entradas de registro y el momento en que aparecen en Cloud Logging.

Usar el panel de control de Logging

También puedes ver los registros de las funciones de Cloud Run desde la Google Cloud consola.

Más información: para obtener más detalles, consulta cómo escribir, ver y responder registros.