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

docs: update examples documentation to use of loading from ENV #350

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

renatocron
Copy link

Description

This PR enhances the Druid Operator's documentation to improve clarity. It addresses the following:

  • Introduction of Environment Variables in Druid Configuration: A new section in the examples documentation introduces the use of environment variables within common.runtime.properties. This provides a mechanism for greater configuration flexibility and security. Users can now manage sensitive information or environment-specific values externally, without directly embedding them in the Druid configuration. This was already being used on Allow possibilities to add env var to erase some config value #35 (comment)

  • Practical Example of Environment Variables: A concrete example showcasing the utilization of environment variables for the metadata store configuration (druid.metadata.storage.connector.*) is added. This example guides users on how to implement this new feature effectively.


Key changed/added files in this PR
  • docs/examples.md

…t for environment variables in Druid configuration

feat(docs): add examples for using environment variables in common.runtime.properties to enhance configuration flexibility and security

fix(docs): correct spelling of "Multiple" in the NodeSpec example header for consistency and professionalism
@renatocron
Copy link
Author

Maybe I should add that this is a feature from druid itself, not the operator https://druid.apache.org/docs/latest/operations/dynamic-config-provider/#environment-variable-dynamic-config-provider
I was just unaware of it and only found it now after searching in the wrong place 🤣

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

Successfully merging this pull request may close these issues.

1 participant