Adding explanation for editing permissions 20230825 #6606

leanneeliatra · 2024-03-06T15:51:44Z

Description

A customer submitted a query in relation to this page of the documentation:
https://opensearch.org/docs/latest/security/access-control/document-level-security/

Customer query

This document did not provide information on how edit the document level permissions.

Fix

To add a section in to address how to edit the document level permissions.

Issues Resolved

This ticket addresses one part of #4314

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: [email protected] <[email protected]>

leanneeliatra · 2024-03-06T19:42:22Z

This PR is ready for review please.
I'm not sure about the review dog failure, to me it is as it should be. Please advise thank you cc @scrawfor99 @hdhalter

Naarcha-AWS

I think we should change this to a step through to make it more readable. Also, we should decide whether the role changes occur in Dashboards on in the configuration level? Specifically, do we need to run securityadmin.sh in order to DLS role changes to occur?

_security/access-control/document-level-security.md

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]>

…dd edit DLS section Signed-off-by: [email protected] <[email protected]>

Signed-off-by: [email protected] <[email protected]>

Naarcha-AWS

A few more suggestions and then we can pass this to editorial.

_security/access-control/document-level-security.md

_security/access-control/users-roles.md

Updates following review Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]>

leanneeliatra · 2024-03-22T16:12:31Z

A few more suggestions and then we can pass this to editorial.

Yes thanks a million for that in-depth review @Naarcha-AWS. Much appreciated. All comments have now been addressed.

leanneeliatra · 2024-03-26T16:27:18Z

This should be ready to merge, all comments addressed from my end. They just need to be accepted. Thank you. cc @Naarcha-AWS

_security/access-control/users-roles.md

Signed-off-by: Naarcha-AWS <[email protected]>

natebower

@leanneeliatra @Naarcha-AWS Please see my comments and changes and let me know if you have any questions. I'd like to see the resolution to my comment on line 24 of the first file before approving. Thanks!

_security/access-control/document-level-security.md

natebower · 2024-03-27T12:19:49Z

_security/access-control/document-level-security.md

-
-A typical request to the `_search` API includes `{ "query": { ... } }` around the query, but in this case, you only need to specify the query itself.
+Document-level security lets you restrict a role to a subset of documents in an index.
+For more information about users and roles in OpenSearch, see the [documentation](https://opensearch.org/docs/latest/security/access-control/users-roles/#create-roles).


What documentation, specifically?

_security/access-control/document-level-security.md

natebower · 2024-03-27T12:22:53Z

_security/access-control/document-level-security.md

+2. Choose **Security** > **Roles**
+3. Select **Create Role** and provide a name for the role.
+4. Review the **Index permissions** section and any necessary [index permissions](https://opensearch.org/docs/latest/security/access-control/permissions/) for the role. 
+5. Add document-level security with the addition of a DSL query inside the `Document level security - optional` section.  A typical request to the `_search` API includes the `{ "query": { ... } }` around the query, but when Document-level security in OpenSearch Dashboards, you only need to specify the query itself. For example, the following DSL query specifies that for the new role to have access to a document, the query's `genres` field must include `Comedy`:


Should DSL be defined on first appearance?

_security/access-control/users-roles.md

natebower · 2024-03-27T12:39:30Z

_security/access-control/users-roles.md

+
+1. Choose **Security** > **Roles**. Under the **Create role** section, select **Explore existing roles**. 
+1. Select the role you would like to edit. 
+1. Choose **edit role** on the upper right. Make any updates you need to the role.


Clarify: "on the upper right of the screen"?

_security/access-control/users-roles.md

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Signed-off-by: Naarcha-AWS <[email protected]>

natebower

@Naarcha-AWS A couple final changes. Otherwise, LGTM!

_security/access-control/document-level-security.md

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: leanneeliatra <[email protected]>

* adding explination for editing permissions Signed-off-by: [email protected] <[email protected]> * changed to a h3 to see if review dog will accept Signed-off-by: [email protected] <[email protected]> * Update _security/access-control/document-level-security.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]> * Update _security/access-control/document-level-security.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]> * Update _security/access-control/document-level-security.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]> * Update _security/access-control/document-level-security.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]> * Updates to both the users roles and DLS sections to reflect need to add edit DLS section Signed-off-by: [email protected] <[email protected]> * updating after reviewdog comments Signed-off-by: [email protected] <[email protected]> * updating roles in OpenSearch updates Signed-off-by: [email protected] <[email protected]> * Apply suggestions from code review Updates following review Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update document-level-security.md Signed-off-by: Naarcha-AWS <[email protected]> * Update _security/access-control/document-level-security.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: leanneeliatra <[email protected]> --------- Signed-off-by: [email protected] <[email protected]> Signed-off-by: leanneeliatra <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 6f8261b) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* adding explination for editing permissions * changed to a h3 to see if review dog will accept * Update _security/access-control/document-level-security.md * Update _security/access-control/document-level-security.md * Update _security/access-control/document-level-security.md * Update _security/access-control/document-level-security.md * Updates to both the users roles and DLS sections to reflect need to add edit DLS section * updating after reviewdog comments * updating roles in OpenSearch updates * Apply suggestions from code review Updates following review * Apply suggestions from code review * Apply suggestions from code review * Update document-level-security.md * Update _security/access-control/document-level-security.md --------- (cherry picked from commit 6f8261b) Signed-off-by: [email protected] <[email protected]> Signed-off-by: leanneeliatra <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>

adding explination for editing permissions

b574c9e

Signed-off-by: [email protected] <[email protected]>

leanneeliatra requested review from hdhalter, kolchfa-aws, Naarcha-AWS, vagimeli, AMoo-Miki, natebower, dlvenable and stephen-crawford as code owners March 6, 2024 15:51

leanneeliatra changed the title ~~adding explanation for editing permissions 20230825~~ Adding explanation for editing permissions 20230825 Mar 6, 2024

leanneeliatra mentioned this pull request Mar 6, 2024

[DOC] Feedback on Security topics #4314

Closed

20 tasks

Naarcha-AWS self-assigned this Mar 6, 2024

changed to a h3 to see if review dog will accept

3f32e80

Signed-off-by: [email protected] <[email protected]>

Naarcha-AWS added 4 - Doc review PR: Doc review in progress backport 2.12 PR: Backport label for 2.12 labels Mar 7, 2024

Naarcha-AWS requested changes Mar 7, 2024

View reviewed changes

leanneeliatra and others added 5 commits March 7, 2024 17:51

Update _security/access-control/document-level-security.md

289943a

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]>

Update _security/access-control/document-level-security.md

7195c42

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]>

Update _security/access-control/document-level-security.md

a918857

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]>

Update _security/access-control/document-level-security.md

5c88efa

Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]>

Merge branch 'main' into 20230825-edit-document-level-permissions

b05db06

hdhalter added the security label Mar 14, 2024

leanneeliatra and others added 6 commits March 15, 2024 16:14

Merge branch 'main' into 20230825-edit-document-level-permissions

97ba3c9

Merge branch 'main' into 20230825-edit-document-level-permissions

e839012

Updates to both the users roles and DLS sections to reflect need to a…

9dde189

…dd edit DLS section Signed-off-by: [email protected] <[email protected]>

updating after reviewdog comments

7a29048

Signed-off-by: [email protected] <[email protected]>

updating roles in OpenSearch updates

2864a8d

Signed-off-by: [email protected] <[email protected]>

Merge branch 'main' into 20230825-edit-document-level-permissions

7bfc487

Naarcha-AWS requested changes Mar 21, 2024

View reviewed changes

Naarcha-AWS and others added 2 commits March 21, 2024 13:33

Merge branch 'main' into 20230825-edit-document-level-permissions

0340211

Apply suggestions from code review

a33218b

Updates following review Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: leanneeliatra <[email protected]>

leanneeliatra added 2 commits March 22, 2024 16:12

Merge branch 'main' into 20230825-edit-document-level-permissions

09a6e06

Merge branch 'main' into 20230825-edit-document-level-permissions

c4cca6b

Naarcha-AWS approved these changes Mar 26, 2024

View reviewed changes

Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Mar 26, 2024

Naarcha-AWS reviewed Mar 26, 2024

View reviewed changes

_security/access-control/users-roles.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Mar 26, 2024

View reviewed changes

_security/access-control/users-roles.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Mar 26, 2024

View reviewed changes

_security/access-control/users-roles.md Show resolved Hide resolved

Naarcha-AWS reviewed Mar 26, 2024

View reviewed changes

_security/access-control/users-roles.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Mar 26, 2024

View reviewed changes

_security/access-control/users-roles.md Outdated Show resolved Hide resolved

Naarcha-AWS reviewed Mar 26, 2024

View reviewed changes

_security/access-control/users-roles.md Show resolved Hide resolved

Apply suggestions from code review

c4f265e

Signed-off-by: Naarcha-AWS <[email protected]>

natebower requested changes Mar 27, 2024

View reviewed changes

leanneeliatra and others added 3 commits March 27, 2024 12:46

Merge branch 'main' into 20230825-edit-document-level-permissions

cb681ae

Apply suggestions from code review

af79721

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>

Update document-level-security.md

24afe20

Signed-off-by: Naarcha-AWS <[email protected]>

natebower approved these changes Mar 27, 2024

View reviewed changes

_security/access-control/document-level-security.md Outdated Show resolved Hide resolved

leanneeliatra and others added 2 commits March 27, 2024 16:27

Update _security/access-control/document-level-security.md

415786f

Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: leanneeliatra <[email protected]>

Merge branch 'main' into 20230825-edit-document-level-permissions

6afb195

hdhalter added 3 - Done Issue is done/complete and removed 5 - Editorial review PR: Editorial review in progress labels Mar 27, 2024

Merge branch 'main' into 20230825-edit-document-level-permissions

06065f6

Naarcha-AWS merged commit 6f8261b into opensearch-project:main Mar 28, 2024
3 checks passed

opensearch-trigger-bot bot mentioned this pull request Mar 28, 2024

[Backport 2.12] Adding explanation for editing permissions 20230825 #6804

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding explanation for editing permissions 20230825 #6606

Adding explanation for editing permissions 20230825 #6606

leanneeliatra commented Mar 6, 2024

leanneeliatra commented Mar 6, 2024

Naarcha-AWS left a comment

Naarcha-AWS left a comment

leanneeliatra commented Mar 22, 2024 •

edited

Loading

leanneeliatra commented Mar 26, 2024 •

edited

Loading

natebower left a comment

natebower Mar 27, 2024

natebower Mar 27, 2024

natebower Mar 27, 2024

natebower left a comment

Adding explanation for editing permissions 20230825 #6606

Adding explanation for editing permissions 20230825 #6606

Conversation

leanneeliatra commented Mar 6, 2024

Description

Customer query

Fix

Issues Resolved

Checklist

leanneeliatra commented Mar 6, 2024

Naarcha-AWS left a comment

Choose a reason for hiding this comment

Naarcha-AWS left a comment

Choose a reason for hiding this comment

leanneeliatra commented Mar 22, 2024 • edited Loading

leanneeliatra commented Mar 26, 2024 • edited Loading

natebower left a comment

Choose a reason for hiding this comment

natebower Mar 27, 2024

Choose a reason for hiding this comment

natebower Mar 27, 2024

Choose a reason for hiding this comment

natebower Mar 27, 2024

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

leanneeliatra commented Mar 22, 2024 •

edited

Loading

leanneeliatra commented Mar 26, 2024 •

edited

Loading