Skip to content

feat(docs): added guide about backup workloads from managed k8s#528

Open
androndo wants to merge 1 commit intomainfrom
backup-for-managed-k8s
Open

feat(docs): added guide about backup workloads from managed k8s#528
androndo wants to merge 1 commit intomainfrom
backup-for-managed-k8s

Conversation

@androndo
Copy link
Copy Markdown
Contributor

@androndo androndo commented May 5, 2026

Summary by CodeRabbit

  • Documentation
    • New comprehensive guide for enabling and configuring the Velero addon in tenant Kubernetes clusters: prerequisites, creating a SeaweedFS-backed bucket and extracting credentials, deploying tenant cluster configuration with Velero settings, verifying backup storage connectivity, performing namespace backup and restore with CSI snapshot support, and instructions for restoring into a different tenant cluster using the same bucket.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 5, 2026

Deploy Preview for cozystack ready!

Name Link
🔨 Latest commit 03d1960
🔍 Latest deploy log https://app.netlify.com/projects/cozystack/deploys/69fc65decef9d30008812047
😎 Deploy Preview https://deploy-preview-528--cozystack.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 5, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

Adds a new end-to-end documentation guide for the tenant-side Velero addon: SeaweedFS-backed Bucket creation and credential extraction, tenant Kubernetes addon configuration (nested valuesOverride), verification steps, backup (with CSI snapshots) and restore workflows, and cross-cluster restore notes.

Changes

Velero Addon Documentation

Layer / File(s) Summary
Documentation Structure & Overview
content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md (range_2954ca3047d1, range_aab5ffe0af63)
Page front matter and overview of the Velero addon installation, what it installs (cozy-velero namespace, plugins, CSI), and prerequisites.
Prerequisites
content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md (range_3e1b7c1e584a)
Lists required platform features and tools: SeaweedFS, Velero CLI, and admin access for management-cluster resources and kubeconfig retrieval.
Bucket creation & credentials
content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md (range_267df2feae52)
Creates a backups Bucket CR and shows how to extract bucket endpoint and keys from the generated Kubernetes secret (ensure https:// formatting).
Tenant addon deployment configuration
content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md (range_d22bf184ba35)
Tenant Kubernetes manifest example and warning that override values must be nested under addons.velero.valuesOverride.velero; kubeconfig and target-cluster setup steps included.
Verification
content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md (range_9de55aa31472)
Velero verification commands and expected BackupStorageLocation status semantics (STATUS: Available).
Backup workflow
content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md (range_d653c2e9facd)
Demo namespace creation and velero backup create --snapshot-move-data flow, waiting for backup Phase: Completed.
Restore workflow
content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md (range_8112bff357e9)
Delete namespace and run velero restore create, then verify resources are recreated.
Cross-cluster pattern & links
content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md (range_af5236ebaa8f)
Notes about re-pointing another tenant cluster at the same bucket for restores and related documentation links.
Next-site copy
content/en/docs/next/kubernetes/backups-with-velero-addon.md (range_ed55bcc8f9f9)
A duplicate/next-version placement of the full guide in the next documentation tree.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A velero guide, hopped into place,
With snapshots and buckets at quickening pace,
From backup to restore, a fuzzy-eared cheer,
Across clusters we hop, your data near! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding documentation about backing up workloads from managed Kubernetes using the Velero addon.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch backup-for-managed-k8s

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@androndo androndo force-pushed the backup-for-managed-k8s branch from fc9f89c to f5fbb6b Compare May 5, 2026 07:33
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new documentation guide for using the Velero addon to perform backups and migrations between tenant Kubernetes clusters using SeaweedFS buckets. The review feedback identifies a missing configuration parameter (deployNodeAgent: true) necessary for data movement, corrects grammatical errors and a missing Hugo shortcode closing tag, and suggests removing redundant instructions in the deployment section.

Comment thread content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md Outdated
Comment thread content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md Outdated
Comment thread content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md Outdated
@androndo androndo force-pushed the backup-for-managed-k8s branch 3 times, most recently from 7b4d680 to 8a40268 Compare May 5, 2026 13:49
@androndo androndo marked this pull request as ready for review May 5, 2026 13:50
@androndo androndo requested review from kvaps and lllamnyp as code owners May 5, 2026 13:50
@androndo androndo force-pushed the backup-for-managed-k8s branch from 8a40268 to ed95568 Compare May 7, 2026 07:34
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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 `@content/en/docs/next/kubernetes/backups-with-velero-addon.md`:
- Around line 158-161: The doc shows using the backup name when describing a
restore which fails because Velero generates a timestamped restore name if none
is provided; update the instructions to either create the restore with an
explicit name using velero restore create --from-backup demo-1 --name
<restore-name> (e.g., --name demo-1-restore) and then run velero restore
describe <restore-name> --details, or instruct readers to capture the generated
restore name from the velero restore create output and pass that exact name to
velero restore describe; reference the commands velero restore create and velero
restore describe in the wording so readers know which flag (--name) or output to
use.
🪄 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: a9a9bdb7-f5a1-42f1-a269-01046b212e79

📥 Commits

Reviewing files that changed from the base of the PR and between 8a40268 and ed95568.

📒 Files selected for processing (2)
  • content/en/docs/next/kubernetes/backups-with-velero-addon.md
  • content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md

Comment thread content/en/docs/next/kubernetes/backups-with-velero-addon.md Outdated
Signed-off-by: Andrey Kolkov <androndo@gmail.com>
@androndo androndo force-pushed the backup-for-managed-k8s branch from 7758c42 to 03d1960 Compare May 7, 2026 10:13
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

♻️ Duplicate comments (1)
content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md (1)

158-160: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Use an explicit restore name so describe works

Line 158 creates a restore without a stable name, but Line 160 describes demo-1 (backup name). That command will fail in typical Velero flows because the restore name is generated unless explicitly provided.

Suggested fix
-velero -n cozy-velero restore create \
-  --from-backup demo-1
-velero -n cozy-velero restore describe demo-1 --details
+velero -n cozy-velero restore create demo-1-restore \
+  --from-backup demo-1
+velero -n cozy-velero restore describe demo-1-restore --details
🤖 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 `@content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md` around lines
158 - 160, The restore is being created without an explicit name (velero -n
cozy-velero restore create), but the subsequent describe targets a named restore
(velero -n cozy-velero restore describe demo-1); update the create command to
include a stable restore name via --name (for example use the same name you plan
to describe) so that the describe command succeeds—modify the restore creation
invocation (velero restore create) to pass --name <restore-name> matching the
describe call.
🤖 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.

Duplicate comments:
In `@content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md`:
- Around line 158-160: The restore is being created without an explicit name
(velero -n cozy-velero restore create), but the subsequent describe targets a
named restore (velero -n cozy-velero restore describe demo-1); update the create
command to include a stable restore name via --name (for example use the same
name you plan to describe) so that the describe command succeeds—modify the
restore creation invocation (velero restore create) to pass --name
<restore-name> matching the describe call.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ffb73e6d-d4a9-4f4d-90e7-e5265782e8e1

📥 Commits

Reviewing files that changed from the base of the PR and between ed95568 and 03d1960.

📒 Files selected for processing (2)
  • content/en/docs/next/kubernetes/backups-with-velero-addon.md
  • content/en/docs/v1.3/kubernetes/backups-with-velero-addon.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant