Cloud Composer 1 | Cloud Composer 2
Panduan ini menjelaskan cara membuat pipeline CI/CD untuk menguji, menyinkronkan, dan men-deploy DAG ke lingkungan Cloud Composer Anda dari repositori GitHub Anda.
Jika Anda hanya ingin menyinkronkan data dari layanan lain, lihat Mentransfer data dari layanan lain.
Ringkasan pipeline CI/CD
Pipeline CI/CD untuk menguji, menyinkronkan, dan men-deploy DAG memiliki langkah-langkah berikut:
Anda membuat perubahan pada DAG dan mengirim perubahan tersebut ke cabang pengembangan di repositori Anda.
Anda membuka permintaan pull terhadap cabang utama repositori Anda.
Cloud Build menjalankan pengujian unit untuk memeriksa apakah DAG Anda valid.
Permintaan pull Anda disetujui dan digabungkan ke cabang utama repositori Anda.
Cloud Build menyinkronkan lingkungan Cloud Composer pengembangan Anda dengan perubahan baru tersebut.
Anda memverifikasi bahwa DAG berperilaku seperti yang diharapkan di lingkungan pengembangan Anda.
Jika DAG berfungsi seperti yang diharapkan, Anda harus mengupload DAG ke lingkungan Cloud Composer produksi.
Tujuan
Sebelum memulai
Panduan ini mengasumsikan bahwa Anda menggunakan dua lingkungan Cloud Composer yang identik: lingkungan pengembangan dan lingkungan produksi.
Untuk keperluan panduan ini, Anda mengonfigurasi pipeline CI/CD hanya untuk lingkungan pengembangan Anda. Pastikan lingkungan yang Anda gunakan bukan lingkungan produksi.
Panduan ini mengasumsikan bahwa Anda memiliki DAG dan pengujiannya disimpan di repositori GitHub.
Contoh pipeline CI/CD menunjukkan konten repositori contoh. DAG dan pengujian disimpan di direktori
dags/
, dengan file persyaratan, file batasan, dan file konfigurasi Cloud Build yang disimpan di level atas. Utilitas sinkronisasi DAG dan persyaratannya terletak di direktoriutils
.Struktur ini dapat digunakan untuk lingkungan Airflow 1, Airflow 2, Cloud Composer 1, dan Cloud Composer 2.
Membuat tugas pemeriksaan pra-pengiriman dan pengujian unit
Tugas Cloud Build pertama menjalankan pemeriksaan pra-pengiriman, yang menjalankan pengujian unit untuk DAG Anda.
Menambahkan pengujian unit
Buat pengujian unit untuk DAG Anda, jika belum melakukannya. Simpan pengujian ini bersama
DAG di repositori Anda, masing-masing dengan akhiran _test
. Misalnya, file
pengujian untuk DAG di example_dag.py
adalah example_dag_test.py
. Pengujian ini
berjalan sebagai pemeriksaan pra-pengiriman di repositori Anda.
Membuat konfigurasi YAML Cloud Build untuk pemeriksaan pra-pengiriman
Di repositori Anda, buat file YAML bernama test-dags.cloudbuild.yaml
yang mengonfigurasi tugas Cloud Build untuk pemeriksaan pra-pengiriman. Di dalamnya, ada
tiga langkah:
- Instal dependensi yang diperlukan oleh DAG Anda.
- Instal dependensi yang diperlukan oleh pengujian unit Anda.
- Jalankan pengujian DAG.
Membuat pemicu Cloud Build untuk pemeriksaan prapengiriman
Ikuti panduan Membuat repositori dari GitHub untuk membuat pemicu berbasis aplikasi GitHub dengan konfigurasi berikut:
Name:
test-dags
Peristiwa: Pull Request
Sumber - Repositori: pilih repositori Anda
Sumber - Cabang dasar:
^main$
(ubahmain
menjadi nama cabang dasar repositori Anda, jika diperlukan)Sumber - Kontrol Komentar: tidak diperlukan
Konfigurasi Build - File konfigurasi build cloud:
/test-dags.cloudbuild.yaml
(jalur ke file build Anda)
Membuat tugas sinkronisasi DAG dan menambahkan skrip utilitas DAG
Selanjutnya, konfigurasikan tugas Cloud Build yang menjalankan skrip utilitas DAG. Skrip utilitas dalam tugas ini menyinkronkan DAG Anda dengan lingkungan Cloud Composer Anda setelah digabungkan ke cabang utama dalam repositori Anda.
Menambahkan skrip utilitas DAG
Tambahkan skrip utilitas DAG ke repositori Anda. Skrip utilitas ini menyalin semua file DAG di direktori dags/
repositori Anda ke direktori sementara, dengan mengabaikan semua file Python non-DAG. Skrip tersebut kemudian menggunakan library klien Cloud Storage untuk mengupload semua file dari direktori sementara tersebut ke direktori dags/
di bucket lingkungan Cloud Composer Anda.
Membuat konfigurasi YAML Cloud Build untuk menyinkronkan DAG
Di repositori Anda, buat file YAML bernama add-dags-to-composer.cloudbuild.yaml
yang mengonfigurasi tugas Cloud Build untuk menyinkronkan DAG. Di dalamnya, ada dua langkah:
Instal dependensi yang diperlukan oleh skrip utilitas DAG.
Jalankan skrip utilitas untuk menyinkronkan DAG di repositori Anda dengan lingkungan Cloud Composer Anda.
Membuat pemicu Cloud Build
Ikuti panduan Membuat repositori dari GitHub untuk membuat pemicu berbasis aplikasi GitHub dengan konfigurasi berikut:
Name:
add-dags-to-composer
Peristiwa: Kirim ke cabang
Sumber - Repositori: pilih repositori Anda
Sumber - Cabang dasar:
^main$
(ubahmain
menjadi nama cabang dasar repositori Anda, jika diperlukan)Sumber - Filter file yang disertakan (glob):
dags/**
Konfigurasi Build - File konfigurasi build cloud:
/add-dags-to-composer.cloudbuild.yaml
(jalur ke file build Anda)
Dalam Konfigurasi lanjutan, tambahkan dua variabel substitusi:
_DAGS_DIRECTORY
- direktori tempat dags berada di repositori Anda. Jika Anda menggunakan repositori contoh dari panduan ini, kodenya adalahdags/
._DAGS_BUCKET
- bucket Cloud Storage yang berisi direktoridags/
di lingkungan Cloud Composer pengembangan Anda. Hapus awalangs://
. Contoh:us-central1-example-env-1234ab56-bucket
.
Menguji pipeline CI/CD
Di bagian ini, ikuti alur pengembangan DAG yang menggunakan pemicu Cloud Build yang baru Anda buat.
Menjalankan tugas prapengiriman
Buat permintaan pull ke cabang utama untuk menguji build Anda. Temukan pemeriksaan pra-pengiriman Anda di halaman tersebut. Klik Details dan pilih View more details on Google Cloud Build untuk melihat log build di Google Cloud Console.
Jika pemeriksaan pra-pengiriman Anda gagal, lihat Mengatasi kegagalan build.
Memvalidasi bahwa DAG berfungsi di lingkungan Cloud Composer pengembangan Anda
Setelah permintaan pull Anda disetujui, gabungkan ke cabang utama Anda. Gunakan konsol Google Cloud untuk melihat hasil build Anda. Jika memiliki banyak pemicu Cloud Build, Anda dapat memfilter build berdasarkan nama pemicu add-dags-to-composer
.
Setelah tugas sinkronisasi Cloud Build berhasil, DAG yang disinkronkan akan muncul di lingkungan Cloud Composer pengembangan Anda. Di sana, Anda dapat memvalidasi bahwa DAG berfungsi seperti yang diharapkan.
Menambahkan DAG ke lingkungan produksi
Setelah DAG berfungsi seperti yang diharapkan, tambahkan secara manual ke lingkungan
produksi Anda. Untuk melakukannya, upload file DAG ke direktori dags/
di bucket lingkungan Cloud Composer produksi Anda.
Jika tugas sinkronisasi DAG gagal atau jika DAG tidak berperilaku seperti yang diharapkan di lingkungan Cloud Composer pengembangan, lihat Mengatasi kegagalan build.
Mengatasi kegagalan build
Bagian ini menjelaskan cara mengatasi skenario kegagalan build umum.
Bagaimana jika pemeriksaan pra-pengiriman saya gagal?
Dari permintaan pull Anda, klik Details, lalu pilih View more details on Google Cloud Build untuk melihat log build di Konsol Google Cloud. Gunakan log ini untuk membantu Anda men-debug masalah pada DAG. Setelah masalahnya teratasi, lakukan perbaikan dan kirim ke cabang Anda. Pemeriksaan pra-pengiriman akan berjalan lagi, dan Anda dapat terus melakukan iterasi menggunakan log sebagai alat proses debug.
Bagaimana jika tugas sinkronisasi DAG saya gagal?
Gunakan konsol Google Cloud untuk
melihat hasil build. Jika memiliki banyak pemicu Cloud Build, Anda dapat memfilter build berdasarkan nama pemicu add-dags-to-composer
. Periksa log tugas build dan selesaikan
error. Jika Anda memerlukan bantuan lainnya untuk mengatasi error, gunakan saluran dukungan.
Bagaimana jika DAG saya tidak berfungsi dengan baik di lingkungan Cloud Composer saya?
Jika DAG tidak berfungsi seperti yang diharapkan di lingkungan Cloud Composer pengembangan, jangan promosikan DAG secara manual ke lingkungan Cloud Composer produksi Anda. Sebagai gantinya, lakukan salah satu hal berikut:
- Kembalikan permintaan pull dengan perubahan yang merusak DAG untuk memulihkannya ke status segera sebelum perubahan Anda (tindakan ini juga akan mengembalikan semua file lain dalam permintaan pull tersebut).
- Buat permintaan pull baru untuk mengembalikan perubahan secara manual pada DAG yang rusak.
- Buat permintaan pull baru untuk memperbaiki error di DAG Anda.
Mengikuti salah satu langkah ini akan memicu pemeriksaan pra-pengiriman baru dan setelah penggabungan, tugas sinkronisasi DAG.