docs(cloud): add Cloud Operations section with Backup and Restore guide#511
docs(cloud): add Cloud Operations section with Backup and Restore guide#511dragnot wants to merge 3 commits into
Conversation
Add a Cloud Operations sub-section under Cloud DBaaS and a Backup and Restore page. Covers RDB export (temporary link, GCS, S3), RDB import (file, URL, GCS, S3, instance clone), scheduled backups on Pro and Enterprise, task history, permissions by role, and limits. Includes console screenshots. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
📝 WalkthroughWalkthroughTwo Cloud Operations docs pages were added: a navigation landing page and an Export and Import guide. The guide covers prerequisites, export and import workflows, scheduled exports, task history, operational limits, and support/FAQ content. ChangesCloud Operations documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 markdownlint-cli2 (0.22.1)cloud/operations/export-import.mdmarkdownlint-cli2 wrapper config was not available before execution cloud/operations/index.mdmarkdownlint-cli2 wrapper config was not available before execution Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@cloud/operations/backup-restore.md`:
- Around line 119-121: Remove the misleading “Upload link validity” entry from
the backup-restore documentation table, since local file uploads do not use an
expiring link. Update the table in the backup-restore content so only the
relevant rows remain, keeping the surrounding formatting consistent.
In `@cloud/operations/index.md`:
- Line 11: The wording in the opening sentence of the operations guide is
awkward and should use the hyphenated phrase “day-to-day” instead of “day to
day.” Update the introductory text in the operations index copy to read
naturally for user-facing docs while keeping the same meaning and location in
the document.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: dcf2a6db-95be-4e61-a424-2e4ad815a3d0
⛔ Files ignored due to path filters (8)
images/cloud/backup-restore/export-amazon-s3.pngis excluded by!**/*.pngimages/cloud/backup-restore/export-google-cloud-storage.pngis excluded by!**/*.pngimages/cloud/backup-restore/export-task-download.pngis excluded by!**/*.pngimages/cloud/backup-restore/export-temporary-link.pngis excluded by!**/*.pngimages/cloud/backup-restore/import-amazon-s3.pngis excluded by!**/*.pngimages/cloud/backup-restore/import-export-tab.pngis excluded by!**/*.pngimages/cloud/backup-restore/import-google-cloud-storage.pngis excluded by!**/*.pngimages/cloud/backup-restore/import-upload-file.pngis excluded by!**/*.png
📒 Files selected for processing (2)
cloud/operations/backup-restore.mdcloud/operations/index.md
| | Temporary download link validity | 1 hour | | ||
| | Upload link validity | 1 hour | | ||
| | Restore size | Must fit the destination capacity | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Remove the “Upload link validity” row.
A local file upload has no expiring link, so this limit is misleading.
Suggested edit
| Temporary download link validity | 1 hour |
-| Upload link validity | 1 hour |
| Restore size | Must fit the destination capacity |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Temporary download link validity | 1 hour | | |
| | Upload link validity | 1 hour | | |
| | Restore size | Must fit the destination capacity | | |
| | Temporary download link validity | 1 hour | | |
| | Restore size | Must fit the destination capacity | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@cloud/operations/backup-restore.md` around lines 119 - 121, Remove the
misleading “Upload link validity” entry from the backup-restore documentation
table, since local file uploads do not use an expiring link. Update the table in
the backup-restore content so only the relevant rows remain, keeping the
surrounding formatting consistent.
|
|
||
| # Cloud Operations | ||
|
|
||
| Operational guides for running your FalkorDB Cloud deployment. These guides cover day to day tasks you perform from the FalkorDB Cloud console. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use “day-to-day” here.
The current wording is awkward in user-facing docs.
Suggested edit
-Operational guides for running your FalkorDB Cloud deployment. These guides cover day to day tasks you perform from the FalkorDB Cloud console.
+Operational guides for running your FalkorDB Cloud deployment. These guides cover day-to-day tasks you perform from the FalkorDB Cloud console.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Operational guides for running your FalkorDB Cloud deployment. These guides cover day to day tasks you perform from the FalkorDB Cloud console. | |
| Operational guides for running your FalkorDB Cloud deployment. These guides cover day-to-day tasks you perform from the FalkorDB Cloud console. |
🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: Use a hyphen to join words.
Context: ...Cloud deployment. These guides cover day to day tasks you perform from the FalkorDB ...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@cloud/operations/index.md` at line 11, The wording in the opening sentence of
the operations guide is awkward and should use the hyphenated phrase
“day-to-day” instead of “day to day.” Update the introductory text in the
operations index copy to read naturally for user-facing docs while keeping the
same meaning and location in the document.
Source: Linters/SAST tools
dudizimber
left a comment
dudizimber
left a comment
There was a problem hiding this comment.
The Import/Export RDB tab is not primarily for backup and restore. We have dedicated tabs for that, which take backups on the disk (infra) level.
An export is the user's own copy and is not a platform snapshot, so it is not subject to the 14 day snapshot deletion. Reword to prevent confusion with the tier Snapshots policy. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Rename the page and section entry from Backup and Restore to Export and Import. Rename the file to export-import.md and the image folder to images/cloud/export-import. Replace backup and restore terminology with export and import throughout. Scheduled backups becomes scheduled exports, and the internal safety backup becomes a safety copy. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
cloud/operations/index.md (1)
11-11: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winHyphenate "day-to-day" for correct grammar.
This mirrors a previous review comment: the user-facing docs should use the standard hyphenated form "day-to-day."
📝 Suggested fix
-Operational guides for running your FalkorDB Cloud deployment. These guides cover day to day tasks you perform from the FalkorDB Cloud console. +Operational guides for running your FalkorDB Cloud deployment. These guides cover day-to-day tasks you perform from the FalkorDB Cloud console.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@cloud/operations/index.md` at line 11, Update the opening sentence in the cloud operations documentation so “day to day” is written as “day-to-day”; this is a simple copyedit in the operational guides text and should keep the rest of the sentence unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@cloud/operations/export-import.md`:
- Line 102: The documentation sentence uses the nonstandard phrase “one off” and
should be updated to the hyphenated form “one-off” for correct user-facing
grammar. Update the wording in the export-import docs so the description of the
scheduled export matches the standard phrasing, keeping the rest of the sentence
unchanged.
---
Duplicate comments:
In `@cloud/operations/index.md`:
- Line 11: Update the opening sentence in the cloud operations documentation so
“day to day” is written as “day-to-day”; this is a simple copyedit in the
operational guides text and should keep the rest of the sentence unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 42038c8e-701c-441c-8d80-5e47524e78b8
⛔ Files ignored due to path filters (8)
images/cloud/export-import/export-amazon-s3.pngis excluded by!**/*.pngimages/cloud/export-import/export-google-cloud-storage.pngis excluded by!**/*.pngimages/cloud/export-import/export-task-download.pngis excluded by!**/*.pngimages/cloud/export-import/export-temporary-link.pngis excluded by!**/*.pngimages/cloud/export-import/import-amazon-s3.pngis excluded by!**/*.pngimages/cloud/export-import/import-export-tab.pngis excluded by!**/*.pngimages/cloud/export-import/import-google-cloud-storage.pngis excluded by!**/*.pngimages/cloud/export-import/import-upload-file.pngis excluded by!**/*.png
📒 Files selected for processing (2)
cloud/operations/export-import.mdcloud/operations/index.md
| - You can keep up to **2 schedules** per instance. | ||
| - A schedule is disabled automatically after **3 consecutive failures**. | ||
|
|
||
| A scheduled export supports the same destinations as a one off export. A scheduled import clones from another instance. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Hyphenate "one-off" for correct grammar.
User-facing docs should use the standard hyphenated form: "one-off" rather than "one off."
📝 Suggested fix
-A scheduled export supports the same destinations as a one off export. A scheduled import clones from another instance.
+A scheduled export supports the same destinations as a one-off export. A scheduled import clones from another instance.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| A scheduled export supports the same destinations as a one off export. A scheduled import clones from another instance. | |
| A scheduled export supports the same destinations as a one-off export. A scheduled import clones from another instance. |
🧰 Tools
🪛 LanguageTool
[grammar] ~102-~102: Use a hyphen to join words.
Context: ... supports the same destinations as a one off export. A scheduled import clones fr...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@cloud/operations/export-import.md` at line 102, The documentation sentence
uses the nonstandard phrase “one off” and should be updated to the hyphenated
form “one-off” for correct user-facing grammar. Update the wording in the
export-import docs so the description of the scheduled export matches the
standard phrasing, keeping the rest of the sentence unchanged.
2 participants
Summary
Add a new Cloud Operations sub-section under Cloud DBaaS, with a Backup and Restore guide for the console Import/Export RDB feature.
Changes
cloud/operations/index.md: new Cloud Operations section index.cloud/operations/backup-restore.md: customer guide coveringimages/cloud/backup-restore/: 8 console screenshots.Testing
Docs-only change. Built from the falkordb-dbaas technical reference and console screenshots. Deprecated username/password fields are intentionally not documented; access is by subscription role. No credentials appear in text.
Memory / Performance Impact
N/A (docs-only).
Related Issues
N/A
Approver: @dudizimber
FYI: @MuhammadQadora
Summary by CodeRabbit