Secret Manager für Ihre Umgebung konfigurieren

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Auf dieser Seite wird gezeigt, wie Sie mit Secret Manager Airflow-Verbindungen und -Secrets sicher speichern.

Secret Manager für Ihre Umgebung konfigurieren

In diesem Abschnitt wird beschrieben, wie Sie Secret Manager so konfigurieren, dass Sie Secrets in Ihrer Cloud Composer-Umgebung verwenden können.

Aktivieren Sie die Secret Manager API:

Console

Enable the Secret Manager API.

Enable the API

gcloud

Enable the Secret Manager API: 

gcloud services enable secretmanager.googleapis.com

Zugriffssteuerung konfigurieren

Sie müssen die Zugriffssteuerung so konfigurieren, dass Airflow auf in Secret Manager gespeicherte Secrets zugreifen kann.

Dazu muss das Dienstkonto, das auf Secrets zugreift, eine Rolle mit secretmanager.versions.access. Die Rolle Zugriffsfunktion für Secret Manager-Secret enthält beispielsweise diese Berechtigung.

Sie können diese Rolle auf Secret-, Projekt-, Ordner- oder Organisationsebene zuweisen.

Verwenden Sie eine der folgenden Optionen:

Secret Manager-Backend aktivieren und konfigurieren

  1. Überschreiben Sie die folgende Airflow-Konfigurationsoption:

    Bereich Schlüssel Wert
    secrets backend airflow.providers.google.cloud.secrets.secret_manager.CloudSecretManagerBackend

  2. Fügen Sie optionale Einstellungen hinzu, indem Sie diese Airflow-Konfigurationsoption überschreiben:

    Bereich Schlüssel Wert
    secrets backend_kwargs Weitere Informationen finden Sie in der folgenden Beschreibung.

    Der Wert backend_kwargs ist die JSON-Darstellung des backend_kwargs-Objekt durch die folgenden Felder:

    • connections_prefix: Präfix des Secret-Namens, der gelesen werden soll, um und rufen Sie Verbindungen ab. Der Standardwert ist airflow-connections.
    • variables_prefix: Präfix des zu lesenden Secret-Namens, um Variablen abzurufen. Der Standardwert ist airflow-variables.
    • gcp_key_path: Pfad zur JSON-Datei mit den Google Cloud-Anmeldedaten Wenn nicht angegeben, wird das Standarddienstkonto verwendet.
    • gcp_keyfile_dict: JSON-Wörterbuch für Google Cloud-Anmeldedaten. Schließt sich mit gcp_key_path gegenseitig aus.
    • sep: Trennzeichen, das zum Verketten von connections_prefix und conn_id verwendet wird. Der Standardwert ist -.
    • project_id: Google Cloud-Projekt-ID, unter der die Secrets gespeichert sind.

    Der Wert von backend_kwargs kann beispielsweise so aussehen: {"project_id": "<project id>", "connections_prefix":"example-connections", "variables_prefix":"example-variables", "sep":"-"}

Verbindungen und Variablen in Secret Manager hinzufügen

Folgen Sie der Anleitung unter Secrets und Versionen erstellen, um Secrets zu erstellen.

Variablen

  • Sie müssen das Format [variables_prefix][sep][variable_name] verwenden.
  • Der Standardwert für [variables_prefix] ist airflow-variables.
  • Das Standardtrennzeichen [sep] ist -

Beispiel: Wenn der Variablenname example-var lautet, lautet der Secret-Name airflow-variables-example-var.

Verbindungsnamen

  • Sie müssen das Format [connection_prefix][sep][connection_name] verwenden.
  • Der Standardwert für [connection_prefix] ist airflow-connections.
  • Das Standardtrennzeichen [sep] ist -

Wenn der Verbindungsname beispielsweise exampleConnection lautet, lautet der Secret-Name airflow-connections-exampleConnection.

Verbindungswerte

  • Muss verwendet werden URI-Darstellung. Beispiel: postgresql://login:secret@examplehost:9000

  • Der URI muss URL-codiert sein (prozentual codiert). Beispielsweise muss ein Passwort, das ein Leerzeichensymbol enthält, so URL-codiert sein: postgresql://login:secret%20password@examplehost:9000.

Airflow hat eine Convenience-Methode zum Generieren einer Verbindung URIs. Ein Beispiel für die Codierung einer komplexen URL mit JSON-Extras finden Sie in der Airflow-Dokumentation.

Secret Manager mit Cloud Composer verwenden

Beim Abrufen von Variablen und Verbindungen prüft Cloud Composer zuerst Secret Manager. Wenn die angeforderte Variable oder Verbindung nicht gefunden wird, prüft Cloud Composer die Umgebungsvariablen und die Airflow-Datenbank.

Variablen mit Jinja-Vorlagen lesen

Mit Secret Manager können Sie Variablen mit Jinja-Vorlagen für vorlagenbasierte Operatorenfelder lesen, die zum Zeitpunkt der Ausführung aufgelöst werden.

Für das Secret airflow-variables-secret_filename:

file_name = '{{var.value.secret_filename}}'

Variablen mithilfe benutzerdefinierter Operatoren und Callbacks lesen

Sie können Secret Manager auch verwenden, um Variablen in benutzerdefinierten Operatoren oder Rückrufmethoden von Operatoren zu lesen. Das Lesen von Variablen in DAGs kann sich negativ auf die Leistung auswirken. Verwenden Sie daher Jinja-Vorlagen, wenn Sie Variablen in Ihren DAGs verwenden möchten.

Zum Beispiel für das Secret airflow-variables-secret_filename:

from airflow.models.variable import Variable
file_name = Variable.get('secret_filename')

Verbindungen lesen

Wenn Sie keinen benutzerdefinierten Operator schreiben, sollten Sie selten direkt auf Verbindungen zugreifen müssen. Die meisten Hooks erhalten den Verbindungsnamen als Instanziierungsparameter und sollte Verbindungen aus dem Secret abrufen beim Ausführen von Aufgaben automatisch das Back-End.

Das direkte Lesen von Verbindungen kann beim Schreiben eines eigenen Hooks hilfreich sein.

Beispiel für die Verbindung airflow-connections-exampleConnection:

from airflow.hooks.base_hook import BaseHook
exampleConnection = BaseHook.get_connection('exampleConnection')

BaseHook.get_connection gibt ein Connection-Objekt zurück. Die URI-Stringdarstellung einer Verbindung kann so abgerufen werden:

exampleConnectionUri = BaseHook.get_connection('exampleConnection').get_uri()

Nächste Schritte