Alibaba Cloud Elasticsearch は、カスタムプラグインのアップロードとインストールをサポートしており、組み込みプラグインでは利用できない機能を提供します。
前提条件
アップロードするプラグインを準備する必要があります。プラグインが使用可能で安全であることを確認してください。
プラグインファイルは、次の要件を満たす必要があります。ファイル名には、大文字、小文字、数字、ハイフン (-)、またはピリオド (.) のみを含めることができます。長さは 8 文字から 128 文字である必要があります。ファイル拡張子は .zip である必要があります。
plugin-descriptor.propertiesファイルは、ZIP パッケージのルートディレクトリにある必要があります。カスタム SQL プラグインをアップロードする場合は、ご利用の Alibaba Cloud Elasticsearch インスタンスの YML 設定ファイルで `xpack.sql.enabled` パラメーターを false に設定します。
詳細については、「YML パラメーターの設定」をご参照ください。
制限事項
Elasticsearch クラスターは、基本コントロールアーキテクチャ (v2) またはクラウドネイティブ新コントロールアーキテクチャ (v3) のいずれかのコントロールアーキテクチャを使用します。Elasticsearch コンソールにログインします。クラスターの 基本情報 ページで、デプロイコントロールモード を確認します：クラウドネイティブの新しいコントロール (v3) または 基本コントロール (v2)。
elasticsearch-analysis-hanlp など、操作権限を定義するプラグインはアップロードできません。
注意事項
アップロードまたはインストール中にコンソールエラー、変更の停止、検証の失敗などのエラーが発生した場合は、「カスタムプラグインのインストールエラーのトラブルシューティングと解決」をご参照ください。
クラスターをアップグレードしても、プラグインは自動的にアップグレードされません。再度アップロードして再インストールする必要があります。
デフォルトでは、カスタムプラグインはインターネットにアクセスできません。インターネットアクセスを有効にするには、NAT Gateway を設定します。ご利用のクラスターが新しいネットワークアーキテクチャを使用している場合、VPC をまたいでプライベートネットワークサービスにアクセスするには PrivateLink を使用します。詳細については、「インスタンスのプライベート接続の設定」をご参照ください。ご利用のクラスターが元のネットワークアーキテクチャを使用している場合、カスタムプラグインは同じ VPC 内のリソースにのみアクセスできます。
プラグインはクラスターの安定性に影響を与える可能性があります。カスタムプラグインが使用可能で安全であることを確認してください。
操作手順
カスタムプラグインをインストールすると、ご利用の Elasticsearch インスタンスが再起動されます。また、プラグインはインスタンスの安定性に影響を与える可能性があります。プラグインが使用可能で安全であることを確認してください。この操作はオフピーク時間に実行することを推奨します。
Alibaba Cloud Elasticsearch コンソールにログインします。
左側のナビゲーションウィンドウで、Elasticsearch クラスター をクリックします。
ターゲットインスタンスに移動します。
上部のメニューバーで、リソースグループとリージョンを選択します。
ターゲットインスタンスの ID をクリックします。
左側のナビゲーションウィンドウで、設定と管理 > プラグインの設定 を選択します。
プラグインの設定 ページで、カスタムプラグインリスト タブをクリックします。次に、アップロード をクリックします。
カスタムプラグインをアップロードしてインストールします。
クラウドネイティブインスタンスの場合、アップロードとインストールは別々のステップです。アップロード開始後にインストールをキャンセルできます。手順とプラグインの検証ルールは、クラウドネイティブインスタンスと非クラウドネイティブインスタンスで異なります。詳細は以下のとおりです：
クラウドネイティブ新コントロール (v3)
プラグインのアップロード ダイアログボックスで、プラグインソース を選択します：ローカルからのアップロード または OSS からのアップロード。ローカルからのアップロード を選択した場合は、ファイルを追加またはここにドロップ をクリックし、アップロードするプラグインファイルを選択します。プラグインファイルをこのエリアに直接ドラッグすることもできます。
プラグインファイルは次の条件を満たす必要があります。そうでない場合、検証は失敗します：
ファイルの命名：ファイル名には、大文字、小文字、数字、ハイフン (-)、ピリオド (.) のみを含めることができます。長さは 8～128 文字である必要があります。ファイル拡張子は .zip である必要があります。
ファイルサイズと数の制限：各ファイルは 100 MB 以下である必要があります。1 つのインスタンスにアップロードできるファイルは最大 50 個です。
プラグインの互換性：プラグイン名は、すべての組み込みプラグインと異なる必要があります。また、現在のバッチまたはすでにインストールされているプラグインの名前とバージョンとも異なる必要があります。ファイル形式は、ご利用のインスタンスと互換性がある必要があります。
ページ下部のメッセージを確認します：ファイルをアップロードしても、すぐには有効化されません。 プラグインのリストに移動して、プラグインをインストールしてください。 次に、OK をクリックします。
カスタムプラグインリスト タブで、プラグイン名の横にある
アイコンをクリックして詳細を展開します。プラグインが正常にアップロードされたことを確認します。展開されたリストにアップロードされたプラグインが表示され、その ステータス が 未インストール の場合、アップロードは成功です。アップロード済みでまだインストールされていないプラグインを削除するには、そのプラグインの [操作] 列にある デリート をクリックします。
プラグインリストで、プラグインの アクション 列にある インストール をクリックします。
システムは、プラグインが正しい Elasticsearch バージョンに依存しているかどうかをチェックします。バージョンが一致しない場合、インストールは失敗します。
一度に複数のプラグインをインストールするには、それらを選択し、ページ下部の 一括インストール をクリックします。
プラグインのインストール ダイアログボックスで、この操作がクラスターの再起動をトリガーすることを示すメッセージを確認します。次に、続行 をクリックします。
インストールにより、クラスターが再起動されます。この操作はオフピーク時間に実行することを推奨します。再起動が完了したら、カスタムプラグインリスト タブに移動します。プラグインの ステータス が インストール済み の場合、インストールは成功です。インストールが成功した後、プラグインを更新またはアンインストールできます：
プラグインの更新
同じプラグインの最新バージョンをアップロードし、手動でインストールします。
プラグインのアンインストール
プラグインの [操作] 列にある [アンインストール] をクリックします。詳細な手順と注意事項については、「組み込みプラグインのインストールまたはアンインストール」をご参照ください。
説明インストール中に、アクション > インストールをキャンセル をクリックしてプロセスを停止できます。インストール中にプラグインが Elasticsearch クラスターに適応できなかった場合、キャンセルすることで安全にロールバックできます。
基本コントロール (v2)
プラグインのアップロード ダイアログボックスで、ファイルを追加またはここにドロップ をクリックし、アップロードするプラグインファイルを選択して、[開く] をクリックします。
プラグインファイルをこのエリアに直接ドラッグすることもできます。
プラグインファイルは次の条件を満たす必要があります。そうでない場合、検証は失敗します：
ファイルの命名：ファイル名には、大文字、小文字、数字、ハイフン (-)、ピリオド (.) のみを含めることができます。長さは 8～128 文字である必要があります。ファイル拡張子は .zip である必要があります。
ファイルサイズと数の制限：各ファイルは 100 MB 以下である必要があります。1 つのインスタンスにアップロードできるファイルは最大 50 個です。
プラグインの互換性：プラグイン名は、すべての組み込みプラグインと異なる必要があります。また、現在のバッチまたはすでにインストールされているプラグインの名前とバージョンとも異なる必要があります。ファイル形式は、ご利用のインスタンスと互換性がある必要があります。
ダイアログボックスの注意事項を読み、チェックボックスをオンにして、アップロード をクリックします。
再起動が完了したら、カスタムプラグインリスト タブに移動します。プラグインが表示され、その ステータス が インストール済み の場合、アップロードとインストールは成功です。
このプラグインが不要になった場合は、[操作] 列の アンインストール をクリックします。詳細な手順と注意事項については、「組み込みプラグインのインストールまたはアンインストール」をご参照ください。アンインストールする前に、プラグインを参照しているインデックスがないことを確認してください。そうしないと、クラスターの再起動が停止する可能性があります。