tarantool / tarantool/doc

vshard: recovery point manager vshard-router backend

Open Beginner friendly
#5,703 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: VShard 0.1.42

VShard now ships a backend for Tarantool's recovery point manager. It
lets a vshard cluster periodically create cluster-consistent recovery
points that can later be used for backup and point-in-time recovery of
the whole cluster. Note, that the whole cluster must be recovered to
that point, recovery of one or several replicasets is prohibited and
lead to doubled buckets.

The backend requires the sharding "router" role. Enable the backend on a
router instance by configuring the recovery point manager role with the
vshard-router backend, for example:

    roles: [roles.recovery-point-manager]
    roles_cfg:
      roles.recovery-point-manager:
        backend: vshard-router
        create:
          timeout: 120
          by:
            interval: 600

The cluster point is created with no bucket rebalancing in progress,
which makes it cluster-consistent.

The create.timeout option should be about 1.5 times bigger than the
storages' sharding.rebalancer_bucket_send_timeout, if recovery points
must be created during rebalancing. With too small timeout no recovery
point can be created for as long as rebalancing is running. Note that
rebalancer_bucket_send_timeout is infinite by default, so set it to a
finite value to make recovery points creatable during rebalancing.
Requested by @Serpentian in https://github.com/tarantool/vshard/commit/f7b998b6810ba0a0bf0f49427f2a6daff8622791.

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

No target file is named. Start by locating the documentation for the recovery point manager and vshard router role, using the supplied YAML configuration and timeout guidance as the source. Done means the vshard-router backend, whole-cluster recovery restriction, and rebalancing timeout requirements are documented clearly.

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.