Merutekan peristiwa Firebase Realtime Database ke GKE

Pemicu Eventarc mendeklarasikan minat Anda pada peristiwa atau kumpulan peristiwa tertentu. Anda dapat mengonfigurasi perutean peristiwa dengan menentukan filter untuk pemicu, termasuk sumber peristiwa, dan layanan Google Kubernetes Engine (GKE) target yang berjalan di cluster GKE. Perlu diperhatikan bahwa target hanya dapat menyertakan layanan yang berjalan di cluster GKE (publik atau pribadi) dengan endpoint publik. Untuk menargetkan layanan di cluster GKE dengan endpoint pribadi, rutekan peristiwa ke endpoint HTTP internal.

Eventarc mengirimkan peristiwa ke penerima peristiwa dalam format CloudEvents melalui permintaan HTTP.

Petunjuk ini menunjukkan cara mengonfigurasi perutean peristiwa ke layanan GKE yang dipicu oleh peristiwaFirebase Realtime Database langsung. Untuk detail selengkapnya, lihat daftar peristiwa langsung yang didukung.

Sebelum memulai

Anda harus mengaktifkan Workload Identity Federation for GKE di cluster GKE tempat layanan tujuan dijalankan. Workload Identity Federation untuk GKE diperlukan untuk menyiapkan forwarder peristiwa dengan benar dan merupakan cara yang direkomendasikan untuk mengakses Google Cloud layanan dari aplikasi yang berjalan dalam GKE karena properti keamanan dan pengelolaannya yang lebih baik.

Peristiwa Eventarc ke arsitektur target GKE

Workload Identity Federation for GKE

Aplikasi yang berjalan di GKE mungkin memerlukan akses ke Google Cloud API. Dengan Workload Identity Federation for GKE, akun layanan Kubernetes di cluster GKE Anda dapat berfungsi sebagai akun layanan IAM. Pod yang menggunakan akun layanan Kubernetes yang dikonfigurasi akan otomatis melakukan autentikasi sebagai akun layanan IAM saat mengakses Google Cloud API. Dengan menggunakan Workload Identity Federation untuk GKE, Anda dapat menetapkan identitas dan otorisasi yang berbeda dan terperinci untuk setiap aplikasi di cluster Anda. Perhatikan bahwa izin khusus harus diberikan ke akun layanan pemicu Eventarc. Dalam dokumen ini, lihat langkah-langkah untuk Membuat akun layanan.

Untuk mengetahui informasi lebih lanjut tentang cara mengaktifkan dan mengonfigurasi Workload Identity Federation untuk GKE pada cluster GKE Anda, lihat Menggunakan Workload Identity Federation untuk GKE.

Penerusan peristiwa

Forwarder peristiwa Eventarc mengambil peristiwa baru dari Eventarc dan meneruskannya ke tujuan GKE. Komponen ini bertindak sebagai mediator antara lapisan transpor Pub/Sub dan layanan GKE. Fitur ini berfungsi pada layanan yang sudah ada dan juga mendukung layanan pemberian sinyal (termasuk layanan yang tidak diekspos di luar cluster yang terkelola sepenuhnya) sekaligus menyederhanakan penyiapan dan pemeliharaan. Di tingkat jaringan, untuk menerima peristiwa di layanan GKE, Anda tidak perlu membuka layanan ke traffic eksternal karena semua peristiwa dikirim dari origin yang berada dalam cluster GKE yang sama.

Perhatikan bahwa siklus proses penerus peristiwa dikelola oleh Eventarc, dan jika Anda tidak sengaja menghapus penerus peristiwa, Eventarc akan memulihkan komponen ini.

Untuk setiap pemicu yang mengarah ke tujuan GKE, penerusan peristiwa (pod gke-forwarder yang dikonfigurasi secara khusus) akan melakukan hal berikut:

  1. Library ini menggunakan Pub/Sub API untuk membuka koneksi StreamingPull ke pengangkut pemicu (topik dan langganan Pub/Sub) dan menerima peristiwa saat tersedia.

  2. Layanan ini mengubah peristiwa ke dalam format CloudEvents yang benar, mengenkode, dan mengirimkannya sebagai permintaan HTTP POST ke layanan GKE target.

Agen layanan Eventarc memerlukan izin untuk berjalan dan memperbarui instance gke-forwarder secara rutin. Izin ini harus diberikan sekali per project. Untuk mengetahui detailnya, dalam dokumen ini, lihat Mengaktifkan tujuan GKE.

Bersiap untuk membuat pemicu

Untuk setiap pemicu yang menargetkan layanan GKE, Eventarc membuat komponen penerus peristiwa. Eventarc memerlukan izin untuk menginstal komponen dan mengelola resource di cluster GKE. Sebelum membuat pemicu Eventarc untuk tujuan GKE, pastikan Anda menyelesaikan tugas-tugas berikut.

Konsol

  1. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat Google Cloud project.

    Buka pemilih project

  2. Aktifkan Eventarc, Eventarc Publishing, Google Kubernetes Engine, dan Resource Manager API.

    Mengaktifkan API

  3. Jika memungkinkan, aktifkan API yang terkait dengan peristiwa langsung. Misalnya, untuk Firebase Realtime Database peristiwa, aktifkan Firebase Realtime Database API.

  4. Jika Anda belum memilikinya, buat akun layanan yang dikelola pengguna, lalu berikan peran dan izin yang diperlukan agar Eventarc dapat mengelola peristiwa untuk layanan target Anda.

    1. Di konsol Google Cloud, buka halaman Create service account.

      Buka Buat akun layanan

    2. Pilih project Anda.

    3. Di kolom Nama akun layanan, masukkan nama. Konsol Google Cloud akan mengisi kolom ID akun layanan berdasarkan nama ini.

      Di kolom Deskripsi akun layanan, masukkan sebuah deskripsi. Contoh, Service account for event trigger.

    4. Klik Buat dan lanjutkan.

    5. Untuk memberikan akses yang sesuai, pada daftar Select a role, pilih peran Identity and Access Management (IAM) yang diperlukan untuk diberikan ke akun layanan Anda. Untuk informasi selengkapnya, lihat Peran dan izin untuk target GKE.

      Untuk peran tambahan, klik Tambahkan peran lain, lalu tambahkan setiap peran tambahan.

    6. Klik Lanjutkan.

    7. Untuk menyelesaikan pembuatan akun, klik Selesai.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Aktifkan Eventarc, Eventarc Publishing, Google Kubernetes Engine, dan Resource Manager API.

    gcloud services enable eventarc.googleapis.com \
    eventarcpublishing.googleapis.com \
    container.googleapis.com \
    cloudresourcemanager.googleapis.com

  3. Jika memungkinkan, aktifkan API yang terkait dengan peristiwa langsung. Misalnya, untuk Firebase Realtime Database peristiwa, aktifkan firebasedatabase.googleapis.com.

  4. Jika Anda belum memilikinya, buat akun layanan yang dikelola pengguna, lalu berikan peran dan izin yang diperlukan agar Eventarc dapat mengelola peristiwa untuk tujuan GKE target Anda.

    1. Buat akun layanan:

      gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

      Ganti SERVICE_ACCOUNT_NAME dengan nama akun layanan. Panjangnya harus antara 6 hingga 30 karakter, serta dapat berisi karakter alfanumerik huruf kecil dan tanda hubung. Setelah membuat akun layanan, Anda tidak dapat mengubah namanya.

    2. Memberikan peran atau izin Identity and Access Management (IAM) yang diperlukan. Untuk informasi selengkapnya, lihat Peran dan izin untuk target GKE.

Mengaktifkan tujuan GKE

Untuk mengizinkan Eventarc mengelola resource di cluster GKE, aktifkan tujuan GKE, dan ikat agen layanan Eventarc dengan peran yang diperlukan.

  1. Aktifkan tujuan GKE untuk Eventarc:

    gcloud eventarc gke-destinations init

  2. Saat diminta untuk mengikat peran yang diperlukan, masukkan y.

    Peran berikut terikat:

    • roles/compute.viewer
    • roles/container.developer
    • roles/iam.serviceAccountAdmin

Buat pemicu

Anda dapat membuat pemicu Eventarc menggunakan Google Cloud CLI atau melalui Konsol Google Cloud.

Konsol

  1. Di Konsol Google Cloud, buka halaman Triggers Eventarc.

    Buka Pemicu

  2. Klik Create trigger.
  3. Ketik Nama pemicu.

    Ini adalah ID pemicu dan harus diawali dengan huruf. Kolom ini dapat berisi hingga 63 huruf kecil, angka, atau tanda hubung.

  4. Untuk Jenis pemicu, pilih Sumber Google.
  5. Dalam daftar Event provider, pilih Firebase Realtime Database.

    Perhatikan bahwa nama penyedia peristiwa yang digunakan dalam Google Cloud dokumentasi terkait mungkin tidak memiliki awalan Cloud atau Google Cloud. Misalnya, di konsol, Memorystore for Redis disebut sebagai Google Cloud Memorystore for Redis.

  6. Dalam daftar Event type, dari peristiwa Direct, pilih jenis peristiwa.
  7. Dalam daftar Jenis konten data peristiwa, pilih encoding payload peristiwa.

    Untuk peristiwa langsung dari Firebase Realtime Database, nilainya harus application/json.

  8. Dalam daftar Region, pilih region yang sama dengan layananGoogle Cloud yang menghasilkan peristiwa.

    Untuk mengetahui informasi selengkapnya, lihat Lokasi Eventarc.

  9. Di kolom Atribut 1, ID resource instance berfungsi sebagai filter peristiwa. Pilih operator untuk filter ini:
  10. Di kolom Nilai atribut 1, masukkan nama instance database yang akan menerima peristiwa. Bergantung pada operator yang Anda pilih pada langkah sebelumnya, nilai atribut harus berupa nama yang tepat atau format pola jalur.
  11. Untuk atribut ref, pilih operator Pola jalur.
  12. Di kolom Nilai atribut 2, masukkan jalur instance database untuk menerima peristiwa dari jika data dibuat, diperbarui, atau dihapus di jalur tersebut atau jalur turunan mana pun.
  13. Pilih Service account yang akan memanggil layanan atau alur kerja Anda.

    Atau, Anda dapat membuat akun layanan baru.

    Tindakan ini menentukan email akun layanan Identity and Access Management (IAM) yang terkait dengan pemicu dan tempat Anda sebelumnya memberikan peran tertentu yang diperlukan oleh Eventarc.

  14. Dalam daftar Event destination, pilih Kubernetes Engine.
  15. Pilih layanan.

    Ini adalah nama layanan yang menerima peristiwa untuk pemicu. Layanan harus berada dalam project yang sama dengan pemicu dan akan menerima peristiwa sebagai permintaan POST HTTP yang dikirim ke jalur URL root-nya (/), setiap kali peristiwa dibuat.

  16. Anda juga dapat menentukan Jalur URL layanan sebagai tujuan pengiriman permintaan masuk.

    Ini adalah jalur relatif pada layanan tujuan tempat peristiwa untuk pemicu harus dikirim. Contoh: /, /route, route, route/subroute.

  17. Jika ingin, untuk menambahkan label, Anda dapat mengklik Tambahkan label. Label adalah key-value pair yang membantu Anda mengatur Google Cloud resource. Untuk mengetahui informasi selengkapnya, lihat Apa yang dimaksud dengan label?
  18. Klik Buat.

    19. Setelah pemicu dibuat, filter sumber peristiwa tidak dapat diubah. Sebagai gantinya, buat pemicu baru dan hapus yang lama. Untuk mengetahui informasi selengkapnya, lihat Mengelola pemicu.

gcloud

Anda dapat membuat pemicu dengan menjalankan perintah gcloud eventarc triggers create beserta flag wajib dan opsional.

gcloud eventarc triggers create TRIGGER \
    --location=LOCATION \
    --destination-gke-cluster=DESTINATION_GKE_CLUSTER \
    --destination-gke-location=DESTINATION_GKE_LOCATION \
    --destination-gke-namespace=DESTINATION_GKE_NAMESPACE \
    --destination-gke-service=DESTINATION_GKE_SERVICE \
    --destination-gke-path=DESTINATION_GKE_PATH \
    --event-filters="type=EVENT_FILTER_TYPE" \
    --event-filters="instance=INSTANCE" \
    --event-filters-path-pattern="ref=REF" \
    --service-account=SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

Ganti kode berikut:

  • TRIGGER: ID pemicu atau ID yang sepenuhnya memenuhi syarat

  • LOCATION: lokasi pemicu Eventarc. Atau, Anda dapat menetapkan properti eventarc/location; misalnya gcloud config set eventarc/location us-central1.

    Pemicu Firebase Realtime Database untuk Eventarc hanya tersedia di lokasi tertentu dan pemicu harus berada di lokasi yang sama dengan instance Firebase Realtime Database. Untuk mengetahui informasi selengkapnya, lihat Lokasi Eventarc dan lokasi Realtime Database.

  • DESTINATION_GKE_CLUSTER: nama cluster GKE tempat layanan GKE target yang menerima peristiwa dijalankan.
  • DESTINATION_GKE_LOCATION: (opsional) region Compute Engine cluster GKE tempat layanan GKE tujuan dijalankan. Jika tidak ditentukan, akan diasumsikan bahwa cluster adalah cluster regional dan berada di region yang sama dengan pemicu.
  • DESTINATION_GKE_NAMESPACE: (opsional) namespace tempat layanan GKE tujuan berjalan. Jika tidak ditentukan, namespace default akan digunakan.
  • DESTINATION_GKE_SERVICE: nama layanan GKE yang menerima peristiwa untuk pemicu. Layanan dapat berada di salah satu lokasi yang didukung GKE dan tidak perlu berada di lokasi yang sama dengan pemicu. Namun, layanan harus berada dalam project yang sama dengan pemicu dan akan menerima peristiwa sebagai permintaan POST HTTP yang dikirim ke jalur URL root-nya (/), setiap kali peristiwa dibuat.
  • DESTINATION_GKE_PATH: (opsional) jalur relatif yang Anda tentukan pada layanan GKE tujuan di mana peristiwa untuk pemicu akan dikirim. Contoh: /, /route, route, route/subroute.

  • EVENT_FILTER_TYPE: ID peristiwa Firebase Realtime Database dan dapat berupa salah satu dari yang berikut:

    • google.firebase.database.ref.v1.created: peristiwa dikirim saat data dibuat di database
    • google.firebase.database.ref.v1.updated: peristiwa dikirim saat data diperbarui di database
    • google.firebase.database.ref.v1.deleted: peristiwa dikirim saat data dihapus dalam database
    • google.firebase.database.ref.v1.written: peristiwa dikirim saat data dibuat, diperbarui, atau dihapus di database

  • INSTANCE: satu instance database dan operator dapat berupa salah satu dari yang berikut ini:

    • Sama; misalnya, --event-filters="instance=INSTANCE"
    • Pola jalur; misalnya, --event-filters-path-pattern="instance=INSTANCE". Untuk mengetahui informasi selengkapnya, lihat Memahami pola jalur.

  • REF: jalur dalam instance database tempat Anda ingin menerima peristiwa dari saat data dibuat, diperbarui, atau dihapus di jalur tersebut, atau turunannya.

  • SERVICE_ACCOUNT_NAME: nama akun layanan yang dikelola pengguna.
  • PROJECT_ID: Google Cloud Project ID Anda.

Catatan:

  • Untuk peristiwa langsung dari Firebase Realtime Database, encoding payload peristiwa adalah application/json.
  • Tanda berikut diperlukan:
    • --event-filters="type=EVENT_FILTER_TYPE"
    • --event-filters="instance=INSTANCE" atau --event-filters-path-pattern="instance=INSTANCE"
    • --event-filters-path-pattern="ref=REF"
    • Setelah pemicu dibuat, jenis filter peristiwa tidak dapat diubah. Untuk jenis peristiwa yang berbeda, Anda harus membuat pemicu baru dan menghapus pemicu yang lama.
    • Tanda --service-account digunakan untuk menentukan email akun layanan Identity and Access Management (IAM) yang terkait dengan pemicu tersebut.

Contoh:

gcloud eventarc triggers create helloworld-trigger \
    --location=us-central1 \
    --destination-gke-cluster=gke-events-cluster \
    --destination-gke-location=us-central1-a \
    --destination-gke-namespace=default \
    --destination-gke-service=helloworld-events \
    --destination-gke-path=/ \
    --event-filters="type=google.firebase.database.ref.v1.created" \
    --event-filters="instance=test-instance" \
    --event-filters-path-pattern="ref=users/*" \
    --service-account=${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com

Perintah ini membuat pemicu yang disebut helloworld-trigger untuk peristiwa yang diidentifikasi sebagai google.firebase.database.ref.v1.created dan untuk jalur users/* dalam instance database yang diidentifikasi sebagai test-instance.

Terraform

Anda dapat membuat pemicu untuk tujuan GKE menggunakan Terraform. Untuk mengetahui detailnya, baca Membuat pemicu menggunakan Terraform.

Membuat daftar pemicu

Anda dapat mengonfirmasi pembuatan pemicu dengan mencantumkan pemicu Eventarc menggunakan Google Cloud CLI atau melalui Konsol Google Cloud.

Konsol

  1. Di Konsol Google Cloud, buka halaman Triggers Eventarc.

    Buka Pemicu

    Halaman ini mencantumkan pemicu Anda di semua lokasi, dan menyertakan detail seperti nama, wilayah, penyedia peristiwa, tujuan, dan lainnya.

  2. Untuk memfilter pemicu:

    1. Klik Filter atau kolom Pemicu filter.
    2. Di daftar Properti, pilih opsi untuk memfilter pemicu.

    Anda dapat memilih satu properti atau menggunakan operator logika OR untuk menambahkan lebih banyak properti.

  3. Untuk mengurutkan pemicu, di samping judul kolom yang didukung, klik Urutkan.

gcloud

Jalankan perintah berikut untuk membuat daftar pemicu:

gcloud eventarc triggers list --location=-

Perintah ini mencantumkan pemicu Anda di semua lokasi, dan menyertakan detail seperti nama, jenis, tujuan, dan status.

Langkah berikutnya