Merutekan peristiwa API Gateway ke Alur Kerja

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

Konsol

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

   Buka pemilih project

2. Aktifkan Eventarc, Eventarc Publishing, Workflows, dan Workflow Executions API.

   Mengaktifkan API

3. Jika memungkinkan, aktifkan API yang terkait dengan peristiwa langsung. Misalnya, untuk API Gateway peristiwa, aktifkan API Gateway 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 alur kerja target.

   1. Di Konsol Google Cloud, buka halaman Akun layanan.

      Buka 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 mengetahui informasi selengkapnya, lihat Peran dan izin untuk target Workflows.

      Untuk peran tambahan, klik add 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, Workflows, dan Workflow Executions API:

   gcloud services enable eventarc.googleapis.com \
       eventarcpublishing.googleapis.com \
       workflows.googleapis.com \
       workflowexecutions.googleapis.com

3. Jika memungkinkan, aktifkan API yang terkait dengan peristiwa langsung. Misalnya, untuk API Gateway peristiwa, aktifkan apigateway.googleapis.com.

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

   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 mengetahui informasi selengkapnya, lihat Peran dan izin untuk target Workflows.

Konsol

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

   Buka Pemicu

2. Klik add_box 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 API Gateway.

   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. Untuk menentukan encoding payload peristiwa, dalam daftar Jenis konten data peristiwa, pilih application/json atau application/protobuf.

   Perhatikan bahwa payload peristiwa yang diformat dalam JSON lebih besar dari yang diformat dalam Protobuf. Hal ini dapat memengaruhi keandalan, bergantung pada tujuan peristiwa Anda dan batasnya pada ukuran peristiwa. Untuk mengetahui informasi selengkapnya, lihat Masalah umum.

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

   Untuk mengetahui informasi selengkapnya, lihat Lokasi Eventarc.

9. Jika berlaku untuk penyedia peristiwa, klik Add filter, lalu tentukan hal berikut:
   1. Di kolom Atribut 1, bergantung pada peristiwa langsung yang Anda pilih, pilih ID resource yang dapat berfungsi sebagai filter peristiwa.
   2. Pilih operator:
      • Sama
      • Pola jalur

        Untuk mengetahui informasi selengkapnya, lihat Memahami pola jalur.

   3. Di kolom Nilai atribut 1, bergantung pada operator yang Anda pilih, ketik nilai yang tepat atau terapkan pola jalur.
   4. Jika ada lebih banyak filter atribut yang berlaku, klik Add filter, lalu tentukan nilai yang sesuai.
10. 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.

11. Dalam daftar Event destination, pilih Workflows.
12. Pilih alur kerja.
    

    Ini adalah nama alur kerja yang akan menerima peristiwa. Peristiwa untuk eksekusi alur kerja ditransformasi dan diteruskan ke alur kerja sebagai argumen runtime.

    Untuk mengetahui informasi selengkapnya, lihat Membuat pemicu untuk Workflows.

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

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 bersama dengan flag wajib dan opsional.

  gcloud eventarc triggers create TRIGGER \
      --location=LOCATION \
      --destination-workflow=DESTINATION_WORKFLOW \
      --destination-workflow-location=DESTINATION_WORKFLOW_LOCATION \
      --event-filters="type=EVENT_FILTER_TYPE" \
      --event-filters="COLLECTION_ID=RESOURCE_ID" \
      --event-filters-path-pattern="COLLECTION_ID=PATH_PATTERN" \
      --event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
      --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.

  Untuk menghindari masalah performa dan residensi data, lokasi harus cocok dengan lokasi Google Cloud layanan yang menghasilkan peristiwa. Untuk mengetahui informasi selengkapnya, lihat Lokasi Eventarc.

• DESTINATION_WORKFLOW: ID alur kerja yang di-deploy yang menerima peristiwa dari pemicu. Alur kerja dapat berada di salah satu lokasi yang didukung Workflows dan tidak perlu berada di lokasi yang sama dengan pemicu. Namun, alur kerja harus berada dalam project yang sama dengan pemicu.
• DESTINATION_WORKFLOW_LOCATION (opsional): lokasi tempat alur kerja tujuan di-deploy. Jika tidak ditentukan, alur kerja akan diasumsikan berada di lokasi yang sama dengan pemicu.
• EVENT_FILTER_TYPE: ID peristiwa. Peristiwa dibuat saat panggilan API untuk metode berhasil. Untuk operasi yang berjalan lama, peristiwa hanya dibuat di akhir operasi, dan hanya jika tindakan berhasil dijalankan. Untuk daftar jenis peristiwa yang didukung, lihat Jenis peristiwa Google yang didukung oleh Eventarc.

• COLLECTION_ID (opsional): komponen resource yang dapat berfungsi sebagai filter peristiwa, dan merupakan salah satu dari hal berikut:
  • api
  • apiconfig
  • gateway
• RESOURCE_ID: ID resource yang digunakan sebagai nilai pemfilteran untuk koleksi terkait. Untuk mengetahui informasi selengkapnya, lihat ID Resource.
• PATH_PATTERN: pola jalur yang akan diterapkan saat memfilter resource
• EVENT_DATA_CONTENT_TYPE: (opsional) encoding payload peristiwa. ID ini dapat berupa application/json atau application/protobuf. Encoding default-nya adalah application/json.

  Perhatikan bahwa payload peristiwa yang diformat dalam JSON lebih besar dari yang diformat dalam Protobuf. Hal ini dapat memengaruhi keandalan, bergantung pada tujuan peristiwa Anda dan batas ukuran peristiwa. Untuk mengetahui informasi selengkapnya, lihat Masalah umum.

• SERVICE_ACCOUNT_NAME: nama akun layanan IAM yang Anda buat, yang Anda beri peran tertentu yang diperlukan oleh Workflows.
• PROJECT_ID: Google Cloud project ID Anda

Catatan:

• Flag --event-filters="type=EVENT_FILTER_TYPE" wajib ada. Jika tidak ada filter peristiwa lain yang ditetapkan, peristiwa untuk semua resource akan dicocokkan.
• EVENT_FILTER_TYPE tidak dapat diubah setelah dibuat. Untuk mengubah EVENT_FILTER_TYPE, buat pemicu baru dan hapus pemicu yang lama.
• Setiap pemicu dapat memiliki beberapa filter peristiwa, yang dipisahkan koma dalam satu tanda --event-filters=[ATTRIBUTE=VALUE,...], atau Anda dapat mengulangi tanda tersebut untuk menambahkan lebih banyak filter. Hanya peristiwa yang cocok dengan semua filter yang dikirim ke tujuan. Karakter pengganti dan ekspresi reguler tidak didukung. Namun, saat menggunakan flag --event-filters-path-pattern, Anda dapat menentukan pola jalur resource.
• 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-workflow=my-workflow \
      --destination-workflow-location=us-central1 \
      --event-filters="type=google.cloud.apigateway.gateway.v1.updated" \
      --event-filters-path-pattern="gateway=my-gateway-*" \
      --service-account="${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com"

Perintah ini membuat pemicu yang disebut helloworld-trigger untuk peristiwa yang diidentifikasi sebagai google.cloud.apigateway.gateway.v1.updated dan cocok dengan peristiwa untuk ID gateway yang dimulai dengan my-gateway-.

Terraform

Anda dapat membuat pemicu untuk alur kerja menggunakan Terraform. Untuk mengetahui detailnya, lihat Memicu alur kerja menggunakan Eventarc dan Terraform.

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_list 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 arrow_upward 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