Membangun CICD untuk integrasi Anda


Tutorial ini menjelaskan cara mengotomatiskan promosi integrasi antara lingkungan yang berbeda di berbagai project Google Cloud menggunakan variabel konfigurasi (pratinjau).

Ringkasan

Dalam tutorial ini, Anda akan mengotomatiskan deployment Application Integration menggunakan variabel config untuk contoh integrasi. Contoh alur integrasi ini memanggil API dan memublikasikan respons dari API ke topik Pub/Sub. Contoh ini dimaksudkan untuk menggambarkan penggunaan tugas Call REST Endpoint dan Connector. Anda dapat menyimpan contoh integrasi di repositori GitHub yang sesuai dengan berbagai lingkungan dan project Google Cloud.

Tujuan

Tutorial ini menunjukkan cara menyelesaikan tugas berikut dalam integrasi Anda:

  • Buat integrasi.
  • Membuat variabel konfigurasi dan menggunakannya dalam integrasi Anda.
  • Promosikan integrasi Anda ke lingkungan lain.

Biaya

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

Petunjuk dalam tutorial ini dirancang untuk menjaga penggunaan resource Anda tetap dalam batas Penawaran uji coba dan fitur cloud 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, lihat Pembersihan.

Sebelum memulai

  1. Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.
  2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

    Buka pemilih project

  3. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

  4. Aktifkan API Secret Manager API, Connectors API.

    Mengaktifkan API

  5. Buat akun layanan:

    1. Di konsol Google Cloud, buka halaman Buat akun layanan.

      Buka Create service account
    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. Sebagai contoh, Service account for quickstart.

    4. Klik Buat dan lanjutkan.
    5. Berikan peran Pub/Sub Publisher (roles/pubsub.publisher) ke akun layanan.

      Untuk memberikan peran, temukan daftar Pilih peran, lalu pilih Pub/Sub Publisher (roles/pubsub.publisher).

    6. Klik Lanjutkan.
    7. Klik Selesai untuk menyelesaikan pembuatan akun layanan.

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

    Buka pemilih project

  7. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

  8. Aktifkan API Secret Manager API, Connectors API.

    Mengaktifkan API

  9. Buat akun layanan:

    1. Di konsol Google Cloud, buka halaman Buat akun layanan.

      Buka Create service account
    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. Sebagai contoh, Service account for quickstart.

    4. Klik Buat dan lanjutkan.
    5. Berikan peran Pub/Sub Publisher (roles/pubsub.publisher) ke akun layanan.

      Untuk memberikan peran, temukan daftar Pilih peran, lalu pilih Pub/Sub Publisher (roles/pubsub.publisher).

    6. Klik Lanjutkan.
    7. Klik Selesai untuk menyelesaikan pembuatan akun layanan.

Membuat topik Pub/Sub

  1. Di konsol Google Cloud, buka halaman Topics Pub/Sub.

    Buka Topik

  2. Klik Create topic.

  3. Di kolom ID Topik, masukkan ID untuk topik Anda. Untuk mengetahui informasi selengkapnya tentang penamaan topik, lihat Panduan untuk menamai topik, langganan, skema, atau ringkasan.

  4. Pertahankan opsi Tambahkan langganan default.

  5. Jangan pilih opsi lain.

  6. Klik Create topic.

Mengonfigurasi konektor Pub/Sub

  1. Di Konsol Google Cloud, buka halaman Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.

    Buka halaman Connections

  2. Klik + Create New untuk membuka halaman Create Connection.
  3. Di bagian Lokasi, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.

    2. Klik BERIKUTNYA.
  4. Di bagian Connection Details, selesaikan tindakan berikut:
    1. Konektor: Pilih Pub/Sub dari menu drop-down Konektor yang tersedia.
    2. Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
    3. Di kolom Connection Name, masukkan pub-sub-connector.
    4. Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
    5. Project ID: Project ID Google Cloud tempat instance Pub/Sub berada.
    6. ID Topik: Masukkan nama topik Pub/Sub.
    7. Klik Next.
  5. Di bagian Authentication, klik BERIKUTNYA.
  6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  7. Klik Create.

Membuat integrasi baru

Setelah Menyiapkan Application Integration, Anda dapat membuat integrasi baru:

  1. Di konsol Google Cloud, buka halaman Application Integration.

    Buka Application Integration

  2. Di menu navigasi, klik Integrasi. Halaman Integrations List akan muncul.
  3. Klik Create integration, lalu berikan detail berikut di halaman Create Integration:
    1. Nama integrasi: Masukkan nama untuk integrasi Anda. Contoh, build-cicd.
    2. Deskripsi: Secara opsional, masukkan deskripsi untuk integrasi Anda. Contoh, Demo integration created for CICD tutorial.
    3. Region: Pilih region us-central1 dari daftar region yang disediakan. Jika region yang ingin Anda pilih tidak disediakan, lihat Menyediakan region baru. Untuk melihat daftar region yang didukung, lihat Lokasi Integrasi Aplikasi.
    4. Akun layanan: Kolom ini muncul jika Anda telah mengaktifkan tata kelola untuk wilayah Anda. Pilih akun layanan untuk integrasi Anda. Untuk mempelajari cara mengaktifkan tata kelola untuk wilayah Anda, lihat Mengedit region.
    5. Klik Create. Tindakan ini akan membuka halaman editor integrasi, tempat Anda dapat menambahkan tugas dan pemicu untuk membuat integrasi.

Membuat alur integrasi

Menambahkan pemicu API dan Memanggil REST Endpoint

Untuk menambahkan pemicu pemicu API, lakukan langkah-langkah berikut:
  1. Di konsol Google Cloud, buka halaman Application Integration.

    Buka Application Integration

  2. Di menu navigasi, klik Integrasi

    Halaman Integrations List akan muncul dan mencantumkan semua integrasi yang tersedia di project Google Cloud.

  3. Pilih integrasi build-cicd.

    Tindakan ini akan membuka integrasi di editor integrasi.

  4. Di menu navigasi editor integrasi, klik Pemicu > Pemicu API untuk menambahkan pemicu.
  5. Di menu navigasi editor integrasi, klik Tasks > Call REST Endpoint untuk menambahkan tugas.
  6. Tambahkan koneksi edge dari elemen pemicu API ke elemen Call REST Endpoint dengan mengarahkan kursor ke titik kontrol di elemen API trigger, lalu klik dan tarik garis ke titik kontrol di elemen tugas Call REST Endpoint.

Membuat variabel konfigurasi

Untuk membuat variabel konfigurasi, ikuti langkah-langkah berikut:
  1. Di menu navigasi editor integrasi, klik (Aktifkan/nonaktifkan panel) untuk menampilkan panel Variabel.
  2. Klik +Create.
  3. Lakukan tindakan berikut di panel Create Variable:
    1. Untuk Name, masukkan url.

      Integrasi Aplikasi menambahkan awalan `CONFIG_ ke variabel konfigurasi. Jika Anda ingin menambahkan variabel konfigurasi ke integrasi menggunakan API, gunakan format berikut untuk variabel konfigurasi: `CONFIG_CONFIG_VARIABLE_NAME`. Untuk mengetahui informasi tentang cara mendownload dan mengupload integrasi, lihat Mengupload dan mendownload integrasi.

    2. Untuk Jenis variabel, pilih Variabel Konfigurasi.
    3. Untuk Data type, pilih String.
    4. Klik Create.

      Variabel konfigurasi akan muncul di panel Variabel.

  4. Ulangi Langkah 2 dan 3 untuk menambahkan variabel konfigurasi berikut:
    • Name: connection_name
    • Jenis variabel: Config Variable
    • Jenis data: String

Menambahkan dan mengonfigurasi Panggilan REST Endpoint

Untuk membuat variabel konfigurasi, ikuti langkah-langkah berikut:
  1. Di editor integrasi, klik tugas Call REST Endpoint untuk membuka panel konfigurasi tugas. Kemudian, lakukan tindakan berikut:
    1. Luaskan bagian Task input.
    2. Di URL dasar endpoint, klik Variabel, lalu tambahkan $`CONFIG_url`$.

Menambahkan dan mengonfigurasi tugas Konektor

  1. Di menu navigasi editor integrasi, klik Tugas > Konektor.
  2. Klik Configure Connectors.
  3. Dari daftar Region, pilih region tempat Anda membuat konektor Pub/Sub.
  4. Di kolom Connection, pilih Pub/Sub Connector yang Anda buat di langkah sebelumnya.
  5. Di bagian Jenis, pilih Tindakan.
  6. Di bagian Set entity/actions, untuk Tindakan, pilih publishMessage.
  7. Di bagian Nilai default, tambahkan nilai default untuk variabel konfigurasi.
  8. Klik Create.
  9. Di panel konfigurasi tugas Connectors, luaskan bagian Connection details untuk memperbarui kolom berikut:
    1. Di kolom Nama koneksi, klik Variabel, lalu pilih $`CONFIG_connection_name`$.

Menambahkan tugas Pemetaan Data

  1. Di menu navigasi editor integrasi, klik Tugas > Pemetaan data.
  2. Tambahkan koneksi edge dari elemen Call REST Endpoint ke elemen Data Mapping dengan mengarahkan kursor ke titik kontrol di elemen Call REST Endpoint, lalu mengklik dan menarik garis ke titik kontrol pada elemen tugas Data Mapping.
  3. Tambahkan sambungan tepi lainnya dari elemen Pemetaan Data ke elemen Konektor dengan mengarahkan kursor ke titik kontrol di elemen Pemetaan Data, lalu mengklik dan menarik garis ke titik kontrol pada elemen tugas Konektor.
  4. Di panel konfigurasi tugas Data Mapping, klik Open Data Mapping Editor.
  5. Petakan variabel output dari tugas Call REST Endpoint ke variabel input tugas Konektor.

Memublikasikan integrasi

Untuk memublikasikan integrasi, ikuti langkah-langkah berikut:
  1. Untuk memublikasikan integrasi, klik Publikasikan di toolbar editor integrasi.

    Dialog Publish integration akan muncul.

  2. Pada dialog Publish integration, masukkan nilai untuk variabel konfigurasi berikut:
    1. url: Masukkan nama URL endpoint.
    2. connection_name: Masukkan nama konektor Pub/Sub yang Anda buat di langkah sebelumnya.
  3. Klik Publikasikan.
  4. Setelah berhasil memublikasikan integrasi, Anda dapat melihat dan memeriksa log eksekusi dari integrasi yang dipublikasikan. Untuk melihat log, klik Logs di toolbar editor integrasi.

Mempromosikan integrasi di seluruh lingkungan

Untuk mempromosikan integrasi di seluruh lingkungan, Anda dapat menggunakan alat integrationcli, yaitu alat open source yang memungkinkan Anda berinteraksi dengan Application Integration API dan Integration Connectors API. Alat ini memungkinkan Anda mengelola entity integrasi seperti integrasi, konfigurasi autentikasi, dan sebagainya. Untuk mengetahui informasi tentang cara membuat scaffold untuk integrasi dan menerapkan perubahan yang dihasilkan oleh scaffold, lihat Pengantar integrationcli di blog komunitas.

Anda juga dapat mempromosikan perubahan di seluruh lingkungan dengan menyiapkan pipeline DevOps, misalnya menggunakan Jenkins, GitLab, Cloud Build, dan sebagainya. Untuk mengetahui informasi selengkapnya, lihat Integrasi dengan Cloud Build.

Jika tidak ingin menggunakan integrationcli, Anda dapat mendownload dan mengupload integrasi secara manual ke project baru. Anda harus membuat konektor di project baru secara manual karena saat ini konektor tersebut tidak dapat didownload. Saat Anda memublikasikan integrasi di lingkungan baru, Application Integration memungkinkan Anda memasukkan nilai untuk variabel konfigurasi.

Langkah selanjutnya