Instructivo para usar flujos de trabajo con Cloud Run y Cloud Functions


En este instructivo, se muestra cómo usar Workflows para vincular una serie de servicios. Si conectas dos servicios de HTTP públicos (con Cloud Functions [2ª gen]), una API de REST externa y un servicio privado de Cloud Run, puedes crear una aplicación flexible y sin servidores.

Objetivos

En este instructivo, usarás la Google Cloud CLI para crear un solo flujo de trabajo y conectar un servicio a la vez:

  1. Implementa dos servicios de Cloud Functions: la primera función genera un número al azar y, luego, pasa ese número a la segunda función, que lo multiplica.
  2. Con Workflows, conecta las dos funciones de HTTP. Ejecuta el flujo de trabajo para que se muestre un resultado que luego se pasa a una API externa.
  3. Con Workflows, conecta una API HTTP externa que muestre el log de un número determinado. Ejecuta el flujo de trabajo para que se muestre un resultado que luego se pasa a un servicio de Cloud Run.
  4. Implementa un servicio de Cloud Run que solo permita el acceso autenticado. El servicio muestra el math.floor de un número determinado.
  5. Con Workflows, conecta el servicio de Cloud Run, ejecuta todo el flujo de trabajo y obtén un resultado final.

En el siguiente diagrama, se muestra una descripción general del proceso y una visualización del flujo de trabajo final:

Visualización de los flujos de trabajo

Costos

En este documento, usarás los siguientes componentes facturables de Google Cloud:

Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios. Es posible que los usuarios nuevos de Google Cloud califiquen para obtener una prueba gratuita.

Antes de comenzar

Es posible que las restricciones de seguridad que define tu organización no te permitan completar los siguientes pasos. Para obtener información sobre la solución de problemas, consulta Desarrolla aplicaciones en un entorno de Google Cloud restringido.

  1. Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.
  2. Instala Google Cloud CLI.
  3. Para inicializar la CLI de gcloud, ejecuta el siguiente comando:

    gcloud init
  4. Crea o selecciona un proyecto de Google Cloud.

    • Crea un proyecto de Google Cloud:

      gcloud projects create PROJECT_ID

      Reemplaza PROJECT_ID por un nombre para el proyecto de Google Cloud que estás creando.

    • Selecciona el proyecto de Google Cloud que creaste:

      gcloud config set project PROJECT_ID

      Reemplaza PROJECT_ID por el nombre del proyecto de Google Cloud.

  5. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

  6. Habilita las APIs de Cloud Build, Cloud Functions, Cloud Run, Cloud Storage, Container Registry, and Workflows :

    gcloud services enable cloudbuild.googleapis.com cloudfunctions.googleapis.com run.googleapis.com storage.googleapis.com containerregistry.googleapis.com workflows.googleapis.com
  7. Instala Google Cloud CLI.
  8. Para inicializar la CLI de gcloud, ejecuta el siguiente comando:

    gcloud init
  9. Crea o selecciona un proyecto de Google Cloud.

    • Crea un proyecto de Google Cloud:

      gcloud projects create PROJECT_ID

      Reemplaza PROJECT_ID por un nombre para el proyecto de Google Cloud que estás creando.

    • Selecciona el proyecto de Google Cloud que creaste:

      gcloud config set project PROJECT_ID

      Reemplaza PROJECT_ID por el nombre del proyecto de Google Cloud.

  10. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

  11. Habilita las APIs de Cloud Build, Cloud Functions, Cloud Run, Cloud Storage, Container Registry, and Workflows :

    gcloud services enable cloudbuild.googleapis.com cloudfunctions.googleapis.com run.googleapis.com storage.googleapis.com containerregistry.googleapis.com workflows.googleapis.com
  12. Actualiza los componentes de la CLI de Google Cloud:
    gcloud components update
  13. Si ejecutas comandos dentro de Cloud Shell, ya estás autenticado con la CLI de gcloud, de lo contrario, accede con tu cuenta:
    gcloud auth login
  14. Reemplaza PROJECT_ID por el ID del proyecto de Google Cloud.

  15. Establece la ubicación predeterminada que se usa en este instructivo:
    gcloud config set project PROJECT_ID
    export REGION=REGION
    gcloud config set run/region ${REGION}
    gcloud config set workflows/location ${REGION}
    

    Reemplaza REGION por la ubicación de Workflows compatible que prefieras.

Funciones obligatorias

Si quieres obtener los permisos que necesitas para completar el instructivo, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

Si quieres obtener más información para otorgar roles, consulta Administra el acceso.

Es posible que también puedas obtener los permisos necesarios mediante funciones personalizadas, o bien otras funciones predefinidas.

Ten en cuenta que, si creas un proyecto, se te otorga la función roles/owner. De forma predeterminada, esta función incluye permisos que te otorgan un control total como creador del proyecto.

Implementa el primer servicio de Cloud Functions

Después de recibir una solicitud HTTP, esta función de HTTP genera un número aleatorio entre 1 y 100 y, luego, lo muestra en formato JSON.

  1. Crea un directorio llamado randomgen y cámbialo como se indica a continuación:

    mkdir ~/randomgen
    cd ~/randomgen
    
  2. Crea un archivo de texto con el nombre de archivo main.py que contenga el siguiente código de Python:

    import functions_framework
    import random
    from flask import jsonify
    
    @functions_framework.http
    def randomgen(request):
        randomNum = random.randint(1, 100)
        output = {"random": randomNum}
        return jsonify(output)
  3. A fin de admitir una dependencia en Flask para el procesamiento de HTTP, crea un archivo de texto destinado al administrador de paquetes pip. Asígnale el nombre requirements.txt y agrega lo siguiente:

    flask>=1.0.2
    
  4. Crea una cuenta de servicio para que Workflows la use:

    export SERVICE_ACCOUNT=workflows-sa
    gcloud iam service-accounts create ${SERVICE_ACCOUNT}
    
  5. Para permitir que la cuenta de servicio llame a los servicios autenticados de Cloud Run, otorga la función run.invoker a la cuenta de servicio de Workflows:

    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member "serviceAccount:${SERVICE_ACCOUNT}@PROJECT_ID.iam.gserviceaccount.com" \
      --role "roles/run.invoker"
    
  6. Implementa la función con un activador de HTTP y permite el acceso no autenticado:

    gcloud functions deploy randomgen-function \
    --gen2 \
    --runtime python310 \
    --region=us-central1 \
    --entry-point=randomgen \
    --trigger-http \
    --allow-unauthenticated
    

    La función puede tardar unos minutos en implementarse. También puedes usar la interfaz de Cloud Functions en la consola de Google Cloud para implementar la función.

  7. Una vez que se implementa la función randomgen, puedes confirmar la propiedad httpsTrigger.url:

    gcloud functions describe randomgen-function --gen2 --region=us-central1 --format="value(serviceConfig.uri)"
    
  8. Guarda la URL. Deberás agregarlo al archivo de origen del flujo de trabajo en ejercicios posteriores.

  9. Puedes probar la función con el siguiente comando curl:

    curl $(gcloud functions describe randomgen-function --gen2 --region=us-central1 --format="value(serviceConfig.uri)")
    

    Se genera y se muestra un número de forma aleatoria.

Implementa el segundo servicio de Cloud Functions

Después de recibir una solicitud HTTP, esta función de HTTP extrae el input del cuerpo JSON, lo multiplica por 2 y muestra el resultado en formato JSON.

  1. Regresa al directorio principal:

    cd ~
    
  2. Crea un directorio llamado multiply y cámbialo como se indica a continuación:

    mkdir ~/multiply
    cd ~/multiply
    
  3. Crea un archivo de texto con el nombre de archivo main.py que contenga el siguiente código de Python:

    import functions_framework
    from flask import jsonify
    
    @functions_framework.http
    def multiply(request):
        request_json = request.get_json()
        output = {"multiplied": 2 * request_json['input']}
        return jsonify(output)
  4. A fin de admitir una dependencia en Flask para el procesamiento de HTTP, crea un archivo de texto destinado al administrador de paquetes pip. Asígnale el nombre requirements.txt y agrega lo siguiente:

    flask>=1.0.2
    
  5. Implementa la función con un activador de HTTP y permite el acceso no autenticado:

    gcloud functions deploy multiply-function \
    --gen2 \
    --runtime python310 \
    --region=us-central1 \
    --entry-point=multiply \
    --trigger-http \
    --allow-unauthenticated
    

    La función puede tardar unos minutos en implementarse. Como alternativa, puedes usar la interfaz de Cloud Functions en la consola de Google Cloud para implementarla.

  6. Una vez que se implementa la función multiply, puedes confirmar la propiedad httpsTrigger.url:

    gcloud functions describe multiply-function --gen2 --region=us-central1 --format="value(serviceConfig.uri)"
    
  7. Guarda la URL. Deberás agregarlo al archivo de origen del flujo de trabajo en ejercicios posteriores.

  8. Puedes probar la función con el siguiente comando curl:

    curl -X POST MULTIPLY_FUNCTION_URL \
      -H "Authorization: Bearer $(gcloud auth print-identity-token)" \
      -H "Content-Type: application/json" \
      -d '{"input": 5}'
    

    Se debería mostrar el número 10.

Conecta los dos servicios de Cloud Functions en un flujo de trabajo

Un flujo de trabajo está compuesto por una serie de pasos descritos con la sintaxis de Workflows, que se pueden escribir en formato YAML o JSON. Esta es la definición del flujo de trabajo. Para obtener una explicación detallada, consulta la página Referencia de sintaxis.

  1. Regresa al directorio principal:

    cd ~
    
  2. Crea un archivo de texto con el nombre de archivo workflow.yaml que incluya el siguiente contenido:

    - randomgen_function:
        call: http.get
        args:
            url: RANDOMGEN_FUNCTION_URL
        result: randomgen_result
    - multiply_function:
        call: http.post
        args:
            url: MULTIPLY_FUNCTION_URL
            body:
                input: ${randomgen_result.body.random}
        result: multiply_result
    - return_result:
        return: ${multiply_result}
    

    Este archivo fuente vincula las dos funciones de HTTP y muestra un resultado final.

  3. Después de crear el flujo de trabajo, puedes implementarlo, con lo que estará listo para ejecutarse.

    gcloud workflows deploy WORKFLOW_NAME --source=workflow.yaml
    

    Reemplaza WORKFLOW_NAME por un nombre para tu VPC.

  4. Ejecuta el flujo de trabajo:

    gcloud workflows run WORKFLOW_NAME
    

    Una ejecución es una ejecución única de la lógica que se incluye en la definición de un flujo de trabajo. Todas las ejecuciones de flujos de trabajo son independientes, y el escalamiento rápido Workflows permite una gran cantidad de ejecuciones simultáneas.

    Una vez que se ejecuta el flujo de trabajo, el resultado debería ser similar al siguiente:

    result: '{"body":{"multiplied":120},"code":200,"headers":{"Alt-Svc":"h3-29=\":443\";
    ...
    startTime: '2021-05-05T14:17:39.135251700Z'
    state: SUCCEEDED
    

Conecta un servicio público de REST en el flujo de trabajo

Actualiza tu flujo de trabajo existente y conecta una API de REST pública (math.js) que pueda evaluar las expresiones matemáticas. Por ejemplo, curl https://api.mathjs.org/v4/?'expr=log(56)'

Ten en cuenta que, como implementaste tu flujo de trabajo, también puedes editarlo en la página Flujos de trabajo en la consola de Google Cloud.

  1. Edita el archivo fuente de tu flujo de trabajo y reemplázalo por el siguiente contenido:

    - randomgen_function:
        call: http.get
        args:
            url: RANDOMGEN_FUNCTION_URL
        result: randomgen_result
    - multiply_function:
        call: http.post
        args:
            url: MULTIPLY_FUNCTION_URL
            body:
                input: ${randomgen_result.body.random}
        result: multiply_result
    - log_function:
        call: http.get
        args:
            url: https://api.mathjs.org/v4/
            query:
                expr: ${"log(" + string(multiply_result.body.multiplied) + ")"}
        result: log_result
    - return_result:
        return: ${log_result}
    

    Esto vincula el servicio de REST externo a los servicios de Cloud Functions y muestra un resultado final.

  2. Implementa el flujo de trabajo modificado:

    gcloud workflows deploy WORKFLOW_NAME --source=workflow.yaml
    

Implementa un servicio de Cloud Run

Implementa un servicio de Cloud Run que, luego de recibir una solicitud HTTP, extrae input del cuerpo JSON, calcula su math.floor y muestra el resultado.

  1. Crea un directorio llamado floor y cámbialo como se indica a continuación:

    mkdir ~/floor
    cd ~/floor
    
  2. Crea un archivo de texto con el nombre de archivo app.py que contenga el siguiente código de Python:

    import json
    import logging
    import os
    import math
    
    from flask import Flask, request
    
    app = Flask(__name__)
    
    @app.route('/', methods=['POST'])
    def handle_post():
        content = json.loads(request.data)
        input = float(content['input'])
        return f"{math.floor(input)}", 200
    
    if __name__ != '__main__':
        # Redirect Flask logs to Gunicorn logs
        gunicorn_logger = logging.getLogger('gunicorn.error')
        app.logger.handlers = gunicorn_logger.handlers
        app.logger.setLevel(gunicorn_logger.level)
        app.logger.info('Service started...')
    else:
        app.run(debug=True, host='0.0.0.0', port=int(os.environ.get('PORT', 8080)))

  3. En el mismo directorio, crea un Dockerfile con el siguiente contenido:

    # Use an official lightweight Python image.
    # https://hub.docker.com/_/python
    FROM python:3.7-slim
    
    # Install production dependencies.
    RUN pip install Flask gunicorn
    
    # Copy local code to the container image.
    WORKDIR /app
    COPY . .
    
    # Run the web service on container startup. Here we use the gunicorn
    # webserver, with one worker process and 8 threads.
    # For environments with multiple CPU cores, increase the number of workers
    # to be equal to the cores available.
    CMD exec gunicorn --bind 0.0.0.0:8080 --workers 1 --threads 8 app:app

  4. Compila la imagen del contenedor:

    export SERVICE_NAME=floor
    gcloud builds submit --tag gcr.io/PROJECT_ID/${SERVICE_NAME}
    
  5. Implementa la imagen de contenedor en Cloud Run y asegúrate de que solo acepte llamadas autenticadas:

    gcloud run deploy ${SERVICE_NAME} \
    --image gcr.io/PROJECT_ID/${SERVICE_NAME} \
    --platform managed \
    --no-allow-unauthenticated
    

Cuando veas la URL del servicio, se completará la implementación. Deberás especificar esa URL cuando actualices la definición del flujo de trabajo.

Conecta el servicio de Cloud Run en el flujo de trabajo

Actualiza tu flujo de trabajo existente y especifica la URL para el servicio de Cloud Run.

  1. Edita el archivo fuente de tu flujo de trabajo y reemplázalo por el siguiente contenido:

    - randomgen_function:
        call: http.get
        args:
            url: RANDOMGEN_FUNCTION_URL
        result: randomgen_result
    - multiply_function:
        call: http.post
        args:
            url: MULTIPLY_FUNCTION_URL
            body:
                input: ${randomgen_result.body.random}
        result: multiply_result
    - log_function:
        call: http.get
        args:
            url: https://api.mathjs.org/v4/
            query:
                expr: ${"log(" + string(multiply_result.body.multiplied) + ")"}
        result: log_result
    - floor_function:
        call: http.post
        args:
            url: CLOUD_RUN_SERVICE_URL
            auth:
                type: OIDC
            body:
                input: ${log_result.body}
        result: floor_result
    - return_result:
        return: ${floor_result}
    
    • Reemplaza RANDOMGEN_FUNCTION_URL por la URL de tu función randomgen.
    • Reemplaza MULTIPLY_FUNCTION_URL por la URL de tu función multiply.
    • Reemplaza CLOUD_RUN_SERVICE_URL por la URL de servicio de Cloud Run.

    Esto conecta el servicio de Cloud Run en el flujo de trabajo. Ten en cuenta que la clave auth garantiza que se transmita un token de autenticación en la llamada al servicio de Cloud Run. Para obtener más información, consulta Realiza solicitudes autenticadas desde un flujo de trabajo.

  2. Implementa el flujo de trabajo modificado:

    gcloud workflows deploy WORKFLOW_NAME --source=workflow.yaml
    
  3. Ejecuta el flujo de trabajo final:

    gcloud workflows run WORKFLOW_NAME
    

    El resultado debe parecerse al siguiente:

    result: '{"body":{"multiplied":192},"code":200,"headers":{"Alt-Svc":"h3-29=\":443\";
    ...
    startTime: '2021-05-05T14:36:48.762896438Z'
    state: SUCCEEDED
    

¡Felicitaciones! Implementaste y ejecutaste un flujo de trabajo que conecta una serie de servicios.

Para crear flujos de trabajo más complejos con expresiones, saltos condicionales, codificación y decodificación de Base64, subflujos de trabajo y más, consulta la página sobre la sintaxis de flujos de trabajo y la descripción general de la biblioteca estándar.

Limpia

Si creaste un proyecto nuevo para este instructivo, bórralo. Si usaste un proyecto existente y deseas conservarlo sin los cambios que se agregaron en este instructivo, borra los recursos creados para el instructivo.

Borra el proyecto

La manera más fácil de eliminar la facturación es borrar el proyecto que creaste para el instructivo.

Para borrar el proyecto, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página Administrar recursos.

    Ir a Administrar recursos

  2. En la lista de proyectos, elige el proyecto que quieres borrar y haz clic en Borrar.
  3. En el diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.

Elimina recursos de instructivos

  1. Usa este comando para borrar el servicio de Cloud Run que implementaste en este instructivo:

    gcloud run services delete SERVICE_NAME

    En el ejemplo anterior, SERVICE_NAME es el nombre del servicio que elegiste.

    También puedes borrar los servicios de Cloud Run desde la consola de Google Cloud.

  2. Quita las opciones de configuración predeterminadas de gcloud que agregaste durante la configuración del instructivo.

     gcloud config unset run/region
     gcloud config unset workflows/location
     gcloud config unset project
    

  3. Borra el flujo de trabajo que se creó en este instructivo:

    gcloud workflows delete WORKFLOW_NAME
    
  4. Borra la imagen del contenedor llamada gcr.io/PROJECT_ID/SERVICE_NAME de Container Registry.

¿Qué sigue?