vshard: `box_cfg_mode` cfg option on router
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue: n/a
Product: Tarantool, vshard
Since: 3.0, 0.1.25
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_rock/vshard/vshard_router/
SME: @ Totktonada, @ Serpentian
Details
The option can be specified at the root level and regulates, whether
vshard calls box.cfg, when vshard.router.cfg() is invoked.
When specified to 'auto' (default), vshard configures box.cfg on its
own. When specified to 'manual', vshard's router can be started even
with unconfigured box.cfg.
Requested by @Serpentian in https://github.com/tarantool/vshard/commit/7a8253cf6d19bd003784b23947bd37457ef204c8.
Contributor guide
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
Open the vshard router root document linked in the issue and inspect the existing configuration-option documentation. Document the root-level box_cfg_mode option, including its auto default and manual behavior, then verify the rendered page reflects when vshard.router.cfg() calls box.cfg.
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
- 50/100