Membuat pemicu dari peristiwa Cloud Storage

Di Cloud Run, Anda dapat memicu layanan dari Cloud Storage menggunakan Eventarc sebagai respons terhadap perubahan dalam Cloud Storage.

Saat menentukan pemicu Cloud Storage untuk layanan, Anda memilih jenis peristiwa dan menentukan bucket Cloud Storage. Sebagai hasil dari pemicu ini, layanan Anda akan dipanggil setiap kali terjadi perubahan pada objek (file) di dalam bucket yang ditentukan.

Agar layanan Anda dipicu oleh peristiwa di bucket Cloud Storage, layanan dan bucket harus berada dalam project yang sama Google Cloud .

Untuk mengetahui petunjuk mendetail dan contoh kode untuk membuat pemicu dari peristiwa Cloud Storage, lihat tutorial berikut:

Jenis peristiwa Cloud Storage yang didukung

Cloud Run mendukung jenis peristiwa Cloud Storage berikut:

Acara Jenis peristiwa Deskripsi
Objek diselesaikan
  • google.cloud.storage.object.v1.finalized (melalui Eventarc)
 Terjadi saat Anda membuat objek baru, atau menimpa objek yang ada, dan Cloud Storage membuat generasi baru objek tersebut.
Objek telah dihapus
  • google.cloud.storage.object.v1.deleted (melalui Eventarc)
 Terjadi saat Anda menghapus objek secara permanen.
Objek diarsipkan
  • google.cloud.storage.object.v1.archived (melalui Eventarc)
 Terjadi saat versi aktif sebuah objek menjadi versi lama. Lihat Pembuatan versi objek untuk informasi selengkapnya.
Metadata objek diperbarui
  • google.cloud.storage.object.v1.metadataUpdated (melalui Eventarc)
 Terjadi saat Anda mengubah metadata objek yang ada.

Repositori Google Events berisi resource tambahan untuk menangani data peristiwa.

Sebelum memulai

  1. Pastikan Anda telah menyiapkan project baru untuk Cloud Run seperti yang dijelaskan di halaman setup.

  2. Aktifkan Artifact Registry, Cloud Build, Cloud Run Admin API, Eventarc, Cloud Logging, Pub/Sub, dan Cloud Storage API:

    Aktifkan API

Menetapkan peran yang diperlukan

Anda atau administrator Anda harus memberikan peran IAM berikut kepada akun deployer, identitas pemicu, dan secara opsional, agen layanan Pub/Sub.

Peran yang diperlukan untuk akun deployer

Untuk mendapatkan izin yang Anda perlukan untuk memicu dari peristiwa Cloud Storage, minta administrator Anda untuk memberi Anda peran IAM berikut di project Anda:

Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

Perhatikan bahwa secara default, izin Cloud Build mencakup izin untuk mengupload dan mendownload artefak Artifact Registry.

Peran yang diperlukan untuk identitas pemicu

  1. Catat akun layanan default Compute Engine karena Anda akan melampirkannya ke pemicu Eventarc untuk merepresentasikan identitas pemicu untuk tujuan pengujian. Akun layanan ini dibuat secara otomatis setelah mengaktifkan atau menggunakan layanan Google Cloud yang menggunakan Compute Engine, dan dengan format email berikut:

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Ganti PROJECT_NUMBER dengan Google Cloud nomor project Anda. Anda dapat menemukan nomor project di halaman Selamat Datang di konsol Google Cloud atau dengan menjalankan perintah berikut:

    gcloud projects describe PROJECT_ID --format='value(projectNumber)'

    Untuk lingkungan produksi, sebaiknya buat akun layanan baru dan berikan satu atau beberapa peran IAM yang berisi izin minimum yang diperlukan dan ikuti prinsip hak istimewa terendah.

  2. Secara default, layanan Cloud Run hanya dapat dipanggil oleh Project Owner, Project Editor, Cloud Run Admin dan Invoker. Anda dapat mengontrol akses per layanan; namun, untuk tujuan pengujian, berikan peran Cloud Run Invoker (run.invoker) di project Google Cloud ke akun layanan Compute Engine. Peran ini akan memberikan peran tersebut di semua layanan dan tugas Cloud Run dalam suatu project. 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/run.invoker

    Perhatikan bahwa pemicu akan berhasil dibuat dan diaktifkan jika Anda membuat pemicu untuk layanan Cloud Run yang diautentikasi tanpa memberikan peran Cloud Run Namun, pemicu tidak akan berfungsi seperti yang diharapkan dan pesan yang mirip dengan berikut ini akan muncul di log:

    The request was not authenticated. Either allow unauthenticated invocations or set the proper Authorization header.
  3. Berikan Peran Eventarc Event Receiver (roles/eventarc.eventReceiver) pada project ke akun layanan default Compute Engine agar pemicu Eventarc dapat menerima peristiwa dari penyedia peristiwa. 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:PROJECT_NUMBER-compute@developer.gserviceaccount.com \
    --role=roles/eventarc.eventReceiver

Peran yang diperlukan untuk agen layanan Pub/Sub

  • Jika Anda mengaktifkan agen layanan Cloud Pub/Sub pada atau sebelum 8 April 2021, untuk mendukung permintaan push Pub/Sub yang diautentikasi, berikan peran Service Account Token Creator (roles/iam.serviceAccountTokenCreator) kepada agen layanan. Jika tidak, peran ini akan diberikan secara default: 
    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \
    --role=roles/iam.serviceAccountTokenCreator

Membuat pemicu untuk layanan

Anda dapat menentukan pemicu setelah men-deploy layanan.

Klik tab untuk mendapatkan petunjuk cara menggunakan alat pilihan Anda.

Konsol

  1. Deploy layanan Cloud Run Anda menggunakan container atau dari sumber.

  2. Di konsol Google Cloud , buka Cloud Run:

    Buka Cloud Run

  3. Dari daftar layanan, klik layanan yang ada.

  4. Di halaman Service details, buka tab Triggers.

  5. Klik Tambahkan pemicu, lalu pilih Pemicu Cloud Storage.

  6. Di panel Eventarc trigger, ubah detail pemicu sebagai berikut:

    1. Di kolom Nama pemicu, masukkan nama pemicu, atau gunakan nama default.

    2. Pilih Jenis pemicu dari daftar untuk menentukan salah satu jenis pemicu berikut:

      • Sumber Google untuk menentukan pemicu bagi Pub/Sub, Cloud Storage, Firestore, dan penyedia peristiwa Google lainnya.

      • Pihak ketiga untuk berintegrasi dengan penyedia non-Google yang menawarkan sumber Eventarc. Untuk mengetahui informasi selengkapnya, lihat Peristiwa pihak ketiga di Eventarc.

    3. Pilih Cloud Storage dari daftar Penyedia peristiwa, untuk memilih produk yang menyediakan jenis peristiwa untuk memicu layanan Anda. Untuk daftar penyedia peristiwa, lihat Penyedia dan tujuan peristiwa.

    4. Pilih google.cloud.storage.object.v1.finalized dari daftar Jenis peristiwa. Konfigurasi pemicu Anda bervariasi, bergantung pada jenis peristiwa yang didukung. Untuk mengetahui informasi selengkapnya, lihat Jenis peristiwa.

    5. Di kolom Bucket, klik Browse untuk memilih bucket Cloud Storage yang akan dipantau oleh pemicu. Perubahan pada objek dalam bucket ini akan memicu panggilan ke fungsi Anda.

    6. Jika kolom Region diaktifkan, pilih lokasi untuk pemicu Eventarc. Secara umum, lokasi pemicu Eventarc harus cocok dengan lokasi resource Google Cloud yang ingin Anda pantau peristiwanya. Dalam sebagian besar skenario, Anda juga harus men-deploy layanan di region yang sama. Lihat Memahami lokasi Eventarc untuk mengetahui detail selengkapnya tentang lokasi pemicu Eventarc.

    7. Di kolom Service account, pilih akun layanan. Pemicu Eventarc ditautkan ke akun layanan untuk digunakan sebagai identitas saat memanggil layanan Anda. Akun layanan pemicu Eventarc Anda harus memiliki izin untuk memanggil layanan Anda. Secara default, Cloud Run menggunakan akun layanan default Compute Engine.

    8. Jika perlu, tentukan Jalur URL layanan untuk mengirim permintaan masuk ke. Ini adalah jalur relatif pada layanan tujuan yang akan menjadi tempat pengiriman peristiwa untuk pemicu. Misalnya: /, /route, route, dan route/subroute.

    9. Setelah Anda mengisi kolom yang wajib diisi, klik Simpan pemicu.

  7. Setelah membuat pemicu, verifikasi kondisinya dengan memastikan bahwa ada tanda centang di tab Pemicu.

gcloud

  1. Deploy layanan Cloud Run Anda menggunakan container atau dari sumber.

  2. Jalankan perintah berikut untuk membuat pemicu yang memfilter peristiwa:

    gcloud eventarc triggers create TRIGGER_NAME  \
    --location=EVENTARC_TRIGGER_LOCATION \
    --destination-run-service=SERVICE  \
    --destination-run-region=REGION \
    --event-filters="type=google.cloud.storage.object.v1.finalized" \
    --event-filters="bucket=PROJECT_ID-bucket" \
    --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Ganti:

    • TRIGGER_NAME dengan nama pemicu Anda.

    • EVENTARC_TRIGGER_LOCATION dengan lokasi untuk pemicu Eventarc. Secara umum, lokasi pemicu Eventarc harus cocok dengan lokasi resource Google Cloud yang ingin Anda pantau peristiwanya. Dalam sebagian besar skenario, Anda juga harus men-deploy layanan di region yang sama. Untuk mengetahui informasi selengkapnya, lihat Lokasi Eventarc.

    • SERVICE dengan nama layanan yang Anda deploy.

    • REGION dengan region Cloud Run layanan.

    • PROJECT_NUMBER dengan Google Cloud nomor project Anda. Pemicu Eventarc ditautkan ke akun layanan untuk digunakan sebagai identitas saat memanggil layanan Anda. Akun layanan pemicu Eventarc Anda harus memiliki izin untuk memanggil layanan Anda. Secara default, Cloud Run menggunakan Akun layanan komputasi default.

    • Flag event-filters menentukan filter peristiwa yang dipantau pemicu. Peristiwa yang cocok dengan semua event-filters, filter memicu panggilan ke layanan Anda. Setiap pemicu harus memiliki jenis peristiwa yang didukung. Anda tidak dapat mengubah jenis filter peristiwa setelah dibuat. Untuk mengubah jenis filter peristiwa, Anda harus membuat pemicu baru dan menghapus pemicu lama. Secara opsional, Anda dapat mengulangi tanda --event-filters dengan filter yang didukung dalam bentuk ATTRIBUTE=VALUE untuk menambahkan lebih banyak filter.

Terraform

Untuk membuat pemicu Eventarc untuk layanan Cloud Run, lihat Membuat pemicu menggunakan Terraform.

Membuat pemicu untuk fungsi

Klik tab untuk mendapatkan petunjuk cara menggunakan alat pilihan Anda.

Konsol

Saat menggunakan konsol Google Cloud untuk membuat fungsi, Anda juga dapat menambahkan pemicu ke fungsi. Ikuti langkah-langkah berikut untuk membuat pemicu bagi fungsi Anda:

  1. Di konsol Google Cloud , buka Cloud Run:

    Buka Cloud Run

  2. Klik Write a function, lalu masukkan detail fungsi. Untuk mengetahui informasi selengkapnya tentang cara mengonfigurasi fungsi selama deployment, lihat Men-deploy fungsi.

  3. Di bagian Pemicu, klik Tambahkan pemicu.

  4. Pilih Pemicu Cloud Storage.

  5. Di panel Eventarc trigger, ubah detail pemicu sebagai berikut:

    1. Masukkan nama pemicu di kolom Nama pemicu, atau gunakan nama default.

    2. Pilih Jenis pemicu dari daftar untuk menentukan salah satu jenis pemicu berikut:

      • Sumber Google untuk menentukan pemicu bagi Pub/Sub, Cloud Storage, Firestore, dan penyedia peristiwa Google lainnya.

      • Pihak ketiga untuk berintegrasi dengan penyedia non-Google yang menawarkan sumber Eventarc. Untuk mengetahui informasi selengkapnya, lihat Peristiwa pihak ketiga di Eventarc.

    3. Pilih Cloud Storage dari daftar Event provider, untuk memilih produk yang menyediakan jenis peristiwa untuk memicu fungsi Anda. Untuk daftar penyedia peristiwa, lihat Penyedia dan tujuan peristiwa.

    4. Pilih google.cloud.storage.object.v1.finalized dari daftar Jenis peristiwa. Konfigurasi pemicu Anda bervariasi, bergantung pada jenis peristiwa yang didukung. Untuk mengetahui informasi selengkapnya, lihat Jenis peristiwa.

    5. Di kolom Bucket, klik Browse untuk memilih bucket Cloud Storage yang akan dipantau oleh pemicu. Perubahan pada objek dalam bucket ini akan memicu panggilan ke fungsi Anda.

    6. Jika kolom Region diaktifkan, pilih lokasi untuk pemicu Eventarc. Secara umum, lokasi pemicu Eventarc harus cocok dengan lokasi resource Google Cloud yang ingin Anda pantau peristiwanya. Dalam sebagian besar skenario, Anda juga harus men-deploy fungsi di region yang sama. Lihat Memahami lokasi Eventarc untuk mengetahui detail selengkapnya tentang lokasi pemicu Eventarc.

    7. Di kolom Service account, pilih akun layanan. Pemicu Eventarc ditautkan ke akun layanan untuk digunakan sebagai identitas saat memanggil fungsi Anda. Akun layanan pemicu Eventarc Anda harus memiliki izin untuk memanggil fungsi Anda. Secara default, Cloud Run menggunakan akun layanan default Compute Engine.

    8. Jika perlu, tentukan Jalur URL layanan untuk mengirim permintaan masuk ke. Ini adalah jalur relatif pada layanan tujuan yang akan menjadi tempat pengiriman peristiwa untuk pemicu. Misalnya: /, /route, route, dan route/subroute.

  6. Setelah Anda mengisi kolom yang wajib diisi, klik Simpan pemicu.

gcloud

Saat membuat fungsi menggunakan gcloud CLI, Anda harus men-deploy fungsi terlebih dahulu, lalu membuat pemicu. Ikuti langkah-langkah berikut untuk membuat pemicu bagi fungsi Anda:

  1. Jalankan perintah berikut di direktori yang berisi kode contoh untuk men-deploy fungsi Anda:

    gcloud run deploy FUNCTION \
        --source . \
        --function FUNCTION_ENTRYPOINT \
        --base-image BASE_IMAGE_ID \
        --region REGION

    Ganti:

    • FUNCTION dengan nama fungsi yang Anda deploy. Anda dapat menghilangkan parameter ini sepenuhnya, tetapi Anda akan diminta untuk memasukkan nama jika menghilangkannya.

    • FUNCTION_ENTRYPOINT dengan titik entri ke fungsi Anda dalam kode sumber. Ini adalah kode yang dieksekusi Cloud Run saat fungsi Anda berjalan. Nilai flag ini harus berupa nama fungsi atau nama class yang sepenuhnya memenuhi syarat yang ada dalam kode sumber Anda.

    • BASE_IMAGE_ID dengan lingkungan image dasar untuk fungsi Anda. Untuk mengetahui detail selengkapnya tentang image dasar dan paket yang disertakan dalam setiap image, lihat Image dasar runtime.

    • REGION dengan Google Cloud region tempat Anda ingin men-deploy fungsi Anda. Contohnya, europe-west1

  2. Jalankan perintah berikut untuk membuat pemicu yang memfilter peristiwa:

    gcloud eventarc triggers create TRIGGER_NAME  \
    --location=EVENTARC_TRIGGER_LOCATION \
    --destination-run-service=FUNCTION  \
    --destination-run-region=REGION \
    --event-filters="type=google.cloud.storage.object.v1.finalized" \
    --event-filters="bucket=PROJECT_ID-bucket" \
    --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Ganti:

    • TRIGGER_NAME dengan nama pemicu Anda.

    • EVENTARC_TRIGGER_LOCATION dengan lokasi untuk pemicu Eventarc. Secara umum, lokasi pemicu Eventarc harus cocok dengan lokasi resource Google Cloud yang ingin Anda pantau peristiwanya. Dalam sebagian besar skenario, Anda juga harus men-deploy fungsi di region yang sama. Untuk mengetahui informasi selengkapnya, lihat Lokasi Eventarc.

    • FUNCTION dengan nama fungsi yang Anda deploy.

    • REGION dengan region Cloud Run fungsi.

    • PROJECT_NUMBER dengan Google Cloud nomor project Anda. Pemicu Eventarc ditautkan ke akun layanan untuk digunakan sebagai identitas saat memanggil fungsi Anda. Akun layanan pemicu Eventarc Anda harus memiliki izin untuk memanggil fungsi Anda. Secara default, Cloud Run menggunakan Akun layanan komputasi default.

    • Flag event-filters menentukan filter peristiwa yang dipantau pemicu. Peristiwa yang cocok dengan semua event-filters, filter memicu panggilan ke fungsi Anda. Setiap pemicu harus memiliki jenis peristiwa yang didukung. Anda tidak dapat mengubah jenis filter peristiwa setelah dibuat. Untuk mengubah jenis filter peristiwa, Anda harus membuat pemicu baru dan menghapus pemicu lama. Secara opsional, Anda dapat mengulangi tanda --event-filters dengan filter yang didukung dalam bentuk ATTRIBUTE=VALUE untuk menambahkan lebih banyak filter.

Terraform

Untuk membuat pemicu Eventarc bagi fungsi Cloud Run, lihat Membuat pemicu menggunakan Terraform.

Pengiriman acara

Pemicu Cloud Storage diimplementasikan dengan notifikasi Pub/Sub untuk Cloud Storage. Peristiwa tunduk pada jaminan pengiriman notifikasi Pub/Sub.

Bucket Cloud Storage dapat memiliki hingga 10 konfigurasi notifikasi yang ditetapkan untuk dipicu untuk peristiwa tertentu. Melebihi batas notifikasi bucket akan menyebabkan deployment fungsi lebih lanjut gagal dengan error seperti berikut:

Cloud Storage bucket ...: Pub/Sub notification limit reached

Anda dapat mengatasi batasan ini dengan mengelola topik Pub/Sub Anda sendiri dan mendaftarkannya untuk notifikasi Cloud Storage jenis yang ingin direspons oleh fungsi Anda. Misalnya, Anda dapat mengonfigurasi satu notifikasi untuk peristiwa yang Anda pilih (seperti pembuatan objek) ke topik Pub/Sub. Kemudian, miliki sebanyak mungkin pelanggan fungsi yang diperlukan untuk topik guna memproses peristiwa dan menyebarkannya ke beberapa tujuan. Contoh:

  1. Buat topik Pub/Sub Anda sendiri.
  2. Buat satu konfigurasi notifikasi di bucket Cloud Storage Anda yang dipicu pada peristiwa tertentu (seperti OBJECT_FINALIZE untuk pembuatan objek) dan mengirimkan peristiwa tersebut ke satu topik Pub/Sub Anda.
  3. Buat fungsi (atau fungsi) yang dipicu oleh topik Pub/Sub.

Hal ini akan menghasilkan satu konfigurasi notifikasi Cloud Storage, satu topik Pub/Sub, dan sebanyak fungsi yang Anda butuhkan (dalam batas pengiriman yang sangat tinggi yang diizinkan oleh Pub/Sub).

Lihat Kuota dan batas Cloud Storage untuk mempelajari lebih lanjut batasan Cloud Storage.

Langkah berikutnya