設定環境變數

本頁面說明在 Cloud Composer 中設定環境變數的規範。

建立或更新環境時,您可以新增環境變數,讓 Cloud Composer 提供給 Apache Airflow 排程器、工作站和網路伺服器程序。例如,針對電子郵件通知,Cloud Composer 是使用 Apache Airflow sendgrid 模組。如要設定電子郵件通知,您必須設定 SENDGRID_API_KEYSENDGRID_MAIL_FROM 環境變數。

規範

環境變數必須符合 [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

事前準備

  • 如要設定環境變數,您必須具備下列權限:

    • composer.environments.create:在建立環境時設定環境變數
    • composer.environments.update:更新環境變數

      詳情請參閱 Cloud Composer 存取權控管一文。

  • 大部分的 gcloud composer 指令都需要位置。如要指定位置,您可以使用 --location 標記或設定預設位置

新增或更新環境變數

如何設定環境變數:

主控台

如要新增環境變數,請按照下列步驟操作:

  1. 在 Google Cloud Platform 主控台中開啟「Create Environment」(建立環境) 頁面。

    開啟「Create Environment」(建立環境) 頁面

  2. 在「Node configuration」(節點設定) 底下,按一下 [Add environment variable] (新增環境變數)。

  3. 輸入環境變數的 NAMEVALUE

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

移除環境變數

如要移除環境變數,請按照下列步驟操作:

主控台

  1. 開啟「Environments」(環境) 頁面。

    開啟「Environments」(環境) 頁面

  2. 在「List Environments」(列出環境) 頁面中,按一下要查看詳細資料的環境名稱。
  3. 在「Environment Variables」(環境變數) 底下,按一下 [Edit] (編輯)。
  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

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Cloud Composer