Perform Security Configuration Upgrade API
출처: 문서
본문
보안 구성 업그레이드 수행 API
2.14에 도입 {: .label .label-purple }
업그레이드 수행 API를 사용하면 Security 플러그인의 구성 컴포넌트를 업그레이드할 수 있어요. 이 API는 보통 업그레이드 확인 API로 필요한 업그레이드를 파악한 후에 사용해요. 이 API는 현재 Security 플러그인 버전과의 호환성을 보장하도록 구성 컴포넌트를 업데이트해 줘요.
이 API는 설치된 Security 플러그인 버전에 번들된 구성을 바탕으로, 클러스터의 기존 보안 구성에 리소스를 추가하고 업데이트해요. 번들된 구성 파일은 <OPENSEARCH_HOME>/security/config 디렉터리에 있어요. 기본 구성 파일은 OpenSearch를 업그레이드할 때 업데이트되는 반면, 클러스터 구성은 클러스터 운영자에 의해서만 업데이트되기 때문에, 이 API를 사용하면 운영자가 누락된 기본값과 오래된 기본 정의를 업그레이드할 수 있어요.
엔드포인트
POST /_plugins/_security/api/_upgrade_perform
요청 본문 필드
요청 본문은 선택 사항이에요. 다음 필드를 가진 JSON 객체예요.
| 속성 | 데이터 타입 | 설명 |
|---|---|---|
config |
문자열 배열 | 업그레이드할 특정 구성 컴포넌트의 목록이에요. 생략하면 업그레이드가 필요한 모든 컴포넌트가 처리돼요. 유효한 값으로는 roles, rolesmapping, actiongroups, config, internalusers, tenants가 있어요. |
요청 예제
POST /_plugins/_security/api/_upgrade_perform
{
"configs": [
"roles"
]
}
{% include copy-curl.html security=true %}
응답 예제
upgrades 객체는 적용된 변경 사항을 나열해요:
{
"status": "OK",
"upgrades": {
"roles": {
"add": [
"flow_framework_full_access"
]
}
}
}
해당 구성이 이미 최신 상태라면 요청은 400 Bad Request로 실패해요:
{
"status": "BAD_REQUEST",
"message": "Unable to upgrade, no differences found in 'roles' config"
}
응답 본문 필드
응답 본문은 다음 필드를 가진 JSON 객체예요.
| 속성 | 데이터 타입 | 설명 |
|---|---|---|
status |
문자열 | 요청의 상태예요. 성공한 요청은 OK를 반환해요. |
upgrades |
객체 | 업그레이드 결과를 담는 컨테이너예요. roles 같은 구성 타입별로 정리되어 있어요. 변경된 각 구성 타입이 이 객체의 키로 표현돼요. |
응답 본문 필드: upgrades
{: .text-delta}
upgrades의 각 구성 타입은 키가 해당 타입에 적용된 작업, 예를 들어 add나 modify인 객체에 매핑돼요. 각 작업은 업그레이드로 수정된 객체 이름의 목록에 매핑돼요.