documentation-website icon indicating copy to clipboard operation
documentation-website copied to clipboard

Published 20 hours ago • verified publisher icon opensearch-project

[DRAFT] Security feature SuperAdmin documentation updates

Open leanneeliatra opened this issue 10 months ago • 4 comments

Description

The SuperAdmin role was added and this will be added to the documentation.

Issues Resolved

One part of: [DOC] Missing documentation for security features #433. The part this PR addresses is: CRUD APIs for default configurations. (Default roles, users and role-mapping can be updated by super admin now).

The original PR for the work of this ticket can be found here: Added SuperAdmin check to allow update/delete/add of reserved config, this PR is concerned with adding the documentation to support the SuperAdmin addition.

Checklist

  • [x] 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.

leanneeliatra avatar Apr 09 '24 13:04 leanneeliatra

Hi @Naarcha-AWS & @hdhalter. I opened this ticket as a draft to get some input from you please. I'm not sure if the file I have included these changes in, is the right place for this addition to the documentation.

Could you take a look and let me know please. I am adding a section to the documentation to convey the addition of the SuperAdmin role. The SuperAdmin can add, update and delete the reserved configuration such as roles, roles_mapping, internal_users, action_groups and tenants.

I have included these changes in the _security/access-control/users-roles.md file at the end, or on the # Users and roles page. Do you think this is a suitable place to add these changes? Thank you.

leanneeliatra avatar Apr 09 '24 13:04 leanneeliatra

We reviewed these changes internally and I am currently in the process of understanding the original PR fully, so I can update the documentation appropriately.

leanneeliatra avatar Apr 11 '24 18:04 leanneeliatra

I reached out to Hardik Shah via slack to discuss the original PR in more depth.

leanneeliatra avatar Apr 15 '24 10:04 leanneeliatra

Thank you @hardik-k-shah for your comments much appreciated. Still testing these changes locally to ensure correct documentation of the SuperAdmin.

leanneeliatra avatar Apr 24 '24 14:04 leanneeliatra

@leanneeliatra - Do you want to close this PR in favor of https://github.com/opensearch-project/documentation-website/pull/7069?

hdhalter avatar May 07 '24 22:05 hdhalter

@leanneeliatra - Do you want to close this PR in favor of #7069?

Hi @hdhalter yes please. I can ensure all aspects are covered in 7069.

leanneeliatra avatar May 08 '24 11:05 leanneeliatra

Closing in favor of https://github.com/opensearch-project/documentation-website/pull/7069

hdhalter avatar May 08 '24 15:05 hdhalter