Cloud Composer 1 | Cloud Composer 2
このページでは、Cloud Composer 環境で環境変数を設定する方法について説明します。
Cloud Composer は、環境変数を使用して Airflow や DAG のランタイム動作を変更します。
環境変数は永続的な変数です。環境変数を指定すると、環境から変数を削除するまで Airflow によって引き続き使用されます。
たとえば、Cloud Composer では、メール通知に Apache Airflow SendGrid モジュールが使用されます。メール通知を構成するには、環境変数 SENDGRID_API_KEY
と SENDGRID_MAIL_FROM
を設定する必要があります。
名前の形式
環境変数は、正規表現 [a-zA-Z_][a-zA-Z0-9_]*
と一致する必要があります。
環境変数で Apache Airflow 構成のオーバーライドを指定しないでください。 つまり、変数は AIRFLOW__{SECTION}__{KEY}
の形式や、正規表現 AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+
と一致するものを使用できません。
予約済みの変数
次の名前は予約されているため使用できません。
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
SQL_DATABASE
SQL_INSTANCE
SQL_HOST
SQL_PASSWORD
SQL_PROJECT
SQL_REGION
SQL_USER
新しい環境に環境変数を設定する
環境変数は、環境の作成時に指定できます。詳細については、環境を作成するをご覧ください。
既存の環境に環境変数を設定する
Console
既存の環境に環境変数を設定するには、次の手順を行います。
Google Cloud Console で [環境] ページに移動します。
環境のリストで、ご利用の環境の名前をクリックします。[環境の詳細] ページが開きます。
[環境変数] タブに移動し、[編集] をクリックします。
ご利用の環境の環境変数を追加、変更、または削除します。
- [名前] フィールドで、変数名を指定します。
- [値] フィールドで、変数の値を指定します。
- 変数をさらに追加するには、[環境変数を追加] をクリックします。
- 変数を削除するには、変数の上にポインタを置き、[項目を削除] をクリックします。
gcloud
次の引数で環境変数を制御します。
--update-env-variables
は、作成または更新する環境変数のカンマ区切りのリストを指定します。--remove-env-variables
には、削除する環境変数のカンマ区切りのリストを指定します。--clear-env-variables
は既存の環境変数をすべて削除します。
gcloud composer environments update \
ENVIRONMENT_NAME \
--location LOCATION \
--update-env-variables=NAME=VALUE
次のように置き換えます。
ENVIRONMENT_NAME
を環境の名前にする。LOCATION
は、環境が配置されているリージョン。NAME
は、作成または更新する変数の名前に置き換えます。VALUE
を変数の値に置き換えます。- 複数の変数を追加するには、定義をカンマで区切ります(
NAME=VALUE,NAME=VALUE,...
)。
例:
gcloud composer environments update \
example-environment \
--location us-central1 \
--update-env-variables=EXAMPLE_VARIABLE=True,ANOTHER_VARIABLE=test
API
environments.patch
API リクエストを作成します。
このリクエストで次のように操作します。
updateMask
パラメータで、マスクを指定します。config.softwareConfig.envVariables
マスクを使用して、既存のすべての変数を指定の変数に置き換えます。指定しない変数は削除されます。config.softwareConfig.envVariables.VAR_NAME
を使用して、特定の変数を追加または更新します。複数の変数を追加または更新するには、複数のマスクをカンマで区切って指定します。
リクエストの本文で、変数とその値を指定します。
{ "config": { "softwareConfig": { "envVariables": { "VAR_NAME": "VAR_VALUE" } } } }
次のように置き換えます。
VAR_NAME
は環境変数の名前に置き換えます。VAR_VALUE
は環境変数の値に置き換えます。- 複数の変数を追加するには、変数のエントリを
envVariables
に追加します。
例:
// 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
software_config
ブロックの env_variables
ブロックは、環境変数を指定します。
resource "google_composer_environment" "example" {
name = "ENVIRONMENT_NAME"
region = "LOCATION"
config {
software_config {
env_variables = {
VAR_NAME = "VAR_VALUE"
}
}
}
}
次のように置き換えます。
ENVIRONMENT_NAME
を環境の名前にする。LOCATION
は、環境が配置されているリージョン。VAR_NAME
は環境変数の名前に置き換えます。VAR_VALUE
は環境変数の値に置き換えます。- 複数の変数を追加するには、変数のエントリを
env_variables
に追加します。
例:
resource "google_composer_environment" "example" {
name = "example-environment"
region = "us-central1"
config {
env_variables = {
EXAMPLE_VARIABLE = "True"
ANOTHER_VARIABLE = "test"
}
}
}