Amazon OpenSearch Service のエンジンバージョンに応じたプラグイン

Amazon OpenSearch Service ドメインには、OpenSearch コミュニティからのプラグインがパッケージされています。サービスはプラグインを自動的にデプロイおよび管理しますが、ドメインに選択した OpenSearch または従来の Elasticsearch OSS のバージョンに応じて異なるプラグインをデプロイします。

以下の表は、OpenSearch のバージョン別のプラグインと、従来の Elasticsearch OSS の互換バージョンを一覧表示しています。このプラグインには、対話する可能性のあるプラグインのみが含まれており、包括的ではありません。OpenSearch Service は追加のプラグインを使用して、スナップショット用の S3 リポジトリプラグインや、最適化とモニタリング用の OpenSearch Performance Analyzer プラグインなど、コアサービス機能を有効にします。ドメインで実行されているすべてのプラグインの完全なリストについては、次のリクエストを実行します。

GET _cat/plugins?v

プラグイン	最低限必要な OpenSearch バージョン	最低限必要な Elasticsearch バージョン
HanLP	2.11	サポートされていません
ヘブライ語分析	2.11	サポートされていません
Amazon Personalize 検索ランキング	2.9	サポートされていません
Neural Search	2.9	サポートされていません
セキュリティ分析	2.5	サポートされていません
OpenSearch 通知	2.3	サポートされていません
ML Commons	1.3	サポートされていません
Sudachi 分析 (日本語に推奨)	1.3	サポートされていません
STConvert	1.3	サポートされていません
Pinyin 分析	1.3	サポートされていません
Nori 分析	1.3	サポートされていません
OpenSearch の観測性	1.2	サポートされていません
OpenSearch クラスター間レプリケーション	1.1	7.10
OpenSearch の非同期検索	1.0	7.10
IK (中国語) 分析	1.0	7.7
ベトナム語分析
タイ語分析
Learning to Rank
OpenSearch の異常検出	1.0	7.4
OpenSearch k-NN	1.0	7.1
OpenSearch のインデックス状態管理	1.0	6.8
OpenSearch のセキュリティ	1.0	6.7
OpenSearch SQL	1.0	6.5
OpenSearch のアラート設定	1.0	6.2
Ukrainian Analysis	1.0	5.3
Mapper Size	1.0	5.3
Mapper Murmur3	1.0	5.1
Ingest User Agent Processor	1.0	5.1
Ingest Attachment Processor	1.0	5.1
Stempel Polish Analysis	1.0	5.1
Smart Chinese Analysis	1.0	5.1
Seunjeon 韓国語分析	1.0	5.1
Phonetic Analysis	1.0	2.3
Japanese (kuromoji) Analysis	1.0	すべてのドメインで含まれる
ICU Analysis	1.0	すべてのドメインで含まれる

オプションプラグイン

Amazon OpenSearch Service は、プリインストールされているデフォルトのプラグインに加えて、いくつかのオプションの言語アナライザープラグインをサポートしています。 AWS Management Console および を使用して AWS CLI 、プラグインをドメインに関連付けたり、プラグインをドメインから関連付け解除したり、すべてのプラグインを一覧表示したりできます。オプションのプラグインパッケージは特定の OpenSearch バージョンと互換性があり、そのバージョンのドメインにのみ関連付けることができます。

Sudachi プラグイン の場合、辞書ファイルを再関連付けしても、すぐにドメインに反映されないことに注意してください。設定変更やその他の更新の一環として、次のブルー/グリーンデプロイがドメインで実行されると、辞書が更新されます。または、更新済みのデータで新しいインデックスを作成し、この新しいパッケージを使用して新しいインデックスを作成し、既存のインデックスを新しいインデックスに再インデックスしてから、古いインデックスを削除することもできます。インデックスの再作成方法を使用する場合は、トラフィックが中断されないようにインデックスエイリアスを使用してください。

オプションプラグインは ZIP-PLUGIN パッケージタイプを使用します。オプションのプラグインについての詳細は、「Amazon OpenSearch Service のカスタムパッケージ」を参照してください。

サードパーティープラグイン

Amazon OpenSearch Service は、一部のパートナーのサードパーティープラグインをサポートするようになりました。オプションのプラグインと同様に、 AWS Management Console と を使用してプラグイン AWS CLI をドメインに関連付けたり、ドメインからプラグインの関連付けを解除したり、ドメイン内のすべてのサードパーティープラグインを一覧表示したりできます。サードパーティーのプラグインパッケージは、特定の OpenSearch バージョンと互換性があり、その OpenSearch バージョンのドメインにのみ関連付けることができます。

サードパーティーのプラグインは、サードパーティー開発者によって所有および提供されます。お客様は、サードパーティー開発者から直接有効なライセンスを取得して維持する責任があります。これらのサードパーティープラグインは、Amazon OpenSearch Service が利用可能なAWS リージョンを除くすべてのAWS GovCloud (US) リージョンで使用できます。

注記

一部のプラグインプロバイダーは、Amazon OpenSearch Service が利用可能なすべての AWS リージョンでプラグインを有効にできない場合があります。 AWS リージョンでのプラグインの可用性に関する質問については、プラグインプロバイダーにお問い合わせください。

サードパーティープラグインの詳細については、「Amazon OpenSearch Service のカスタムパッケージ」を参照してください。

Amazon OpenSearch Service では、次のサードパーティープラグインが利用できるようになりました。

• Portal26 Encrypted Search Plugin (Titanium-lockbox): Portal26.ai の Portal26 暗号化プラグインは、NIST FIPS 140-2 認定暗号化を使用して、Amazon OpenSearch Service によってインデックス化されたデータを暗号化します。このプラグインには、Bring Your Own Key (BYOK) 機能が含まれており、インデックスごとに個別の暗号化キーを設定できます。

• OpenSearch 用 Babel Street Match Plugin (RNI): このプラグインは、24 以上の言語の名前、組織、住所、日付を正確に照合し、誤検出を減らし、運用効率を向上させながら、セキュリティ運用と規制コンプライアンスを強化します。

Amazon OpenSearch Service では、以下のサードパーティープラグインを使用できます。

プラグイン名	サードパーティープロバイダー	最低限必要な OpenSearch Service バージョン	最低限必要な Elasticsearch バージョン	ライセンスが必要
Titanium ロックボックス	Portal26.ai	2.15	サポートされていません	Y
名前一致 (RNI) OpenSearch プラグイン	babelstreet.com	2.15	サポートされていません	Y

以下の Amazon OpenSearch Service 機能は、サードパーティープラグインを使用する場合は使用できません。

プラグイン名	暗号化プラグイン	Babel Street Match プラグイン
クラスター間検索	サポートされません	サポートされません
クロスクラスターレプリケーション	サポートされません	サポートされません
リモート再インデックス	サポートされません	サポートされません
自動調整	サポートされません	サポートされません
超ウォーム	サポート外	サポート
Multi-AZ with Standby	サポートされません	サポートされません

"CreatePackage"、、"AssociatePackage"および を使用して"DissociatePackage"、使用するプラグインをアップロードし、Amazon OpenSearch Service マネージドドメインに関連付けることができます。 "PACKAGE-CONFIG"および "PACKAGE-LICENSE"パッケージタイプは、プラグイン設定ファイルとライセンスファイルのアップロードでサポートされています。Portal26 をインストールするためのライセンスファイルを取得するには、Portal26.ai を参照してください。名前一致 (RNI) OpenSearch プラグインをインストールするためのライセンスファイルを取得するには、「Babel Street」を参照してください。

前提条件

• Amazon theOpenSearch OpenSearch バージョンのプラグイン設定ファイルとライセンスファイルがあることを確認します。

• Amazon OpenSearch Service ドメインで以下を有効にする必要があります。

  • ノード間の暗号化

  • 保管中のデータの暗号化

  • 「EnforceHTTPS」を「true」に設定する

  • TLSSecurityPolicy 'Policy-Min-TLS-1-2-PFS-2023-10' のサポートを有効にします。詳細については、「DomainEndpointOptions」を参照してください。

を使用したサードパーティープラグインのインストール AWS CLI

を使用してサードパーティープラグインを使用できるようにするには AWS CLI 、次のサービスモデル JSON を適用する必要があります。

1. describe-packages API を使用して、利用可能なサードパーティープラグインのリストを取得します。

   aws opensearch --region $REGION describe-packages --filters '[{"Name": "PackageType","Value": ["ZIP-PLUGIN"]}, {"Name": "PackageName","Value": ["<package-name>"]}]'

2. 既存の CreatePackage API を使用して、プラグインライセンス用の新しいパッケージを作成します。

   aws opensearch --region $REGION create-package --package-name <package-name> --package-type PACKAGE-LICENSE --package-source S3BucketName=<bucket>,S3Key=<key>

   アカウントの s3 バケット内のライセンスファイルを指すようにバケットとキーの場所を更新してください。ファイルには .json または .xml 拡張子が必要です。

3. 既存の CreatePackage API を使用して、プラグイン設定用の新しいパッケージを作成します。

   aws opensearch --region $REGION create-package --package-name <package-name> --package-type PACKAGE-CONFIG --package-source S3BucketName=<bucket>,S3Key=<key

   注記

   バケットとキーの場所を更新して、呼び出し元のアカウントの s3 バケット内の設定 zip ファイルを指定します。s3 は、パッケージが作成されるのと同じリージョンに存在する必要があります。設定タイプパッケージでは zip ファイルのみがサポートされています。zip ファイルの内容は、プラグインが期待するディレクトリ構造に従う必要があります。

4. 新しい AssociatePackage API を使用して、パートナープラグインをライセンスと設定とともに、これらのパッケージのパッケージ ID を使用して互換性のある Amazon OpenSearch Service ドメイン (一致バージョン) に関連付けます。

   aws opensearch --region $REGION associate-packages --domain-name <domain-name> --package-list '[{"PackageID": "<plugin-package-id>"},{"PackageID": "<license-package-id>","PrerequisitePackageIDList":["<plugin-package-id>"]},{"PackageID":"<config-package-id>","PrerequisitePackageIDList":["<plugin-package-id>"]}]'

   注記

   プラグインは、ブルー/グリーンデプロイプロセスを使用してインストールおよびアンインストールされます。

5. 既存の ListPackagesForDomain API を使用して、関連付けのステータスを確認します。ワークフローが ASSOCATING から ACTIVE に進行すると、関連付けステータスが変わります。プラグインのインストールワークフローが完了し、プラグインを使用する準備ができると、関連付けステータスが ACTIVE に変わります。

   aws opensearch --region $REGION list-packages-for-domain --domain-name <domain name>

6. 既存の GetPackageVersionHistory API を使用して、任意のパッケージのバージョンを確認します。

7. ライセンス/設定パッケージは、既存の UpdatePackage API を使用して更新できます。次の API を使用して、パッケージの更新をドメインに適用します。

   aws opensearch --region $REGION update-package --package-id <package-id>  --package-source S3BucketName=<bucket>,S3Key=<key> --package-description <description>

8. 既存の DissociatePackage API を使用して、任意のドメインからプラグインをアンインストールします。既存の ListPackagesForDomain API を使用して、関連付け解除のステータスを確認できます。

   aws opensearch --region $REGION dissociate-package --package-id <plugin-package-id> --domain-name <domain name>

   注記

   プラグインをアンインストールするには、プラグインパッケージの関連付けを解除する前に、まずすべてのインデックスからプラグインを無効にする必要があります。

9. 既存の ListPackagesForDomain API を使用して、関連付け解除のステータスを確認します。