[DOC] Feedback on Security topics

[hdhalter]

What do you want to do?

x Request a change to existing documentation

Community feedback from the documentation website:

Tell us about your request. Provide a summary of the request and all versions that are affected.

• 20230505 | /docs/latest/security/audit-logs/index |
  /plugins.security.audit.ignore_requests is plugins.security.audit.config.ignore_requests, and this is the same for most of the settings - Fixed by Add documentation for config file settings #4058
• 20230526 | /docs/latest/security/authentication-backends/authc-index/ | There is no description of the configuration for Basic Auth/internal users. There is no description of how to use multiple authentication methods together. See https://github.com/opensearch-project/documentation-website/pull/4638/files
• 20230526 | /docs/latest/security/configuration/configuration/config.yml | contains element 'config' not element opensearch_security'
• 20230527 | docs/latest/security/configuration/configuration/ | Example root element is documented as 'opensearch_security:' when it is actually 'config:'
• 20230526 |/docs/latest/security/configuration/multi-auth/ | opensearch_security.openid.scope is not described or even mentioned
• 20230525 |/docs/2.7/security/multi-tenancy/dynamic-config/ | "Disable or enable multi-tenancy...The default is true" Does that mean the default is true==disable or true==enable? Update the multi-tenancy default status in Dashboards multi-tenancy documentation #5722
• 20230524 | /docs/2.5/security/configuration/disable/ | When I remove securityDashboards plugin, the OpenSearch Dashboards don't start until the plugin is installed back. Add sections for removing OpenSearch Dashboards Security plugin #5830
  (Solution from Peter) PZ: 1. OS must also disable security if OSD removed security 2. OSD must change config to remove all the security related settings, and change https to http. 3. Reboot OS/OSD.
• 20230525 | /docs/latest/security/multi-tenancy/multi-tenancy-config/ | Is this for kibana or opensearch dashboards? n seems to override any sort filter. Addressed by Clarification of Customer Comment # 20230525 #6374
• 20230914 | /docs/2.6/security/configuration/disable/ | Please try to build and EXECUTE the docker container you propose. You will see that it fails - Fixed with Add sections for removing OpenSearch Dashboards Security plugin #5830
• 20231012 | /docs/latest/security/multi-tenancy/tenant-index/ | The global tenant is not a primary tenant -> are you meaning your private tenant? - Addressed by Clarification of Customer Comment # 20231012 #6373
• 20230726 | /docs/latest/security/access-control/permissions/ | indices:admin/mappings/get
  Index permissions could have a description or something - Addressed by Updated index permissions as per customer request #20230726 #6404
• 20231026 | /docs/1.3/security/access-control/default-action-groups/ | not enough details -Addressed by Updated action groups tables as per customer request #20231026 #6405
• 20231107 | /docs/latest/security/authentication-backends/proxy/ | Even though everything is set, I am still facing 401 error -x adding proxy configuration #20231107 #20230503 in 4314 issue #6952
• 20230825 | /docs/latest/security/access-control/document-level-security/ | This document did not provide information on how edit the document level permissions. In progress - Addressed by Adding explanation for editing permissions 20230825 #6606
• 20231130 | /docs/latest/security/configuration/system-indices/ | "When Security is installed" is not a helpful condition. If one asks "How to install security" using the built in search at the top "When Security is installed" is not a helpful condition. If one asks "How to install security" using the built in search at the top of the page one gets a long list of "hits". None of the top ones seems to answer the questions and studying all of them would take days. So the list of hits is actually worthless.Please underpin the phrase with a link. (in progress) - Addressed by Adding security installation information #20231130 #6605
• 20231026 | /docs/latest/api-reference/document-apis/index-document/ | please give a full detailed document with method type. what use put method? like this if describe that can easy to use a developer this apies.-x
  - [ ] 20230811 | /docs/latest/security/access-control/permissions/ | No example code
• 20230503 | /docs/latest/security/access-control/cross-cluster-search/ |What about other details? What if my port is proxied? adding proxy configuration #20231107 #20230503 in 4314 issue #6952
• 20230804 | /docs/latest/security/access-control/cross-cluster-search/ | no information on remote clusters that are not docker managed - in progress - Add more details to cross-cluster page #20230811 #20231102 #20230804 #6657
• 20231102 | /docs/latest/security/configuration/index/ | how do I do this in the UI if I am not using the docker image at the moment - in progress - Add more details to cross-cluster page #20230811 #20231102 #20230804 #6657
• 20230811 | /docs/latest/security/access-control/cross-cluster-search/ | why is it docker centric - in progress - Add more details to cross-cluster page #20230811 #20231102 #20230804 #6657

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
https://opensearch.org/docs/latest/security/index/

[hdhalter]

This PR fixes a couple of the items. #4315

[hdhalter]

In progress by @john-eliatra

[john-eliatra]

I can work on this.

[leanneeliatra]

PR submitted for multi-tenancy issues

1. 20231012 | /docs/latest/security/multi-tenancy/tenant-index/ | The global tenant is not a primary tenant -> are you meaning your private tenant? -x (Resolved & Merged)
2. 20230525 | /docs/latest/security/multi-tenancy/multi-tenancy-config/ | Is this for kibana or opensearch dashboards? n seems to override any sort filter.-x (Resolved & Merged)

cc @hdhalter, just to flag the above, thank you.

[leanneeliatra]

PR created for 20230825 | /docs/latest/security/access-control/document-level-security/ | This document did not provide information on how edit the document level permissions.

[AntonEliatra]

PR (Draft) created for 20231130 | /docs/latest/security/configuration/system-indices/ | "When Security is installed" is not a helpful condition. If one asks "How to install security" using the built in search at the top of the page one gets a long list of "hits". None of the top ones seems to answer the questions and studying all of them would take days. So the list of hits is actually worthless.Please underpin the phrase with a link. (in progress)

[leanneeliatra]

Complete 20231026 | /docs/latest/api-reference/document-apis/index-document/ | please give a full detailed document with method type...

[leanneeliatra]

I've been looking into 20230811 | /docs/latest/security/access-control/permissions/ | No example code, from reading through the page, there are examples given.
There are lists provided such as, Alerting Permissions, Asynchronous Search permissions, Index State Management permissions, etc.
At the top of those lists there are links to the relevant page where the examples are given e.g. Alerting Permissions shows the link See Alerting API where the examples are given in further depth on the relevant page. cc @hdhalter

[AntonEliatra]

#20231107 #20230503
PR raised for proxy configuration on ccs #6952

[hdhalter]

I've been looking into 20230811 | /docs/latest/security/access-control/permissions/ | No example code, from reading through the page, there are examples given. There are lists provided such as, Alerting Permissions, Asynchronous Search permissions, Index State Management permissions, etc. At the top of those lists there are links to the relevant page where the examples are given e.g. Alerting Permissions shows the link See Alerting API where the examples are given in further depth on the relevant page. cc @hdhalter

Thanks for looking at this, @leanneeliatra ! There were some updates to that topic after the comment was made. Let's close that one.

[leanneeliatra]

Brilliant, thank you @hdhalter

[hdhalter]

All feedback has been addressed. Thanks, @AntonEliatra and @leanneeliatra !