docs: document Kafka WAL create_index option - #2731
Merged
Merged
Conversation
Signed-off-by: WenyXu <wenymedia@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the Datanode Kafka Remote WAL create_index option across the intended documentation scopes (Nightly + v1.2, English + Chinese) to reflect the v1.2 default and explain when/why operators might enable it during recovery.
Changes:
- Added
create_index = falseto the Kafka WAL Datanode configuration examples (Nightly + v1.2, EN + ZH). - Added a new option-table entry documenting the
create_indexdefault (false), distributed-mode-only behavior, and recovery/replay guidance.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/user-guide/deployments-administration/wal/remote-wal/configuration.md | Adds create_index to Nightly English Remote WAL configuration example and option reference. |
| versioned_docs/version-1.2/user-guide/deployments-administration/wal/remote-wal/configuration.md | Adds create_index to v1.2 English Remote WAL configuration example and option reference. |
| i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/wal/remote-wal/configuration.md | Adds create_index to Nightly Chinese Remote WAL configuration example and option reference. |
| i18n/zh/docusaurus-plugin-content-docs/version-1.2/user-guide/deployments-administration/wal/remote-wal/configuration.md | Adds create_index to v1.2 Chinese Remote WAL configuration example and option reference. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
fengjiachun
reviewed
Aug 10, 2026
Signed-off-by: WenyXu <wenymedia@gmail.com>
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
Document the Datanode Kafka WAL
create_indexoption in the Nightly and v1.2 Remote WAL configuration pages. The update describes its default value offalse, its distributed-mode limitation, and when enabling it can reduce Kafka reads and speed up WAL replay.Closes #2724.
Scope
Verification
pnpm buildDOC_LANG=zh pnpm buildDOC_LANG=en pnpm check:linksDOC_LANG=zh pnpm check:linksgit diff --checkChecklist