Elasticsearch:カスタムプラグインのアップロードとインストール

前提条件

• アップロードするプラグインを準備し、その可用性とセキュリティを確保してください。

  プラグインは .zip ファイルである必要があります。ファイル名は 8～128 文字とし、英字、数字、ハイフン (-)、ピリオド (.) のみを使用できます。プラグインの plugin-descriptor.properties ファイルは、ZIP パッケージのルートディレクトリに配置する必要があります。

• カスタム SQL プラグインをアップロードする場合は、Alibaba Cloud Elasticsearch クラスターの YAML ファイルで xpack.sql.enabled パラメーターを false に設定する必要があります。

  詳細については、「YML パラメーターの設定」をご参照ください。

制限事項

• ES クラスターには、基本制御アーキテクチャ (v2) とクラウドネイティブ新制御アーキテクチャ (v3) の 2 種類の制御アーキテクチャがあります。 ES クラスターが使用するアーキテクチャを確認するには、Elasticsearch コンソールにログインし、基本情報 ページに移動します。 デプロイコントロールモード フィールドに、クラウドネイティブの新しいコントロール (v3) または 基本コントロール (v2) のいずれかが表示されます。

• elasticsearch-analysis-hanlp プラグインなど、権限クラスを定義するプラグインはアップロードできません。

注意事項

• アップロードとインストール中にエラー (コンソールエラー、変更の停止、検証の失敗など) が発生した場合は、「カスタムプラグインのインストールエラーのトラブルシューティングと解決」をご参照ください。

• クラスターをアップグレードしても、プラグインは自動的にアップグレードされません。再度アップロードして再インストールする必要があります。

• デフォルトでは、カスタムプラグインはインターネットにアクセスできません。アクセスを有効にするには、NAT ゲートウェイの設定が必要です。新しいネットワークアーキテクチャでは、VPC をまたいでプライベートサービスにアクセスするために PrivateLink を使用できます。詳細については、「クラスターのプライベート接続の設定」をご参照ください。元のネットワークアーキテクチャでは、プラグインは同じ VPC 内のネットワーク環境にのみアクセスできます。

• プラグインはクラスターの安定性に影響を与える可能性があります。カスタムプラグインの可用性とセキュリティを確保してください。

操作手順

1. Alibaba Cloud Elasticsearch コンソールにログインします。

2. 左側のナビゲーションペインで、Elasticsearch クラスター をクリックします。

3. 1. 上部メニューで、クラスターが所在するリソースグループとリージョンを選択します。

   2. 対象クラスターの ID をクリックします。

4. 左側のナビゲーションペインで、設定と管理 > プラグインの設定を選択します。

5. プラグインの設定 ページで、カスタムプラグインリスト タブをクリックし、アップロード をクリックします。

6. カスタムプラグインをアップロードしてインストールします。

   クラウドネイティブアーキテクチャを使用するクラスターの場合、アップロードとインストールの手順は別々です。進行中のインストールはキャンセルできます。手順と検証は、クラスターのコントロールアーキテクチャによって異なります。

   クラウドネイティブ新コントロールアーキテクチャ (v3)

   1. プラグインのアップロード ダイアログボックスで、プラグインソース として ローカルからのアップロード または OSS からのアップロード を選択します。 ローカルからのアップロード を選択した場合は、ファイルを追加またはここにドロップ をクリックして、アップロードするプラグインを選択します。

      検証に合格するには、プラグインファイルが次の条件を満たす必要があります。

      • プラグインの .zip ファイル名は 8～128 文字とし、英字、数字、ハイフン (-)、ピリオド (.) のみを使用できます。

      • 各ファイルは 100 MB を超えることはできず、クラスターごとに最大 50 個のプラグインファイルをアップロードできます。

      • プラグインはクラスターと互換性がある必要があります。プラグイン名は、同じバッチアップロード内の他のプラグインを含め、インストール済みの組み込みプラグインやカスタムプラグインと競合してはなりません。

   2. ページの下部にあるファイルをアップロードしても、すぐには有効化されません。 プラグインのリストに移動して、プラグインをインストールしてください。 メッセージを選択し、OK をクリックします。

   3. カスタムプラグインリスト タブで、目的のプラグインを見つけ、 アイコンをクリックして詳細を展開します。

      プラグインがリストに表示され、ステータス が 未インストール となっていれば、アップロードは成功です。アップロード済みで未インストールのプラグインが不要になった場合は、「操作」列にある デリート をクリックしてプラグインを削除できます。

   4. インストールするプラグインの アクション 列で、インストール をクリックします。

      システムは、プラグインが Elasticsearch のバージョンと互換性があることを検証します。バージョンが一致しない場合、インストールは失敗します。

      複数のプラグインを選択し、ページ下部の一括インストールをクリックして、一度にインストールすることもできます。

   5. プラグインのインストール ダイアログボックスで、クラスターの再起動に関する警告を読み、続行 をクリックします。

      インストールすると、クラスターが再起動します。この操作は、ピーク時間外に実行することをお勧めします。クラスターが再起動した後、カスタムプラグインリスト タブでプラグインの ステータス が インストール済み になっていれば、インストールは成功です。インストールが完了すると、プラグインを更新またはアンインストールできます：

      • プラグインの更新

        プラグインを更新するには、同じ名前の新しいバージョンをアップロードしてからインストールします。

      • プラグインのアンインストール

        プラグインをアンインストールするには、[操作] 列の [アンインストール] をクリックします。詳細な操作と注意事項については、「組み込みプラグインのインストールまたはアンインストール」をご参照ください。

      説明

      インストール中に、アクション 列の インストールをキャンセル をクリックできます。この操作は、ES クラスターとの非互換性が原因でインストールが失敗した場合に、変更がロールバックされるため便利です。

   ベーシックコントロールアーキテクチャ (v2)

   1. プラグインのアップロード ダイアログボックスで、ファイルを追加またはここにドロップ をクリックし、アップロードするプラグインを選択して、[開く] をクリックします。

      検証に合格するには、プラグインファイルが次の条件を満たす必要があります。

      • プラグインの .zip ファイル名は 8～128 文字とし、英字、数字、ハイフン (-)、ピリオド (.) のみを使用できます。

      • 各ファイルは 100 MB を超えることはできず、クラスターごとに最大 50 個のプラグインファイルをアップロードできます。

      • プラグインはクラスターと互換性がある必要があります。プラグイン名は、同じバッチアップロード内の他のプラグインを含め、インストール済みの組み込みプラグインやカスタムプラグインと競合してはなりません。

   2. 注意事項を確認し、対応するチェックボックスを選択して、アップロード をクリックします。

      クラスターが再起動した後、プラグインが カスタムプラグインリスト タブに表示され、ステータス が インストール済み になっていれば、プロセスは成功です。

      プラグインが不要になった場合は、[操作] 列の アンインストール をクリックします。詳細な操作と注意事項については、「組み込みプラグインをインストールまたはアンインストールする」をご参照ください。アンインストールする前に、クラスターが再起動時に停止するのを防ぐため、プラグインを参照するインデックスがないことを確認してください。