Confluence

Anda dapat menggunakan konektor Confluence untuk melakukan operasi penyisipan, penghapusan, pembaruan, dan pembacaan di Confluence.

Sebelum memulai

Sebelum menggunakan konektor Confluence, lakukan tugas berikut:

• Di project Google Cloud Anda:
  • Pastikan konektivitas jaringan sudah disiapkan. Untuk mengetahui informasi tentang pola jaringan, lihat Konektivitas jaringan.
  • Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
  • Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu diautentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk informasi selengkapnya, lihat Membuat akun layanan.

  • Aktifkan layanan berikut:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.

  Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.

Mengonfigurasi konektor

Untuk mengonfigurasi konektor, Anda harus membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:

1. Di konsol Cloud, buka halaman Konektor Integrasi > Koneksi, lalu pilih atau buat project Google Cloud.

   Buka halaman Koneksi

2. Klik + CREATE NEW untuk membuka halaman Create Connection.
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 Confluence 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 instance Connection.

      Nama koneksi harus memenuhi kriteria berikut:

      • Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
      • Huruf harus berupa huruf kecil.
      • Nama koneksi harus diawali dengan huruf dan diakhiri dengan huruf atau angka.
      • Nama koneksi tidak boleh melebihi 49 karakter.
   4. Secara opsional, masukkan Description untuk instance koneksi.
   5. Secara opsional, aktifkan Cloud Logging, lalu pilih level log. Secara default, level log ditetapkan ke Error.
   6. Service Account: Pilih akun layanan yang memiliki peran yang diperlukan.
   7. Secara opsional, pilih Sertakan Ruang yang Diarsipkan untuk menyertakan konten dari ruang yang diarsipkan dalam hasil. Secara default, nilainya adalah false.
   8. Secara opsional, masukkan Kunci Ruang untuk penelusuran agar hanya menampilkan konten dari ruang tertentu ini.
   9. Secara opsional, konfigurasikan Setelan node koneksi:
      • Jumlah node minimum: Masukkan jumlah minimum node koneksi.
      • Maximum number of nodes: Masukkan jumlah maksimum node koneksi.

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

   Catatan: Anda hanya dapat menyesuaikan nilai node koneksi jika merupakan pelanggan Bayar sesuai penggunaan.
   10. Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
   11. Klik NEXT.
5. Di bagian Destinations, masukkan detail host jarak jauh (sistem backend) yang ingin Anda hubungkan.
   1. Jenis Tujuan: Pilih Jenis Tujuan.
      • Pilih Host address dari daftar untuk menentukan nama host atau alamat IP tujuan.
      • Jika Anda ingin membuat koneksi pribadi ke sistem backend, pilih Endpoint attachment dari daftar, lalu pilih lampiran endpoint yang diperlukan dari daftar Endpoint Attachment.
        Catatan: Untuk memahami cara membuat lampiran endpoint, lihat lampiran layanan PSC dan lampiran endpoint. Setelah Anda membuat lampiran endpoint, lampiran tersebut akan terlihat dalam daftar Lampiran Endpoint.

      Jika ingin membuat koneksi publik ke sistem backend dengan keamanan tambahan, Anda dapat mempertimbangkan untuk mengonfigurasi alamat IP keluar statis untuk koneksi, lalu mengonfigurasi aturan firewall untuk hanya mengizinkan alamat IP statis tertentu.

      Untuk memasukkan tujuan tambahan, klik +TAMBAHKAN TUJUAN.

   2. Klik NEXT.
6. Di bagian Authentication, masukkan detail autentikasi.
   1. Pilih Jenis autentikasi dan masukkan detail yang relevan.

      Jenis autentikasi berikut didukung oleh konektor Confluence:

      • Basic
      • APIToken
      • OAuth2.0

   Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.

   2. Klik NEXT.
7. Tinjau: Tinjau detail koneksi dan autentikasi Anda.
8. Klik Create.

Mengonfigurasi autentikasi

Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.

• Dasar
  • Nama pengguna: Akun pengguna Confluence yang digunakan untuk mengautentikasi.
  • Sandi: Sandi yang terkait dengan akun.
• APIToken
  • Nama pengguna: Nama pengguna Confluence yang digunakan untuk membuat token API.
  • Token API: Sandi untuk nama pengguna adalah token API. Pilih Secret Manager Secret yang berisi Token API yang terkait dengan nama pengguna Confluence.
• OAuth 2.0 - Kode otorisasi
  • Client ID: Client ID seperti yang disediakan oleh aplikasi eksternal Anda.
  • Cakupan: Cakupan izin. Cakupan offline_access harus digunakan dengan konektor Confluence. Untuk mengetahui informasi selengkapnya tentang cakupan Confluence, lihat Cakupan Confluence.
  • Rahasia klien: Pilih Rahasia Secret Manager. Anda harus membuat secret Pengelola Secret sebelum mengonfigurasi otorisasi ini.
  • Versi secret: Versi secret Secret Manager untuk secret klien.

  Untuk jenis autentikasi Authorization code, setelah membuat koneksi, Anda harus melakukan beberapa langkah tambahan untuk mengonfigurasi autentikasi. Untuk informasi selengkapnya, lihat Langkah tambahan setelah pembuatan koneksi.

  Catatan: Jika menggunakan jenis autentikasi Authorization code dan telah melakukan perubahan konfigurasi di aplikasi Confluence, Anda harus memberikan otorisasi ulang ke koneksi Confluence. Untuk memahami cara memberikan otorisasi ulang, lihat Otorisasi ulang untuk Kode otorisasi.

Langkah-langkah tambahan setelah pembuatan koneksi

Jika memilih OAuth 2.0 - Authorization code untuk autentikasi, Anda harus melakukan langkah-langkah tambahan berikut setelah membuat koneksi:

1. Di halaman Koneksi, cari koneksi yang baru dibuat.

   Perhatikan bahwa Status untuk konektor baru akan menjadi Otorisasi diperlukan.

2. Klik Otorisasi diperlukan.

   Tindakan ini akan menampilkan panel Edit otorisasi.

3. Salin nilai Redirect URI ke aplikasi eksternal Anda.
4. Verifikasi detail otorisasi.
5. Klik Otorisasi.

   Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

Otorisasi ulang untuk kode otorisasi

Jika menggunakan jenis autentikasi Authorization code dan telah melakukan perubahan konfigurasi di aplikasi Confluence, Anda harus memberikan otorisasi ulang ke koneksi Confluence. Untuk memberikan otorisasi ulang pada koneksi, lakukan langkah-langkah berikut:

1. Klik koneksi yang diperlukan di halaman Koneksi.

   Tindakan ini akan membuka halaman detail koneksi.

2. Klik Edit untuk mengedit detail koneksi.
3. Verifikasi detail OAuth 2.0 - Authorization code di bagian Authentication.

   Jika diperlukan, buat perubahan yang diperlukan.

4. Klik Simpan. Tindakan ini akan mengarahkan Anda ke halaman detail koneksi.
5. Klik Edit authorization di bagian Authentication. Tindakan ini akan menampilkan panel Authorize.
6. Klik Otorisasi.

   Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.

Batasan sistem

Konektor Confluence dapat memproses 28 transaksi per detik, per node, dan mencegah transaksi apa pun yang melebihi batas ini. Secara default, Konektor Integrasi mengalokasikan 2 node (untuk ketersediaan yang lebih baik) untuk koneksi.

Untuk mengetahui informasi tentang batas yang berlaku untuk Konektor Integrasi, lihat Batas.

Catatan: Jumlah node Konektor Integrasi akan diskalakan secara otomatis secara dinamis berdasarkan penggunaan Anda. Namun, jika ingin mencadangkan kapasitas untuk volume besar tanpa menunggu penskalaan otomatis, Anda dapat menyesuaikan nilai node minimum untuk koneksi. Diperlukan lebih banyak node untuk memproses lebih banyak transaksi untuk koneksi. Sebaliknya, lebih sedikit node yang diperlukan jika koneksi memproses lebih sedikit transaksi. Untuk mengonfigurasi nilai node, lakukan hal berikut:

• Jika Anda adalah pelanggan bayar sesuai penggunaan, konfigurasikan nilai node minimum dan maksimum di halaman edit koneksi.
• Jika Anda adalah pelanggan berbasis langganan, hubungi dukungan.

Transaksi maksimum yang dapat ditangani node bergantung pada berbagai faktor. Jadi, sebelum menyesuaikan node minimum untuk throughput yang lebih baik, sebaiknya periksa apakah sistem backend Anda disiapkan secara optimal untuk menangani traffic yang diperlukan.

Menggunakan koneksi Confluence dalam integrasi

Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Integration Apigee dan Integration Aplikasi. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.

• Untuk memahami cara membuat dan menggunakan tugas Konektor di Apigee Integration, lihat Tugas konektor.
• Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Aplikasi, lihat Tugas konektor.

Entity, operasi, dan tindakan

Semua Konektor Integrasi menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entitas, operasi, dan tindakan.

Catatan: Anda dapat melihat entity, operasi, dan tindakan konektor di tugas Konektor.

• Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam aplikasi atau layanan yang terhubung. Definisi entitas berbeda dari konektor ke konektor. Misalnya, dalam konektor database, tabel adalah entitas, dalam konektor server file, folder adalah entitas, dan dalam konektor sistem pesan, antrean adalah entitas.

  Namun, mungkin konektor tidak mendukung atau memiliki entity apa pun, dalam hal ini, daftar Entities akan kosong.

• Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan salah satu operasi berikut pada entitas:
  • Cantumkan
  • Dapatkan
  • Buat
  • Update
  • Hapus

  Memilih entitas dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entitas tersebut. Untuk deskripsi mendetail tentang operasi, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung operasi entitas apa pun, operasi yang tidak didukung tersebut tidak akan tercantum dalam daftar Operations.

• Tindakan: Tindakan adalah fungsi kelas satu yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan bervariasi dari satu konektor ke konektor lainnya. Biasanya, tindakan akan memiliki beberapa parameter input, dan parameter output. Namun, konektor mungkin tidak mendukung tindakan apa pun, dalam hal ini daftar Actions akan kosong.

Catatan: Semua entitas dan tindakan akan memiliki skema yang terkait dengannya. Misalnya, skema tindakan akan memiliki detail parameter seperti; nama parameter, dan jenis data yang sesuai. Skema (metadata) untuk entity dan tindakan diambil oleh koneksi saat runtime dari backend Anda. Jika ada pembaruan pada skema, pembaruan tersebut tidak akan otomatis ditampilkan di koneksi yang ada; Anda harus memuat ulang skema secara manual. Untuk memuat ulang skema koneksi, buka halaman Connection details koneksi, lalu klik Refresh connection schema.

Tindakan

Konektor Confluence menyediakan tindakan seperti DownloadAttachment dan UploadAttachment. Untuk memahami cara mengonfigurasi tindakan, lihat Contoh tindakan.

Contoh tindakan

Bagian ini menjelaskan cara melakukan beberapa tindakan di konektor ini.

Contoh - Download Lampiran

1. Pada dialog Configure connector task, klik Actions.
2. Pilih tindakan DownloadAttachment, lalu klik Selesai.
3. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

     {
       "AttachmentId": "xyz"
     }

Contoh operasi entity

Contoh - Mencantumkan semua Permintaan

Contoh ini mencantumkan semua Permintaan dalam entity Requests.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Permintaan dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.

Contoh - Mendapatkan Pengguna dari ID Akun tertentu

Contoh ini mendapatkan Pengguna dengan AccoundId sebagai 6035864ce2020c0070b5285b dari entitas Users.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Users dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik filterClause, lalu masukkan AccountId=6035864ce2020c0070b5285b di kolom Default Value.

   Di sini, AccountId adalah nilai kunci utama entity Users.

Contoh - Halaman Daftar

Contoh ini mencantumkan halaman dari entity Pages.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Pages dari daftar Entity.
3. Pilih operasi LIST, lalu klik Selesai.

Contoh - Mendapatkan Halaman

Contoh ini mendapatkan data halaman dari entity Pages.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Pages dari daftar Entity.
3. Pilih operasi GET, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 123 di kolom Default Value.

   Di sini, 123 adalah ID unik untuk entitas Pages resource.

Contoh - Membuat Halaman

Contoh ini membuat data halaman di entitas Pages.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Pages dari daftar Entity.
3. Pilih operasi CREATE, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik connectorInputPayload, lalu masukkan nilai yang mirip dengan berikut di kolom Default Value:

   {
         "SpaceId": "12345",
         "Status": "Current",
         "Title": "FROM XYZ",
         "Storage": "XYZ1234"
       }
   

Example - Update Pages

This example updates a page record in the Pages entity.

1. In the Configure connector task dialog, click Entities.
2. Select Pages from the Entity list.
3. Select the UPDATE operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "Title": "Update abc"
       }

5. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 12345 di kolom Default Value.

Jika integrasi berhasil, kolom connectorOutputPayload tugas konektor akan memiliki respons operasi pembaruan.

{
    "Id": 1234
    }

Contoh - Menghapus Halaman

Contoh ini menghapus halaman dari entity Pages.

1. Pada dialog Configure connector task, klik Entities.
2. Pilih Pages dari daftar Entity.
3. Pilih operasi DELETE, lalu klik Selesai.
4. Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan 123 di kolom Default Value.

   Atau, jika entitas memiliki kunci utama gabungan, bukan menentukan entityId, Anda dapat menetapkan filterClause. Misalnya, Id='123'.

Menggunakan terraform untuk membuat koneksi

Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.

Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.

Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:

Nama parameter	Jenis data	Wajib	Deskripsi
proxy_enabled	BOOLEAN	Salah	Centang kotak ini untuk mengonfigurasi server proxy untuk koneksi.
proxy_auth_scheme	ENUM	Salah	Jenis autentikasi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. Nilai yang didukung adalah: BASIC, DIGEST, NONE
proxy_user	STRING	Salah	Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer.
proxy_password	SECRET	Salah	Sandi yang akan digunakan untuk melakukan autentikasi ke proxy ProxyServer.
proxy_ssltype	ENUM	Salah	Jenis SSL yang akan digunakan saat terhubung ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, TUNNEL

Mendapatkan bantuan dari komunitas Google Cloud

Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.

Langkah selanjutnya

• Pahami cara menangguhkan dan melanjutkan koneksi.
• Pahami cara memantau penggunaan konektor.
• Pahami cara melihat log konektor.