Puedes crear y administrar flujos de trabajo en la consola de Google Cloud o con Google Cloud CLI en la terminal o en Cloud Shell. También puedes administrar flujos de trabajo a través de la API de Workflows.
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.
Console
- 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.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Workflows API.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Workflows API.
gcloud
- 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 Workflows API:
gcloud services enable 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 Workflows API:
gcloud services enable workflows.googleapis.com
REST
Para administrar flujos de trabajo con la API de Workflows, te recomendamos que uses las bibliotecas cliente que proporciona Google para llamar al servicio workflows.googleapis.com
. Para obtener más información, consulta la API de Workflows.
Cree una cuenta de servicio
Una cuenta de servicio representa la identidad de un flujo de trabajo y determina los permisos que tiene y a qué recursos de Google Cloud puede acceder. Crea una cuenta de servicio si aún no tienes una y, luego, otórgale los roles necesarios para administrar flujos de trabajo y crear registros.
Si no especificas una cuenta de servicio durante la creación del flujo de trabajo, este usa la cuenta de servicio predeterminada de Compute Engine para su identidad. Para obtener más información, consulta Cómo otorgar permiso a un flujo de trabajo para acceder a recursos de Google Cloud.
Recomendamos usar una cuenta de servicio con los privilegios mínimos necesarios para acceder a los recursos requeridos.
Ten en cuenta que, para crear un recurso y conectar una cuenta de servicio, necesitas permisos para crear ese recurso y actuar en nombre de la cuenta de servicio que conectarás al recurso. Para obtener más información, consulta Permisos de la cuenta de servicio.
Console
En la consola de Google Cloud, ve a la página Cuentas de servicio.
Selecciona un proyecto y, luego, haz clic en Crear cuenta de servicio.
Escribe un nombre en el campo Nombre de cuenta de servicio.
El nombre debe tener entre 6 y 30 caracteres y puede contener guiones y caracteres alfanuméricos en minúscula. Después de crear una cuenta de servicio, no podrás cambiar su nombre.
Haz clic en Crear y continuar.
Haga clic en Selecciona un rol.
Selecciona los siguientes roles y haz clic en Agregar otro rol según sea necesario:
- Para crear, actualizar y ejecutar flujos de trabajo, selecciona Flujo de trabajo > Editor de flujos de trabajo.
- Para enviar registros a Cloud Logging, selecciona Registro > Escritor de registros.
Haz clic en Listo para terminar de crear la cuenta de servicio.
gcloud
Cree la cuenta de servicio.
gcloud iam service-accounts create SERVICE_ACCOUNT
Otorga permisos a la cuenta de servicio asignando roles.
Para crear, actualizar y ejecutar flujos de trabajo, asigna el rol
roles/workflows.editor
:gcloud projects add-iam-policy-binding PROJECT_ID \ --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \ --role "roles/workflows.editor"
Para enviar registros a Cloud Logging, asigna el rol
roles/logging.logWriter
:gcloud projects add-iam-policy-binding PROJECT_ID \ --member "serviceAccount:SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com" \ --role "roles/logging.logWriter"
Reemplaza lo siguiente:
SERVICE_ACCOUNT
: el nombre de la cuenta de servicio Debe tener entre 6 y 30 caracteres y puede contener guiones y caracteres alfanuméricos en minúscula. Después de crear una cuenta de servicio, no podrás cambiar su nombre.PROJECT_ID
: Es el ID de tu proyecto.
REST
Puedes usar el método serviceAccounts.create
para crear una cuenta de servicio. Para obtener más información, consulta Crea cuentas de servicio.
Puedes otorgar varios roles de forma programática si modificas y configuras la
política de permiso para un recurso con el método
setIamPolicy
. Para obtener más información, consulta Otorga o revoca varios roles de manera programática.
Crea un flujo de trabajo
La definición de un flujo de trabajo está compuesta por una serie de pasos descritos con la sintaxis de Workflows, que se pueden escribir en formato YAML o JSON. Después de definir un flujo de trabajo, debes implementarlo para que esté disponible para su ejecución. El paso de implementación también valida que se pueda ejecutar el archivo de origen. Falla si el archivo de origen no contiene una definición de flujo de trabajo válida.
La edición de archivos YAML puede ser propensa a errores. Puedes crear tu flujo de trabajo con un IDE o editor de código fuente preferido y configurar el autocompletado y la validación de sintaxis para reducir los errores.
Console
En la consola de Google Cloud, ve a la página Workflows.
Haz clic en
Crear.Ingresa un nombre para el flujo de trabajo, como
myFirstWorkflow
. El nombre puede contener letras, números, guiones bajos y guiones. Debe comenzar con una letra y terminar con una letra o un númeroDe manera opcional, agrega una descripción del flujo de trabajo.
En la lista Región, selecciona una ubicación adecuada para implementar tu flujo de trabajo, por ejemplo, us-central1.
En la lista Cuenta de servicio, selecciona una cuenta de servicio que tu flujo de trabajo usará para acceder a otros servicios de Google Cloud. Para obtener más información, consulta Crea una cuenta de servicio en este documento.
De forma opcional, puedes hacer lo siguiente:
Especifica el nivel de registro de llamadas que deseas aplicar a la definición del flujo de trabajo. En la lista Nivel de registro de llamadas, 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.
Especifica una clave de Cloud Key Management Service que el flujo de trabajo debería usar para la encriptación de datos: selecciona Clave de encriptación administrada por el cliente (CMEK). Para obtener más información, consulta Usa claves de encriptación administradas por el cliente.
Especifica una variable de entorno a la que pueda acceder el flujo de trabajo en el entorno de ejecución. Para obtener más información, consulta Usa variables de entorno.
Agrega una etiqueta: Las etiquetas son pares clave-valor que te ayudan a organizar tus instancias de Google Cloud. Para obtener más información, consulta ¿Qué son las etiquetas? Las ejecuciones del flujo de trabajo heredan las etiquetas del flujo de trabajo. Para ver las etiquetas de ejecución, usa el método
workflows.executions.list
para enumerar y filtrar las ejecuciones de flujos de trabajo.Programa tu flujo de trabajo: Selecciona Agregar activador nuevo > Cloud Scheduler. Para obtener más información, consulta Programa un flujo de trabajo con Cloud Scheduler.
Activa el flujo de trabajo a través de un evento o mensaje de Pub/Sub: Selecciona Agregar activador nuevo > Eventarc. Para obtener más información, consulta Activa un flujo de trabajo con eventos o mensajes de Pub/Sub.
Haga clic en Siguiente.
En el editor de flujos de trabajo, ingresa la definición para el flujo de trabajo. Consulta un flujo de trabajo de ejemplo.
Haga clic en Implementar.
gcloud
Asegúrate de que el código fuente de tu flujo de trabajo se guarde en un archivo YAML o JSON, como
MY_WORKFLOW.YAML
oMY_WORKFLOW.JSON
. Consulta un flujo de trabajo de ejemplo.Abre una terminal.
Puedes crear e implementar un flujo de trabajo con el comando
gcloud workflows deploy
:gcloud workflows deploy WORKFLOW_NAME \ --location=LOCATION \ --call-log-level=CALL_LOGGING_LEVEL \ --description="DESCRIPTION" \ --labels="LABEL_KEY=LABEL_VALUE" \ --set-env-vars="ENV_KEY=ENV_VALUE" \ --kms-key=ENCRYPT_KEY \ --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \ --source=YAML_OR_JSON_SOURCE_FILE
Reemplaza lo siguiente:
WORKFLOW_NAME
: Es el nombre de tu flujo de trabajo, por ejemplo,myFirstWorkflow
. El nombre puede contener letras, números, guiones bajos y guiones. Debe empezar con una letra y terminar con una letra o un número.LOCATION
: Es la región en la que se implementará tu flujo de trabajo, por ejemplo,us-central1
.CALL_LOGGING_LEVEL
: es opcional. Nivel del 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.
DESCRIPTION
: es opcional. Es una descripción del flujo de trabajo.LABEL_KEY=LABEL_VALUE
: es opcional. Es una lista de pares clave-valor de etiquetas que te ayuda a organizar tus instancias de Google Cloud, por ejemplo,name=wrench
. Para obtener más información, consulta ¿Qué son las etiquetas? Las ejecuciones del flujo de trabajo heredan las etiquetas del flujo de trabajo. Para ver las etiquetas de ejecución, usa el métodoworkflows.executions.list
para enumerar y filtrar las ejecuciones de flujos de trabajo.ENV_KEY=ENV_VALUE
: es opcional. Es la lista de pares clave-valor de la variable de entorno, por ejemplo,MONTH=January
. Para obtener más información, consulta Usa variables de entorno.ENCRYPT_KEY
: es opcional. Una clave de Cloud KMS que el flujo de trabajo debe usar para la encriptación de datos en el formatoprojects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME
. Para obtener más información, consulta Usa claves de encriptación administradas por el cliente.SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com
: Opcional. La cuenta de servicio que usará el flujo de trabajo para acceder a otros servicios de Google Cloud. Para obtener más información, consulta Crea una cuenta de servicio en este documento.YAML_OR_JSON_SOURCE_FILE
: Es el archivo de origen de la definición del flujo de trabajo. Por ejemplo:myFirstWorkflow.yaml
.
REST
Para crear un flujo de trabajo nuevo con un nombre especificado, usa el método projects.locations.workflows.create
y el parámetro de consulta workflowId
para especificar un ID para el flujo de trabajo.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
WORKFLOW_NAME
: El nombre de tu flujo de trabajo, por ejemplo,myFirstWorkflow
. El nombre puede contener letras, números, guiones bajos y guiones. Debe empezar con una letra y terminar con una letra o un número.DESCRIPTION
: es opcional. Una descripción de tu flujo de trabajo No debe tener más de 1,000 caracteres Unicode.LABEL_KEY
yLABEL_VALUE
: Opcional. Un mapa de pares clave-valor de etiquetas que te ayudan a organizar tus instancias de Google Cloud. Por ejemplo:{"name": "wrench", "mass": "1kg", "count": "3"}
Para obtener más información, consulta ¿Qué son las etiquetas? Las ejecuciones del flujo de trabajo heredan las etiquetas del flujo de trabajo. Para ver las etiquetas de ejecución, usa el métodoworkflows.executions.list
para enumerar y filtrar las ejecuciones de flujos de trabajo.SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com
: Es opcional. La cuenta de servicio que usará el flujo de trabajo para acceder a otros servicios de Google Cloud. El ID del proyecto es el ID de tu proyecto de Google Cloud. Para obtener más información, consulta Crea una cuenta de servicio en este documento.ENCRYPT_KEY
: es opcional. Una clave de Cloud KMS que el flujo de trabajo debe usar para la encriptación de datos en el formatoprojects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME
. Para obtener más información, consulta Usa claves de encriptación administradas por el cliente.CALL_LOGGING_LEVEL
: es opcional. Es el nivel de registro de llamadas que se aplicará durante la ejecución. La opción predeterminada es que no se especifique ningún nivel de registro y, en su lugar, se aplique el nivel de registro del flujo de trabajo. Para obtener más información, consulta Cómo enviar registros a Logging. Uno de los siguientes:CALL_LOG_LEVEL_UNSPECIFIED
: No se especifica ningún nivel de registro y, en su lugar, 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 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.
ENV_KEY
yENV_VALUE
: Opcional. Un mapa de pares clave-valor de la variable de entorno, por ejemplo,{ "month": "January", "day": "Monday"}
. Para obtener más información, consulta Usa variables de entorno.SOURCE_CODE
: La definición del flujo de trabajo. Debes escapar las líneas nuevas en YAML. Por ejemplo:main:\n params:\n - input\n steps:\n - returnOutput:\n return: Hello
.Debes escapar las comillas en JSON. Por ejemplo:
{\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}
.LOCATION
: Es la región en la que se implementará el flujo de trabajo, por ejemplo,us-central1
.
Cuerpo JSON de la solicitud:
{ "name": "WORKFLOW_NAME", "description": "DESCRIPTION", "labels": {"LABEL_KEY":"LABEL_VALUE"}, "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com", "cryptoKeyName": "ENCRYPT_KEY", "callLogLevel": "CALL_LOGGING_LEVEL", "userEnvVars": {"ENV_KEY":"ENV_VALUE"}, "sourceContents": "SOURCE_CODE" }
Para enviar tu solicitud, expande una de estas opciones:
Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de
Operation
:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata", "createTime": "2023-12-05T14:06:06.338390918Z", "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME", "verb": "create", "apiVersion": "v1" }, "done": false }
Si el valor de "done"
es false
, la operación
aún está en curso.
Cómo enumerar flujos de trabajo
Puedes enumerar flujos de trabajo o usar filtros para recuperar uno específico.
Console
En la consola de Google Cloud, ve a la página Flujos de trabajo.
En esta página, se enumeran tus flujos de trabajo en todas las ubicaciones y se incluyen detalles, como nombres, regiones, revisiones más recientes y mucho más.
Para filtrar tus flujos de trabajo, haz lo siguiente:
- Haz clic en Filtrar o en el campo Filtrar flujos de trabajo.
- En la lista Propiedades, selecciona una opción para filtrar los flujos de trabajo.
Puedes elegir una sola propiedad o usar el operador lógico
OR
para agregar más propiedades.Para ordenar los flujos de trabajo, junto con el encabezado de la columna compatible, haz clic en
Ordenar.
gcloud
Enumera los flujos de trabajo con el comando gcloud workflows list
:
gcloud workflows list --location=LOCATION
Reemplaza LOCATION
por el ID o el identificador completamente calificado de la ubicación de tu flujo de trabajo.
Este comando muestra una lista de tus flujos de trabajo en la ubicación especificada y
también incluye detalles como NAME
, STATE
, REVISION_ID
y
UPDATE_TIME
de un flujo de trabajo.
REST
Para enumerar los flujos de trabajo en un proyecto y una ubicación determinados, usa el
método projects.locations.workflows.list
.
Como alternativa, para recuperar los detalles de un solo flujo de trabajo, usa el método projects.locations.workflows.get
.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
PROJECT_ID
: el ID del proyecto de Google Cloud.LOCATION
: La región en la que se implementan los flujos de trabajo, por ejemplo,us-central1
.
Para enviar tu solicitud, expande una de estas opciones:
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene instancias de
Workflow
y la respuesta debe ser similar a la siguiente:
{ "workflows": [ { "name": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME", "state": "ACTIVE", "revisionId": "000001-0ce", "createTime": "2023-12-08T13:56:59.306770745Z", "updateTime": "2023-12-08T13:56:59.547021939Z", "revisionCreateTime": "2023-12-08T13:56:59.340161044Z", "serviceAccount": "projects/PROJECT_ID/serviceAccounts/PROJECT_NUMBER-compute@developer.gserviceaccount.com", "sourceContents": "main:\n params: [input]\n [...] return: '${wikiResult.body[1]}'\n" }, { object (Workflow) } ], "nextPageToken": string, "unreachable": [ string ] }
Actualiza un flujo de trabajo
Puedes actualizar un flujo de trabajo existente. Debes especificar el nombre del flujo de trabajo que deseas actualizar y su fuente. Ten en cuenta que no puedes cambiar el nombre ni la ubicación de un flujo de trabajo.
La actualización de un flujo de trabajo no afecta las ejecuciones en curso. Solo las ejecuciones futuras del flujo de trabajo usarán la configuración actualizada.
Cada vez que actualizas un flujo de trabajo, se actualiza su versionID
. versionID
consta de dos partes, separadas por un guion:
Es un número, que comienza en uno, que aumenta cada vez que actualizas un flujo de trabajo.
Una cadena alfanumérica aleatoria de tres caracteres.
Por ejemplo, 000001-27f
indica la versión inicial de un flujo de trabajo y 000002-d52
indica un flujo de trabajo que se actualizó una vez.
Console
En la consola de Google Cloud, ve a la página Flujos de trabajo.
Haz clic en el nombre del flujo de trabajo que deseas actualizar. Ten en cuenta que no puedes cambiar el nombre del flujo de trabajo.
Aparecerá la página Detalles del flujo de trabajo.
Puedes editar el flujo de trabajo de las siguientes maneras:
Para editar la fuente, haz lo siguiente:
- Haz clic en la pestaña Fuente.
- Haz clic en Edit.
- Para guardar los cambios, haz clic en Guardar. Se implementa el flujo de trabajo actualizado.
Para actualizar la descripción, la cuenta de servicio que usa el flujo de trabajo para la autenticación, el nivel del registro de llamadas, las variables de entorno, las etiquetas o la clave de encriptación, sigue estos pasos:
- Haz clic en la pestaña Detalles.
- Haz clic en el ícono correspondiente.
- Si actualizas el nivel de registro de llamadas, 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.
- Si actualizas una etiqueta existente o agregas una nueva, esta puede tardar hasta 10 minutos en aplicarse. Las ejecuciones del flujo de trabajo heredan las etiquetas del flujo de trabajo. Para ver las etiquetas de ejecución, usa el método
workflows.executions.list
para hacer una lista de las ejecuciones de flujos de trabajo y filtrar. - Para guardar los cambios, haz clic en Guardar. Se implementa el flujo de trabajo actualizado.
Para editar los campos anteriores al mismo tiempo, o agregar o actualizar un activador, sigue estos pasos:
- Haz clic en Editar.
- Para editar la fuente, haz clic en Siguiente.
- Para guardar los cambios y, luego, implementar el flujo de trabajo actualizado, haz clic en Implementar.
Si quieres actualizar los roles de tu cuenta de servicio, haz clic en la pestaña Permisos.
Las principales son usuarios, grupos, dominios o cuentas de servicio. Para actualizar un principal existente, haz lo siguiente:
- Busca una fila que contenga el principal.
- Haz clic en Editar principal en esa fila.
- Haz clic en Agregar otro rol o en Borrar rol.
Si vas a agregar un rol, en la lista Seleccionar un rol, selecciona un rol apropiado.
Para agregar otro rol, haz clic en Agregar otro rol.
Haz clic en Guardar.
gcloud
Abre una terminal.
Busca el nombre del flujo de trabajo que deseas actualizar. Si no conoces el nombre del flujo de trabajo, puedes ingresar el siguiente comando para ver una lista de todos tus flujos de trabajo:
gcloud workflows list
Busca el archivo YAML o JSON en el que se guarda la fuente de tu flujo de trabajo, como
WORKFLOW_NAME.YAML
oWORKFLOW_NAME.JSON
.Puedes actualizar un flujo de trabajo existente para cambiar su fuente, descripción, etiquetas, variables de entorno, nivel de registro de llamadas, clave de encriptación o su cuenta de servicio asociada con el comando
gcloud workflows deploy
.Debes especificar el nombre del flujo de trabajo que deseas actualizar y su fuente. Sin embargo, el resto de las marcas son opcionales. Para quitar una clave de encriptación administrada por el cliente, usa la marca
--clear-kms-key
.gcloud workflows deploy WORKFLOW_NAME \ --call-log-level=CALL_LOGGING_LEVEL \ --description="DESCRIPTION" \ --labels="LABEL_KEY=LABEL_VALUE" \ --set-env-vars="ENV_KEY=ENV_VALUE" \ --kms-key=ENCRYPT_KEY \ --service-account=SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com \ --source=YAML_OR_JSON_SOURCE_FILE
Reemplaza lo siguiente:
WORKFLOW_NAME
: Obligatorio. Es el nombre de tu flujo de trabajo.CALL_LOGGING_LEVEL
: es opcional. Es el nivel de registro de llamadas que se aplicará al flujo de trabajo. 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.
DESCRIPTION
: es opcional. Es una descripción del flujo de trabajo.LABEL_KEY=LABEL_VALUE
: es opcional. Es una lista de pares clave-valor de etiquetas que te ayuda a organizar tus instancias de Google Cloud, por ejemplo,name=wrench
. Para obtener más información, consulta ¿Qué son las etiquetas? Las ejecuciones del flujo de trabajo heredan las etiquetas del flujo de trabajo. Para ver las etiquetas de ejecución, usa el métodoworkflows.executions.list
para enumerar y filtrar las ejecuciones de flujos de trabajo.ENV_KEY=ENV_VALUE
: es opcional. Es la lista de pares clave-valor de la variable de entorno, por ejemplo,MONTH=January
. Para obtener más información, consulta Usa variables de entorno.ENCRYPT_KEY
: es opcional. Una clave de Cloud KMS que el flujo de trabajo debe usar para la encriptación de datos en el formatoprojects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME
. Para obtener más información, consulta Usa claves de encriptación administradas por el cliente.SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com
: Opcional. La cuenta de servicio que usará el flujo de trabajo para acceder a otros servicios de Google Cloud. Si deseas actualizar los roles de tu cuenta de servicio, consulta Otorga permiso a un flujo de trabajo para acceder a los recursos de Google Cloud y Administra el acceso a los proyectos, las carpetas y las organizaciones.YAML_OR_JSON_SOURCE_FILE
: Obligatorio. Es el archivo fuente del flujo de trabajo en formato YAML o JSON. Por ejemplo:myFirstWorkflow.yaml
REST
Para actualizar un flujo de trabajo existente, usa el método
projects.locations.workflows.patch
y, de forma opcional, usa el parámetro de consulta updateMask
para especificar una lista
de campos que se actualizarán.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
WORKFLOW_NAME
: El nombre de tu flujo de trabajo, por ejemplo,myFirstWorkflow
.DESCRIPTION
: es opcional. Una descripción de tu flujo de trabajo No debe tener más de 1,000 caracteres Unicode.LABEL_KEY
yLABEL_VALUE
: Opcional. Un mapa de pares clave-valor de etiquetas que te ayudan a organizar tus instancias de Google Cloud. Por ejemplo:{"name": "wrench", "mass": "1kg", "count": "3"}
Para obtener más información, consulta ¿Qué son las etiquetas? Las ejecuciones del flujo de trabajo heredan las etiquetas del flujo de trabajo. Para ver las etiquetas de ejecución, usa el métodoworkflows.executions.list
para enumerar y filtrar las ejecuciones de flujos de trabajo.SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com
: Es opcional. La cuenta de servicio que usará el flujo de trabajo para acceder a otros servicios de Google Cloud. El ID del proyecto es el ID de tu proyecto de Google Cloud. Para obtener más información, consulta Crea una cuenta de servicio en este documento.ENCRYPT_KEY
: es opcional. Una clave de Cloud KMS que el flujo de trabajo debe usar para la encriptación de datos en el formatoprojects/PROJECT_NAME/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME
. Para obtener más información, consulta Usa claves de encriptación administradas por el cliente.CALL_LOGGING_LEVEL
: es opcional. Es el nivel de registro de llamadas que se aplicará durante la ejecución. La opción predeterminada es que no se especifique ningún nivel de registro y, en su lugar, se aplique el nivel de registro del flujo de trabajo. Para obtener más información, consulta Cómo enviar registros a Logging. Uno de los siguientes:CALL_LOG_LEVEL_UNSPECIFIED
: No se especifica ningún nivel de registro y, en su lugar, 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 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.
ENV_KEY
yENV_VALUE
: Opcional. Un mapa de pares clave-valor de la variable de entorno, por ejemplo,{ "month": "January", "day": "Monday"}
. Para obtener más información, consulta Usa variables de entorno.SOURCE_CODE
: Es la definición del flujo de trabajo reducido. Por ejemplo:{\"main\":{\"params\":[\"input\"],\"steps\":[{\"returnOutput\":{\"return\":\"Hello\"}}]}}
.LOCATION
: Es la región en la que se implementa el flujo de trabajo, por ejemplo,us-central1
.UPDATE_FIELDS
: es opcional. Una lista de los campos separados por comas que se deben actualizar. Si no se proporciona, se actualiza todo el flujo de trabajo. Por ejemplo,description,callLogLevel
.
Cuerpo JSON de la solicitud:
{ "name": "WORKFLOW_NAME", "description": "DESCRIPTION", "labels": {"LABEL_KEY":"LABEL_VALUE"}, "serviceAccount": "SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com", "cryptoKeyName": "ENCRYPT_KEY", "callLogLevel": "CALL_LOGGING_LEVEL", "userEnvVars": {"ENV_KEY":"ENV_VALUE"}, "sourceContents": "SOURCE_CODE" }
Para enviar tu solicitud, expande una de estas opciones:
Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de
Operation
:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata", "createTime": "2023-12-05T14:06:06.338390918Z", "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME", "verb": "update", "apiVersion": "v1" }, "done": false }
Si el valor de "done"
es false
, la operación
aún está en curso.
Cómo borrar un flujo de trabajo
Puedes borrar un flujo de trabajo existente. Si borras un flujo de trabajo, también se borran sus ejecuciones y se cancelan las ejecuciones activas del flujo de trabajo.
Console
En la consola de Google Cloud, ve a la página Flujos de trabajo.
Haz clic en el nombre del flujo de trabajo que quieres borrar y, luego, en
Borrar.En el mensaje para confirmar la eliminación, ingresa el nombre del flujo de trabajo.
Haz clic en Confirmar.
gcloud
Abre una terminal.
Busca el nombre del flujo de trabajo que deseas borrar. Si no conoces el nombre del flujo de trabajo, puedes ingresar el siguiente comando para ver una lista de todos tus flujos de trabajo:
gcloud workflows list
Borra un flujo de trabajo con el comando
gcloud workflows delete
:gcloud workflows delete WORKFLOW_NAME
Reemplaza
WORKFLOW_NAME
por el nombre de tu flujo de trabajo.
REST
Para borrar un flujo de trabajo con un nombre especificado, usa el
método projects.locations.workflows.delete
.
Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:
WORKFLOW_NAME
: Es el nombre del flujo de trabajo que deseas borrar.PROJECT_ID
: el ID del proyecto de Google Cloud.LOCATION
: Es la región en la que se implementa el flujo de trabajo, por ejemplo,us-central1
.
Para enviar tu solicitud, expande una de estas opciones:
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de
Operation
:
{ "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.workflows.v1.OperationMetadata", "createTime": "2023-12-05T14:06:06.338390918Z", "target": "projects/PROJECT_ID/locations/LOCATION/workflows/WORKFLOW_NAME", "verb": "delete", "apiVersion": "v1" }, "done": false }
Si el valor de "done"
es false
, la operación
aún está en curso.