Update backup guide #8405
Update backup guide #8405
Conversation
WalkthroughThe documentation for the backup and restoration of CVAT data has been updated to clarify the use of Docker volumes. The Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant BackupSystem
participant Docker
participant Clickhouse
User->>BackupSystem: Initiate backup
BackupSystem->>Docker: Access volume cvat_events_db
Docker->>Clickhouse: Retrieve database files
Clickhouse-->>Docker: Send database files
Docker-->>BackupSystem: Provide backup data
BackupSystem-->>User: Confirm backup completion
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- site/content/en/docs/administration/advanced/backup_guide.md (3 hunks)
Additional context used
LanguageTool
site/content/en/docs/administration/advanced/backup_guide.md
[uncategorized] ~23-~23: Loose punctuation mark.
Context: .../home/django/keyspath. -cvat_logs: used to store logs of CVAT backend proc...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...e/django/logspath. -cvat_events_db`: this volume is used to store Clickhouse...(UNLIKELY_OPENING_PUNCTUATION)
Additional comments not posted (4)
site/content/en/docs/administration/advanced/backup_guide.md (4)
26-27: Approved: Volume renaming and description update.The changes to rename the volume to
cvat_events_dband update its description to specify its use for Clickhouse database files are clear and consistent with the PR objectives.Tools
LanguageTool
[uncategorized] ~26-~26: Loose punctuation mark.
Context: ...e/django/logspath. -cvat_events_db`: this volume is used to store Clickhouse...(UNLIKELY_OPENING_PUNCTUATION)
46-46: Approved: Backup command update.The update to the backup command correctly reflects the new volume name
cvat_events_dband its mount path.
53-53: Approved: Updated backup file listing.The listing of backup files now correctly includes
cvat_events_db.tar.gz, ensuring completeness and accuracy in the documentation.
77-77: Approved: Restore command update.The update to the restore command correctly reflects the new volume name
cvat_events_dband its mount path.
<!-- Raise an issue to propose your change (https://github.com/cvat-ai/cvat/issues). It helps to avoid duplication of efforts from multiple independent contributors. Discuss your ideas with maintainers to be sure that changes will be approved and merged. Read the [Contribution guide](https://docs.cvat.ai/docs/contributing/). --> <!-- Provide a general summary of your changes in the Title above --> ### Motivation and context <!-- Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here. Describe your changes in detail, add screenshots. --> ### How has this been tested? <!-- Please describe in detail how you tested your changes. Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc. --> ### Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. If an item isn't applicable for some reason, then ~~explicitly strikethrough~~ the whole line. If you don't do that, GitHub will show incorrect progress for the pull request. If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [x] I submit my changes into the `develop` branch - [ ] I have created a changelog fragment <!-- see top comment in CHANGELOG.md --> - [ ] I have updated the documentation accordingly - [ ] I have added tests to cover my changes - [ ] I have linked related issues (see [GitHub docs]( https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)) - [ ] I have increased versions of npm packages if it is necessary ([cvat-canvas](https://github.com/cvat-ai/cvat/tree/develop/cvat-canvas#versioning), [cvat-core](https://github.com/cvat-ai/cvat/tree/develop/cvat-core#versioning), [cvat-data](https://github.com/cvat-ai/cvat/tree/develop/cvat-data#versioning) and [cvat-ui](https://github.com/cvat-ai/cvat/tree/develop/cvat-ui#versioning)) ### License - [x] I submit _my code changes_ under the same [MIT License]( https://github.com/cvat-ai/cvat/blob/develop/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated the backup and restoration guide for CVAT data to clarify the use of Docker volumes. - Renamed the volume from `cvat_events` to `cvat_events_db` for better accuracy regarding its function. - Streamlined instructions by removing references to Elasticsearch, focusing solely on Clickhouse database backups. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
Motivation and context
How has this been tested?
Checklist
developbranch(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit
cvat_eventstocvat_events_dbfor better accuracy regarding its function.