Umgebungsvariablen verwenden

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

Umgebungsvariablen werden als beliebige Schlüssel/Wert-Paare von Strings festgelegt und sind für den Workflow zur Laufzeit zugänglich. Sie werden im Workflows-Backend gespeichert, sind auf die Workflowausführung beschränkt und während der Ausführung eines Workflows unveränderlich.

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

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

Reservierte Namen

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

Die folgenden Variablen können nicht für Workflows verwendet werden:

Umgebungsvariablen festlegen

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

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

Mehrere Umgebungsvariablen festlegen

Wenn Sie mehrere Umgebungsvariablen festlegen möchten, verwenden Sie eine durch Kommas getrennte Liste:

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, z. B. @, wenn Ihre Variablenwerte Kommas enthalten:

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 Versionskontrolle), 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, die die Definitionen für Ihre Umgebungsvariablen enthält. Die Variablennamen und ‑werte müssen Strings sein. 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

Wenn Sie auf eine Umgebungsvariable zugreifen möchten, rufen Sie in einem Ausdruck die Funktion sys.get_env() 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 Workflowvariablen mit dem Namen 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.

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

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.

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

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 von Ihrem Quellcode und Ihren Umgebungsvariablen gespeichert und nicht versehentlich an Protokolle gesendet werden.

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

Namenskonventionen

Als allgemeine Regel empfehlen wir, dass Schlüssel von Umgebungsvariablen ausschließlich aus Großbuchstaben, Ziffern und Unterstrichen (_) bestehen und nicht mit einer Ziffer beginnen. Sie sollten Ihren benutzerdefinierten Umgebungsvariablen ein eindeutiges Präfix voranstellen, 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

• Workflow ausführen
• Laufzeitargumente in einer Ausführungsanfrage übergeben