Document a way to check `backup` status
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Audience/target: admin
Root document: https://www.tarantool.io/en/doc/latest/book/admin/backups/ ?
SME: @ alyapunov
This is an example on how to check if Tarantool backup mode is enabled:
unix/:./tmp/run/router.control> box.backup.start()
---
- - /home/user/.../tmp/data/router/00000000000000000000.snap
...
unix/:./tmp/run/.router.control> box.info.gc()
---
- signature: 0
checkpoint_is_in_progress: false
consumers: []
is_paused: false
vclock: {}
checkpoints:
- references:
- backup
vclock: {}
signature: 0
...
unix/:./tmp/run/router.control> box.backup.stop()
---
...
unix/:./tmp/run/router.control> box.info.gc()
---
- signature: 0
checkpoint_is_in_progress: false
consumers: []
is_paused: false
vclock: {}
checkpoints:
- references: []
vclock: {}
signature: 0
...
unix/:./tmp/run/router.control>
courtesy of @no1seman
Oneliner according to console output above:
box.info.gc().checkpoints[1].references[1] == 'backup'
This is a bit uncomfortable way, but we have what we have. Can you check if it is the only way? If so -- document it?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Tarantool backups documentation at the linked root document and review the shown box.backup.start(), box.backup.stop(), and box.info.gc() output. Check whether another way to determine backup status exists, then document the confirmed approach and its result in that section.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100