Repository navigation
docs(config): document environment overrides for region_engine - #2988
Merged
MichaelScofield merged 1 commit intoOct 28, 2026
Merged
MichaelScofield merged 1 commit into
MichaelScofield merged 1 commit into
Conversation
5 of 6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Documents the tag-based environment variable overrides for
region_engineondatanodeandstandalone, added in GreptimeTeam/greptimedb#9700 (merged; the feature is onmain, i.e. 1.4.0, and is not inrelease/v1.3).#### Environment Variable Rules: new paragraph on options whose value is a list of named entries. They are addressed by the entry name, not by its position in the list (GREPTIMEDB_DATANODE__REGION_ENGINE__MITO__GLOBAL_WRITE_BUFFER_REJECT_SIZE=4GB); a numeric index is rejected;region_enginedefaults tomitoandfilewhile themetricengine is always registered; and once a[[region_engine]]entry appears in the configuration file the whole list comes from the file, so these variables are ignored for it.### Region engine options: corrected the stale sentence that said onlymitoandmetricoptions are available, and added a cross-reference to the environment variable rules.The wording follows the merged
config/config.mdand the resolution of the Copilot review note on #9700 ("describemitoandfileas the default configuration entries, not the only enabled engines"): the default configuration listsmitoandfile, andmetricis always registered, so ametricentry only supplies its options rather than enabling the engine.Scope
docs/). The option does not exist in any released GreptimeDB version:src/common/config/src/tagged_seq.rsis absent fromrelease/v1.3, and the workspace onmainis1.4.0-alpha.0. Noversioned_docs/changes and no backport.Verification
Rendered route (Nightly):
/nightly/user-guide/deployments-administration/configuration/. Checked in the built HTML that both new paragraphs are present, that the old "Currently, options formitoandmetricregion engines are available" sentence is gone, and that the#environment-variable-rulesanchor target exists.Checklist
main/ 1.4.0:tagged_seq.rs, theregion_enginedefaults insrc/datanode/src/config.rsandsrc/standalone/src/options.rs, themetricengine construction insrc/datanode/src/datanode.rs, and the tests insrc/cmd/tests/load_config_test.rs.)