Usa variables de entorno

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 implemente. También puedes crear un flujo de trabajo que se pueda reutilizar como plantilla y configurar según las variables de entorno que se mantienen por separado.

Las variables de entorno se configuran como pares de cadenas clave y valor arbitrarios a los que puede acceder tu flujo de trabajo en el entorno de ejecución. Se almacenan en el backend de Workflows, se asignan al alcance de 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. La creación o el cambio de una variable de entorno requiere una implementación exitosa. Si por algún motivo una implementación falla, no se aplicarán los cambios 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 definas variables de entorno para Workflows:

Configura variables de entorno

Puedes definir variables nuevas o reemplazar las existentes cuando implementes un flujo de trabajo. Para realizar cambios aditivos, consulta Actualiza las variables de entorno en este documento.

gcloud workflows deploy WORKFLOW_NAME \
    --set-env-vars KEY1=VALUE1

Configura varias variables de entorno

Para configurar varias 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 tus variables 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, en el control de 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 de tus variables de entorno. Ten en cuenta que los nombres y los valores de las variables deben ser cadenas. Workflows quitan todas las variables de entorno existentes antes de agregar las 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 parámetro. El nombre de la variable de entorno se debe pasar como una cadena.

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, muestra 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 las borra.

gcloud workflows deploy WORKFLOW_NAME \
    --update-env-vars KEY1=VALUE1

gcloud workflows deploy WORKFLOW_NAME \
    --update-env-vars KEY1=VALUE1,KEY2=VALUE2

Borra variables de entorno

Puedes borrar las variables de entorno definidas por el usuario para los flujos de trabajo existentes.

gcloud workflows deploy WORKFLOW_NAME \
    --remove-env-vars KEY1,KEY2

gcloud workflows deploy WORKFLOW_NAME \
    --clear-env-vars

Prácticas recomendadas

Como práctica recomendada, te sugerimos que no dependas de ninguna variable de entorno que no hayas configurado explícitamente ni la modifiques. Si modificas variables de entorno que no sean las que configuraste de forma explícita, es posible que se produzcan 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 las credenciales de la base de datos o las claves de API. Estos valores sensibles deben almacenarse por separado del código fuente y de las variables de entorno, y no deben enviarse a los registros por error.

Si deseas almacenar secretos, te sugerimos que revises las prácticas recomendadas para la administración de secretos y sigas las instrucciones para usar Secret Manager con flujos de trabajo.

Convenciones de nombres

Como regla general, recomendamos que las claves de variable de entorno tengan únicamente letras mayúsculas, dígitos y guiones bajos (_), y que no comiencen con un dígito. Considera colocar una clave única como prefijo 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.