Add documentation for Experimental Security Configuration Versioning Management and APIs #11195
Conversation
…k API Signed-off-by: Divyanshi Chouksey <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
nagarajg17
requested review from
AMoo-Miki,
dlvenable,
epugh,
kolchfa-aws,
natebower and
sumobrian
as code owners
…Management and its APIs Signed-off-by: Nagaraj G <[email protected]>
|
@kolchfa-aws Addressing comments from the original PR #10143 in this new PR |
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
|
|
||
| The system automatically creates a new version when a security configuration change is detected, the change differs from the most recent saved version, and an administrator makes modifications through supported APIs. | ||
|
|
||
| Each version contains a version ID (unique identifier such as `v1`, `v2`), a configuration snapshot (complete security configuration at the time of creation), a timestamp indicating when the version was created, and user information identifying who made the change. |
There was a problem hiding this comment.
@nagarajg17 So the versions must be specified in the form of vN or can they be any string?
There was a problem hiding this comment.
Its like, v1, v2...v10. It can hold upto maximum number of versions mentioned in this config plugins.security.config_version.retention_count or default upto to 10 i.e v10
Signed-off-by: Fanit Kolchina <[email protected]>
kolchfa-aws
added
Editorial review
Signed-off-by: Nathan Bower <[email protected]>
natebower
added
Awaiting response
and removed
Editorial review
Signed-off-by: kolchfa-aws <[email protected]>
|
@kolchfa-aws Anything pending on me? |
Signed-off-by: kolchfa-aws <[email protected]>
|
Thanks for answering the question, @nagarajg17, I updated the version ID description. Ready to merge. |
3 participants
Description
Adding documentation for Experimental Versioned Security Configuration Management and the View and the Rollback APIs.
This is a continuation of PR-10143. The author of original PR is no longer working on this project, created this new PR to address outstanding comments of original PR
Issues Resolved
Closes #5093
Version
3.3+
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.