tarantool / tarantool/doc

config.context: scalar values for template variables

Open Beginner friendly
#5,693 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

The config.context section can be used to define named values
for {{ context.<name> }} template substitution. A variable
can be set to a string, a number, or a boolean directly:

config:
  context:
    port: 3301
iproto:
  listen:
    - uri: 'localhost:{{ context.port }}'

Or loaded from an external source using the record form:

config:
  context:
    port:
      from: env
      env: MY_PORT

The config.context section can be placed at any hierarchy
level - global, group, replicaset, or instance. Values at more
specific levels override the ones from outer levels for the
same key.
Requested by @Godrik0 in https://github.com/tarantool/tarantool/commit/4b90dd4484308e3e5f4097011ced6801ce3f57c6.

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

Locate the existing documentation for config.context and compare its current description with the requested behavior. Document scalar string, number, and boolean values alongside the external-source record form, including hierarchy levels and override precedence; use the YAML examples in the issue to verify that the documented result matches the request.

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
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.