Pratinjau

Produk atau fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum di Persyaratan Khusus Layanan. Produk dan fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Buat konektor kustom

Halaman ini menjelaskan cara membuat konektor kustom. Untuk memahami apa itu konektor kustom, lihat Konektor kustom.

Catatan: Konektor kustom adalah resource global. Artinya, setelah dibuat, Anda dapat menggunakannya di salah satu lokasi yang didukung untuk Integration Connectors.

Untuk membuat konektivitas ke backend menggunakan konektor kustom, Anda harus melakukan tugas berikut:

1. Membuat konektor kustom - Dalam tugas ini, Anda akan menentukan kontrak antara Integration Connectors dan endpoint (backend) dengan memberikan spesifikasi OpenAPI endpoint. Saat ini, hanya OpenAPI versi 3.0 dan semua versi minornya yang didukung. Menetapkan spesifikasi adalah aktivitas satu kali.
2. Membuat koneksi konektor kustom - Dalam tugas ini, Anda akan mengonfigurasi detail koneksi backend, seperti nama host dan autentikasi. Untuk konektor kustom tertentu, Anda dapat membuat koneksi sebanyak yang diperlukan.

Untuk memahami perbedaan antara konektor dan koneksi, lihat Konektor versus koneksi.

Sebelum memulai

Pastikan pengguna yang membuat konektor kustom memiliki salah satu peran IAM berikut:

• Admin Konektor Kustom
• Admin Konektor

Buat konektor kustom

Seperti yang dijelaskan dalam skenario konektivitas backend, konektor kustom dapat memiliki pola konektivitas berikut:

• Konektivitas langsung ke endpoint publik backend Anda.
• Konektivitas tidak langsung ke backend Anda melalui endpoint publik perantara.

Langkah-langkah pembuatan konektor kustom sedikit berbeda untuk kedua pola ini.

Membuat konektor kustom dengan konektivitas langsung

Untuk membuat konektor kustom dengan konektivitas langsung ke endpoint backend Anda, lakukan langkah-langkah berikut:

Konsol

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

   Buka halaman Konektor kustom

2. Klik Buat baru untuk membuka halaman Buat konektor kustom.
3. Di bagian Detail konektor, tetapkan kolom berikut:
   1. Nama konektor: Masukkan nama untuk konektor.
   2. Nama tampilan: Masukkan nama tampilan untuk konektor.
   3. Deskripsi: Masukkan deskripsi.
   4. Jenis konektor kustom: Pilih jenis konektor kustom.
   5. Service account: Pilih akun layanan yang memiliki peran yang diperlukan.
4. Klik Next.
5. Di bagian Konektor spesifikasi, masukkan URL spesifikasi Open API backend Anda di kolom URL Spesifikasi, lalu klik Berikutnya. Contohnya, https://petstore3.swagger.io/api/v3/openapi.json
   Catatan: URL spesifikasi Open API harus dapat diakses secara publik.
6. Tinjau detail konfigurasi konektor, lalu klik Buat.

Jika pembuatan konektor berhasil, konektor yang baru dibuat akan ditampilkan di Buka halaman Konektor kustom. Namun, perhatikan bahwa agar dapat terhubung ke backend, Anda harus membuat koneksi untuk konektor yang baru dibuat. Untuk mengetahui informasi selengkapnya, lihat Membuat koneksi konektor kustom.

API

Contoh perintah berikut menunjukkan cara membuat konektor kustom dengan menggunakan Integration Connectors API:

1. Buat konektor.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json"
   -d '{"customConnectorType":"OPEN_API", \
   "displayName":"CUSTOM_CONNECTOR_NAME", \
   "description": "an open api based custom connector for hrms"}' \
   "https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"
   

   Ganti kode berikut:

   • CUSTOM_CONNECTOR_NAME: Nama untuk konektor kustom.
   • PROJECT_ID: ID project Google Cloud Anda.
   • UNIQUE_IDENTIFIER: ID unik untuk konektor. Contohnya, custom-connector-1.
2. Mengonfigurasi versi konektor kustom.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -d '{"spec_location": "SPECIFICATION_URL",}' \
   "https://connectors.googleapis.comv1/projects/PROJECT_ID/locations/global/customConnectors/openapi-customconnector/customConnectorVersions?custom_connector_version_id=VERSION_NUMBER"
   

Ganti kode berikut:

• SPECIFICATION_URL: URL spesifikasi Open API. Misalnya, https://petstore3.swagger.io/api/v3/openapi.json.
• PROJECT_ID: ID project Google Cloud Anda.
• VERSION_NUMBER: Nomor versi untuk konektor. Contoh, 2.

Membuat konektor kustom dengan konektivitas tidak langsung

Untuk membuat konektor kustom yang terhubung ke backend Anda melalui endpoint perantara, lakukan langkah-langkah berikut:

Konsol

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

   Buka halaman Konektor kustom

2. Klik Buat baru untuk membuka halaman Buat konektor kustom.
3. Di bagian Detail konektor, tetapkan kolom berikut:
   1. Nama konektor: Masukkan nama untuk konektor.
   2. Nama tampilan: Masukkan nama tampilan untuk konektor.
   3. Deskripsi: Masukkan deskripsi.
   4. Jenis konektor kustom: Pilih jenis konektor kustom.
   5. Akun layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
4. Klik Next.
5. Di bagian Spesifikasi konektor, masukkan URL spesifikasi Open API layanan perantara Anda di kolom URL Spesifikasi, lalu pilih opsi Konfigurasi tujuan konektor untuk akses backend.

   Ini akan menampilkan bagian konfigurasi tambahan di halaman tersebut.

6. Klik Next.
7. Di bagian Tujuan konektor, tetapkan kolom berikut:
   1. Jenis tujuan: Pilih Alamat host.
   2. Host: Masukkan nama host tempat layanan perantara Anda berjalan.
   3. Port: Masukkan nomor port layanan perantara Anda.
8. Klik Next.
9. Di bagian Autentikasi konektor, pilih jenis autentikasi layanan perantara, lalu masukkan detail yang sesuai saat diminta. Langkah ini adalah mengonfigurasi autentikasi dari Integration Connectors ke layanan perantara.

   Konfigurasi autentikasi dari layanan perantara ke backend tidak dapat dikonfigurasi dalam Integration Connectors; bergantung pada layanan perantara terkait cara melakukan autentikasi dengan backend.

10. Klik Next.
11. Di bagian Backend variables, masukkan nilai yang ingin Anda kirim ke backend melalui layanan perantara. Anda harus mengonfigurasi nilai sebagai key-value paris. Untuk memasukkan pasangan nilai kunci, klik Tambahkan variabel, lalu tetapkan kolom berikut:
    • Kunci: Masukkan nama kunci.
    • Jenis nilai: Pilih jenis data variabel.
    • Nama tampilan: Masukkan nama tampilan.
    • Lokasi: Tentukan cara konektor mengirim variabel ke layanan perantara. Opsi yang tersedia adalah; Header, Request payload, dan Query parameter.
    • Secara opsional, pilih Required untuk menentukan bahwa variabel adalah variabel wajib.
    Catatan: Anda akan diminta untuk memasukkan nilai variabel yang dikonfigurasi saat membuat koneksi.
12. Klik Next.
13. Tinjau detail konfigurasi konektor, lalu klik Buat.

Jika pembuatan konektor berhasil, konektor yang baru dibuat akan ditampilkan di Buka halaman Konektor kustom. Namun, perhatikan bahwa agar dapat terhubung ke backend, Anda harus membuat koneksi untuk konektor yang baru dibuat. Untuk mengetahui informasi selengkapnya, lihat Membuat koneksi konektor kustom.

API

Contoh perintah berikut menunjukkan cara membuat konektor kustom dengan menggunakan Integration Connectors API:

1. Buat konektor.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json"
   -d '{"customConnectorType":"OPEN_API", \
   "displayName":"CUSTOM_CONNECTOR_NAME", \
   "description": "an open api based custom connector for hrms"}' \
   "https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors?custom_connector_id=UNIQUE_IDENTIFIER"
   

   Ganti kode berikut:

   • CUSTOM_CONNECTOR_NAME: Nama untuk konektor kustom.
   • PROJECT_ID: ID project Google Cloud Anda.
   • UNIQUE_IDENTIFIER: ID unik untuk konektor. Contohnya, custom-connector-1.
2. Konfigurasikan versi konektor kustom dan autentikasi.

   curl -X POST \
   -H "authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -d '{"spec_location": "SPECIFICATION_URL", \
   "service_account":"test-sa", \
   "enable_backend_destination_config": true, \
   "auth_config": { \
   "auth_type":"USER_PASSWORD", \
   "auth_key": "basic", \
   "user_password": { \
   "username":"USERNAME", \
   "password": {"secret_version":"projects/PROJECT_ID/secrets/fidelity-secret/versions/SECRET_VERSION_NUMBER"} \
   }}, \
   "backend_variable_templates": [{ \
   "key":"authkey", \
   "value_type":"SECRET", \
   "display_name":"Authorization Key", \
   "required":true, \
   "location_type": "HEADER" \
   }], \
   "destination_configs":[{ \
   "key":"base_url", \
   "destinations": [{ \
   "host":"DESTINATION_HOST_ADDRESS" \
   }]} \
   ]}' \
   "https://connectors.googleapis.com/v1/projects/PROJECT_ID/locations/global/customConnectors/facade-connector/customConnectorVersions?custom_connector_version_id=CONNECTOR_VERSION_NUMBER"
   

Ganti kode berikut:

• SPECIFICATION_URL: URL spesifikasi Open API. Misalnya, https://petstore3.swagger.io/api/v3/openapi.json.
• PROJECT_ID: ID project Google Cloud Anda.
• USERNAME: Nama pengguna untuk autentikasi dengan layanan perantara.
• SECRET_VERSION_NUMBER: Nomor versi rahasia Secret Manager. Contoh, 2.
• DESTINATION_HOST_ADDRESS: Alamat host layanan perantara. Contoh, http://www.test.com:80.
• CONNECTOR_VERSION_NUMBER: Nomor versi konektor kustom. Contoh, 1.
Catatan: Contoh panggilan API ini menggunakan autentikasi Username and Password. Berdasarkan persyaratan, Anda dapat menggunakan jenis autentikasi yang berbeda.

Membuat koneksi konektor kustom

Setelah membuat konektor kustom, Anda harus membuat koneksi dari jenis konektor kustom agar dapat terhubung ke backend. Berikut adalah langkah-langkah tingkat tinggi untuk membuat koneksi baru:

1. Di Konsol 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 Location, pilih lokasi untuk koneksi dari kolom Region.

   Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.

4. Klik Next.
5. Di bagian Connection details, tetapkan kolom berikut:
   1. Konektor: Pilih konektor kustom 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 nama untuk koneksi tersebut.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus kecil.
      • Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh lebih dari 63 karakter.
   4. Secara opsional, masukkan Deskripsi untuk koneksi.
   5. Secara opsional, pilih Enable cloud logging untuk mengaktifkan cloud logging.
   6. Service account: Pilih akun layanan yang memiliki peran yang diperlukan.
   7. Secara opsional, konfigurasikan Setelan node koneksi:
      • Jumlah minimum node: Masukkan jumlah minimum node koneksi.
      • Jumlah maksimum node: Masukkan jumlah maksimum node koneksi.

      {i>Node<i} adalah unit (atau replika) koneksi yang memproses transaksi. Lebih banyak node diperlukan untuk memproses lebih banyak transaksi untuk sebuah koneksi dan sebaliknya, lebih sedikit node diperlukan untuk memproses transaksi yang lebih sedikit. Untuk memahami pengaruh node terhadap harga konektor Anda, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum akan ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.

   Catatan: Anda dapat menyesuaikan nilai node koneksi hanya jika Anda adalah pelanggan Bayar sesuai penggunaan.
   8. Anda juga dapat mengklik Add label untuk menambahkan label ke koneksi dalam bentuk pasangan nilai kunci.
6. Klik Next.
7. Di bagian Authentication, masukkan detail autentikasi untuk backend Anda.
   • Jika Anda terhubung langsung ke backend, Integration Connectors akan meminta Anda mengonfigurasi autentikasi untuk backend.
   • Jika Anda terhubung secara tidak langsung ke backend melalui layanan perantara, Integration Connectors tidak akan meminta Anda untuk mengonfigurasi detail autentikasi. Saat membuat konektor, Anda tentu sudah mengonfigurasi autentikasi antara Integration Connectors dan layanan perantara. Integration Connectors tidak mengharuskan Anda mengonfigurasi autentikasi antara layanan perantara dan backend; Anda dapat memilih layanan perantara terkait cara melakukan autentikasi dengan backend.
8. Klik Next.
9. Tinjau detail konfigurasi koneksi, lalu klik Create.

Jika pembuatan koneksi berhasil, koneksi akan tercantum di halaman Semua koneksi, dan koneksi akan tersedia dalam Application Integration. Anda dapat menggunakan koneksi dalam integrasi Anda melalui tugas Konektor.

Pertimbangan

Pertimbangkan hal-hal berikut saat membuat konektor kustom:

• Integration Connectors hanya mendukung OpenAPI versi 3.0 dan semua versi minornya.
• Spesifikasi Open API tidak divalidasi selama pembuatan konektor kustom. Saat Anda membuat koneksi untuk konektor kustom, Integration Connectors akan memvalidasi spesifikasi, dan jika mengalami error, koneksi tersebut akan berada dalam status Error.
• Integration Connectors tidak membedakan antara entity dan tindakan. Oleh karena itu, entity dan tindakan backend Anda akan tercantum sebagai Actions di konektor kustom Anda.
• Konektor kustom tidak didukung di project Google Cloud yang mengaktifkan Kontrol Layanan VPC.
• Endpoint spesifikasi Open API dan endpoint backend harus dapat diakses secara publik. Artinya, Anda tidak dapat membuat konektivitas pribadi ke backend.
• Jenis media multi-bagian tidak didukung dalam spesifikasi Open API.
• Saat ini, setelah membuat konektor kustom, Anda tidak dapat mengedit detailnya.