tarantool / tarantool/doc

`app.cfg` and `roles_cfg` are now merged deeply

Open
#4,686 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Since Tarantool 3.4.0, 3.3.1, 3.2.2 <schema object>:merge() performs a
deep merge for table values marked with the any type in the schema if
all the keys in these tables are strings. Please, update the method
description in 1 accordingly.

Fields of app.cfg and roles_cfg are defined as any in the cluster
configuration schema, so now it is possible to set options on different
levels and get a merged result from config:get(). The roles
documentation in 2 needs an update, from the following words:

If a configuration for the same role is provided at different levels
<...>

Requested by @Totktonada in https://github.com/tarantool/tarantool/commit/4c302320c40f7ec2c81b10bf72287bb5779ab43b.

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 with the method description at the config schema object merge page in [1], then review the configuration application roles section linked in [2]. Update both passages to document deep merging for string-keyed any tables and the resulting merged app.cfg and roles_cfg options; verify the wording against the behavior and commit cited in the issue.

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
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.