Membuat pendaftaran untuk menerima peristiwa

Pipeline

1. Buka terminal.

2. Buat pipeline menggunakan perintah gcloud beta eventarc pipelines create:

   gcloud beta eventarc pipelines create PIPELINE_NAME \
       --destinations=DESTINATION_KEY \
       --location=LOCATION

   Ganti kode berikut:

   • PIPELINE_NAME: ID pipeline atau nama yang sepenuhnya memenuhi syarat

   • DESTINATION_KEY: satu atau beberapa key-value pair untuk mengonfigurasi tujuan pipeline

     Anda hanya boleh menyetel satu kunci berikut:

     • http_endpoint_uri—URI tujuan. Host dapat berupa alamat IP statis yang dapat diakses dari jaringan Virtual Private Cloud (VPC), atau nama host Domain Name System (DNS) internal dari layanan yang dapat diselesaikan menggunakan Cloud DNS. Secara opsional, Anda juga dapat menetapkan http_endpoint_message_binding_template ke menentukan pengikatan pesan.

       Perhatikan bahwa Anda dapat menggunakan kunci ini untuk menargetkan fungsi Cloud Run, job Cloud Run, atau layanan Cloud Run yang akan menerima peristiwa sebagai permintaan HTTP POST.

     • message_bus—ID bus Eventarc Advanced.

     • pubsub_topic—ID topik Pub/Sub.

     • workflow—ID alur kerja Workflows.

     Khusus untuk http_endpoint_uri (termasuk URL Cloud Run), Anda harus menetapkan kunci berikut:

     • network_attachment—resource yang memungkinkan jaringan VPC produsen memulai koneksi ke jaringan VPC konsumen. Untuk memublikasikan peristiwa, Eventarc Advanced menggunakan lampiran jaringan untuk membuat koneksi ke endpoint yang dihosting di jaringan VPC.

       Anda dapat membuat lampiran jaringan yang otomatis menerima koneksi dari antarmuka Private Service Connect mana pun yang merujuk ke lampiran jaringan. Buat lampiran jaringan di jaringan dan region yang sama dengan yang berisi resource tujuan.

       Jika Anda merutekan pesan ke tujuan Google menggunakan alamat DNS—misalnya, Cloud Run—pastikan Akses Google Pribadi diaktifkan di subnet yang digunakan dalam lampiran jaringan; jika tidak, alamat DNS tidak dapat diselesaikan.

     Untuk mengaktifkan autentikasi, Anda dapat menetapkan salah satu kunci berikut:

     • google_oidc_authentication_service_account—email akun layanan yang digunakan untuk membuat token OIDC yang dapat digunakan untuk banyak skenario, termasuk endpoint tempat Anda ingin memvalidasi token sendiri. Secara opsional, Anda dapat menetapkan google_oidc_authentication_audience untuk menentukan audiens yang dituju token ini. Umumnya, URL ini harus cocok dengan URL pipeline target. Jika tidak ditentukan, seluruh URL akan digunakan, termasuk parameter permintaan apa pun.

       Perhatikan bahwa Cloud Run melakukan pemeriksaan IAM pada setiap permintaan dan Anda dapat menggunakan izin run.routes.invoke untuk mengonfigurasi siapa saja yang dapat mengakses layanan Cloud Run Anda dengan salah satu cara berikut:

       • Berikan izin untuk memilih akun atau grup layanan yang akan mengizinkan akses ke layanan tersebut. Semua permintaan harus memiliki header Otorisasi HTTP yang berisi token OpenID Connect yang ditandatangani oleh Google untuk salah satu akun layanan yang diberi otorisasi.

       • Berikan izin kepada allUsers untuk mengizinkan akses tanpa autentikasi.

       Untuk mengetahui informasi selengkapnya, lihat Kontrol akses untuk Cloud Run .

     • oauth_token_authentication_service_account—email akun layanan yang digunakan untuk membuat token OAuth yang umumnya hanya boleh digunakan saat memanggil Google API yang dihosting di *.googleapis.com. Secara opsional, Anda dapat menetapkan oauth_token_authentication_scope untuk menentukan cakupan token ini; jika tidak, defaultnya adalah https://www.googleapis.com/auth/cloud-platform. Untuk layanan Google Cloud , praktik terbaiknya adalah menggunakan cakupan https://www.googleapis.com/auth/cloud-platform, yang mencakup semua Google Cloud API, bersama dengan Identity and Access Management (IAM), yang menyediakan kontrol akses terperinci.

       Perhatikan bahwa semua permintaan ke bus Eventarc Advanced, Pub/Sub, atau Workflows lainnya harus memiliki header Otorisasi HTTP yang berisi token OAuth yang ditandatangani oleh Google untuk salah satu akun layanan yang diberi otorisasi.

       Pelajari jenis token lebih lanjut.

     Opsional: Anda dapat menetapkan salah satu kunci berikut:

     • output_payload_format_avro_schema_definition
     • output_payload_format_json

     • output_payload_format_protobuf_schema_definition

       Perhatikan bahwa jika Anda menetapkan format output, Anda juga harus menentukan format input (lihat flag input-payload-format-* berikut).

     Opsional: Jika http_endpoint_uri tidak digunakan sebagai kunci tujuan, Anda dapat menetapkan kunci berikut:

     • project—project ID dari resource tujuan; secara default, project ID untuk pipeline digunakan. Google Cloud
     • location—lokasi resource tujuan; secara default, lokasi untuk pipeline digunakan.

   • LOCATION: region Eventarc Advanced yang didukung

     Atau, Anda dapat menetapkan properti lokasi gcloud CLI:

     gcloud config set eventarc/location LOCATION
     

   Opsional: Anda dapat menggunakan flag berikut:

   • --async untuk segera kembali dari perintah, tanpa menunggu operasi yang sedang berlangsung selesai.
   • --crypto-key untuk menentukan nama yang sepenuhnya memenuhi syarat dari kunci enkripsi yang dikelola pelanggan; jika tidak ditentukan, Google-owned and managed keys akan digunakan.
   • --logging-config untuk mengonfigurasi tingkat logging yang harus berupa salah satu dari berikut ini: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.

   • --mediations untuk menerapkan transformasi; transformation_template adalah satu-satunya template yang didukung dan hanya satu mediasi per pipeline yang didukung; misalnya:

     --mediations=transformation_template='message.removeFields(["id\ ","credit_card_number","age"])'

     Perhatikan bahwa jika Anda menerapkan transformasi, Anda harus menggunakan salah satu flag berikut untuk menentukan format input.

   • Salah satu opsi berikut untuk menentukan format input:

     • --input-payload-format-avro-schema-definition
     • --input-payload-format-json
     • --input-payload-format-protobuf-schema-definition

   • --max-retry-attempts, --max-retry-delay, dan --min-retry-delay untuk mencoba lagi peristiwa

   Contoh:

   gcloud beta eventarc pipelines create my-pipeline \
       --destinations=http_endpoint_uri='https://example-endpoint.com',network_attachment=my-network-attachment,oauth_token_authentication_service_account=example-service-account@example-project.gserviceaccount.iam.com,oauth_token_authentication_scope='https://www.googleapis.com/auth/cloud-platform',output_payload_format_avro_schema_definition='{"type": "record","name": "my_record", "fields": [{"name": "my_field", "type":"string"}]}' \
       --input-payload-format-avro-schema-definition='{"type":"record", "name": "my_record", "fields": [{"name": "my_field","type": "string"}]}' \
       --location=us-central1 \
       --async
   

   Untuk mengetahui detail dan contoh selengkapnya, lihat dokumentasi gcloud CLI.

Pendaftaran

1. Buka terminal.

2. Buat pendaftaran menggunakan perintah gcloud beta eventarc enrollments create:

   gcloud beta eventarc enrollments create ENROLLMENT_NAME \
       --cel-match=MATCH_EXPRESSION \
       --destination-pipeline=PIPELINE_NAME \
       --message-bus=BUS_NAME \
       --message-bus-project=PROJECT_ID \
       --location=LOCATION

   Ganti kode berikut:

   • ENROLLMENT_NAME: ID pendaftaran atau nama yang sepenuhnya memenuhi syarat
   • MATCH_EXPRESSION: ekspresi pencocokan untuk pendaftaran ini menggunakan CEL—misalnya, "message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'"
   • PIPELINE_NAME: ID pipeline target atau nama lengkapnya untuk pendaftaran ini
   • BUS_NAME: ID bus Eventarc Advanced atau nama lengkapnya
   • PROJECT_ID: Google Cloud project ID untuk bus

   • LOCATION: region Eventarc Advanced yang didukung

     Atau, Anda dapat menetapkan properti lokasi gcloud CLI:

     gcloud config set eventarc/location LOCATION
     

   Opsional: Anda dapat menggunakan flag berikut:

   • --async untuk segera kembali dari perintah, tanpa menunggu operasi yang sedang berlangsung selesai

   Contoh:

   gcloud beta eventarc enrollments create my-enrollment \
       --cel-match="message.type == 'google.cloud.dataflow.job.v1beta3.statusChanged'" \
       --destination-pipeline=my-pipeline \
       --message-bus=my-message-bus \
       --message-bus-project=another-google-cloud-project \
       --location=us-central1 \
       --async
   

Pipeline

Untuk membuat pipeline, gunakan metode projects.locations.pipelines.create.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• name: nama lengkap resource pipeline dalam format projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME

  Ganti kode berikut:

  • PROJECT_ID: ID Google Cloud project untuk project pipeline
  • LOCATION: region tempat pipeline akan di-deploy—misalnya, us-central1
  • PIPELINE_NAME: nama pipeline
• LABEL_KEY dan LABEL_VALUE: opsional. Peta pasangan nilai dan kunci label yang membantu Anda mengatur resource. Google Cloud Untuk informasi selengkapnya, lihat Apa yang dimaksud dengan label?
• ANNOTATION_KEY dan ANNOTATION_VALUE: opsional. Peta pasangan nilai kunci anotasi teks bentuk bebas. Anda dapat menggunakannya untuk melampirkan informasi arbitrer yang terkait dengan resource. Untuk mengetahui informasi selengkapnya, lihat Anotasi.
• LOG_SEVERITY: optional. Tingkat keparahan minimum peristiwa yang dijelaskan dalam entri log. Salah satu dari: NONE, DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY. Defaultnya adalah NONE. Untuk mengetahui informasi selengkapnya, lihat LogSeverity.
• destinations: tujuan ke mana pesan akan diteruskan. Hanya satu tujuan yang didukung: httpEndpoint, messageBus, topic, atau workflow. Untuk mengetahui informasi selengkapnya, lihat Destination target. Misalnya, ganti yang berikut:
  • HTTP_URI: URI tujuan. Host dapat berupa alamat IP statis yang dapat diakses dari jaringan Virtual Private Cloud (VPC), atau nama host Domain Name System (DNS) internal dari layanan yang dapat di-resolve menggunakan Cloud DNS. Secara opsional, Anda juga dapat menetapkan messageBindingTemplate untuk menentukan pengikatan pesan.
  • networkAttachment: hanya berlaku untuk httpEndpoint (termasuk URL Cloud Run). Nama lengkap resource lampiran jaringan dalam format ini: projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION /networkAttachments/NETWORK_ATTACHMENT_NAME. Lampiran jaringan adalah resource yang memungkinkan jaringan Virtual Private Cloud produsen memulai koneksi ke jaringan VPC konsumen dan harus ditentukan. Untuk memublikasikan peristiwa, Eventarc Advanced menggunakan lampiran jaringan untuk membuat koneksi ke endpoint yang dihosting dalam jaringan VPC.

    Anda dapat membuat lampiran jaringan yang otomatis menerima koneksi dari antarmuka Private Service Connect mana pun yang merujuk ke lampiran jaringan. Buat lampiran jaringan di jaringan dan region yang sama yang berisi resource tujuan.

    Jika Anda merutekan pesan ke tujuan Google menggunakan alamat DNS—misalnya, Cloud Run—pastikan Akses Google Pribadi diaktifkan di subnet yang digunakan dalam lampiran jaringan; jika tidak, alamat DNS tidak dapat di-resolve.

  • SERVICE_ACCOUNT_EMAIL: nama email akun layanan yang digunakan untuk membuat token OIDC yang dapat digunakan untuk banyak skenario, termasuk endpoint tempat Anda ingin memvalidasi token sendiri. Secara opsional, Anda dapat menyetel audience untuk menentukan audiens yang dituju token ini. Umumnya, URL ini harus cocok dengan URL pipeline target. Jika tidak ditentukan, seluruh URL akan digunakan, termasuk parameter permintaan apa pun.

    Atau, Anda dapat menggunakan oauthToken untuk menentukan email akun layanan yang digunakan untuk membuat token OAuth yang umumnya hanya boleh digunakan saat memanggil Google API yang dihosting di *.googleapis.com. Secara opsional, Anda dapat menetapkan scope untuk menentukan cakupan token ini; jika tidak, defaultnya adalah https://www.googleapis.com/auth/cloud-platform. Untuk layanan Google Cloud, praktik terbaiknya adalah menggunakan cakupan https://www.googleapis.com/auth/cloud-platform, yang mencakup semua API Google Cloud , bersama dengan Identity and Access Management (IAM), yang menyediakan kontrol akses terperinci.

    Perhatikan bahwa semua permintaan ke bus Eventarc Advanced lainnya, Pub/Sub, atau Workflows harus memiliki header Otorisasi HTTP yang berisi token OAuth yang ditandatangani oleh Google untuk salah satu akun layanan yang diberi otorisasi.

    Pelajari jenis token lebih lanjut.

Meminta isi JSON:

{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},"networkConfig":
  {"networkAttachment": "projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION/networkAttachments/NETWORK_ATTACHMENT_NAME"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

cat > request.json << 'EOF'
{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},"networkConfig":
  {"networkAttachment": "projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION/networkAttachments/NETWORK_ATTACHMENT_NAME"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}
EOF

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelines?pipeline_id=PIPELINE_NAME"

@'
{
  "name": "projects/PROJECT_ID/regions/LOCATION/pipelines/PIPELINE_NAME",
  "labels": {"LABEL_KEY":"LABEL_VALUE"},
  "annotations": {"ANNOTATION_KEY":"ANNOTATION_VALUE"},
  "loggingConfig": {"logSeverity":"LOG_SEVERITY"},
  "destinations": [{"httpEndpoint": {"uri": "HTTP_URI"},"networkConfig":
  {"networkAttachment": "projects/NETWORK_ATTACHMENT_PROJECT_ID/regions/NETWORK_ATTACHMENT_LOCATION/networkAttachments/NETWORK_ATTACHMENT_NAME"},
  "authenticationConfig": {"googleOidc": {"serviceAccount": "SERVICE_ACCOUNT_EMAIL"}}}]
}
'@  | Out-File -FilePath request.json -Encoding utf8

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelines?pipeline_id=PIPELINE_NAME" | Select-Object -Expand Content

Jika berhasil, isi respons berisi instance Operation yang baru dibuat:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.eventarc.v1.OperationMetadata",
    "createTime": "2024-01-25T17:17:45.782370139Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Pendaftaran

Untuk membuat pendaftaran, gunakan metode projects.locations.enrollments.create.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• ENROLLMENT_NAME: nama tampilan pendaftaran Anda—misalnya, my_enrollment.
• MATCH_EXPRESSION: ekspresi CEL yang mengidentifikasi pesan mana yang berlaku untuk pendaftaran ini. Misalnya, message.type == 'hello-world-type'.
• destination: nama resource lengkap pipeline target dalam format projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME.

  Ganti kode berikut:

  • PROJECT_ID: Google Cloud project ID untuk project pipeline
  • LOCATION: region tempat pipeline di-deploy—misalnya, us-central1.
  • PIPELINE_NAME: nama pipeline
• message_bus: nama lengkap resource bus yang mengidentifikasi sumber pesan dalam format projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME.

  Ganti kode berikut:

  • BUS_PROJECT_ID: the Google Cloud project ID untuk project bus
  • BUS_LOCATION: region tempat bus di-deploy—misalnya, us-central1
  • BUS_NAME: nama bus pesan

Meminta isi JSON:

{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}

Untuk mengirim permintaan Anda, perluas salah satu opsi berikut:

cat > request.json << 'EOF'
{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}
EOF

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/enrollments?enrollment_id=ENROLLMENT_NAME"

@'
{
  "display_name": "ENROLLMENT_NAME",
  "cel_match": "MATCH_EXPRESSION",
  "message_bus": "projects/BUS_PROJECT_ID/locations/BUS_LOCATION/messageBuses/BUS_NAME",
  "destination": "projects/PROJECT_ID/locations/LOCATION/pipelines/PIPELINE_NAME"
}
'@  | Out-File -FilePath request.json -Encoding utf8

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://eventarc.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/enrollments?enrollment_id=ENROLLMENT_NAME" | Select-Object -Expand Content

Jika berhasil, isi respons berisi instance Operation yang baru dibuat:

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.eventarc.v1.OperationMetadata",
    "createTime": "2024-01-25T17:17:45.782370139Z",
    "target": "projects/PROJECT_ID/locations/LOCATION/enrollments/ENROLLMENT_NAME",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}