Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOC] Feedback on configuration settings #3582

Open
2 tasks done
hdhalter opened this issue Mar 24, 2023 · 7 comments · Fixed by #7400
Open
2 tasks done

[DOC] Feedback on configuration settings #3582

hdhalter opened this issue Mar 24, 2023 · 7 comments · Fixed by #7400
Assignees
@leanneeliatra
Labels
2 - In progress Issue/PR: The issue or PR is in progress. configuration Feedback Feedback received from feedback mechanism on doc-website security

Comments

@hdhalter
Copy link
Contributor

hdhalter commented Mar 24, 2023 •
edited
Loading

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.

  • "It would be helpful if you could include a clear link to reference documentation with the full list of available settings.
  • "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 Setting-envars-docs #3582 #7400
@hdhalter hdhalter added 1 - Backlog Issue: The issue is unassigned or assigned but not started and removed untriaged labels Mar 24, 2023
@hdhalter hdhalter assigned cwillum and unassigned ariamarble May 9, 2023
@hdhalter hdhalter added the Feedback Feedback received from feedback mechanism on doc-website label May 23, 2023
@hdhalter hdhalter assigned kolchfa-aws and unassigned cwillum Nov 17, 2023
@hdhalter
Copy link
Contributor Author

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

@kolchfa-aws
Copy link
Collaborator

@hdhalter No, I don't

@hdhalter hdhalter removed the 1 - Backlog Issue: The issue is unassigned or assigned but not started label Nov 30, 2023
@hdhalter
Copy link
Contributor Author

hdhalter commented Jun 11, 2024 •
edited
Loading

  • 20240417 | /docs/latest/security/configuration/demo-configuration/ | Very confusing. Does not have instructions for Mac; fixed by 20240417 Adding OpenSearch demo configuration mac instructions #7381
  • 20240322 | /docs/latest/security/configuration/configuration/ | what is absolute path to config/opensearch-security/config.yml??? Fixed by 20240322 Adding absolute path for config.yml #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.

@leanneeliatra
Copy link
Contributor

leanneeliatra commented Jun 13, 2024 •
edited
Loading

@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 leanneeliatra mentioned this issue Jun 13, 2024
Merged
1 task
@hdhalter hdhalter added the 2 - In progress Issue/PR: The issue or PR is in progress. label Jun 13, 2024
@leanneeliatra leanneeliatra mentioned this issue Jun 13, 2024
Merged
1 task
AntonEliatra added a commit to AntonEliatra/documentation-website that referenced this issue Jun 17, 2024
@AntonEliatra
setting-envars-docs opensearch-project#3582
f9ea9db 
Signed-off-by: AntonEliatra <[email protected]>
@AntonEliatra AntonEliatra mentioned this issue Jun 17, 2024
Merged
1 task
Naarcha-AWS added a commit that referenced this issue Jul 9, 2024
@AntonEliatra @Naarcha-AWS
Setting-envars-docs #3582 (#7400)
8f6ea3f 
* setting-envars-docs #3582

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

* Update index.md

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

* Apply suggestions from code review

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

* Update index.md

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

---------

Signed-off-by: AntonEliatra <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
opensearch-trigger-bot bot pushed a commit that referenced this issue Jul 9, 2024
@github-actions @Naarcha-AWS
Setting-envars-docs #3582 (#7400)
3282950 
* setting-envars-docs #3582

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

* Update index.md

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

* Apply suggestions from code review

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

* Update index.md

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

---------

Signed-off-by: AntonEliatra <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 8f6ea3f)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
github-actions bot pushed a commit that referenced this issue Jul 9, 2024
@opensearch-trigger-bot
Setting-envars-docs #3582 (#7400) (#7658)
ae2a16d
@hdhalter hdhalter reopened this Jul 9, 2024
@hdhalter
Copy link
Contributor Author

hdhalter commented Jul 9, 2024

Not all feedback is addressed; reopening.

@hdhalter hdhalter removed the untriaged label Jul 9, 2024
@leanneeliatra
Copy link
Contributor

Thank you @hdhalter, I will address this.

@hdhalter
Copy link
Contributor Author

Thank you @hdhalter, I will address this.

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

leanneeliatra pushed a commit to leanneeliatra/opensearch-documentation-website-forl that referenced this issue Jul 24, 2024
@AntonEliatra @Naarcha-AWS @leanneeliatra
Setting-envars-docs opensearch-project#3582 (opensearch-project#7400)
e7acb29 
* setting-envars-docs opensearch-project#3582

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

* Update index.md

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

* Apply suggestions from code review

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

* Update index.md

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

---------

Signed-off-by: AntonEliatra <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: [email protected] <[email protected]>
sandervandegeijn pushed a commit to sandervandegeijn/documentation-website that referenced this issue Jul 30, 2024
@AntonEliatra @Naarcha-AWS @sandervandegeijn
Setting-envars-docs opensearch-project#3582 (opensearch-project#7400)
6f8bccb 
* setting-envars-docs opensearch-project#3582

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

* Update index.md

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

* Apply suggestions from code review

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

* Update index.md

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

---------

Signed-off-by: AntonEliatra <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Sander van de Geijn <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@leanneeliatra leanneeliatra

Labels
2 - In progress Issue/PR: The issue or PR is in progress. configuration Feedback Feedback received from feedback mechanism on doc-website security
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Setting-envars-docs #3582 AntonEliatra/documentation-website
5 participants
@hdhalter @kolchfa-aws @cwillum @ariamarble @leanneeliatra