Adds doc for Resource Sharing and Access Control feature #11571
Conversation
Signed-off-by: Darshit Chanpura <[email protected]>
Signed-off-by: Darshit Chanpura <[email protected]>
Signed-off-by: Darshit Chanpura <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Darshit Chanpura <[email protected]>
Signed-off-by: Darshit Chanpura <[email protected]>
Signed-off-by: Darshit Chanpura <[email protected]>
|
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. |
kolchfa-aws
added
In progress
Signed-off-by: Darshit Chanpura <[email protected]>
kolchfa-aws
added
Doc review
Signed-off-by: Fanit Kolchina <[email protected]>
|
@DarshitChanpura Doc review complete. I moved the Dashboards file to under management because this is where the feature is in Dashboards. I also deduplicated and expanded the API documentation according to our API template. Could you please provide example responses and response fields tables for meaningful responses? I inserted placehoders for these for now. Thanks! |
Signed-off-by: Darshit Chanpura <[email protected]>
|
@kolchfa-aws I've added example responses. I do see that you have removed the plugin-developer related doc completely from resources.md. We do need this documentation to let custom-plugin and other plugin devs know how they can onboard to this feature. How should we do that ? |
DarshitChanpura
requested review from
AMoo-Miki,
dlvenable,
epugh,
kolchfa-aws and
natebower
as code owners
kolchfa-aws
added
Editorial review
|
Thank you, @DarshitChanpura! The developer documentation will live in the GitHub repo. The documentation on the doc site is for OpenSearch users. Plugin developers will follow the link to the GitHub repo for information about configuring this feature. |
| * System index protection must be enabled. | ||
| * Users still require plugin-level cluster permissions, including permission to create resources. | ||
| * Action groups must be defined in the plugin configuration. | ||
|
|
|
|
||
| ## Related documentation | ||
|
|
||
| - [Resource sharing APIs]({{site.url}}{{site.baseurl}}/security/access-control/resource-sharing-api/) - REST API reference for programmatic management |
There was a problem hiding this comment.
| - [Resource sharing APIs]({{site.url}}{{site.baseurl}}/security/access-control/resource-sharing-api/) - REST API reference for programmatic management | |
| - [Resource sharing APIs]({{site.url}}{{site.baseurl}}/security/access-control/resource-sharing-api/) -- REST API reference for programmatic management |
| ## Related documentation | ||
|
|
||
| - [Resource sharing APIs]({{site.url}}{{site.baseurl}}/security/access-control/resource-sharing-api/) - REST API reference for programmatic management | ||
| - [Resource access management]({{site.url}}{{site.baseurl}}/dashboards/management/resource-sharing/) - UI workflows and user guidance |
There was a problem hiding this comment.
| - [Resource access management]({{site.url}}{{site.baseurl}}/dashboards/management/resource-sharing/) - UI workflows and user guidance | |
| - [Resource access management]({{site.url}}{{site.baseurl}}/dashboards/management/resource-sharing/) -- UI workflows and user guidance |
|
|
||
| - [Resource sharing APIs]({{site.url}}{{site.baseurl}}/security/access-control/resource-sharing-api/) - REST API reference for programmatic management | ||
| - [Resource access management]({{site.url}}{{site.baseurl}}/dashboards/management/resource-sharing/) - UI workflows and user guidance | ||
| - [Sample resource plugin](https://github.com/opensearch-project/security/tree/main/src/test/java/org/opensearch/security/resources/sample) - Implementation examples in the security plugin repository |
There was a problem hiding this comment.
| - [Sample resource plugin](https://github.com/opensearch-project/security/tree/main/src/test/java/org/opensearch/security/resources/sample) - Implementation examples in the security plugin repository | |
| - [Sample resource plugin](https://github.com/opensearch-project/security/tree/main/src/test/java/org/opensearch/security/resources/sample) -- Implementation examples in the Security plugin repository |
| - [Resource sharing APIs]({{site.url}}{{site.baseurl}}/security/access-control/resource-sharing-api/) - REST API reference for programmatic management | ||
| - [Resource access management]({{site.url}}{{site.baseurl}}/dashboards/management/resource-sharing/) - UI workflows and user guidance | ||
| - [Sample resource plugin](https://github.com/opensearch-project/security/tree/main/src/test/java/org/opensearch/security/resources/sample) - Implementation examples in the security plugin repository | ||
| - [Developer documentation](https://github.com/opensearch-project/security/blob/main/RESOURCE_SHARING_AND_ACCESS_CONTROL.md) - Detailed technical documentation for plugin developers, users, and administrators |
There was a problem hiding this comment.
| - [Developer documentation](https://github.com/opensearch-project/security/blob/main/RESOURCE_SHARING_AND_ACCESS_CONTROL.md) - Detailed technical documentation for plugin developers, users, and administrators | |
| - [Developer documentation](https://github.com/opensearch-project/security/blob/main/RESOURCE_SHARING_AND_ACCESS_CONTROL.md) -- Detailed technical documentation for plugin developers, users, and administrators |
Signed-off-by: Nathan Bower <[email protected]>
natebower
added
release-notes
4 participants
Description
Adds doc for the newly added Centralized Resource Access Control and Sharing feature.
rewrites #9667
Issues Resolved
Closes #9652
Versions
3.3,3.4
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.