Umgebungsvariablen festlegen

Auf dieser Seite werden die Anforderungen zum Festlegen von Umgebungsvariablen in Cloud Composer beschrieben.

Beim Erstellen oder Aktualisieren einer Umgebung können Sie Umgebungsvariablen hinzufügen, die Cloud Composer für Prozesse in Verbindung mit dem Apache Airflow-Planer, Workern und dem Webserver bereitstellt. Für E-Mail-Benachrichtigungen verwendet Cloud Composer beispielsweise das SendGrid-Modul von Apache Airflow. Zum Konfigurieren von E-Mail-Benachrichtigungen müssen Sie die Umgebungsvariablen SENDGRID_API_KEY und SENDGRID_MAIL_FROM festlegen.

Anforderungen

Umgebungsvariablen müssen dem regulären Ausdruck [a-zA-Z_][a-zA-Z0-9_]* entsprechen.

Umgebungsvariablen dürfen keine Überschreibungen der Apache Airflow-Softwarekonfiguration angeben. Variablen können also nicht das Format $AIRFLOW__{SECTION}__{KEY} oder den regulären Ausdruck AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+) verwenden.

Reservierte Namen

Die folgenden Namen sind reserviert und können nicht verwendet werden:

  • 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

Vorbereitung

  • Die folgenden Berechtigungen sind für das Festlegen von Umgebungsvariablen erforderlich:

    • composer.environments.create zum Festlegen von Umgebungsvariablen beim Erstellen der Umgebung
    • composer.environments.update zum Aktualisieren von Umgebungsvariablen

      Weitere Informationen finden Sie unter Cloud Composer-Zugriffssteuerung.

  • Für die meisten gcloud composer-Befehle ist ein Speicherort erforderlich. Sie können den Speicherort mit dem Flag --location oder durch Festlegen eines Standardspeicherorts angeben.

Umgebungsvariablen hinzufügen und aktualisieren

So legen Sie Umgebungsvariablen fest:

Console

So fügen Sie eine Umgebungsvariable hinzu:

  1. Rufen Sie in der Google Cloud Console die Seite Umgebung erstellen auf.

    Seite "Umgebung erstellen" öffnen

  2. Klicken Sie unter Knotenkonfiguration auf Umgebungsvariable hinzufügen.

  3. Geben Sie NAME und VALUE für die Umgebungsvariablen ein.

gcloud

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

Dabei gilt:

  • ENVIRONMENT_NAME ist der Name der Umgebung.
  • LOCATION ist die Compute Engine-Region, in der sich die Umgebung befindet.
  • KEY=VALUE gibt die Umgebungsvariablen an, die erstellt oder aktualisiert werden sollen.

Beispiel:

gcloud composer environments update test-environment 
--location us-central1
--update-env-variables=SENDGRID_MAIL_FROM=updated-email@domain.com

API

Wenn Sie die Cloud Composer REST API verwenden möchten, senden Sie einen environments.patch.

Umgebungsvariablen entfernen

So entfernen Sie Umgebungsvariablen:

Console

  1. Öffnen Sie die Seite Umgebungen.

    Seite "Umgebungen" öffnen

  2. Klicken Sie auf der Seite Umgebungen auflisten auf den Namen der Umgebung, zu der Details angezeigt werden sollen.
  3. Klicken Sie unter Umgebungsvariablen auf Bearbeiten.
  4. Klicken Sie rechts neben dem Variablenwert auf das Papierkorbsymbol.

gcloud

So entfernen Sie alle Umgebungsvariablen:

gcloud composer environments update ENVIRONMENT_NAME 
--location LOCATION
--clear-env-variables

Dabei gilt:

  • ENVIRONMENT_NAME ist der Name der Umgebung.
  • LOCATION ist die Compute Engine-Region, in der sich die Umgebung befindet.

Beispiel:

gcloud composer environments update test-environment 
--location us-central1
--clear-env-variables

So entfernen Sie eine Liste mit Umgebungsvariablen:

gcloud composer environments update ENVIRONMENT_NAME 
--location LOCATION
--remove-env-variables=NAME,NAME,...
Dabei gilt:

  • ENVIRONMENT_NAME ist der Name der Umgebung.
  • LOCATION ist die Compute Engine-Region, in der sich die Umgebung befindet.
  • NAME ist die Umgebungsvariable, die entfernt werden soll.

API

Wenn Sie die Cloud Composer REST API verwenden möchten, senden Sie einen environments.patch.