Mengonfigurasi Secret Manager untuk lingkungan Anda

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

Halaman ini menunjukkan cara menggunakan Secret Manager untuk menyimpan koneksi dan secret Airflow dengan aman.

Mengonfigurasi Secret Manager untuk lingkungan Anda

Bagian ini menjelaskan cara mengonfigurasi Secret Manager agar Anda dapat menggunakan secret dengan lingkungan Cloud Composer.

Mengaktifkan Secret Manager API

Konsol

Enable the Secret Manager API.

Enable the API

gcloud

Enable the Secret Manager API: 

gcloud services enable secretmanager.googleapis.com

Mengonfigurasi kontrol akses

Anda harus mengonfigurasi kontrol akses agar Airflow dapat mengakses secret yang disimpan di Secret Manager.

Untuk melakukannya, akun layanan yang mengakses secret harus memiliki peran dengan izin secretmanager.versions.access. Misalnya, peran Secret Manager Secret Accessor mencakup izin ini.

Anda dapat memberikan peran ini di tingkat Secret, Project, Folder, atau Org.

Gunakan salah satu opsi berikut:

Mengaktifkan dan mengonfigurasi backend Secret Manager

  1. Ganti opsi konfigurasi Airflow berikut:

    Bagian Kunci Nilai
    secrets backend airflow.providers.google.cloud.secrets.secret_manager.CloudSecretManagerBackend

  2. (Cloud Composer 2.11.3 dengan Airflow 2.10.2 dan versi yang lebih baru) Pastikan opsi konfigurasi Airflow [secrets]backends_order menentukan urutan penelusuran secret yang memiliki backend secret custom di dalamnya. Nilai default opsi ini sudah berisi nilai ini.

    Bagian Kunci Nilai
    secrets backends_order (default) custom,environment_variable,metastore

  3. Tambahkan setelan opsional dengan mengganti opsi konfigurasi Airflow berikut:

    Bagian Kunci Nilai
    secrets backend_kwargs Lihat deskripsi berikut.

    Nilai backend_kwargs adalah representasi JSON dari objek backend_kwargs dengan kolom berikut:

    • connections_prefix: awalan nama secret yang akan dibaca untuk mendapatkan Koneksi. Defaultnya adalah airflow-connections.
    • variables_prefix: awalan nama secret yang akan dibaca untuk mendapatkan Variabel. Defaultnya adalah: airflow-variables.
    • gcp_key_path: jalur ke file JSON Kredensial Google Cloud (jika tidak diberikan, akun layanan default akan digunakan).
    • gcp_keyfile_dict: Google Cloud Kamus JSON kredensial. Tidak dapat muncul bersamaan dengan gcp_key_path.
    • sep: pemisah yang digunakan untuk menggabungkan connections_prefix dan conn_id. Defaultnya adalah -.
    • project_id: Google Cloud Project ID tempat secret disimpan.

    Misalnya, nilai backend_kwargs dapat berupa: {"project_id": "<project id>", "connections_prefix":"example-connections", "variables_prefix":"example-variables", "sep":"-"}.

Menambahkan koneksi dan variabel di Secret Manager

Buat secret dengan mengikuti langkah-langkah yang diuraikan dalam Membuat secret dan versi.

Variabel

  • Harus menggunakan format [variables_prefix][sep][variable_name].
  • Nilai default untuk [variables_prefix] adalah airflow-variables.
  • Pemisah default [sep] adalah -.

Misalnya, jika nama variabelnya adalah example-var, maka nama secret-nya adalah airflow-variables-example-var.

Nama koneksi

  • Harus menggunakan format [connection_prefix][sep][connection_name].
  • Nilai default untuk [connection_prefix] adalah airflow-connections.
  • Pemisah default [sep] adalah -.

Misalnya, jika nama koneksinya adalah exampleConnection, maka nama secret-nya adalah airflow-connections-exampleConnection.

Nilai koneksi

  • Harus menggunakan representasi URI. Contoh, postgresql://login:secret@examplehost:9000.

  • URI harus berenkode URL (berenkode persen). Misalnya, sandi yang memiliki simbol spasi di dalamnya harus dienkode ke URL sebagai berikut: postgresql://login:secret%20password@examplehost:9000.

Airflow memiliki metode praktis untuk membuat URI koneksi. Contoh cara mengenkode URL kompleks dengan ekstra JSON tersedia di dokumentasi Airflow.

Menggunakan Secret Manager dengan Cloud Composer

Saat mengambil variabel dan koneksi, Cloud Composer akan memeriksa Secret Manager terlebih dahulu. Jika variabel atau koneksi yang diminta tidak ditemukan, Cloud Composer akan memeriksa variabel lingkungan dan database Airflow.

Membaca variabel menggunakan template Jinja

Anda dapat menggunakan Secret Manager untuk membaca variabel dengan template Jinja untuk kolom operator yang dibuat dengan template (diselesaikan pada waktu eksekusi).

Untuk rahasia airflow-variables-secret_filename:

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

Membaca variabel menggunakan operator dan callback kustom

Anda juga dapat menggunakan Secret Manager untuk membaca variabel di operator kustom atau metode callback dari operator. Membaca variabel dari dalam DAG dapat berdampak negatif pada performa, jadi gunakan template Jinja jika Anda ingin menggunakan variabel dalam DAG.

Misalnya, untuk rahasia airflow-variables-secret_filename:

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

Membaca koneksi

Kecuali jika Anda menulis operator kustom, Anda jarang perlu mengakses koneksi secara langsung. Sebagian besar hook mendapatkan nama koneksi sebagai parameter instansiasi, dan harus mengambil koneksi dari backend rahasia secara otomatis saat tugas dijalankan.

Membaca saran koneksi secara langsung dapat berguna saat menulis saran koneksi Anda sendiri.

Misalnya, untuk koneksi airflow-connections-exampleConnection:

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

BaseHook.get_connection menampilkan objek Connection. Anda dapat memperoleh representasi string URI koneksi seperti ini:

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

Langkah berikutnya