Skip to content

[Config] Configuration reference (YAML) #3664

Closed
@andreyaksenov

Description

@andreyaksenov

Product: Tarantool
Since: 3.0
Root document: https://www.tarantool.io/en/doc/latest/reference/configuration/configuration_reference/
SME: @ Totktonada

Note: Looks like adding descriptions for specific options makes sense when describing corresponding functionality. So, this issue should be used to verify that all necessary options are added to Configuration reference at some moment.

Details

Create a configuration reference for a new approach. Instance config schema: https://github.com/tarantool/tarantool/blob/master/src/box/lua/config/instance_config.lua
Add information about applicable configuration scopes for each option.

See the comparison table: https://docs.google.com/spreadsheets/d/1_yEK9N_hBVWIga9mOk7zZzA6Zd3mAq7e5KZsnrbgj30/edit#gid=0

Old approach reference are kept here: https://www.tarantool.io/en/doc/latest/reference/configuration/.

instance/replicaset/group names validation

Note from @ Totktonada: #3825 (comment)

We should also mention validation rules for instance/replicaset/group names somewhere. See https://github.com/tarantool/tarantool/blob/10372d0d9ded18ff64c256e125ce740bb0605587/src/box/lua/config/cluster_config.lua#L120-L141.

PRs

Here are PRs that already added some configuration properties related to corresponding features:

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions