Check for Security Configuration Upgrades API
출처: 문서
본문
보안 구성 업그레이드 확인 API
2.14에 도입됨 {: .label .label-purple }
Check for Upgrades API를 사용하면 Security 플러그인 구성에 업그레이드가 필요한지 확인할 수 있어요. OpenSearch를 새 버전으로 업그레이드한 후에 특히 유용한데요, 호환성을 유지하거나 새 기능을 활용하려면 업데이트가 필요한 보안 구성 요소를 찾아내는 데 도움이 되기 때문이에요.
새 OpenSearch 버전이 나올 때마다 기본 보안 구성은 바뀌어요. 이 API는 호스트의 Security 플러그인에 번들된 구성을 클러스터의 현재 구성과 비교해서, 업그레이드를 수행할 수 있는지와 어떤 리소스가 업데이트될지를 응답으로 알려줘요. 클러스터에 기본값이 누락되었거나 기본값 정의가 낡았는지 판단할 때 이 API를 사용하세요.
엔드포인트
GET /_plugins/_security/api/_upgrade_check
요청 예시
GET /_plugins/_security/api/_upgrade_check
{% include copy-curl.html security=true %}
응답 예시
업그레이드가 가능할 때는 upgradeActions에 변경될 객체들이 나열돼요:
{
"status": "OK",
"upgradeAvailable": true,
"upgradeActions": {
"roles": {
"add": [
"flow_framework_full_access"
]
}
}
}
구성이 이미 최신 상태일 때는 upgradeActions가 생략돼요:
{
"status": "OK",
"upgradeAvailable": false
}
응답 본문 필드
응답 본문은 다음 필드를 가진 JSON 객체예요.
| 속성 | 데이터 타입 | 설명 |
|---|---|---|
status |
String | 요청의 상태예요. 성공한 요청은 "OK"를 반환해요. |
upgradeAvailable |
Boolean | 보안 구성 업그레이드가 가능할 때 true를 반환해요. |
upgradeActions |
Object | 호스트의 Security 플러그인을 업그레이드할 때 수정될 보안 객체들이에요. roles 같은 구성 타입별로 정리되어 있어요. 각 구성 타입은 객체에 매핑되는데, 이 객체의 키는 add 같은 적용될 액션이고, 값은 영향을 받는 객체 이름 목록이에요. |
사용 참고 사항
OpenSearch 업그레이드 과정에서 보안 구성을 관리할 때는 Check for Upgrades API 결과를 해석하고 이에 따라 조치하는 방법을 이해하는 것이 중요해요. 다음 참고 사항에서 이 API를 활용하는 방법을 안내해 드릴게요:
- 이 API를 실행해도 구성은 변경되지 않아요. 잠재적인 업그레이드를 확인할 뿐이에요.
- 이 API로 필요한 업그레이드를 파악한 후에는 적절한 Configuration API를 사용해서 필요한 변경 사항을 적용할 수 있어요.
- OpenSearch 버전을 업그레이드할 때마다 이 확인을 실행하는 것을 권장해요.
- 이 API를 사용하려면 관리자 권한이 필요할 수 있어요.