Alibaba Cloud Elasticsearch mendukung pengunggahan dan pemasangan plug-in kustom untuk menyediakan fungsionalitas yang tidak tersedia pada plug-in bawaan.
Prasyarat
Siapkan plug-in yang akan diunggah. Pastikan plug-in tersebut berfungsi dengan baik dan aman.
File plug-in harus memenuhi persyaratan berikut: nama file hanya boleh terdiri dari huruf kapital, huruf kecil, angka, tanda hubung (-), atau titik (.); panjang nama file antara 8 hingga 128 karakter; ekstensi file harus .zip; dan file
plugin-descriptor.propertiesharus berada di direktori root paket ZIP.Jika Anda ingin mengunggah plug-in SQL kustom, atur parameter xpack.sql.enabled dalam file konfigurasi YML instans Alibaba Cloud Elasticsearch menjadi false.
Untuk informasi selengkapnya, lihat Konfigurasi parameter YML.
Batasan
Kluster Elasticsearch menggunakan salah satu dari dua arsitektur kontrol: arsitektur kontrol dasar (v2) atau arsitektur kontrol cloud-native baru (v3). Masuk ke Konsol Elasticsearch. Pada halaman Basic Information kluster Anda, periksa Control Architecture Type: Cloud-native Control Architecture (v3) atau Basic Control Architecture (v2).
Anda tidak dapat mengunggah plug-in yang menentukan izin operasi, seperti elasticsearch-analysis-hanlp.
Peringatan
Jika terjadi error selama pengunggahan atau pemasangan—seperti error konsol, perubahan macet, atau verifikasi gagal—lihat Pemecahan masalah dan penyelesaian error pemasangan plug-in kustom.
Plug-in tidak ditingkatkan secara otomatis saat Anda melakukan upgrade kluster. Anda harus mengunggah dan memasang ulang plug-in tersebut.
Secara default, plug-in kustom tidak dapat mengakses Internet. Untuk mengaktifkan akses Internet, konfigurasikan NAT Gateway. Untuk mengakses layanan jaringan pribadi lintas VPC, gunakan PrivateLink jika kluster Anda menggunakan arsitektur jaringan baru. Untuk informasi selengkapnya, lihat Konfigurasi koneksi pribadi untuk instans Anda. Jika kluster Anda menggunakan arsitektur jaringan lama, plug-in kustom hanya dapat mengakses resource dalam VPC yang sama.
Plug-in dapat memengaruhi stabilitas kluster. Pastikan plug-in kustom Anda berfungsi dengan baik dan aman.
Prosedur
Pemasangan plug-in kustom akan memicu restart instans Elasticsearch Anda. Plug-in tersebut juga dapat memengaruhi stabilitas instans. Pastikan plug-in tersebut berfungsi dengan baik dan aman. Kami menyarankan Anda melakukan operasi ini pada jam sepi.
Masuk ke Konsol Alibaba Cloud Elasticsearch.
Pada panel navigasi di sebelah kiri, klik Elasticsearch Clusters.
Arahkan ke instans target Anda.
Pada bilah menu atas, pilih kelompok sumber daya dan wilayah.
Klik ID instans target Anda.
Pada panel navigasi di sebelah kiri, pilih Configuration and Management > Plug-in Configuration.
Pada halaman Plug-in Configuration, klik tab Custom Plug-ins. Lalu, klik Upload.
Unggah dan instal plug-in kustom.
Untuk instans cloud-native, unggah dan instal merupakan langkah terpisah. Anda dapat membatalkan pemasangan setelah proses unggah dimulai. Langkah-langkah dan aturan validasi plug-in berbeda antara instans cloud-native dan non-cloud-native. Detailnya disajikan di bawah ini:
Cloud-native New Control (v3)
Pada kotak dialog Upload Plug-in, pilih Plug-in Source: Local File atau OSS Object. Jika Anda memilih Local File, klik Select files, or drag and drop files to this area, lalu pilih file plug-in untuk diunggah. Anda juga dapat menyeret file plug-in langsung ke area ini.
File plug-in Anda harus memenuhi kondisi berikut. Jika tidak, validasi akan gagal:
Penamaan file: Nama file hanya boleh terdiri dari huruf kapital, huruf kecil, angka, tanda hubung (-), atau titik (.). Panjang nama file harus antara 8 hingga 128 karakter. Ekstensi file harus .zip.
Batas ukuran dan jumlah file: Setiap file tidak boleh lebih besar dari 100 MB. Satu instans dapat memiliki hingga 50 file yang diunggah.
Kompatibilitas plug-in: Nama plug-in harus berbeda dari semua plug-in bawaan. Nama dan versinya juga harus berbeda dari plug-in dalam batch saat ini atau yang sudah terpasang. Format file harus kompatibel dengan instans Anda.
Konfirmasi pesan di bagian bawah halaman: The uploaded file does not take effect immediately. Go to the plug-in list to install the plug-in. Lalu, klik OK.
Pada tab Custom Plug-ins, klik ikon
di samping nama plug-in untuk memperluas detailnya. Konfirmasi bahwa plug-in telah berhasil diunggah.Jika daftar yang diperluas menampilkan plug-in yang diunggah dan Status-nya adalah Not Installed, unggahan berhasil. Untuk menghapus plug-in yang sudah diunggah tetapi belum dipasang, klik Delete di kolom Actions untuk plug-in tersebut.
Pada daftar plug-in, klik Install di kolom Actions untuk plug-in tersebut.
Sistem akan memeriksa apakah plug-in bergantung pada versi Elasticsearch yang benar. Pemasangan akan gagal jika versi tidak sesuai.
Untuk memasang beberapa plug-in sekaligus, pilih plug-in tersebut lalu klik Batch Install di bagian bawah halaman.
Pada kotak dialog Install Plug-in, konfirmasi pesan yang menyatakan bahwa tindakan ini akan memicu restart kluster. Lalu, klik Continue.
Pemasangan akan memicu restart kluster. Kami menyarankan Anda melakukan operasi ini pada jam sepi. Setelah restart selesai, buka tab Custom Plug-ins. Jika Status plug-in tersebut adalah Installed, pemasangan berhasil. Setelah pemasangan berhasil, Anda dapat memperbarui atau menguninstal plug-in tersebut:
Perbarui plug-in
Unggah versi terbaru dari plug-in yang sama, lalu pasang secara manual.
Copot pemasangan Plugin
Klik Uninstall di kolom Actions untuk plug-in tersebut. Untuk langkah-langkah dan peringatan selengkapnya, lihat Install or uninstall a built-in plug-in.
CatatanSelama pemasangan, klik Actions > Cancel Installation untuk menghentikan proses. Jika plug-in gagal beradaptasi dengan kluster Elasticsearch Anda selama pemasangan, pembatalan memungkinkan Anda melakukan rollback dengan aman.
Basic Control (v2)
Pada kotak dialog Upload Plug-in, klik Select files, or drag and drop files to this area, pilih file plug-in untuk diunggah, lalu klik Open.
Anda juga dapat menyeret file plug-in langsung ke area ini.
File plug-in Anda harus memenuhi kondisi berikut. Jika tidak, validasi akan gagal:
Penamaan file: Nama file hanya boleh terdiri dari huruf kapital, huruf kecil, angka, tanda hubung (-), atau titik (.). Panjang nama file harus antara 8 hingga 128 karakter. Ekstensi file harus .zip.
Batas ukuran dan jumlah file: Setiap file tidak boleh lebih besar dari 100 MB. Satu instans dapat memiliki hingga 50 file yang diunggah.
Kompatibilitas plug-in: Nama plug-in harus berbeda dari semua plug-in bawaan. Nama dan versinya juga harus berbeda dari plug-in dalam batch saat ini atau yang sudah terpasang. Format file harus kompatibel dengan instans Anda.
Baca peringatan dalam kotak dialog, centang kotak centang, lalu klik Upload.
Setelah restart selesai, buka tab Custom Plug-ins. Jika Anda melihat plug-in tersebut dan Status-nya adalah Installed, unggahan dan pemasangan berhasil.
Jika Anda tidak lagi membutuhkan plug-in ini, klik Remove di kolom Actions. Untuk langkah-langkah dan peringatan selengkapnya, lihat Install or uninstall a built-in plug-in. Sebelum menguninstal, pastikan tidak ada indeks yang mereferensikan plug-in tersebut. Jika tidak, restart kluster mungkin akan macet.