tarantool / tarantool/doc

config module `has_role`, `is_router` and `is_storage` methods

Open
#5,010 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Related dev. issue(s): https://github.com/tarantool/tarantool/issues/11288
Product: Tarantool
Since: 3.4
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/config/#lua-object.config
SME: @ grafin

Details

has_role(<role_name>, {instance = <instance_name}) returns true if
the instance with the name <instance_name> has role <role_name> enabled
in the current config, false if not. Second argument is optional, and
if not provided the check will be done for the instance the method is
called on.

is_router({instance = <instance_name}) returns true if the instance
with name <instance_name> is a vshard router, according to the current
config, false if not. Argument is optional, and if not provided the
check will be done for the instance the method is called on.

is_storage({instance = <instance_name}) returns true if the instance
with name <instance_name> is a vshard storage, according to the current
config, false if not. Argument is optional, and if not provided the
check will be done for the instance the method is called on.
Requested by @ grafin in https://github.com/tarantool/tarantool/commit/76c82641577fed83bada247a9a9168d5d9204e99.

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 linked root document at reference/reference_lua/config/#lua-object.config and add the three config methods described in this issue. Done means the documentation explains each method, its optional instance argument, and its return value for the current configuration; no test file is mentioned in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.