環境変数の設定

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

環境を作成または更新するときに、Cloud Composer により Apache Airflow のスケジューラ、ワーカー、ウェブサーバー プロセスに提供される環境変数を追加できます。

たとえば、Cloud Composer では、メール通知に Apache Airflow SendGrid モジュールが使用されます。メール通知を構成するには、環境変数 SENDGRID_API_KEY と SENDGRID_MAIL_FROM を設定する必要があります。

環境変数は永続的です。環境変数を指定すると、環境からその変数が削除されるまで 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
  • 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

始める前に

  • 環境の更新オペレーションをトリガーするロールが必要です。また、環境のサービス アカウントには、更新オペレーションを実行するのに十分な権限を持つロールが必要です。詳しくは、アクセス制御をご覧ください。

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

環境変数の追加と更新

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

Console

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

  1. Google Cloud 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=updated-email@domain.com

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 を発行します。