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

[DOC] Feedback on configuration settings

Open hdhalter opened this issue 2 years ago • 7 comments

What do you want to do?

  • x Request a change to existing documentation

Tell us about your request. Provide a summary of the request and all versions that are affected. Feedback on /docs/latest/install-and-configure/configuration/

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

  • [x] "It would be helpful if you could include a clear link to reference documentation with the full list of available settings.
  • [x] "Specify settings as environment variables" section is misleading - you can also just specify each setting as an env var. But the doc doesn't mention this possibility." Fixed by https://github.com/opensearch-project/documentation-website/pull/7400

hdhalter avatar Mar 24 '23 22:03 hdhalter

Tagging you, @kolchfa-aws, since this has to do with config settings. Do you know if this feedback is valid?

hdhalter avatar Nov 17 '23 21:11 hdhalter

@hdhalter No, I don't

kolchfa-aws avatar Nov 17 '23 21:11 kolchfa-aws

  • [x] 20240417 | /docs/latest/security/configuration/demo-configuration/ | Very confusing. Does not have instructions for Mac; fixed by https://github.com/opensearch-project/documentation-website/pull/7381
  • [x] 20240322 | /docs/latest/security/configuration/configuration/ | what is absolute path to config/opensearch-security/config.yml??? Fixed by https://github.com/opensearch-project/documentation-website/pull/7380
  • [ ] 20240211 | /docs/latest/security/configuration/tls/ | fine to tell us, that we can use encrypted passwords and write in the logs that we shall use the _secure version. But how shall they be encrypted? And what is the relation to the openseach.keystore? Are these complementary or orthogonal concepts?
  • [ ] 20240326 | /docs/latest/security/configuration/security-admin/ | How to deal with docker? Do i have add command running securityadmin.sh in docker compose file or what? It does not apply when mounted to container? Is it so hard to add proper docker documentation?
  • [ ] 20240404 | /docs/latest/security/configuration/yaml/ | For user kibanaserver there are additional steps needed but not documented here. See: https://groups.google.com/g/wazuh/c/rdCF0MBR6oU I used this as a starting point and modified the path to opensear ch-dashboards-keystore accordingly for using opensearch-dashboards without Wazu. Would be great to find this here in the future
  • [ ] 20240328 | /docs/2.12/security/configuration/yaml/ | Allowlist description only shows config examples for URLs, not remote hosts.

hdhalter avatar Jun 11 '24 22:06 hdhalter

@hdhalter I'm working on those issues listed above. Please see PR below. cc @scrawfor99

PR for 20240322 - add absolute path for config.yml PR for 20240417 - add demo config instructions for Mac

leanneeliatra avatar Jun 13 '24 15:06 leanneeliatra

Not all feedback is addressed; reopening.

hdhalter avatar Jul 09 '24 19:07 hdhalter

Thank you @hdhalter, I will address this.

leanneeliatra avatar Jul 10 '24 12:07 leanneeliatra

Thank you @hdhalter, I will address this.

Thanks, @leanneeliatra! The issue was auto-closed by an associated PR, so I just reopened it.

hdhalter avatar Jul 10 '24 14:07 hdhalter

Closing as stale

natebower avatar Jul 14 '25 16:07 natebower