環境変数の設定

このページでは、Cloud Composer で環境変数を設定するための要件について説明します。

環境を作成または更新するときに、Cloud Composer により Apache Airflow のスケジューラ、ワーカー、ウェブサーバー プロセスに提供される環境変数を追加できます。たとえば、Cloud Composer では、メール通知に Apache Airflow SendGrid モジュールが使用されます。メール通知を構成するには、環境変数 SENDGRID_API_KEY と SENDGRID_MAIL_FROM を設定する必要があります。

注: Cloud Composer により、このページで記述されている環境変数を使用して、Apache Airflow やワークフローのランタイムでの動作が変更されます。 Cloud Composer では、Airflow の構成にこれらの環境変数を使用しません。

要件

環境変数は、正規表現 [a-zA-Z_][a-zA-Z0-9_]* と一致する必要があります。

環境変数で Apache Airflow ソフトウェア構成のオーバーライドを指定しないでください。つまり、変数は $AIRFLOW__{SECTION}__{KEY} の形式や、正規表現 AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+) と一致するものを使用できません。

予約済みの名前

次の名前は予約されているため使用できません。

• AIRFLOW_HOME
• C_FORCE_ROOT
• CONTAINER_NAME
• DAGS_FOLDER
• GCP_PROJECT
• GCS_BUCKET
• GKE_CLUSTER_NAME
• SQL_DATABASE
• SQL_INSTANCE
• SQL_PASSWORD
• SQL_PROJECT
• SQL_REGION
• SQL_USER

注: Cloud Composer で、これらの予約済みの名前は、内部プロセスで使用する変数に使用されます。ワークフローで予約済みの名前を参照しないでください。変数の値は通知することなく変更される場合があります。

始める前に

• 環境変数を設定するには、次の権限が必要になります。

  • composer.environments.create（環境の作成中に環境変数を設定するために使用します）

  • composer.environments.update（環境変数を更新するために使用します）

    詳細については、Cloud Composer のアクセス制御をご覧ください。

• ほとんどの gcloud composer コマンドにはロケーションが必要です。--location フラグを使用するかデフォルトのロケーションを設定することによりロケーションを指定できます。

環境変数の追加と更新

環境変数を設定するには、次の手順を行います。

Console

環境変数を追加するには、次の手順を行います。

1. Google Cloud Platform Console の [環境の作成] ページを開きます。

   [環境の作成] ページを開く

2. [ノード構成] で [環境変数を追加] をクリックします。

3. 環境変数に NAME と VALUE を入力します。

gcloud

gcloud composer environments update ENVIRONMENT_NAME \
  --location LOCATION \
  --update-env-variables=KEY=VALUE,KEY=VALUE...

ここで

• ENVIRONMENT_NAME は、環境の名前です。
• LOCATION は、環境が配置される Compute Engine のリージョンです。
• KEY=VALUE は、作成または更新する環境変数を指定します。

例:

gcloud composer environments update test-environment 

   --location us-central1 

   --update-env-variables=SENDGRID_MAIL_FROM=[e-mail]

API

Cloud Composer REST API を使用するには、environments.patch を発行します。

環境変数の削除

環境変数を削除するには、次の手順を行います。

Console

1. [環境] ページを開きます。

   [環境] ページを開く

2. [List Environments] ページで、環境の名前をクリックして詳細を表示します。
3. [環境変数] で [編集] をクリックします。
4. 変数値の右側にあるゴミ箱アイコンをクリックします。

gcloud

すべての環境変数を削除するには、次の手順を行います。

gcloud composer environments update ENVIRONMENT_NAME 

  --location LOCATION 

  --clear-env-variables

ここで

• ENVIRONMENT_NAME は、環境の名前です。
• LOCATION は、環境が配置される Compute Engine のリージョンです。

例:

gcloud composer environments update test-environment 

   --location us-central1 

   --clear-env-variables

環境変数のリストを削除するには、次の手順を行います。

gcloud composer environments update ENVIRONMENT_NAME 

  --location LOCATION 

  --remove-env-variables=NAME,NAME,...

ここで

• ENVIRONMENT_NAME は、環境の名前です。
• LOCATION は、環境が配置される Compute Engine のリージョンです。
• NAME は削除する環境変数です。

API

Cloud Composer REST API を使用するには、environments.patch を発行します。