pingcap / pingcap/docs-tidb-operator
The documentation should include a note instructing users to validate modified configurations before applying changes in TiKV
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 52
- Forks
- 129
- Avg merge
- 12m
- Merged PRs (30d)
- 2
Description
https://github.com/pingcap/docs-tidb-operator/commit/154c6229966d7edd7df31e325763284503bddaec
For config modification, there is config check in tiup, while no such logic for TiOperator. So we suggest add some note to describe how to validate manually here.
https://github.com/pingcap/tiup/blob/master/pkg/cluster/spec/server_config.go#L297
Since unvalidated configuration changes could cause TiKV to fail on startup.
Here is an example:
Related code: https://github.com/tikv/tikv/blob/master/components/server/src/setup.rs#L307
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading TiUP's pkg/cluster/spec/server_config.go and TiKV's components/server/src/setup.rs, then find the TiDB Operator documentation section covering configuration changes. Done means adding a note that explains how users can manually validate modified configurations before applying them and why this prevents TiKV startup failures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100