pingcap / pingcap/docs

Not clear that some configurations such as [raftstore] raftdb-path are ignored when raft engine is on (default)

Open
#13,231 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

File: /master/tikv-configuration-file.md

We spent sometime configuring raftdb-path in [raftstore] before realizing that this parameter was ignored due to raft engine being on by default and a different config had to be used.

The [raft-engine] enabled has a short note saying it's on by default and when it's on raftdb configs will be ignored, but it's not clear which all configs are raftdb specific. It would be clearer to add a note next to the config parameters or sections which are ignored that those won't apply unless raft-engine is off (especially since those sections will mostly be ignored with the raft engine default)

A little more confusing was that setting raftdb-path was actually getting validated in info logs (and would fail if we specified a bad dir), making it look it was used, but eventually not actually being used.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in tikv-configuration-file.md, especially the [raft-engine] and [raftstore] sections. Identify the raftdb-related parameters described there and make it clear which are ignored when raft engine is enabled; done means the affected configuration entries explain when they apply.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.