Cuando se ejecuta un flujo de trabajo, se ejecuta la definición del flujo de trabajo actual asociada con el en el flujo de trabajo.
Puedes pasar argumentos del entorno de ejecución en una solicitud de ejecución de flujo de trabajo y acceder a esos argumentos con una variable de flujo de trabajo. Para obtener más información, consulta Cómo pasar argumentos del entorno de ejecución en una solicitud de ejecución.
Después de que se completa la ejecución de un flujo de trabajo, su historial y sus resultados se conservan durante por un tiempo limitado. Para obtener más información, consulta Cuotas y límites.
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.
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.
- Si un flujo de trabajo accede a otros recursos de Google Cloud, asegúrate de que
asociada con una cuenta de servicio que tenga los permisos correctos para hacerlo.
Para saber qué cuenta de servicio está asociada con un flujo de trabajo existente, consulta
Verifica un
la cuenta de servicio asociada del flujo de trabajo.
Ten en cuenta que, para crear un recurso y conectar una cuenta de servicio, necesitas permisos para crear ese recurso y usar la identidad de la cuenta de servicio que que adjuntarás al recurso. Para obtener más información, consulta Permisos de la cuenta de servicio.
- Implementa un flujo de trabajo con Consola de Google Cloud o Google Cloud CLI.
Ejecuta un flujo de trabajo
Puedes ejecutar un flujo de trabajo con bibliotecas cliente. En la consola de Google Cloud, con gcloud CLI o enviando una solicitud a la API de REST de Workflows.
Console
Para ejecutar un flujo de trabajo, en la consola de Google Cloud, ve a la página Workflows:
En la página Flujos de trabajo, selecciona un flujo de trabajo para ir a su en la página de detalles.
En la página Detalles del flujo de trabajo, haz clic en play_arrow Ejecución.
En la página Ejecutar flujo de trabajo, en el panel Entrada, puedes ingresar argumentos de entorno de ejecución opcionales para pasar al flujo de trabajo antes de la ejecución. Los argumentos deben estar en JSON formato; por ejemplo,
{"animal":"cat"}
. Si tu flujo de trabajo no usa argumentos de tiempo de ejecución, déjalo en blanco.Si lo deseas, puedes especificar el nivel de registro de llamadas que quieras para aplicar a la ejecución del flujo de trabajo. En el Nivel de registro de llamadas, haz lo siguiente: selecciona una de las siguientes opciones:
- No especificado: No se especifica ningún nivel de registro. Esta es la opción predeterminada. Un nivel de registro de ejecución tiene prioridad sobre cualquier nivel de registro de flujo de trabajo, a menos que no se especifique el nivel de registro de ejecución (predeterminado). En ese caso, se aplica el nivel de registro del flujo de trabajo.
- Solo errores: Registra todas las excepciones detectadas, o cuando se detiene una llamada debido a una excepción.
- Todas las llamadas: Registra todas las llamadas a subflujos de trabajo o funciones de biblioteca y sus resultados.
- Sin registros: Sin registro de llamadas.
Haz clic en Ejecutar.
En la página Detalles de la ejecución, puedes ver los resultados de la ejecución, incluidos los resultados, el ID y el estado de la ejecución, y el paso actual o final de la ejecución del flujo de trabajo. Para obtener más información, ver Accede a los resultados de la ejecución del flujo de trabajo.
gcloud
Abre una terminal.
Busca el nombre del flujo de trabajo que deseas ejecutar. Si no conoces el del flujo de trabajo, puedes ingresar el siguiente comando para enumerar todos flujos de trabajo:
gcloud workflows list
Puedes ejecutar el flujo de trabajo con el comando
gcloud workflows run
o el comandogcloud workflows execute
:Ejecuta el flujo de trabajo y espera a que se complete la ejecución:
gcloud workflows run WORKFLOW_NAME \ --call-log-level=CALL_LOGGING_LEVEL \ --data=DATA
Ejecutar el flujo de trabajo sin esperar a que se intente ejecutar finalizar:
gcloud workflows execute WORKFLOW_NAME \ --call-log-level=CALL_LOGGING_LEVEL \ --data=DATA
Reemplaza lo siguiente:
WORKFLOW_NAME
: Es el nombre del flujo de trabajo.CALL_LOGGING_LEVEL
(opcional): Es el nivel de registro de llamadas que se aplicará durante la ejecución. Puede ser una de las siguientes opciones:none
: No se especifica ningún nivel de registro. Esta es la opción predeterminada. Un nivel de registro de ejecución tiene prioridad sobre cualquier nivel de registro de flujo de trabajo, a menos que no se especifique el nivel de registro de ejecución (predeterminado). En ese caso, se aplica el nivel de registro del flujo de trabajo.log-errors-only
: Registra todas las excepciones detectadas; o cuando se detiene una llamada debido a una excepción.log-all-calls
: Registra todas las llamadas a subflujos de trabajo o funciones de biblioteca y sus resultados.log-none
: Sin registro de llamadas.
DATA
(opcional): Argumentos de tiempo de ejecución para tu de Terraform en formato JSON.
Si ejecutaste
gcloud workflows execute
, el ID único del flujo de trabajo de ejecución, y el resultado es similar al siguiente:To view the workflow status, you can use following command: gcloud workflows executions describe b113b589-8eff-4968-b830-8d35696f0b33 --workflow workflow-2 --location us-central1
Para ver el estado de la ejecución, ingresa el comando que devuelve el paso anterior.
Si el intento de ejecución se realiza correctamente, el resultado será similar al siguiente:
a continuación, con un state
que indica el éxito del flujo de trabajo y un status
que especifique el paso final del flujo de trabajo de la ejecución.
argument: '{"searchTerm":"Friday"}' endTime: '2022-06-22T12:17:53.086073678Z' name: projects/1051295516635/locations/us-central1/workflows/myFirstWorkflow/executions/c4dffd1f-13db-46a0-8a4a-ee39c144cb96 result: '["Friday","Friday the 13th (franchise)","Friday Night Lights (TV series)","Friday the 13th (1980 film)","Friday the 13th","Friday the 13th (2009 film)","Friday the 13th Part III","Friday the 13th Part 2","Friday (Rebecca Black song)","Friday Night Lights (film)"]' startTime: '2022-06-22T12:17:52.799387653Z' state: SUCCEEDED status: currentSteps: - routine: main step: returnOutput workflowRevisionId: 000001-ac2
Bibliotecas cliente
En los siguientes ejemplos, se supone que ya implementaste un flujo de trabajo.
myFirstWorkflow
Instala la biblioteca cliente y configura tu entorno de desarrollo. Para detalles, consulta la Descripción general de las bibliotecas cliente de Workflows.
Clona el repositorio de la aplicación de muestra en tu máquina local:
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
De manera opcional, puedes descargar la muestra como un archivo zip y extraerla.
Cambia al directorio que contiene la muestra de Workflows código:
Java
cd java-docs-samples/workflows/cloud-client/
Node.js
cd nodejs-docs-samples/workflows/quickstart/
Python
cd python-docs-samples/workflows/cloud-client/
Ve el código de muestra:
Java
Node.js (JavaScript)
Node.js (TypeScript)
Python
En el ejemplo, se hace lo siguiente:
- Configura las bibliotecas cliente de Cloud para Workflows.
- Ejecuta un flujo de trabajo.
- Sondea la ejecución del flujo de trabajo (usando la retirada exponencial) hasta la la ejecución.
- Imprime los resultados de la ejecución.
Para ejecutar la muestra, primero instala las dependencias:
Java
mvn compile
Node.js (JavaScript)
npm install
Node.js (TypeScript)
npm install && npm run build
Python
pip3 install -r requirements.txt
Ejecuta la secuencia de comandos:
Java
GOOGLE_CLOUD_PROJECT=PROJECT_ID LOCATION=CLOUD_REGION WORKFLOW=WORKFLOW_NAME mvn compile exec:java -Dexec.mainClass=com.example.workflows.WorkflowsQuickstart
Node.js (JavaScript)
npm start PROJECT_ID CLOUD_REGION WORKFLOW_NAME
Node.js (TypeScript)
npm start PROJECT_ID CLOUD_REGION WORKFLOW_NAME
Python
GOOGLE_CLOUD_PROJECT=PROJECT_ID LOCATION=CLOUD_REGION WORKFLOW=WORKFLOW_NAME python3 main.py
Reemplaza lo siguiente:
PROJECT_ID
(obligatorio): Es el ID del proyecto de la Proyecto de Google CloudCLOUD_REGION
: Es la ubicación del flujo de trabajo (predeterminada:us-central1
).WORKFLOW_NAME
: Es el ID del flujo de trabajo. (valor predeterminado:myFirstWorkflow
)
El resultado es similar a este:
Execution finished with state: SUCCEEDED ["Sunday","Sunday in the Park with George","Sunday shopping","Sunday Bloody Sunday","Sunday Times Golden Globe Race","Sunday All Stars","Sunday Night (South Korean TV series)","Sunday Silence","Sunday Without God","Sunday Independent (Ireland)"]
API de REST
Para crear una ejecución nueva con la revisión más reciente de un flujo de trabajo determinado, usa
el
projects.locations.workflows.executions.create
.
Ten en cuenta que, para realizar la autenticación, necesitarás una cuenta de servicio con suficientes
privilegios para ejecutar el flujo de trabajo. Por ejemplo, puedes otorgarle a un servicio
cuenta el rol de Invocador de flujos de trabajo
(roles/workflows.invoker
) para que la cuenta tenga permiso para
activar la ejecución del flujo de trabajo. Para obtener más información, consulta
Invoca flujos de trabajo.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
PROJECT_NUMBER
: tu Google Cloud número de proyecto que figura en la lista de las cuentas de IAM y Administrador Configuración.LOCATION
: Es la región en la que se implementa el flujo de trabajo, por ejemplo,us-central1
.WORKFLOW_NAME
: Es el nombre definido por el usuario. para el flujo de trabajo, por ejemplo,myFirstWorkflow
.PARAMETER
: es opcional. Si el flujo de trabajo que ejecutas pueden recibir argumentos de tiempo de ejecución que pasas como parte de una solicitud de ejecución puedes agregar al cuerpo de la solicitud una cadena con formato JSON cuyo valor sea uno o más caracteres pares parámetro-valor, por ejemplo,"{\"searchTerm\":\"asia\"}"
.VALUE
: es opcional. El valor de un par parámetro-valor que tu flujo de trabajo puede recibir como un argumento de entorno de ejecución.CALL_LOGGING_LEVEL
: es opcional. El nivel de registro de llamadas que se aplicará durante la ejecución. El valor predeterminado es que ningún nivel de registro se especifica y, en su lugar, se aplica el nivel de registro del flujo de trabajo. Para obtener más información, consulta Envía registros a Logging. Uno de los lo siguiente:CALL_LOG_LEVEL_UNSPECIFIED
: No se especifica ningún nivel de registro. se aplica el nivel de registro del flujo de trabajo. Esta es la opción predeterminada. De lo contrario, se aplica el nivel de registro de ejecución y tiene prioridad sobre el nivel de registro de flujo de trabajo.LOG_ERRORS_ONLY
: registra todas las excepciones capturadas. o cuando una llamada sea se detuvo debido a una excepción.LOG_ALL_CALLS
: Registra todas las llamadas a subflujos de trabajo o funciones de biblioteca y sus resultados.LOG_NONE
: Sin registro de llamadas.
BACKLOG_EXECUTION
: opcional. Si se configura comotrue
, la ejecución no se acumula cuando la simultaneidad se agote la cuota. Para obtener más información, consulta Administra el backlogging de ejecución.
Cuerpo JSON de la solicitud:
{ "argument": "{\"PARAMETER\":\"VALUE\"}", "callLogLevel": "CALL_LOGGING_LEVEL", "disableConcurrencyQuotaOverflowBuffering": "BACKLOG_EXECUTION" }
Para enviar tu solicitud, expande una de estas opciones:
Si se ejecuta correctamente, el cuerpo de la respuesta contiene una instancia de Execution
recién creada:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/workflows/WORKFLOW_NAME/executions/EXECUTION_ID", "startTime": "2023-11-07T14:35:27.215337069Z", "state": "ACTIVE", "argument": "{\"PARAMETER\":\"VALUE\"}", "workflowRevisionId": "000001-2df", "callLogLevel": "CALL_LOGGING_LEVEL", "status": {} }
Verifica el estado de las ejecuciones
Hay varios comandos para ayudarte a verificar el estado de un flujo de trabajo ejecución.
Para recuperar una lista de los intentos de ejecución de un flujo de trabajo y sus IDs, ingresa el siguiente comando:
gcloud workflows executions list WORKFLOW_NAME
Reemplaza
WORKFLOW_NAME
por el nombre del flujo de trabajo.El comando muestra un valor
NAME
similar al siguiente:projects/PROJECT_NUMBER/locations/REGION/workflows/WORKFLOW_NAME/executions/EXECUTION_ID
Copia el ID de ejecución para usarlo en el siguiente comando.
Para verificar el estado de un intento de ejecución y esperar a que el intento finaliza, ingresa el siguiente comando:
gcloud workflows executions wait EXECUTION_ID
Reemplaza
EXECUTION_ID
por el ID del intento de ejecución.El comando espera a que finalice el intento de ejecución y, luego, muestra el resultados.
Esperar hasta que se complete la última ejecución y, luego, mostrar el resultado del se completó la ejecución, ingresa el siguiente comando:
gcloud workflows executions wait-last
Si realizaste un intento de ejecución anterior en la misma sesión de
gcloud
, el comando espera a que finalice el intento de ejecución anterior y, luego, muestra los resultados de la ejecución completada. Si no existe un intento anterior,gcloud
muestra el siguiente error:ERROR: (gcloud.workflows.executions.wait-last) [NOT FOUND] There are no cached executions available.
Para obtener el estado de la última ejecución, ingresa el siguiente comando:
gcloud workflows executions describe-last
Si realizaste un intento de ejecución anterior en la misma sesión de
gcloud
, el muestra los resultados de la última ejecución, incluso si está en ejecución. Si la respuesta es no existe un intento anterior,gcloud
muestra el siguiente error:ERROR: (gcloud.beta.workflows.executions.describe-last) [NOT FOUND] There are no cached executions available.
Filtrar ejecuciones
Puedes aplicar filtros a la lista de ejecuciones de flujos de trabajo que devuelve el
Método workflows.executions.list
.
Puedes filtrar según los siguientes campos:
createTime
disableOverflowBuffering
duration
endTime
executionId
label
startTime
state
stepName
workflowRevisionId
Por ejemplo, para filtrar en una etiqueta (labels."fruit":"apple"
), puedes realizar una solicitud a la API similar a la siguiente:
GET https://workflowexecutions.googleapis.com/v1/projects/MY_PROJECT/locations/MY_LOCATION/workflows/MY_WORKFLOW/executions?view=full&filter=labels.%22fruit%22%3A%22apple%22"
Aquí:
view=full
especifica una vista que define qué campos se deben completar en la ejecuciones devueltas; En este caso, todos los datoslabels.%22fruit%22%3A%22apple%22
es la sintaxis de filtro codificada para URL.
Para obtener más información, consulta Filtrado de AIP-160.
Administrar las tareas pendientes de ejecución
Puedes usar el backlogging de ejecución para evitar los reintentos del cliente, quitar la ejecución las demoras y maximizar la capacidad de procesamiento. Las ejecuciones pendientes se ejecutan automáticamente en cuanto a medida que esté disponible la cuota de simultaneidad de ejecución.
Hay una cantidad máxima de ejecuciones de flujo de trabajo activas que se pueden ejecutar de forma simultánea. Una vez que esta cuota se agote,
el backlog de la ejecución está inhabilitado o si la cuota de las ejecuciones pendientes es
si se alcanza, las ejecuciones nuevas fallan con un estado HTTP 429 Too many requests
código. Con el backlog de ejecución habilitado, las ejecuciones nuevas se completan de forma correcta y
creada en un estado QUEUED
. En cuanto la cuota de simultaneidad de ejecución pasa a ser
disponible, las ejecuciones se ejecutan automáticamente y pasan a un estado ACTIVE
.
De forma predeterminada, el almacenamiento en cola de ejecución está habilitado para todas las solicitudes (incluidas las que activa Cloud Tasks) con las siguientes excepciones:
- Cuando creas una ejecución con un
executions.run
oexecutions.create
en un flujo de trabajo, el trabajo pendiente de ejecución está inhabilitado de forma predeterminada. Puedes configurarlo estableciendo explícitamente la propiedad de la ejecucióndisableConcurrencyQuotaOverflowBuffering
comofalse
. - Para las ejecuciones que activa Pub/Sub, el trabajo pendiente de ejecución es inhabilitado y no se puede configurar.
Ten en cuenta lo siguiente:
- Las ejecuciones en cola se inician en el orden de primero en entrar, primero en salir (FIFO), en un del mejor esfuerzo.
- El campo de marca de tiempo
createTime
indica cuando se crea una ejecución. El La marca de tiempostartTime
indica cuándo una ejecución sale automáticamente de la cola de tareas pendientes y empieza a ejecutarse. Para las ejecuciones que no están pendientes, ambos valores de marca de tiempo son idénticos. - El límite de las ejecuciones pendientes se puede observar a través del
Métrica de cuota de
workflowexecutions.googleapis.com/executionbacklogentries
. Para para obtener más información, consulta Visualiza y administra cuotas.
Inhabilitar el backlogging de ejecución
Puedes inhabilitar el backlogging de ejecución estableciendo una marca cuando uses el con Google Cloud CLI. Por ejemplo:
gcloud workflows execute WORKFLOW_NAME --disable-concurrency-quota-overflow-buffering
También puedes inhabilitar el trabajo pendiente de ejecución estableciendo la
Campo disableConcurrencyQuotaOverflowBuffering
como true
en el JSON de la solicitud
cuando se envía una solicitud de ejecución a la API de REST de Workflows.
Por ejemplo:
{ "argument": {"arg1":"value1"}, "callLogLevel": "LOG_NONE", "disableConcurrencyQuotaOverflowBuffering": true }
Para obtener más información, consulta Cómo ejecutar un flujo de trabajo.