Puedes definir variables de entorno para Workflows en el momento de la implementación. Por ejemplo, puedes crear un flujo de trabajo que se configure de forma dinámica según el entorno en el que se implementa. O bien, puedes crear un flujo de trabajo que se pueda volver a usar como una plantilla y configurarse de acuerdo con las variables de entorno que se mantienen por separado.
Las variables de entorno se configuran como pares de cadenas de clave y valor arbitrarios a los que tu flujo de trabajo puede acceder en el entorno de ejecución. Se almacenan en el backend de Workflows, se limitan a la ejecución del flujo de trabajo y son inmutables durante la ejecución de un flujo de trabajo.
Todas las variables de entorno están vinculadas a una implementación de un flujo de trabajo y solo se pueden configurar o cambiar con una implementación. Crear o cambiar una variable de entorno requiere una implementación exitosa. Si una implementación falla por algún motivo, no se aplicará ningún cambio en las variables de entorno.
Puedes agregar, actualizar o quitar variables de entorno definidas por el usuario con Google Cloud CLI.
Nombres reservados
Las variables de entorno integradas definidas para Workflows están reservadas y no se pueden configurar.
Ten en cuenta que no puedes usar lo siguiente cuando defines variables de entorno para Workflows:
| Clave | Descripción |
|---|---|
Vacío ('') |
Las claves no pueden ser una string vacía. |
GOOGLE_ |
Las claves no pueden contener el prefijo GOOGLE_. |
WORKFLOWS_ |
Las claves no pueden contener el prefijo WORKFLOWS_. |
Configura las variables de entorno
Puedes definir variables nuevas o reemplazar variables existentes cuando implementes un flujo de trabajo. Para hacer cambios aditivos, en este documento, consulta Actualiza variables de entorno.
Console
En la consola de Google Cloud, ve a la página Workflows.
En la página Workflows, haz clic en Crear.
En la página Crear flujo de trabajo, completa los campos adecuados para configurar la definición de tu flujo de trabajo.
En la sección Variables de entorno (opcional), haz clic en Agregar variable.
En el campo Nombre 1, especifica el nombre de la variable.
En el campo Valor 1, especifica el valor de la variable.
Para agregar otra variable, haz clic en Agregar variable.
Haz clic en Siguiente.
Después de definir tu flujo de trabajo, haz clic en Implementar para implementarlo.
gcloud
Para configurar una variable de entorno, usa la marca --set-env-vars:
gcloud workflows deploy WORKFLOW_NAME \
--set-env-vars KEY1=VALUE1
Reemplaza lo siguiente:
WORKFLOW_NAME: Es el ID del flujo de trabajo.KEY1=VALUE1: Es el nombre de la variable de entorno y su valor; por ejemplo,MONTH=January.
Terraform
Para crear un flujo de trabajo, usa el recurso google_workflows_workflow y modifica tu archivo main.tf como se indica en el ejemplo. Para obtener más información,
consulta
Crea un flujo de trabajo con Terraform.
Usa el argumento user_env_vars para asociar una variable de entorno con la revisión del flujo de trabajo.
Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.
Configura múltiples variables de entorno
Para configurar múltiples variables de entorno, usa una lista separada por comas:
gcloud workflows deploy WORKFLOW_NAME \
--set-env-vars KEY1=VALUE1,KEY2=VALUE2
Caracteres de coma de escape
Dado que el carácter de coma (,) se usa para delimitar las variables de entorno, si los valores de tu variable incluyen comas, debes especificar un carácter delimitador diferente, por ejemplo, @:
gcloud workflows deploy WORKFLOW_NAME \
--set-env-vars ^@^KEY1=VALUE1,VALUE2,VALUE3@KEY2=VALUE2
Almacena variables en un archivo
Para almacenar tus variables en un archivo (por ejemplo, bajo el control del código fuente), usa un archivo YAML y la marca --env-vars-file:
gcloud workflows deploy WORKFLOW_NAME \
--env-vars-file FILE_PATH
Reemplaza FILE_PATH por la ruta de acceso a un archivo YAML local que enumere las definiciones para las variables de entorno. Ten en cuenta que los nombres y valores de las variables deben ser cadenas. Workflows quita todas las variables de entorno existentes antes de agregar las variables de entorno nuevas.
Por ejemplo, el contenido del archivo YAML podría ser el siguiente:
KEY1: "value1" KEY2: "value2"
Para obtener más información sobre el comando deploy, consulta gcloud workflows deploy.
Accede a las variables de entorno
Para acceder a una variable de entorno, realiza una llamada a la función sys.get_env() en una expresión y pasa el nombre de la variable de entorno como un parámetro. El nombre de la variable de entorno se debe pasar como una string.
Por ejemplo, el siguiente flujo de trabajo asigna el valor de la variable de entorno KEY1 a una variable de flujo de trabajo llamada keyValue y, luego, genera ese valor:
main:
steps:
- init:
assign:
- keyValue: ${sys.get_env("KEY1")}
- returnResult:
return: ${keyValue}
Actualiza las variables de entorno
Puedes actualizar las variables de entorno definidas por el usuario para los flujos de trabajo existentes. Este es un enfoque no destructivo que modifica o agrega variables de entorno, pero no borra variables.
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.
Aparecerá la página Detalles del flujo de trabajo.
Para editar una variable de entorno existente, realiza una de las siguientes acciones:
Haz clic en la pestaña Detalles.
- Junto a Variables de entorno, haz clic en el ícono .
- Realiza tus cambios.
- Para implementar el flujo de trabajo actualizado, haz clic en Guardar.
Haz clic en Editar.
- En la sección Variables de entorno (opcional), realiza los cambios.
- Para implementar el flujo de trabajo actualizado, haz clic en Siguiente y, luego, en Implementar.
gcloud
Para actualizar una variable, usa la marca --update-env-vars:
gcloud workflows deploy WORKFLOW_NAME \
--update-env-vars KEY1=VALUE1
Para actualizar varias variables de entorno, usa una lista separada por comas:
gcloud workflows deploy WORKFLOW_NAME \
--update-env-vars KEY1=VALUE1,KEY2=VALUE2
Borra las variables de entorno
Puedes borrar variables de entorno definidas por el usuario para flujos de trabajo existentes.
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.
Aparecerá la página Detalles del flujo de trabajo.
Para borrar una variable de entorno existente, realiza una de las siguientes acciones:
Haz clic en la pestaña Detalles.
- Haz clic en la correspondiente.
- Haz clic en el ícono junto a la variable de entorno que deseas borrar.
- Para implementar el flujo de trabajo actualizado, haz clic en Guardar.
Haz clic en Editar.
- Haz clic en el ícono junto a la variable de entorno que deseas borrar.
- Para implementar el flujo de trabajo actualizado, haz clic en Siguiente y, luego, en Implementar.
gcloud
Si deseas quitar variables de entorno de forma selectiva, usa la marca --remove-env-vars:
gcloud workflows deploy WORKFLOW_NAME \
--remove-env-vars KEY1,KEY2
Como alternativa, puedes borrar todas las variables de entorno configuradas previamente con el marcador --clear-env-vars:
gcloud workflows deploy WORKFLOW_NAME \
--clear-env-vars
prácticas recomendadas
Te recomendamos que no dependas de ninguna variable de entorno que no hayas configurado de forma explícita ni que la modifiques. Si modificas otras variables de entorno que no sean las que configuraste de forma explícita, podrías generar consecuencias no deseadas.
Administra secretos
Las variables de entorno se pueden usar para configurar flujos de trabajo, pero no se recomiendan como una forma de almacenar y consumir secretos como credenciales de base de datos o claves de API. Estos valores sensibles deben almacenarse por separado del código fuente y las variables de entorno, y no enviarse de forma involuntaria a los registros.
Si quieres almacenar secretos, te recomendamos que revises las prácticas recomendadas para la administración de secretos y sigas las instrucciones a fin de usar Secret Manager con Workflows.
Convenciones de nombres
Como regla general, recomendamos que las claves de variable de entorno constan solo de letras mayúsculas, dígitos y guiones bajos (_), y que no comiencen con un dígito. Considera anteponer una clave única a las variables de entorno definidas por el usuario para evitar conflictos con otras variables.
Límites de tamaño
Se puede definir un máximo de 20 variables de entorno definidas por el usuario. Cada cadena de definición (KEY=value) está limitada a 4 KiB.
¿Qué sigue?
- Ejecuta un flujo de trabajo.
- Pasa argumentos del entorno de ejecución en una solicitud de ejecución.