Membangun CICD untuk integrasi Anda

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

Ringkasan

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

Tujuan

Tutorial ini menunjukkan cara menyelesaikan tugas-tugas berikut dalam integrasi Anda:

  • Buat integrasi.
  • Buat variabel konfigurasi dan gunakan dalam integrasi Anda.
  • Dorong integrasi Anda ke lingkungan lain.

Biaya

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

Petunjuk dalam tutorial ini dirancang untuk menjaga penggunaan resource Anda tetap sesuai 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. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Secret Manager API, Connectors API APIs.

    Enable the APIs

  5. Create a service account:

    1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
    2. Select your project.

    3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

    4. Click Create and continue.

    5. Grant the Pub/Sub Publisher (roles/pubsub.publisher) role to the service account.

      To grant the role, find the Select a role list, then select Pub/Sub Publisher (roles/pubsub.publisher).

    6. Click Continue.

    7. Click Done to finish creating the service account.

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

    Go to project selector

  7. Make sure that billing is enabled for your Google Cloud project.

  8. Enable the Secret Manager API, Connectors API APIs.

    Enable the APIs

  9. Create a service account:

    1. In the Google Cloud console, go to the Create service account page.

      Go to Create service account
    2. Select your project.

    3. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

      In the Service account description field, enter a description. For example, Service account for quickstart.

    4. Click Create and continue.

    5. Grant the Pub/Sub Publisher (roles/pubsub.publisher) role to the service account.

      To grant the role, find the Select a role list, then select Pub/Sub Publisher (roles/pubsub.publisher).

    6. Click Continue.

    7. Click Done to finish creating the service account.

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 memberi nama topik, langganan, skema, atau snapshot.

  4. Pertahankan opsi Tambahkan langganan default.

  5. Jangan pilih opsi lainnya.

  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 Koneksi

  2. Klik + Buat Baru untuk membuka halaman Buat Koneksi.
  3. Di bagian Location, pilih lokasi untuk koneksi.
    1. Region: Pilih lokasi dari menu drop-down.

      Untuk mengetahui daftar semua region yang didukung, lihat Lokasi.

    2. Klik NEXT.
  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 Nama Koneksi, masukkan pub-sub-connector.
    4. Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
    5. Project ID: Project ID Google Cloud tempat instance Pub/Sub berada.
    6. Topic ID: Masukkan nama topik Pub/Sub Anda.
    7. Klik Berikutnya.
  5. Di bagian Authentication, klik BERIKUTNYA.
  6. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
  7. Klik Create.

Membuat integrasi baru

Setelah Menyiapkan Integrasi Aplikasi, Anda dapat membuat integrasi baru:

  1. Di konsol Google Cloud, buka halaman Integrasi Aplikasi.

    Buka Application Integration

  2. Di menu navigasi, klik Integrations. Halaman Integrations akan muncul.
  3. Klik Buat integrasi dan berikan detail berikut di halaman Buat Integrasi:
    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 wilayah 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 wilayah.
    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 Call REST Endpoint

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

    Buka Application Integration

  2. Di menu navigasi, klik Integrations

    Halaman Daftar Integrasi akan muncul yang 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 integration editor, klik Triggers > API Trigger untuk menambahkan pemicu.
  5. Di menu navigasi editor integrasi, klik Tugas > Call REST Endpoint untuk menambahkan tugas.
  6. Tambahkan koneksi tepi dari elemen API trigger ke elemen Call REST Endpoint dengan mengarahkan kursor ke titik kontrol pada elemen API trigger, lalu mengklik dan menarik garis ke titik kontrol pada elemen tugas Call REST Endpoint.

Membuat variabel konfigurasi

Untuk membuat variabel konfigurasi, ikuti langkah-langkah berikut:
  1. Di menu navigasi editor integrasi, klik (Panel tombol) untuk menampilkan panel Variabel.
  2. Klik +Create.
  3. Lakukan hal 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 Jenis data, pilih String.
    4. Klik Create.

      Variabel konfigurasi akan muncul di panel Variabel.

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

Menambahkan dan mengonfigurasi Call 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 hal berikut:
    1. Luaskan bagian Input tugas.
    2. Di Endpoint base URL, klik Variable dan tambahkan $`CONFIG_url`$.

Menambahkan dan mengonfigurasi tugas Konektor

  1. Di menu navigasi editor integrasi, klik Tugas > Konektor.
  2. Klik Konfigurasi Konektor.
  3. Dari daftar Region, pilih region tempat Anda membuat konektor Pub/Sub.
  4. Di kolom Koneksi, pilih konektor Pub/Sub yang Anda buat di langkah sebelumnya.
  5. Di bagian Type, pilih Actions.
  6. Di bagian Set entities/actions, untuk Actions, pilih publishMessage.
  7. Di bagian Nilai default, tambahkan nilai default untuk variabel konfigurasi.
  8. Klik Create.
  9. Di panel konfigurasi tugas Konektor, luaskan bagian Detail koneksi untuk memperbarui kolom berikut:
    1. Di kolom Nama koneksi, klik Variable, lalu pilih $`CONFIG_connection_name`$.

Menambahkan tugas Pemetaan Data

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

Memublikasikan integrasi

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

    Dialog Publikasikan integrasi akan muncul.

  2. Di 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 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, yang merupakan alat open source yang memungkinkan Anda berinteraksi dengan Application Integration API dan Integration Connectors API. Alat ini memungkinkan Anda mengelola entitas integrasi seperti integrasi, konfigurasi autentikasi, dan sebagainya. Untuk 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 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 tidak dapat didownload. Saat memublikasikan integrasi di lingkungan baru, Integrasi Aplikasi memungkinkan Anda memasukkan nilai untuk variabel konfigurasi.

Langkah selanjutnya