vshard: `box_cfg_mode` cfg option
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related dev. issue(s): https://github.com/tarantool/vshard/issues/428
Related doc. issue(s): https://github.com/tarantool/doc/issues/3895
Product: Tarantool, vshard
Since: 3.0
Root document: https://docs.d.tarantool.io/en/doc/3.0/reference/reference_rock/vshard/vshard_ref/
SME: @ Serpentian
Details
The option can be specified at the root level and regulates, whether
vshard calls box.cfg, when vshard.storage is invoked.
When specified to 'auto' (default), vshard configures box.cfg on its
own. When specified to 'manual', it's user's responsibility to call
box.cfg prior to vshard's configuration
Requested by @ Serpentian in https://github.com/tarantool/vshard/commit/95325a96f5357a0ead94830c45ffac99102fe8b7.
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 reference root document linked in the issue and locate the root-level configuration options for vshard.storage. Document the box_cfg_mode option, including its auto default and manual behavior, and verify that the wording covers the requirement to call box.cfg before vshard configuration.
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