Set environment variables

Cloud Composer 1 | Cloud Composer 2

This page explains how to set environment variables in your Cloud Composer environment.

Cloud Composer uses the environment variables to alter the runtime behavior of Airflow or your DAGs.

Environment variables are persistent. Once you specify an environment variable, Airflow keeps using it until you remove the variable from your environment.

For example, Cloud Composer uses the Apache Airflow Sendgrid module for email notifications. To configure email notifications, you need to set the SENDGRID_API_KEY and SENDGRID_MAIL_FROM environment variables.

Name format

Environment variables must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*.

Environment variables must not specify Apache Airflow configuration overrides. This means the variables cannot use the AIRFLOW__{SECTION}__{KEY} format or match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+.

Reserved variables

The following names are reserved and cannot be used:

  • AIRFLOW_HOME
  • AIRFLOW_SRC_DIR
  • C_FORCE_ROOT
  • CLOUDSDK_METRICS_ENVIRONMENT
  • 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
  • KUBERNETES_PORT
  • KUBERNETES_PORT_443_TCP_PROTO
  • KUBERNETES_PORT_443_TCP_ADDR
  • KUBERNETES_PORT_443_TCP_PORT
  • KUBERNETES_PORT_443_TCP
  • KUBERNETES_SERVICE_HOST
  • KUBERNETES_SERVICE_PORT
  • KUBERNETES_SERVICE_PORT_HTTPS
  • MAJOR_VERSION
  • MINOR_VERSION
  • PROJECT_ID
  • SQL_DATABASE
  • SQL_INSTANCE
  • SQL_HOST
  • SQL_PASSWORD
  • SQL_PROJECT
  • SQL_REGION
  • SQL_USER

Set environment variables for new environments

You can specify environment variables when you create an environment. For more information, see Create environments.

Set environment variables for existing environments

Console

To set environment variables for an existing environment:

  1. In Google Cloud console, go to the Environments page.

    Go to Environments

  2. In the list of environments, click the name of your environment. The Environment details page opens.

  3. Go to the Environment variables tab and click Edit.

  4. Add, change, or delete environment variables for your environment:

    • In the Name field, specify the variable name.
    • In the Value field, specify the variable value.
    • To add an extra variable, click Add environment variable.
    • To delete a variable, hold the pointer over a variable, then click Delete item.

gcloud

Following arguments control environment variables:

  • --update-env-variables specifies a comma-separated list of environment variables to create or update.

  • --remove-env-variables specifies a comma-separated list of environment variables to delete.

  • --clear-env-variables deletes all existing environment variables.

gcloud composer environments update \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --update-env-variables=NAME=VALUE

Replace:

  • ENVIRONMENT_NAME with the name of the environment.
  • LOCATION with the region where the environment is located.
  • NAME with the name of the variable that you want to create or update.
  • VALUE with the value for the variable.
  • To add more than one variable, separate the definitions with commas: NAME=VALUE,NAME=VALUE,....

Example:

gcloud composer environments update \
  example-environment \
  --location us-central1 \
  --update-env-variables=EXAMPLE_VARIABLE=True,ANOTHER_VARIABLE=test

API

Construct an environments.patch API request.

In this request:

  1. In the updateMask parameter, specify the mask:

    • Use config.softwareConfig.envVariables mask to replace all existing variables with the specified variables. Variables that you do not specify are deleted.
    • Use config.softwareConfig.envVariables.VAR_NAME to add or update a specific variable. To add or update several variables, specify several masks with commas.

  2. In the request body, specify variables and their values:

    {
  "config": {
    "softwareConfig": {
      "envVariables": {
        "VAR_NAME": "VAR_VALUE"
      }
    }
  }
}

    Replace:

    • VAR_NAME with the name of the environment variable.
    • VAR_VALUE with the value of the environment variable.
    • To add more than one variable, add extra entries for variables to envVariables.

Example:

// PATCH https://composer.googleapis.com/v1beta1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.softwareConfig.envVariables.EXAMPLE_VARIABLE,
// config.softwareConfig.envVariables.ANOTHER_VARIABLE
{
  "config": {
    "softwareConfig": {
      "envVariables": {
        "EXAMPLE_VARIABLE": "True",
        "ANOTHER_VARIABLE": "test"
      }
    }
  }
}

Terraform

The env_variables block in the software_config block specifies environment variables.

resource "google_composer_environment" "example" {
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {

    software_config {

      env_variables = {
        VAR_NAME = "VAR_VALUE"
      }

    }
  }
}

Replace:

  • ENVIRONMENT_NAME with the name of the environment.
  • LOCATION with the region where the environment is located.
  • VAR_NAME with the name of the environment variable.
  • VAR_VALUE with the value of the environment variable.
  • To add more than one variable, add extra entries for variables to env_variables.

Example:

resource "google_composer_environment" "example" {
  name = "example-environment"
  region = "us-central1"

  config {

      env_variables = {
        EXAMPLE_VARIABLE = "True"
        ANOTHER_VARIABLE = "test"
      }

  }
}

What's next