Amazon OpenSearch Service でのカスタムプラグイン管理

カスタムプラグインをインストールするには

1. Amazon OpenSearch Service コンソール (https://console.aws.amazon.com/aos/home) にサインインします。

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

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

4. [名前] に、このプラグインの一意の識別可能な名前を入力します。

5. (オプション) [説明] に、パッケージまたはその目的に関する有用な詳細を入力します。

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

7. [パッケージソース] に、パスを入力するか、Amazon S3 のプラグイン ZIP ファイルを参照して選択します。

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

9. [パッケージ暗号化] で、パッケージの暗号化キーをカスタマイズするかどうかを選択します。デフォルトでは、OpenSearch Service はプラグインパッケージを AWS 所有のキー で暗号化します。代わりにカスタマーマネージドキーを使用することもできます。

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

AWS CLI を使用してカスタムプラグインをインストールするには

1. 以下の create-package コマンドを実行して、カスタムプラグインの新しいパッケージを作成します。その際、以下の要件を満たしていることを確認してください。

   • バケットとキーの場所は、コマンドを実行しているアカウントの S3 バケット内のプラグイン .zip ファイルを指している必要があります。

   • S3 バケットは、パッケージを作成しているリージョンと同じリージョンにある必要があります。

   • ZIP-PLUGIN パッケージでサポートされているのは .zip ファイルのみです。

   • .zip ファイルの内容は、プラグインが想定するディレクトリ構造に従う必要があります。

   • --engine-version の値は OpenSearch_{MAJOR}.{MINOR} 形式である必要があります。例: OpenSearch_2.17。

   プレースホルダー値は、ユーザー自身の情報に置き換えてください。

   aws opensearch create-package \
       --package-name package-name \
       --region region \
       --package-type ZIP-PLUGIN \
       --package-source S3BucketName=amzn-s3-demo-bucket,S3Key=s3-key \
       --engine-version opensearch-version

2. (オプション) describe-packages コマンドを使用して、検証やセキュリティ脆弱性の検出結果を含む、create-package オペレーションのステータスを表示します。プレースホルダー値は、ユーザー自身の情報に置き換えてください。

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

   コマンドは以下のような情報を返します。

   {
       "PackageDetailsList": [{
           "PackageID": "pkg-identifier",
           "PackageName": "package-name",
           "PackageType": "ZIP-PLUGIN",
           "PackageStatus": "VALIDATION_FAILED",
           "CreatedAt": "2024-11-11T13:07:18.297000-08:00",
           "LastUpdatedAt": "2024-11-11T13:10:13.843000-08:00",
           "ErrorDetails": {
               "ErrorType": "",
               "ErrorMessage": "PluginValidationFailureReason : Dependency Scan reported 3 vulnerabilities for the plugin: CVE-2022-23307, CVE-2019-17571, CVE-2022-23305"
           },
           "EngineVersion": "OpenSearch_2.15",
           "AllowListedUserList": [],
           "PackageOwner": "OWNER-XXXX"
       }]
   }

   注記

   create-package オペレーションの間、Amazon OpenSearch Service は ZIP-PLUGIN の値について、バージョン互換性、サポートされているプラグイン拡張機能、セキュリティの脆弱性をチェックします。セキュリティの脆弱性は、Amazon Inspector サービスを使用してスキャンされます。これらのチェックの結果は、API レスポンスの ErrorDetails フィールドに表示されます。

3. associate-package コマンドを使用して、プラグインを任意の OpenSearch Service ドメインに関連付けます。その際は、前のステップで作成したパッケージのパッケージ ID を使用します。

   ヒント

   複数のプラグインがある場合は、代わりに associate-packages コマンドを使用します。これにより、1 回のオペレーションで複数のパッケージをドメインに関連付けることができます。

   プレースホルダー値は、ユーザー自身の情報に置き換えてください。

   aws opensearch associate-package \
       --domain-name domain-name \
       --region region \
       --package-id package-id

   注記

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

4. (オプション) list-packages-for-domain コマンドを使用して、関連付けのステータスを表示します。関連付けステータスは、ワークフローが ASSOCIATING から ACTIVE に進行するにつれて変化します。プラグインのインストールが完了し、プラグインを使用できる状態になると、関連付けステータスは ACTIVE に変わります。

   プレースホルダー値を、ユーザー自身の情報に置き換えます。

   aws opensearch list-packages-for-domain \
       --region region \
       --domain-name domain-name

AWS CLI を使用してカスタムプラグインを更新するには

• 以下のコマンドを実行してください。プレースホルダー値を、ユーザー自身の情報に置き換えます。

  aws opensearch update-package \
      --region region \
      --package-id package-id \
      --package-source S3BucketName=amzn-s3-demo-bucket,S3Key=s3-key \
      --package-description description

AWS CLI を使用して、カスタムプラグインを持つ OpenSearch Service ドメインを OpenSearch の新しいバージョンにアップグレードするには

1. create-package コマンドを使用して、新しい OpenSearch バージョンを指定するプラグインの新しいパッケージを作成します。

   すべてのエンジンバージョンのプラグインでパッケージ名が同じであることを確認します。パッケージ名を変更すると、ブルー/グリーンデプロイ中にドメインのアップグレードプロセスが失敗します。

2. 「Amazon OpenSearch Service ドメインのアップグレード」の手順に従って、ドメインを上位バージョンにアップグレードします。

   このプロセス中、Amazon OpenSearch Service は以前のバージョンのプラグインパッケージの関連付けを解除し、ブルー/グリーンデプロイを使用して新しいバージョンをインストールします。

カスタムプラグインをアンインストールして、関連付け解除ステータスを表示するには

1. すべてのインデックスでプラグインを無効にします。これは、プラグインパッケージの関連付けを解除する前に行う必要があります。

   すべてのインデックスからプラグインを無効にする前にプラグインをアンインストールしようとすると、ブルー/グリーンデプロイプロセスは Processing 状態でスタックしたままになります。

2. 次のコマンドを実行して、プラグインをアンインストールします。プレースホルダー値を、ユーザー自身の情報に置き換えます。

   aws opensearch dissociate-package \
       --region region \
       --package-id plugin-package-id \
       --domain-name domain name
   

3. (オプション) list-packages-for-domain コマンドを実行して、関連付け解除のステータスを表示します。