Compilar y crear una tarea de Python en Cloud Run

Aprende a crear un trabajo de Cloud Run sencillo y, a continuación, a desplegarlo desde el origen, lo que empaqueta automáticamente tu código en una imagen de contenedor, sube la imagen de contenedor a Artifact Registry y, después, la despliega en Cloud Run. Puedes usar otros idiomas además de los que se muestran.

Antes de empezar

  1. 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.

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

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Make sure that you have the following role or roles on the project: Cloud Run Admin, Cloud Run Source Developer, Logs Viewer

    Check for the roles

    1. In the Google Cloud console, go to the IAM page.

      Go to IAM
    2. Select the project.

    3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

    4. For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.

    Grant the roles

    1. In the Google Cloud console, go to the IAM page.

      Ir a IAM
    2. Selecciona el proyecto.
    3. Haz clic en Conceder acceso.

    4. En el campo Nuevos principales, introduce tu identificador de usuario. Normalmente, se trata de la dirección de correo de una cuenta de Google.

    5. En la lista Selecciona un rol, elige un rol.
    6. Para conceder más roles, haz clic en Añadir otro rol y añade cada rol adicional.
    7. Haz clic en Guardar.

  5. Install the Google Cloud CLI.

  6. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  7. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

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

    Go to project selector

  9. Verify that billing is enabled for your Google Cloud project.

  10. Make sure that you have the following role or roles on the project: Cloud Run Admin, Cloud Run Source Developer, Logs Viewer

    Check for the roles

    1. In the Google Cloud console, go to the IAM page.

      Go to IAM
    2. Select the project.

    3. In the Principal column, find all rows that identify you or a group that you're included in. To learn which groups you're included in, contact your administrator.

    4. For all rows that specify or include you, check the Role column to see whether the list of roles includes the required roles.

    Grant the roles

    1. In the Google Cloud console, go to the IAM page.

      Ir a IAM
    2. Selecciona el proyecto.
    3. Haz clic en Conceder acceso.

    4. En el campo Nuevos principales, introduce tu identificador de usuario. Normalmente, se trata de la dirección de correo de una cuenta de Google.

    5. En la lista Selecciona un rol, elige un rol.
    6. Para conceder más roles, haz clic en Añadir otro rol y añade cada rol adicional.
    7. Haz clic en Guardar.

  11. Install the Google Cloud CLI.

  12. Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

  13. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

  14. Habilita las APIs Admin de Cloud Run y Cloud Build:

    gcloud services enable run.googleapis.com \
    cloudbuild.googleapis.com

    Una vez que se haya habilitado la API Cloud Run Admin, se creará automáticamente la cuenta de servicio predeterminada de Compute Engine.

  15. Asegúrate de que tienes asignado el rol Usuario de cuenta de servicio en la identidad de servicio. De forma predeterminada, la identidad de servicio es la cuenta de servicio predeterminada de Compute Engine.

    Conceder los roles

    Para conceder acceso al recurso de identidad de servicio, usa el comando gcloud iam service-accounts add-iam-policy-binding y sustituye las variables destacadas por los valores correspondientes:

          gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_EMAIL \
          --member="PRINCIPAL" \
          --role="roles/iam.serviceAccountUser"

    Haz los cambios siguientes:

    • SERVICE_ACCOUNT_EMAIL: la dirección de correo de la cuenta de servicio que usas como identidad de servicio, como:
      • Cuenta de servicio predeterminada de Compute Engine: PROJECT_NUMBER-compute@developer.gserviceaccount.com
      • Una cuenta de servicio que has creado: SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
    • PRINCIPAL: el identificador de usuario. Normalmente, se trata de la dirección de correo de una cuenta de Google.
  16. Concede a la cuenta de servicio de Cloud Build el siguiente rol de gestión de identidades y accesos.

    Haz clic para ver los roles necesarios de la cuenta de servicio de Cloud Build

    Cloud Build usa automáticamente la cuenta de servicio predeterminada de Compute Engine como cuenta de servicio predeterminada de Cloud Build para compilar tu código fuente y tu recurso de Cloud Run, a menos que anules este comportamiento. Para que Cloud Build compile tus fuentes, pide a tu administrador que conceda el rol Compilador de Cloud Run (roles/run.builder) a la cuenta de servicio predeterminada de Compute Engine de tu proyecto:

      gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
      --role=roles/run.builder

    Sustituye PROJECT_NUMBER por el número de tu proyecto Google Cloud y PROJECT_ID por el ID de tu proyecto Google Cloud. Para obtener instrucciones detalladas sobre cómo encontrar el ID y el número de tu proyecto, consulta el artículo Crear y gestionar proyectos.

    La concesión del rol de compilador de Cloud Run a la cuenta de servicio predeterminada de Compute Engine tarda un par de minutos en propagarse.

    17. Escribir la tarea de ejemplo

    Para escribir un trabajo en Python, sigue estos pasos:

    1. Crea un directorio llamado jobs y cambia al directorio:

      mkdir jobs
cd jobs

    2. Crea un archivo main.py para el código de trabajo real. Copia las siguientes líneas de ejemplo en él:

      import json
import os
import random
import sys
import time

# Retrieve Job-defined env vars
TASK_INDEX = os.getenv("CLOUD_RUN_TASK_INDEX", 0)
TASK_ATTEMPT = os.getenv("CLOUD_RUN_TASK_ATTEMPT", 0)
# Retrieve User-defined env vars
SLEEP_MS = os.getenv("SLEEP_MS", 0)
FAIL_RATE = os.getenv("FAIL_RATE", 0)


# Define main script
def main(sleep_ms=0, fail_rate=0):
    """Program that simulates work using the sleep method and random failures.

    Args:
        sleep_ms: number of milliseconds to sleep
        fail_rate: rate of simulated errors
    """
    print(f"Starting Task #{TASK_INDEX}, Attempt #{TASK_ATTEMPT}...")
    # Simulate work by waiting for a specific amount of time
    time.sleep(float(sleep_ms) / 1000)  # Convert to seconds

    # Simulate errors
    random_failure(float(fail_rate))

    print(f"Completed Task #{TASK_INDEX}.")


def random_failure(rate):
    """Throws an error based on fail rate

    Args:
        rate: a float between 0 and 1
    """
    if rate < 0 or rate > 1:
        # Return without retrying the Job Task
        print(
            f"Invalid FAIL_RATE env var value: {rate}. "
            + "Must be a float between 0 and 1 inclusive."
        )
        return

    random_failure = random.random()
    if random_failure < rate:
        raise Exception("Task failed.")


# Start script
if __name__ == "__main__":
    try:
        main(SLEEP_MS, FAIL_RATE)
    except Exception as err:
        message = (
            f"Task #{TASK_INDEX}, " + f"Attempt #{TASK_ATTEMPT} failed: {str(err)}"
        )

        print(json.dumps({"message": message, "severity": "ERROR"}))
        sys.exit(1)  # Retry Job Task by exiting the process

      Las tareas de Cloud Run permiten a los usuarios especificar el número de tareas que debe ejecutar la tarea. En este código de ejemplo se muestra cómo usar la variable de entorno CLOUD_RUN_TASK_INDEX integrada. Cada tarea representa una copia en ejecución del contenedor. Ten en cuenta que las tareas suelen ejecutarse en paralelo. Usar varias tareas es útil si cada tarea puede procesar de forma independiente un subconjunto de tus datos.

      Cada tarea conoce su índice, que se almacena en la variable de entorno CLOUD_RUN_TASK_INDEX. La variable de entorno CLOUD_RUN_TASK_COUNT integrada contiene el número de tareas proporcionadas en el momento de la ejecución del trabajo a través del parámetro --tasks.

      El código que se muestra también indica cómo reintentar tareas mediante la variable de entorno CLOUD_RUN_TASK_ATTEMPT integrada, que contiene el número de veces que se ha reintentado esta tarea. El primer intento es 0 y se incrementa en 1 en cada reintento sucesivo, hasta --max-retries.

      El código también te permite generar fallos para probar los reintentos y generar registros de errores para que puedas ver cómo son.

    3. Crea un archivo de texto llamado Procfile sin extensión que contenga lo siguiente:

      web: python3 main.py

    El código está completo y listo para empaquetarse en un contenedor.

    Crear un contenedor de tareas, enviarlo a Artifact Registry y desplegarlo en Cloud Run

    Importante: En esta guía de inicio rápido se da por hecho que tienes el rol de propietario o editor en el proyecto que vas a usar. De lo contrario, consulta los permisos necesarios para implementar un recurso de Cloud Run desde el origen.

    En esta guía de inicio rápido se usa la opción de desplegar desde el código fuente, que crea el contenedor, lo sube a Artifact Registry y despliega el trabajo en Cloud Run:

    gcloud run jobs deploy job-quickstart \
    --source . \
    --tasks 50 \
    --set-env-vars SLEEP_MS=10000 \
    --set-env-vars FAIL_RATE=0.1 \
    --max-retries 5 \
    --region REGION \
    --project=PROJECT_ID

    donde PROJECT_ID es el ID de tu proyecto y REGION es tu región (por ejemplo, europe-west1). Ten en cuenta que puedes cambiar los distintos parámetros por los valores que quieras usar para tus pruebas. SLEEP_MS simula el trabajo y FAIL_RATE provoca que falle el X% de las tareas para que puedas experimentar con el paralelismo y los reintentos de tareas fallidas.

    Ejecutar una tarea en Cloud Run

    Para ejecutar el trabajo que acabas de crear, haz lo siguiente:

    gcloud run jobs execute job-quickstart --region REGION

    Sustituye REGION por la región que usaste al crear y desplegar el trabajo (por ejemplo, europe-west1).

    Siguientes pasos

    Para obtener más información sobre cómo crear un contenedor a partir del código fuente y enviarlo a un repositorio, consulta los siguientes enlaces: