Mengonfigurasi cluster untuk menerima notifikasi melalui email

Tutorial ini menunjukkan cara mengonfigurasi Application Integration untuk menerima notifikasi cluster Google Kubernetes Engine (GKE) melalui email.

Anda membuat integrasi dengan pemicu Pub/Sub untuk memproses topik yang ada yang menerima notifikasi dari cluster GKE. Kemudian, Anda dapat menggunakan tugas Pemetaan Data dan Transformer Data untuk mengubah pesan Pub/Sub dan membuat isi email teks biasa.

Tujuan

  • Membuat aplikasi Application Integration untuk menerima dan mengubah notifikasi eksternal dari GKE.
  • Menulis tugas Kirim Email yang mengirimkan notifikasi Pub/Sub ke email.

Biaya

Dalam dokumen ini, Anda akan menggunakan komponen yang dapat ditagih berikut Google Cloud:

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga.

Pengguna baru mungkin memenuhi syarat untuk mendapatkan uji coba gratis. Google Cloud

Setelah menyelesaikan tugas yang dijelaskan dalam dokumen ini, Anda dapat menghindari penagihan berkelanjutan dengan menghapus resource yang Anda buat. Untuk mengetahui informasi selengkapnya, baca bagian Pembersihan.

Sebelum memulai

  1. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  2. Verify that billing is enabled for your Google Cloud project.

  3. Enable the GKE, Application Integration and Pub/Sub APIs.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

  4. Aktifkan penerimaan notifikasi cluster GKE melalui Pub/Sub.
  5. Jika Anda menggunakan Application Integration di project untuk pertama kalinya, Anda harus menyiapkan Application Integration dengan membuka halaman Application Integration di konsol dan mengklik Provision.

Peran yang diperlukan

Untuk memastikan bahwa service-PROJECT_NUMBER@gcp-sa-integrations. memiliki izin yang diperlukan untuk menyiapkan notifikasi email untuk notifikasi cluster, minta administrator Anda untuk memberikan peran IAM berikut kepada service-PROJECT_NUMBER@gcp-sa-integrations. di project Anda:

Menyiapkan notifikasi cluster untuk cluster GKE Anda

Untuk menggunakan Pub/Sub guna menerima notifikasi tentang cluster GKE Anda, ikuti Menerima notifikasi cluster melalui Pub/Sub.

Membuat integrasi baru

Untuk membuat integrasi baru, lakukan langkah-langkah berikut:

  1. Buka halaman Application Integration di Google Cloud konsol.

    Buka Application Integration

  2. Di menu navigasi, klik Integrations. Halaman Integrations akan muncul.

  3. Klik Create integration.

  4. Di Integration name, masukkan nama untuk integrasi yang Anda buat.

  5. Jika Anda mengaktifkan beberapa region, opsi drop-down akan ditampilkan agar Anda dapat memilih region untuk integrasi. Jika hanya satu region yang diaktifkan, region tersebut akan ditetapkan secara default dan drop-down tidak akan ditampilkan.

    Catatan: Drop-down Regions hanya mencantumkan region yang disediakan di Google Cloud project Anda. Untuk menyediakan region baru, klik Enable Region yang ditampilkan di bagian bawah kotak.

  6. Klik Create untuk membuka editor integrasi.

Menambahkan dan mengonfigurasi pemicu Pub/Sub

Untuk menambahkan pemicu Pub/Sub ke integrasi, ikuti langkah-langkah berikut:

  1. Di editor integrasi, pilih Triggers untuk menampilkan daftar pemicu yang tersedia.

  2. Klik dan tempatkan elemen pemicu Pub/Sub ke desainer.

  3. Klik elemen Pub/Sub trigger di editor integrasi untuk melihat panel konfigurasi pemicu.

  4. Tentukan topik yang harus diproses oleh pemicu di kolom Pub/Sub topic dalam format berikut:

    projects/PROJECT_ID/topics/TOPIC_ID
    

    Ganti kode berikut:

  • PROJECT_ID: Google Cloud project tempat topik Anda dibuat.

  • TOPIC_ID: ID topik Pub/Sub yang Anda buat di Menyiapkan lingkungan Anda.

    Misalnya, jika project Anda diberi nama my-project dan Anda memberi nama topik gke-notifications, masukkan:

    projects/my-project/topics/gke-notifications
    

    Untuk melihat semua topik yang tersedia di project Anda, lihat kolom Topic name di Topics. Google Cloud Panel konfigurasi pemicu Pub/Sub akan otomatis mengisi kolom Trigger Output dengan variabel untuk menyimpan pesan Pub/Sub.

Menambahkan dan mengonfigurasi tugas Pemetaan Data

Tugas Pemetaan Data membantu mengekstrak variabel yang relevan dari notifikasi Pub/Sub. Tugas ini menggunakan file JSON pesan Pub/Sub sebagai input dan mengekstrak variabel sebagai output.

Untuk mengonfigurasi tugas Pemetaan Data:

  1. Pilih Tasks untuk menampilkan daftar tugas yang tersedia.

  2. Klik dan tempatkan elemen Data Mapping di editor integrasi.

  3. Klik tugas Data Mapping di desainer untuk membuka panel konfigurasi tugas.

  4. Untuk menambahkan koneksi edge dari pemicu Pub/Sub ke Pemetaan Data, tahan kursor di atas titik kontrol pada pemicu Pub/Sub, lalu tarik garis ke titik kontrol pada tugas Pemetaan Data. Edge menunjukkan aliran kontrol dari pemicu Pub/Sub ke tugas Pemetaan Data.

  5. Klik Open Data Mapping Editor. Data Mapping Editor memungkinkan Anda memetakan variabel input ke variabel output yang dipilih, menggunakan fungsi transformasi yang tersedia. Output kemudian tersedia sebagai variabel untuk tugas atau pemicu integrasi lainnya. Untuk mengetahui informasi selengkapnya tentang variabel di Application Integration, lihat Variabel.

    Untuk tutorial ini, ikuti langkah-langkah berikut untuk membuat pemetaan menggunakan CloudPubSubMessage sebagai input:

    1. Luaskan variabel JSON CloudPubSubMessage dalam daftar Variables lalu tarik variabel CloudPubSubMessage.data ke baris Input pertama.
    2. Untuk membuat variabel output baru yang menyimpan nilai data yang diubah, klik baris pertama di kolom Output. Kemudian, lakukan hal berikut:
      1. Di kolom Name, masukkan message_data.
      2. Dari daftar Variable Type, pilih Output from integration.
      3. Dari daftar Data Type, pilih String.
      4. Klik Create. Variabel message_data akan muncul di Output.
    3. Tarik variabel CloudPubSubMessage.attributes dari daftar Variables ke baris kedua di kolom Input.
    4. Klik baris kedua di kolom Output untuk membuat variabel output baru yang menyimpan nilai payload JSON dengan atribut cluster. Lengkapi kolom berikut:

      1. Di kolom Name, masukkan attributes.
      2. Dari daftar Variable Type, pilih None.
      3. Dari daftar Data Type, pilih JSON.
      4. Pilih Enter a JSON schema dari JSON schema options, lalu tempel payload berikut:

        {
          "$schema": "http://json-schema.org/draft-07/schema#",
          "type": "object",
          "properties": {
            "cluster_name": {
              "type": "string"
            },
            "payload": {
              "type": "string"
            },
            "project_id": {
              "type": "string"
            },
            "cluster_location": {
              "type": "string"
            },
            "type_url": {
              "type": "string"
            }
          }
        }
        
      5. Klik Create. Variabel attributes akan muncul di Output. Pastikan variabel atribut terlihat mirip dengan berikut ini:

        Variabel Lokal Application Integration

    5. Klik baris ketiga di kolom Input , lalu pilih attributes.cluster_name dari panel Variables. Anda mungkin perlu mulai mengetik attributes untuk melihat semua 5 atribut yang ditentukan dari skema yang dimasukkan pada langkah sebelumnya.

    6. Klik baris yang sesuai dari kolom Output untuk membuat variabel output baru yang akan menyimpan nilai atribut nama cluster. Lengkapi kolom berikut:

      1. Di kolom Name, masukkan cluster_name.
      2. Dari daftar Variable Type, pilih Output from integration.
      3. Dari daftar Data Type, pilih String.
      4. Klik Create. Variabel cluster_name akan muncul di Output.
    7. Ulangi langkah e dan f untuk project_id, cluster_location, type_url, dan payload.

    8. Tutup Data Mapping Editor setelah pemetaan Anda selesai. Semua perubahan akan disimpan secara otomatis.

Menambahkan dan mengonfigurasi tugas Data Transformer (Skrip)

Tugas Data Transformer menggunakan variabel yang diekstrak dari tugas Pemetaan Data sebagai input dan mengubahnya menjadi isi pesan untuk penggunaan pengguna akhir.

Untuk mengonfigurasi tugas Data Transformer:

  1. Pilih Tasks untuk menampilkan daftar tugas yang tersedia.
  2. Klik dan tempatkan elemen Data Transformer (Script) di editor integrasi.
  3. Klik tugas Data Transformer di desainer untuk membuka panel konfigurasi tugas.
  4. Untuk menambahkan koneksi edge dari tugas Pemetaan Data ke tugas Data Transformer, tahan kursor di atas titik kontrol pada Pemetaan Data, lalu tarik garis ke titik kontrol pada tugas Data Transformer. Edge menunjukkan aliran kontrol dari tugas Pemetaan Data ke tugas Data Transformer.
  5. Klik Open Data Transformer Editor. Data Transformer Editor memungkinkan Anda menulis, mengedit, dan mengevaluasi template Jsonnet kustom untuk melakukan pemetaan data dalam integrasi Anda. Output kemudian tersedia sebagai variabel untuk tugas atau pemicu integrasi lainnya. Untuk mengetahui detail selengkapnya tentang tugas transformer ini, lihat Tugas Data Transformer. Untuk panduan memulai ini, ikuti langkah-langkah berikut untuk membuat skrip:

    1. Klik Create di panel kiri Variables. Tindakan ini akan membuka panel Create variable di sisi kanan. Lengkapi kolom berikut:

      • Name: Masukkan full_message.
      • Pilih Output from integration di kotak drop-down Variable Type.
      • Pilih String di kotak drop-down Data Type.
      • Klik Create untuk membuat variabel dan menutup panel. Variabel full_message baru akan muncul dalam daftar Variables.
    2. Pilih Script.

    3. Gunakan contoh skrip berikut sebagai template untuk isi pesan saat notifikasi dikirim dari cluster Anda:

      local message_data = std.extVar("message_data");
      local cluster_name = std.extVar("cluster_name");
      local project_id = std.extVar("project_id");
      local cluster_location = std.extVar("cluster_location");
      local type_url = std.extVar("type_url");
      local payload = std.extVar("payload");
      
      {full_message: "Project ID: " + project_id + "\n" +
                    "Cluster Name: " + cluster_name + "\n" +
                    "Location: " + cluster_location + "\n" +
                    "Event Type: " + type_url + "\n" +
                    "Message: " + message_data + "\n" +
                    "Payload: " + std.manifestJson(std.parseJson(payload))}
      
    4. Tutup Data Mapping Editor setelah pemetaan Anda selesai. Semua perubahan akan disimpan secara otomatis.

Menambahkan dan mengonfigurasi tugas Kirim Email

Untuk mengonfigurasi tugas Kirim Email:

  1. Pilih Tasks di editor integrasi untuk menampilkan daftar tugas yang tersedia.
  2. Klik dan tempatkan elemen Send Email di editor integrasi.
  3. Untuk menambahkan koneksi edge dari tugas Data Transformer ke tugas Kirim email, tahan kursor di atas titik kontrol pada tugas Data Transformer, lalu tarik garis ke titik kontrol pada tugas Kirim email. Edge menunjukkan aliran kontrol dari tugas Data Transformer ke tugas Kirim email.
  4. Klik elemen Send Email di desainer untuk membuka panel konfigurasi tugas. Tetapkan properti berikut:
    1. To Recipient(s): Masukkan alamat email. Anda akan menggunakan email ini untuk mengonfirmasi keberhasilan penyelesaian integrasi.
    2. Subjek: Masukkan GKE Notifications.
    3. Body in Plain Text: Pilih variabel full_message yang dibuat sebelumnya dalam tugas Data Transformer.
    4. Opsi yang tersisa dapat dibiarkan dalam konfigurasi default.

Perubahan yang Anda buat pada properti akan disimpan secara otomatis dan kanvas Anda akan terlihat mirip dengan berikut ini:

Kanvas Application Integration

Menguji integrasi

Untuk menguji integrasi baru, buka menu navigasi di bagian atas diagram Integrasi Anda, lalu klik Test. Tindakan ini akan membuka panel di sisi kanan. Anda dapat menggunakan contoh pesan Pub/Sub berikut di bagian Add a json value:

{
  "data": "Node pool projects/my-project/locations/us-central1-c/clusters/cluster-1/nodePools/default-pool is upgrading to version 1.29.1-gke.1589017.",
  "attributes": {
    "cluster_location": "us-central1-c",
    "cluster_name": "cluster-1",
    "payload": "{\"resourceType\":\"NODE_POOL\",\"operation\":\"operation-upgrade\",\"operationStartTime\":\"2024-05-07T20:09:35.528855756Z\",\"currentVersion\":\"1.28.7-gke.1026000\",\"targetVersion\":\"1.29.1-gke.1589017\",\"resource\":\"projects/my-project/locations/us-central1-c/clusters/cluster-1/nodePools/default-pool\"}",
    "project_id": "my-project",
    "type_url": "type.googleapis.com/google.container.v1beta1.UpgradeEvent"
  }
}

Email akan dikirim ke alamat email yang telah Anda konfigurasi dalam tugas Kirim Email setelah mengklik tombol Test Integration.

Memublikasikan integrasi Anda

Setelah berhasil menguji integrasi ini, klik Publish agar integrasi Anda mulai memproses pesan.

Anda hanya dapat mengedit integrasi versi DRAFT, dan hanya menjalankan integrasi versi ACTIVE. Jika ingin mengedit integrasi, klik Enable Editing di halaman desainer integrasi, lalu buat versi draf. Untuk mengetahui informasi selengkapnya, lihat Kunci pengeditan integrasi.

Pembersihan

Agar tidak perlu membayar biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, hapus project yang berisi resource tersebut, atau simpan project dan hapus setiap resource.

Menghapus project

  1. Dikonsol, buka halaman Manage resources. Google Cloud

    Buka Kelola resource

  2. Pada daftar project, pilih project yang Anda ingin Anda hapus, lalu klik Delete.
  3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus project.

Menghapus resource satu per satu

  1. Hapus Application Integration Anda.

  2. Hapus topik Pub/Sub Anda.

Langkah berikutnya