Amazon OpenSearch Service でのサードパーティープラグインのインストール - Amazon OpenSearch Service

Amazon OpenSearch Service でのサードパーティープラグインのインストール

Amazon OpenSearch Service は、選択したパートナーのサードパーティープラグインをサポートしています。これらのプラグインにより、カスタムアナライザー、トークナイザ、暗号化機能などの追加機能を使用して OpenSearch のセットアップを強化できます。OpenSearch Service ドメインと適切に統合するには、サードパーティー開発者が提供する特定のインストールと設定の手順に従います。

注記

サードパーティー開発者から直接有効なライセンスを取得して維持する必要があります。一部のプロバイダーは、すべての AWS リージョン でプラグインを有効にしていない可能性があるため、プラグインプロバイダーに可用性を確認してください。

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

  • Portal26 暗号化プラグイン (Titanium-lockbox) – NIST FIPS 140-2 認定暗号化を使用して、インデックス作成時にデータを暗号化します。これには、セキュリティを強化するために暗号化キーを管理できる Bring Your Own Key (BYOK) サポートが含まれています。プラグインは Portal26 によって提供され、OpenSearch バージョン 2.15 以降が必要です。

  • 名前一致 (RNI) – 24 以上の言語で名前、組織、住所、日付を一致させて、セキュリティとコンプライアンスを向上させます。プラグインは Babel Street によって提供され、OpenSearch バージョン 2.15 以降が必要です。

前提条件

サードパーティープラグインをインストールする前に、次の手順を実行します。

  • プラグイン設定ファイルとライセンスファイルを取得し、Amazon S3 バケットにアップロードします。バケットは、ドメインと同じ AWS リージョン に存在する必要があります。

  • サードパーティープラグインは、カスタムプラグインの一種です。ドメインがカスタムプラグインの前提条件を満たしていることを確認してください。

サードパーティープラグインのインストール

サードパーティープラグインを OpenSearch Service ドメインに関連付けるには、まずライセンスパッケージ、設定パッケージ、プラグインパッケージの 3 つの個別のパッケージをアップロードする必要があります。

  • ライセンスパッケージには、プラグインに関連付けられたライセンス情報またはメタデータが .json または .xml 形式で含まれています。

  • 設定パッケージには、プラグイン設定ファイルと、サポートされているアセットと設定が含まれています。これらのファイルは、プラグインの動作または OpenSearch との統合方法を定義します。

  • プラグインパッケージには、OpenSearch が実行する実行可能コードであるコンパイル済みプラグインバイナリが含まれています。これはプラグイン機能の中核です。

両方のパッケージをアップロードすると、プラグインとライセンスを互換性のあるドメインに関連付けることができます。

サードパーティープラグインをドメインに関連付けるには、まずプラグインのライセンスと設定をパッケージとしてインポートします。

サードパーティープラグインをインストールするには
  1. Amazon OpenSearch Service コンソール (https://console.aws.amazon.com/aos/home) にサインインします。

  2. 左のナビゲーションペインで [パッケージ] を選択します。

  3. まず、ライセンスパッケージをインポートします。[パッケージのインポート] を選択します。

  4. [パッケージタイプ] で、[ライセンス] を選択します。

  5. [パッケージソース] には、Amazon S3 のライセンス JSON または XML ファイルへのパスを入力します。

  6. [インポート] を選択します。パッケージは、[パッケージ] ページの [ライセンス] タブに表示されます。

  7. 次に、プラグイン設定をインポートします。[パッケージのインポート] を再度選択します。

  8. [パッケージタイプ] で、[設定] を選択します。

  9. [パッケージソース] には、Amazon S3 のプラグイン設定 ZIP ファイルへのパスを入力します。

  10. [インポート] を選択します。

  11. 最後に、プラグイン自体をインポートします。[パッケージのインポート] を選択します。

  12. [パッケージタイプ][プラグイン] を選択します。

  13. [パッケージソース] には、Amazon S3 のプラグイン ZIP ファイルへのパスを入力します。

  14. プラグインがサポートする OpenSearch エンジンのバージョンを選択します。

  15. [インポート] を選択します。

サードパーティープラグインをドメインに関連付けるには
  1. 次に、プラグインのライセンスと設定をドメインに関連付けます。左側のナビゲーションペインで [ドメイン] を選択します。

  2. ドメイン名を選択し、クラスター設定を開きます。

  3. [プラグイン] タブに移動します。

  4. [パッケージを関連付ける] を選択し、インポートしたプラグイン、ライセンス、および設定パッケージを選択します。

  5. [選択] を選択します。

  6. [次へ] を選択します。関連付けるパッケージを確認し、[関連付け] を選択します。

まず、create-package コマンドを使用して、プラグインライセンスを含む新しいパッケージを作成します。S3Key は、ライセンステキストまたはメタデータを含む Amazon S3 の .json ファイルまたは .xml ファイルを指す必要があります。

aws opensearch create-package \ --package-name plugin-license-package \ --package-type PACKAGE-LICENSE \ --package-source S3BucketName=my-bucket,S3Key=licenses/my-plugin-license.json

create-package コマンドを再度使用して、プラグイン設定を含むパッケージを作成します。S3Key は、プラグインで想定されるディレクトリ構造に準拠する Amazon S3 の .zip ファイルを指す必要があります。

aws opensearch create-package \ --package-name plugin-config-package \ --package-type PACKAGE-CONFIG \ --package-source S3BucketName=my-bucket,S3Key=path/to/package.zip

create-package コマンドを再度使用して、プラグイン自体を含むパッケージを作成します。S3Key は、Amazon S3 のプラグイン .zip ファイルを指す必要があります。

aws opensearch create-package \ --package-name plugin-package \ --package-type ZIP-PLUGIN \ --package-source S3BucketName=my-bucket,S3Key=path/to/package.zip

最後に、associate-package コマンドを使用して、それぞれのパッケージ ID を指定することで、パートナープラグイン、ライセンス、および設定を互換性のあるドメインにリンクします。プラグイン ID を他のパッケージの前提条件として指定します。つまり、他のパッケージより前にドメインに関連付けられている必要があります。

aws opensearch associate-packages \ --domain-name my-domain \ --package-list '[{"PackageID": "plugin-package-id"},{"PackageID": "license-package-id","PrerequisitePackageIDList":["plugin-package-id"]},{"PackageID":"config-package-id","PrerequisitePackageIDList":["plugin-package-id"]}]'

次のステップ

関連付けが完了したら、要件に基づき、特定のインデックスでプラグインを有効にするか、必要に応じて設定できます。サードパーティープラグイン機能を特定のインデックスに適用するには、インデックスの作成時にインデックス設定を変更するか、既存のインデックスを更新します。例えば、サードパーティープラグインにカスタムアナライザーが含まれている場合は、インデックス設定でそれを参照します。

プラグイン機能を複数のインデックスに一貫して適用するには、プラグイン設定が含まれたインデックステンプレートを使用します。OpenSearch のセットアップ用に機能を設定する方法については、プラグインのドキュメントを必ず参照してください。