すべてのプロダクト
Search
ドキュメントセンター

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

最終更新日:Apr 10, 2025

Alibaba Cloud Elasticsearch では、カスタムまたはオープンソースのプラグインをアップロードしてインストールできます。このトピックでは、手順について詳しく説明します。

説明

この機能は、新しいコントロールアーキテクチャ(V3)にデプロイされたクラスターでのみ使用できます。クラスターの [基本情報] ページで、クラスターのコントロールアーキテクチャ(V2 または V3)を表示できます。

前提条件

  • アップロードするプラグインが準備されていること。プラグインが使用可能で安全であることを確認してください。

    アップロードするプラグインファイルの名前は、長さが 8 ~ 128 文字で、文字、数字、ハイフン(-)、およびピリオド(.)のみを含めることができます。ファイル名拡張子は .zip である必要があります。

    重要

    プラグインをアップロードする前に、Alibaba Cloud Elasticsearch クラスターと同じバージョンのセルフマネージド Elasticsearch クラスターでテストを実行することをお勧めします。テストが成功したら、プラグインをアップロードします。詳細については、「Installing Plugins」をご参照ください。

  • カスタム SQL プラグインをアップロードする場合、Elasticsearch クラスターの YML 構成ファイルの xpack.sql.enabled パラメーターが false に設定されていることを確認する必要があります。

    詳細については、「YML ファイルを構成する」をご参照ください。

制限

elasticsearch-analysis-hanlp など、操作権限を定義するセキュリティポリシーを持つプラグインはアップロードできません。

注意事項

  • カスタム プラグインのアップロードとインストール時に、コンソールで報告されたエラー、クラスター更新の一時停止、検証の失敗などの問題が発生した場合は、「カスタム プラグインのインストール エラー」に記載されている手順に従って、問題の特定と解決を行うことができます。

  • Elasticsearch クラスターがスペックアップされると、クラスターにインストールされているプラグインは自動的に更新されません。プラグインを更新するには、新しいバージョンのプラグインを手動でアップロードする必要があります。

  • デフォルトでは、カスタム プラグインはインターネットにアクセスできません。クラスターが新しいネットワークアーキテクチャにデプロイされている場合は、PrivateLink サービスを使用してクラスターのプライベート接続を確立し、クラスターにインストールされているカスタム プラグインがインターネットにアクセスできるようにすることができます。詳細については、「Elasticsearch クラスターのプライベート接続を構成する」をご参照ください。クラスターが元のネットワークアーキテクチャにデプロイされている場合、カスタム プラグインはクラスターが存在する仮想プライベートクラウド(VPC)にのみアクセスできます。

  • カスタム プラグインは、Elasticsearch クラスターの安定性に影響を与える可能性があります。アップロードするカスタム プラグインが使用可能で安全であることを確認する必要があります。

手順

警告

カスタム プラグインのアップロードにより Elasticsearch クラスターが再起動され、プラグインがクラスターの安定性に影響を与える可能性があります。カスタム プラグインが使用可能で安全であることを確認してください。オフピーク時にカスタム プラグインをアップロードすることをお勧めします。

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

  2. 左側のナビゲーションウィンドウで、[Elasticsearch クラスター] をクリックします。

  3. 目的のクラスターに移動します。

    1. 上部のナビゲーションバーで、クラスターが属するリソースグループとクラスターが存在するリージョンを選択します。

    2. [Elasticsearch クラスター] ページで、クラスターを見つけて ID をクリックします。

  4. 表示されるページの左側のナビゲーションウィンドウで、[構成と管理] > [プラグイン] を選択します。

  5. [プラグイン] ページで、[カスタム プラグイン] タブをクリックします。次に、[アップロード] をクリックします。

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

    1. [プラグインのアップロード] パネルで、[ファイルを選択するか、ファイルをこの領域にドラッグアンドドロップします] をクリックします。次に、アップロードするカスタム プラグインファイルを選択し、[開く] をクリックします。

      カスタム プラグインファイルをこの領域にドラッグしてアップロードすることもできます。次の図は、プラグインファイル elasticsearch-sql-6.7.0.0.zip が追加されたことを示しています。插件上传对话框

      アップロードするカスタム プラグインファイルは、以下の条件を満たしている必要があります。ファイルが条件を満たしていない場合、ファイルの検証に失敗する可能性があります。

      • ファイル名:

        ファイル名は 8 ~ 128 文字で、文字、数字、ハイフン(-)、およびピリオド(.)のみを含めることができます。ファイル名拡張子は .zip である必要があります。

        重要

        以下の特徴を持つカスタム プラグインは、アップロードまたはインストールできません。カスタム プラグインの名前が Alibaba Cloud Elasticsearch によって提供される組み込みプラグインと同じである、カスタム プラグインの名前とバージョンが既にアップロードされているカスタム プラグインの名前とバージョンと同じである、カスタム プラグインをインストールする Elasticsearch クラスターのバージョンが正しくない、カスタム プラグインのバージョンがカスタム プラグインをインストールする Elasticsearch クラスターのバージョンと互換性がない。

      • ファイルサイズ:ファイルサイズは 100 MB を超えることはできません。

      • アップロードされるファイルの総数:単一の Elasticsearch クラスターに最大 50 個のファイルをアップロードできます。

    2. 注意事項を読み、チェックボックスをオンにして、[OK] をクリックします。

      システムはクラスターを再起動します。オフピーク時にプラグインをアップロードすることをお勧めします。クラスターが再起動した後、[カスタム プラグイン] タブでプラグインを確認できます。[ステータス][インストール済み] の場合、プラグインは正常にアップロードおよびインストールされています。安装成功的插件

      プラグインが不要になった場合は、[カスタム プラグイン] タブで見つけて、[操作] 列の [削除] をクリックします。詳細については、「組み込みプラグインをインストールおよび削除する」をご参照ください。また、削除するプラグインがインデックスによって参照されていないことを確認してください。そうでない場合、クラスターの再起動が停止する可能性があります。