Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
Apache Airflow memiliki antarmuka REST API yang dapat Anda gunakan untuk melakukan tugas seperti mendapatkan informasi tentang tugas dan operasi DAG, memperbarui DAG, mendapatkan konfigurasi Airflow, menambahkan dan menghapus koneksi, serta mencantumkan pengguna.
Untuk mengetahui contoh penggunaan Airflow REST API dengan fungsi Cloud Run, lihat artikel Memicu DAG dengan fungsi Cloud Run.
Versi Airflow REST API
- Airflow 2 menggunakan REST API stabil.
- REST API eksperimental tidak digunakan lagi oleh Airflow.
Mengonfigurasi REST API Airflow yang stabil
REST API stabil diaktifkan secara default di Airflow 2. Cloud Composer menggunakan backend autentikasi API-nya sendiri.
Otorisasi berfungsi dengan cara standar yang disediakan oleh Airflow. Saat pengguna baru memberikan otorisasi melalui API, akun pengguna tersebut akan mendapatkan peran Op
secara default.
Anda dapat mengaktifkan atau menonaktifkan REST API stabil, atau mengubah peran pengguna default dengan mengganti opsi konfigurasi Airflow berikut:
Bagian | Kunci | Nilai | Catatan |
---|---|---|---|
api
|
auth_backends
|
airflow.composer.api.backend.composer_auth
|
Untuk menonaktifkan REST API stabil, ubah ke
airflow.api.auth.backend.deny_all |
api
|
composer_auth_user_registration_role
|
Op
|
Anda dapat menentukan peran lainnya. |
Mengizinkan panggilan API ke Airflow REST API menggunakan kontrol akses server web
Bergantung pada metode yang digunakan untuk memanggil Airflow REST API, metode pemanggil dapat menggunakan alamat IPv4 atau IPv6. Jangan lupa untuk berhenti memblokir traffic IP ke Airflow REST API menggunakan kontrol akses server web.
Gunakan opsi konfigurasi default yang merupakan
All IP addresses have access (default)
jika Anda tidak yakin dari alamat IP mana
panggilan Anda ke Airflow REST API akan dikirim.
Melakukan panggilan ke Airflow REST API
Bagian ini memberikan contoh skrip Python yang dapat Anda gunakan untuk memicu DAG dengan Airflow REST API yang stabil.
Masukkan konten contoh berikut ke dalam file bernama
composer2_airflow_rest_api.py
, lalu tetapkan variabel berikut:
dag_id
: nama DAG, seperti yang ditentukan dalam file sumber DAG.dag_config
: konfigurasi untuk operasi DAG.web_server_url
: URL server web Airflow Anda. Formatnya adalahhttps://<web-server-id>.composer.googleusercontent.com
.
Mengakses Airflow REST API menggunakan akun layanan
Database Airflow membatasi panjang kolom email hingga 64 karakter. Akun layanan terkadang memiliki alamat email yang lebih panjang dari 64 karakter. Anda tidak dapat membuat pengguna Airflow untuk akun layanan tersebut dengan cara biasa. Jika tidak ada pengguna Airflow untuk akun layanan tersebut, mengakses Airflow REST API akan menghasilkan error HTTP 401 dan 403.
Sebagai solusi, Anda dapat melakukan prapendaftaran pengguna Airflow untuk akun layanan. Untuk
melakukannya, gunakan accounts.google.com:NUMERIC_USER_ID
sebagai nama pengguna, dan string unik
apa pun sebagai email.
Untuk mendapatkan
NUMERIC_USER_ID
untuk akun layanan, jalankan:gcloud iam service-accounts describe \ SA_NAME@PROJECT_ID.iam.gserviceaccount.com \ --format="value(oauth2ClientId)"
Ganti:
SA_NAME
dengan nama akun layanan.PROJECT_ID
dengan Project ID.
Buat pengguna Airflow dengan peran
Op
untuk akun layanan:UI Airflow
Buka Keamanan > Daftar Pengguna, lalu klik Tambahkan data baru. Pengguna Airflow Anda harus memiliki peran
Admin
untuk membuka halaman ini.Tentukan
accounts.google.com:NUMERIC_USER_ID
sebagai nama pengguna. GantiNUMERIC_USER_ID
dengan ID pengguna yang diperoleh di langkah sebelumnya.Tentukan ID unik sebagai email. Anda dapat menggunakan string unik apa pun.
Tentukan peran untuk pengguna. Misalnya,
Op
.Pastikan kotak centang Aktif? dicentang.
Tentukan nama depan dan nama belakang untuk pengguna. Anda dapat menggunakan string apa pun.
Klik Simpan.
gcloud
Jalankan perintah Airflow CLI berikut:
gcloud composer environments run ENVIRONMENT_NAME \ --location LOCATION \ users create -- \ -u accounts.google.com:NUMERIC_USER_ID \ -e UNIQUE_ID \ -f UNIQUE_ID \ -l - -r Op --use-random-password
Ganti:
ENVIRONMENT_NAME
dengan nama lingkungan.LOCATION
dengan region tempat lingkungan tersebut berada.NUMERIC_USER_ID
dengan ID pengguna yang diperoleh di langkah sebelumnya.UNIQUE_ID
dengan ID untuk pengguna Airflow. Anda dapat menggunakan string unik apa pun.
Setelah Anda membuat pengguna Airflow untuk akun layanan, pemanggil yang diautentikasi sebagai akun layanan akan dikenali sebagai pengguna yang terdaftar sebelumnya, dan login ke Airflow.
Menskalakan komponen Airflow REST API
Endpoint Airflow REST API dan UI Airflow dijalankan dalam server web Airflow. Jika Anda menggunakan REST API secara intensif, pertimbangkan untuk meningkatkan jumlah CPU dan memori yang tersedia untuk server web Airflow, berdasarkan beban yang diharapkan.