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.

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

[DOC] unclear/missing documentation for settings sources #9142

Open
1 of 4 tasks
rursprung opened this issue Jan 30, 2025 · 0 comments
Open
1 of 4 tasks

[DOC] unclear/missing documentation for settings sources #9142

rursprung opened this issue Jan 30, 2025 · 0 comments

Comments

@rursprung
Copy link
Contributor

rursprung commented Jan 30, 2025

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request.
hidden under the Updating cluster settings using the API chapter it lists the precedence of settings sources. however, (a) this list is incomplete (it's at least missing the environment variables and -E arguments passed at startup) and (b) this should be its own heading (as it's not related to the API).

furthermore, the page is missing an actual example of using environment variables since you can't normally define an env. variable in a shell with dots in it:

$ export discovery.type=single-node
bash: export: `discovery.type=single-node': not a valid identifier

if there's a way to see where which setting came from then this should also be documented (though i don't know if that already exists - if not i guess that'd be a feature request of its own for OpenSearch as it'd be really useful when debugging issues 🙂)

furthermore missing is an information on how to unset a setting which is set at a lower level - e.g. if a setting is set in opensearch.yml, how can one remove that value with an env variable? (for scalar values you can probably just set it to an empty value, but what about list values?)

Version:
all

What other resources are available?
Slack discussion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant