Umgebungsvariablen verwenden

Sie können Umgebungsvariablen für Workflows bei der Bereitstellung definieren. Sie können beispielsweise einen Workflow erstellen, der je nach Umgebung, in der er bereitgestellt wird, dynamisch konfiguriert wird. Oder Sie können einen Workflow erstellen, der als Vorlage wiederverwendet und gemäß separat verwalteten Umgebungsvariablen konfiguriert werden kann.

Umgebungsvariablen werden als beliebige Schlüssel/Wert-Stringpaare festgelegt, auf die Ihr Workflow zur Laufzeit zugreifen kann. Sie werden im Workflows-Backend gespeichert, sind auf die Workflow-Ausführung beschränkt und können während der Ausführung eines Workflows nicht geändert werden.

Alle Umgebungsvariablen sind an eine Bereitstellung eines Workflows gebunden und können nur mit einer Bereitstellung festgelegt oder geändert werden. Das Erstellen oder Ändern einer Umgebungsvariablen erfordert eine erfolgreiche Bereitstellung. Wenn eine Bereitstellung aus irgendeinem Grund fehlschlägt, werden Änderungen an Umgebungsvariablen nicht angewendet.

Sie können benutzerdefinierte Umgebungsvariablen mit der Google Cloud CLI hinzufügen, aktualisieren oder entfernen.

Reservierte Namen

Die integrierten Umgebungsvariablen die für Workflows definiert sind, sind reserviert und können nicht festgelegt werden.

Beachten Sie, dass Sie Folgendes nicht verwenden können, wenn Sie Umgebungsvariablen für Workflows definieren:

Schlüssel Beschreibung
Leer ('') Schlüssel dürfen keine leeren Strings sein.
GOOGLE_ Schlüssel dürfen nicht das Präfix GOOGLE_ enthalten.
WORKFLOWS_ Schlüssel dürfen nicht das Präfix WORKFLOWS_ enthalten.

Umgebungsvariablen festlegen

Sie können beim Bereitstellen eines Workflows neue Variablen definieren oder vorhandene Variablen ersetzen. Informationen zu additiven Änderungen finden Sie stattdessen unter Umgebungsvariablen aktualisieren.

Console

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

    Zur Seite "Workflows"

  2. Klicken Sie auf der Seite Workflows auf Erstellen.

  3. Füllen Sie auf der Seite Workflow erstellen die entsprechenden Felder aus, um die Workflow-Definition zu konfigurieren.

  4. Klicken Sie im Bereich Umgebungsvariablen (optional) auf Variable hinzufügen.

  5. Geben Sie im Feld Name 1 den Variablennamen an.

  6. Geben Sie im Feld Wert 1 den Variablenwert an.

  7. Wenn Sie eine weitere Variable hinzufügen möchten, klicken Sie auf Variable hinzufügen.

  8. Klicken Sie auf Weiter.

  9. Nachdem Sie Ihren Workflow definiert haben, klicken Sie auf Bereitstellen, um ihn bereitzustellen.

gcloud

Verwenden Sie das Flag --set-env-vars, um eine Umgebungsvariable festzulegen:

gcloud workflows deploy WORKFLOW_NAME \
    --set-env-vars KEY1=VALUE1

Ersetzen Sie Folgendes:

  • WORKFLOW_NAME: die ID Ihres Workflows.
  • KEY1=VALUE1: der Name der Umgebungsvariablen und ihr Wert, z. B. MONTH=January.

Terraform

Verwenden Sie die google_workflows_workflow Ressource , um einen Workflow zu erstellen, und ändern Sie die main.tf Datei wie im Beispiel gezeigt. Weitere Informationen finden Sie unter siehe Workflow mit Terraform erstellen.

Verwenden Sie das Argument user_env_vars, um eine Umgebungsvariable mit der Workflow-Überarbeitung zu verknüpfen.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

Mehrere Umgebungsvariablen festlegen

Verwenden Sie eine durch Kommas getrennte Liste, um mehrere Umgebungsvariablen festzulegen:

gcloud workflows deploy WORKFLOW_NAME \
      --set-env-vars KEY1=VALUE1,KEY2=VALUE2

Escape-Zeichen

Da das Komma (,) verwendet wird, um Umgebungsvariablen zu trennen, müssen Sie ein anderes Trennzeichen angeben, wenn Ihre Variablenwerte Kommas enthalten, z. B. @:

gcloud workflows deploy WORKFLOW_NAME \
      --set-env-vars ^@^KEY1=VALUE1,VALUE2,VALUE3@KEY2=VALUE2

Variablen in einer Datei speichern

Wenn Sie Ihre Variablen in einer Datei speichern möchten (z. B. unter der Versionsverwaltung), verwenden Sie eine YAML-Datei und das Flag --env-vars-file:

gcloud workflows deploy WORKFLOW_NAME \
      --env-vars-file FILE_PATH

Ersetzen Sie FILE_PATH durch den Pfad zu einer lokalen YAML-Datei, in der die Definitionen für Ihre Umgebungsvariablen aufgeführt sind. Beachten Sie, dass die Variablennamen und -werte Strings sein müssen. Alle vorhandenen Umgebungsvariablen werden von Workflows entfernt, bevor die neuen Umgebungsvariablen hinzugefügt werden.

Der Inhalt der YAML-Datei könnte beispielsweise so aussehen:

KEY1: "value1"
KEY2: "value2"

Weitere Informationen zum Befehl deploy finden Sie unter gcloud workflows deploy.

Auf Umgebungsvariablen zugreifen

Um auf eine Umgebungsvariable zuzugreifen, rufen Sie in einem sys.get_env() Ausdruck die Funktion auf und übergeben Sie den Namen der Umgebungsvariablen als Parameter. Der Name der Umgebungsvariablen muss als String übergeben werden.

Im folgenden Workflow wird beispielsweise der Wert der Umgebungsvariablen KEY1 einer Workflow-Variablen namens keyValue zugewiesen und dann ausgegeben:

main:
  steps:
    - init:
        assign:
          - keyValue: ${sys.get_env("KEY1")}
    - returnResult:
        return: ${keyValue}

Umgebungsvariablen aktualisieren

Sie können benutzerdefinierte Umgebungsvariablen für vorhandene Workflows aktualisieren. Bei diesem nicht destruktiven Ansatz werden Umgebungsvariablen geändert oder hinzugefügt, jedoch nicht gelöscht.

Console

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

    Zur Seite "Workflows"

  2. Klicken Sie auf den Namen des Workflows, den Sie aktualisieren möchten.

    Die Seite Workflowdetails wird angezeigt.

  3. Führen Sie einen der folgenden Schritte aus, um eine vorhandene Umgebungsvariable zu bearbeiten:

    • Klicken Sie auf den Tab Details.

      1. Klicken Sie neben Umgebungsvariablen auf das Symbol.
      2. Nehmen Sie die gewünschten Änderungen vor.
      3. Klicken Sie auf Speichern, um den aktualisierten Workflow bereitzustellen.

    • Klicken Sie auf „Bearbeiten“ Bearbeiten.

      1. Nehmen Sie im Bereich Umgebungsvariablen (optional) die gewünschten Änderungen vor.
      2. Klicken Sie auf Weiter und dann auf Bereitstellen, um den aktualisierten Workflow bereitzustellen.

gcloud

Verwenden Sie das Flag --update-env-vars, um eine Variable zu aktualisieren:

gcloud workflows deploy WORKFLOW_NAME \
    --update-env-vars KEY1=VALUE1

Verwenden Sie eine durch Kommas getrennte Liste, um mehrere Umgebungsvariablen zu aktualisieren:

gcloud workflows deploy WORKFLOW_NAME \
    --update-env-vars KEY1=VALUE1,KEY2=VALUE2

Umgebungsvariablen löschen

Sie können benutzerdefinierte Umgebungsvariablen für vorhandene Workflows löschen.

Console

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

    Zur Seite "Workflows"

  2. Klicken Sie auf den Namen des Workflows, den Sie aktualisieren möchten.

    Die Seite Workflowdetails wird angezeigt.

  3. Führen Sie einen der folgenden Schritte aus, um eine vorhandene Umgebungsvariable zu löschen:

    • Klicken Sie auf den Tab Details.

      1. Klicken Sie auf die entsprechende .
      2. Klicken Sie neben der Umgebungsvariablen, die Sie löschen möchten, auf das Symbol.
      3. Klicken Sie auf Speichern, um den aktualisierten Workflow bereitzustellen.

    • Klicken Sie auf „Bearbeiten“ Bearbeiten.

      1. Klicken Sie neben der Umgebungsvariablen, die Sie löschen möchten, auf das Symbol.
      2. Klicken Sie auf Weiter und dann auf Bereitstellen, um den aktualisierten Workflow bereitzustellen.

gcloud

Wenn Sie Umgebungsvariablen selektiv entfernen möchten, verwenden Sie das Flag --remove-env-vars:

gcloud workflows deploy WORKFLOW_NAME \
    --remove-env-vars KEY1,KEY2

Alternativ können Sie alle zuvor festgelegten Umgebungsvariablen mit dem Flag --clear-env-vars löschen:

gcloud workflows deploy WORKFLOW_NAME \
    --clear-env-vars

Best Practices

Als Best Practice empfehlen wir Ihnen, sich nicht auf Umgebungsvariablen zu verlassen und keine Umgebungsvariablen zu ändern, die Sie nicht explizit festgelegt haben. Wenn Sie andere Umgebungsvariablen als die von Ihnen explizit festgelegten ändern, kann dies zu unbeabsichtigten Folgen führen.

Secrets verwalten

Umgebungsvariablen können zum Konfigurieren von Workflows verwendet werden. Zum Speichern und Verwenden von Secrets wie Datenbankanmeldedaten oder API-Schlüsseln werden sie jedoch nicht empfohlen. Diese vertraulichen Werte sollten getrennt vom Quellcode und von Umgebungsvariablen gespeichert und nicht versehentlich an Logs gesendet werden.

Für das Speichern von Secrets empfehlen wir Ihnen, die Best Practices für die Verwaltung von Secretszu lesen und der Anleitung zur Verwendung von Secret Manager mit Workflowszu folgen.

Namenskonventionen

Als allgemeine Regel sollten Schlüssel von Umgebungsvariablen ausschließlich aus Großbuchstaben, Ziffern und Unterstrichen (_) bestehen und nicht mit einer Ziffer beginnen. Setzen Sie vor Ihre benutzerdefinierten Umgebungsvariablen einen eindeutigen Schlüssel, um Konflikte mit anderen Variablen zu vermeiden.

Größenbeschränkungen

Es können maximal 20 benutzerdefinierte Umgebungsvariablen definiert werden. Jeder Definitionsstring (KEY=value) ist auf 4 KiB begrenzt.

Nächste Schritte