tarantool / tarantool/doc

box.cfg.read_only supports the 'unless_bootstrap' value

Open
#5,710 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

box.cfg.read_only now accepts the string 'unless_bootstrap' along
with the usual booleans. An instance configured this way becomes
writable only if it has bootstrapped the replicaset on the current
startup. It stays read-only if it recovered from a local snapshot or
joined an already bootstrapped replicaset (including a rebootstrap of
a wiped instance into its old registration). The mode is resolved
atomically during the initial box.cfg() call, so the instance never
goes through a transient writable state.
box.cfg.read_only keeps reporting the configured 'unless_bootstrap'
string; the effective state is visible in box.info.ro. The value may
be set only during the initial box.cfg() call, is incompatible with
replication_anon = true and is supported in the TT_READ_ONLY
environment variable as well.
Requested by @okhsunrog in https://github.com/tarantool/tarantool/commit/75ab296f5c3f2d9b7799f798dc9c875704e515e4.

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

Search the documentation for box.cfg.read_only and start from the box.cfg entry, checking the related box.info.ro and TT_READ_ONLY references. Document the unless_bootstrap behavior, restrictions, and startup cases described in the issue; done means the documented configuration and effective read-only state match this specification.

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
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.