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 Run Functions, 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:
- Implementa dos funciones de Cloud Run: la primera función genera un número al azar y, luego, pasa ese número a la segunda función, que lo multiplica.
- 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.
- 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. - Implementa un servicio de Cloud Run que solo permita el acceso autenticado. El servicio muestra el
math.floor
de un número determinado. - 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:
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.
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.
- 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.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
Create or select a Google Cloud project.
-
Create a Google Cloud project:
gcloud projects create PROJECT_ID
Replace
PROJECT_ID
with a name for the Google Cloud project you are creating. -
Select the Google Cloud project that you created:
gcloud config set project PROJECT_ID
Replace
PROJECT_ID
with your Google Cloud project name.
-
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Artifact Registry, Cloud Build, Cloud Run, Cloud Run functions, Cloud Storage, and Workflows APIs:
gcloud services enable artifactregistry.googleapis.com
cloudbuild.googleapis.com run.googleapis.com cloudfunctions.googleapis.com storage.googleapis.com workflows.googleapis.com - Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
Create or select a Google Cloud project.
-
Create a Google Cloud project:
gcloud projects create PROJECT_ID
Replace
PROJECT_ID
with a name for the Google Cloud project you are creating. -
Select the Google Cloud project that you created:
gcloud config set project PROJECT_ID
Replace
PROJECT_ID
with your Google Cloud project name.
-
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Artifact Registry, Cloud Build, Cloud Run, Cloud Run functions, Cloud Storage, and Workflows APIs:
gcloud services enable artifactregistry.googleapis.com
cloudbuild.googleapis.com run.googleapis.com cloudfunctions.googleapis.com storage.googleapis.com workflows.googleapis.com - Actualiza los componentes de la CLI de Google Cloud:
gcloud components update
- Si ejecutas comandos dentro de Cloud Shell, ya estás autenticado con gcloud CLI, de lo contrario, accede con tu cuenta:
gcloud auth login
- Establece la ubicación predeterminada que se usa en este instructivo:
gcloud config set project PROJECT_ID export REGION=REGION gcloud config set functions/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. -
Si eres el creador del proyecto, se te otorga el rol de propietario básico (
roles/owner
). De forma predeterminada, este rol de Identity and Access Management (IAM) incluye los permisos necesarios para obtener acceso completo a la mayoría de los recursos de Google Cloud, pero puedes omitir este paso.Si no eres el creador del proyecto, se deben otorgar los permisos necesarios en el proyecto a la principal correspondiente. Por ejemplo, una principal puede ser una Cuenta de Google (para usuarios finales) o una cuenta de servicio (para aplicaciones y cargas de trabajo de procesamiento). Para obtener más información, consulta la página Roles y permisos para el destino del evento.
Permisos necesarios
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:
-
Editor de Cloud Build (
roles/cloudbuild.builds.editor
) -
Desarrollador de Cloud Functions (
roles/cloudfunctions.developer
) -
Administrador de Cloud Run (
roles/run.admin
) -
Crea cuentas de servicio (
roles/iam.serviceAccountCreator
) -
Administrador de IAM de proyecto (
roles/resourcemanager.projectIamAdmin
) -
Usuario de cuenta de servicio (
roles/iam.serviceAccountUser
) -
Consumidor de Service Usage (
roles/serviceusage.serviceUsageConsumer
) -
Administrador de almacenamiento (
roles/storage.admin
) -
Editor de flujos de trabajo (
roles/workflows.editor
)
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.
-
Editor de Cloud Build (
- Cuando implementas tu flujo de trabajo, lo asocias con una cuenta de servicio
especificada. Crea una cuenta de servicio para que Workflows la use:
export SERVICE_ACCOUNT=workflows-sa gcloud iam service-accounts create ${SERVICE_ACCOUNT}
- Todos los servicios de Cloud Run se implementan de forma privada de forma predeterminada y solo los propietarios y los editores del proyecto, los administradores de Cloud Run y los invocadores de Cloud Run pueden llamar a ellos. Para permitir que la cuenta de servicio llame a un servicio de Cloud Run autenticado, otorga el rol
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"
Implementa las primeras funciones de Cloud Run
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.
Crea un directorio llamado
randomgen
y cámbialo como se indica a continuación:mkdir ~/randomgen cd ~/randomgen
Crea un archivo de texto con el nombre de archivo
main.py
que contenga el siguiente código de Python: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:Implementa la función con un activador de HTTP y permite el acceso no autenticado:
gcloud functions deploy randomgen-function \ --gen2 \ --runtime python310 \ --entry-point=randomgen \ --trigger-http \ --allow-unauthenticated
La función puede tardar unos minutos en implementarse. También puedes usar la interfaz de Cloud Run Functions en la consola de Google Cloud para implementar la función.
Una vez que se implementa la función
randomgen
, puedes confirmar la propiedadhttpsTrigger.url
:gcloud functions describe randomgen-function \ --gen2 \ --format="value(serviceConfig.uri)"
Guarda la URL. Deberás agregarlo a tu archivo fuente de flujo de trabajo en ejercicios posteriores.
Puedes probar la función con el siguiente comando curl:
curl $(gcloud functions describe randomgen-function \ --gen2 \ --format="value(serviceConfig.uri)")
Se genera y se muestra un número de forma aleatoria.
Implementa las segundas funciones de Cloud Run
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.
Regresa al directorio principal:
cd ~
Crea un directorio llamado
multiply
y cámbialo como se indica a continuación:mkdir ~/multiply cd ~/multiply
Crea un archivo de texto con el nombre de archivo
main.py
que contenga el siguiente código de Python: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:Implementa la función con un activador de HTTP y permite el acceso no autenticado:
gcloud functions deploy multiply-function \ --gen2 \ --runtime python310 \ --entry-point=multiply \ --trigger-http \ --allow-unauthenticated
La función puede tardar unos minutos en implementarse. También puedes usar la interfaz de Cloud Run Functions en la consola de Google Cloud para implementar la función.
Una vez que se implementa la función
multiply
, puedes confirmar la propiedadhttpsTrigger.url
:gcloud functions describe multiply-function \ --gen2\ --format="value(serviceConfig.uri)"
Guarda la URL. Deberás agregarlo a tu archivo fuente de flujo de trabajo en ejercicios posteriores.
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 las dos funciones de Cloud Run 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.
Regresa al directorio principal:
cd ~
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}
- Reemplaza
RANDOMGEN_FUNCTION_URL
por la URL de tu funciónrandomgen
. - Reemplaza
MULTIPLY_FUNCTION_URL
por la URL de tu funciónmultiply
.
Este archivo fuente vincula las dos funciones de HTTP y muestra un resultado final.
- Reemplaza
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 \ --service-account=${SERVICE_ACCOUNT}@PROJECT_ID.iam.gserviceaccount.com
Reemplaza
WORKFLOW_NAME
por un nombre para tu VPC.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.
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}
- Reemplaza
RANDOMGEN_FUNCTION_URL
por la URL de tu funciónrandomgen
. - Reemplaza
MULTIPLY_FUNCTION_URL
por la URL de tu funciónmultiply
.
Esto vincula el servicio de REST externo a las funciones de Cloud Run y muestra un resultado final.
- Reemplaza
Implementa el flujo de trabajo modificado:
gcloud workflows deploy WORKFLOW_NAME \ --source=workflow.yaml \ --service-account=${SERVICE_ACCOUNT}@PROJECT_ID.iam.gserviceaccount.com
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.
Crea un directorio llamado
floor
y cámbialo como se indica a continuación:mkdir ~/floor cd ~/floor
Crea un archivo de texto con el nombre de archivo
app.py
que contenga el siguiente código de Python:En el mismo directorio, crea un
Dockerfile
con el siguiente contenido:Crea un repositorio estándar de Artifact Registry en el que puedas almacenar la imagen de contenedor de Docker:
gcloud artifacts repositories create REPOSITORY \ --repository-format=docker \ --location=${REGION}
Reemplaza
REPOSITORY
por un nombre único para el repositorio.Compila la imagen del contenedor:
export SERVICE_NAME=floor gcloud builds submit --tag ${REGION}-docker.pkg.dev/PROJECT_ID/REPOSITORY/${SERVICE_NAME}
Implementa la imagen de contenedor en Cloud Run y asegúrate de que solo acepte llamadas autenticadas:
gcloud run deploy ${SERVICE_NAME} \ --image ${REGION}-docker.pkg.dev/PROJECT_ID/REPOSITORY/${SERVICE_NAME}:latest \ --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.
Regresa al directorio principal:
cd ~
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 - create_output_map: assign: - outputMap: randomResult: ${randomgen_result} multiplyResult: ${multiply_result} logResult: ${log_result} floorResult: ${floor_result} - return_output: return: ${outputMap}
- Reemplaza
RANDOMGEN_FUNCTION_URL
por la URL de tu funciónrandomgen
. - Reemplaza
MULTIPLY_FUNCTION_URL
por la URL de tu funciónmultiply
. - 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.- Reemplaza
Implementa el flujo de trabajo modificado:
gcloud workflows deploy WORKFLOW_NAME \ --source=workflow.yaml \ --service-account=${SERVICE_ACCOUNT}@PROJECT_ID.iam.gserviceaccount.com
Ejecuta el flujo de trabajo final:
gcloud workflows run WORKFLOW_NAME
El resultado debe parecerse al siguiente:
result: '{"floorResult":{"body":"4","code":200 ... "logResult":{"body":"4.02535169073515","code":200 ... "multiplyResult":{"body":{"multiplied":56},"code":200 ... "randomResult":{"body":{"random":28},"code":200 ... startTime: '2023-11-13T21:22:56.782669001Z' 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 referencia de sintaxis de flujos de trabajo y la descripción general de la biblioteca estándar.
Realiza una limpieza
Si creaste un proyecto nuevo para este instructivo, bórralo. Si usaste un proyecto existente y quieres 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:
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Elimina recursos de instructivos
Borra el servicio de Cloud Run que implementaste en este instructivo.
Borra el flujo de trabajo que creaste en este instructivo.
Borra la imagen del contenedor de Artifact Registry.
Quita las opciones de configuración predeterminadas de Google Cloud CLI que agregaste durante la configuración del instructivo.
gcloud config unset functions/region gcloud config unset run/region gcloud config unset workflows/location gcloud config unset project