En esta página, se describen los requisitos para configurar variables de entorno en Cloud Composer.
Cuando creas o actualizas un entorno, puedes agregar variables de entorno, las cuales Cloud Composer proporciona a los procesos del programador, trabajador y servidor web de Apache Airflow. Por ejemplo, Cloud Composer usa el módulo sendgrid de Apache Airflow para recibir notificaciones por correo electrónico. Para configurar las notificaciones de correo electrónico, debes establecer las variables de entorno SENDGRID_API_KEY
y SENDGRID_MAIL_FROM
.
Requisitos
Las variables de entorno deben coincidir con la expresión regular [a-zA-Z_][a-zA-Z0-9_]*
.
Las variables de entorno no deben especificar anulaciones de configuración de software de Apache Airflow. Esto significa que las variables no pueden usar el formato $AIRFLOW__{SECTION}__{KEY}
ni hacer coincidir la expresión regular
.AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+
)
Nombres reservados
Los siguientes nombres están reservados y no se pueden utilizar:
AIRFLOW_HOME
C_FORCE_ROOT
COMPOSER_ENVIRONMENT
COMPOSER_GKE_NAME
COMPOSER_GKE_ZONE
COMPOSER_LOCATION
COMPOSER_PYTHON_VERSION
CONTAINER_NAME
DAGS_FOLDER
GCP_PROJECT
GCS_BUCKET
GKE_CLUSTER_NAME
GOOGLE_APPLICATION_CREDENTIALS
SQL_DATABASE
SQL_INSTANCE
SQL_PASSWORD
SQL_PROJECT
SQL_REGION
SQL_USER
Antes de comenzar
Se requieren los siguientes permisos para establecer variables de entorno:
composer.environments.create
para establecer variables de entorno durante la creación del entornocomposer.environments.update
para actualizar las variables de entornoPara obtener más información, consulta el Control de acceso de Cloud Composer.
La mayoría de los comandos
gcloud composer
requiere una ubicación. Puedes especificar la ubicación mediante la marca--location
o estableciendo la ubicación predeterminada.
Agrega y actualiza variables de entorno
Para establecer variables de entorno, sigue estos pasos:
Console
Para agregar una variable de entorno, haz lo siguiente:
- Abre la página Crear entorno en Google Cloud Console.
En Configuración de nodos, haz clic en Agregar variable de entorno.
Ingresa las variables
NAME
yVALUE
para las variables de entorno.
gcloud
gcloud composer environments update ENVIRONMENT_NAME \ --location LOCATION \ --update-env-variables=KEY=VALUE,KEY=VALUE...
Donde:
ENVIRONMENT_NAME
es el nombre del entorno.LOCATION
es la región de Compute Engine donde se encuentra el entorno.KEY=VALUE
especifica las variables de entorno que se crearán o actualizarán.
Por ejemplo:
gcloud composer environments update test-environment
--location us-central1
--update-env-variables=SENDGRID_MAIL_FROM=updated-email@domain.com
API
Para usar la API de REST de Cloud Composer, envía un environments.patch
.
Quita variables de entorno
Para quitar las variables de entorno, haz lo siguiente:
Console
- Abre la página Entornos.
- En la página Mostrar lista de entornos, haz clic en el nombre del entorno para ver sus detalles.
- En Variables de entorno, haz clic en Editar.
- A la derecha del valor de la variable, haz clic en el ícono de la papelera.
gcloud
Para quitar todas las variables de entorno, usa lo siguiente:
gcloud composer environments update ENVIRONMENT_NAME
--location LOCATION
--clear-env-variables
Donde:
ENVIRONMENT_NAME
es el nombre del entorno.LOCATION
es la región de Compute Engine donde se encuentra el entorno.
Por ejemplo:
gcloud composer environments update test-environment
--location us-central1
--clear-env-variables
Para quitar una lista de variables de entorno, usa lo siguiente:
gcloud composer environments update ENVIRONMENT_NAMEDonde:
--location LOCATION
--remove-env-variables=NAME,NAME,...
ENVIRONMENT_NAME
es el nombre del entorno.LOCATION
es la región de Compute Engine donde se encuentra el entorno.NAME
es la variable de entorno que se debe quitar.
API
Para usar la API de REST de Cloud Composer, envía un environments.patch
.