Amazon OpenSearch Service에서 사용자 지정 플러그인 관리

사용자 지정 플러그인을 설치하려면

1. https://console.aws.amazon.com/aos/home에서 Amazon OpenSearch Service 콘솔에 로그인합니다.

2. 왼쪽 탐색 창에서 패키지를 선택합니다.

3. [패키지 가져오기(Import package)]를 선택합니다.

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 명령을 사용하여 이전 단계에서 생성한 패키지의 패키지 ID로, 선택한 OpenSearch Service 도메인과 플러그인을 연결합니다.

   작은 정보

   플러그인이 여러 개 있는 경우 associate-packages 명령을 사용하여 단일 작업에서 여러 패키지를 도메인에 연결할 수 있습니다.

   자리 표시자 값을 자신의 정보로 바꿉니다.

   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 명령을 실행하여 연결 해제 상태를 확인합니다.