Skip to content

feat(docs): actualize about backups#434

Draft
androndo wants to merge 1 commit intomainfrom
feat/backups-rework
Draft

feat(docs): actualize about backups#434
androndo wants to merge 1 commit intomainfrom
feat/backups-rework

Conversation

@androndo
Copy link
Contributor

Now we have separated docs for ops and users

@netlify
Copy link

netlify bot commented Feb 27, 2026

Deploy Preview for cozystack ready!

Name Link
🔨 Latest commit 1156bc4
🔍 Latest deploy log https://app.netlify.com/projects/cozystack/deploys/69a27ab69667860008b82ce4
😎 Deploy Preview https://deploy-preview-434--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
Contributor

coderabbitai bot commented Feb 27, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/backups-rework

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.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refactors the documentation related to backup and recovery within Cozystack. The primary goal is to improve clarity and relevance for different user personas by separating administrator-level Velero configuration details from tenant-level backup creation and management instructions. This ensures that both administrators and end-users can quickly find the information pertinent to their roles, streamlining the process of managing backups.

Highlights

  • Documentation Restructuring: The backup and recovery documentation has been split into two distinct guides, one for tenant users and another for cluster administrators, to provide more targeted information.
  • Tenant User Backup Workflows: The backup-and-recovery.md guide now focuses on how tenant users can create one-off backups using BackupJob and scheduled backups using BackupPlan Custom Resources.
  • Administrator Backup Configuration: A new guide, velero-backup-configuration.md, has been introduced to detail the setup of Velero storage, backup strategies, and BackupClasses for cluster administrators.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • content/en/docs/v1/kubernetes/backup-and-recovery.md
    • Updated the description to reflect the focus on BackupJobs and BackupPlans for tenant users.
    • Removed detailed sections on setting up S3 credentials, BackupStorageLocation, and VolumeSnapshotLocation.
    • Replaced manual Velero Backup and Schedule instructions with examples for BackupJob and BackupPlan CRDs.
    • Simplified the restore section, directing users to administrator-level documentation for complex restore scenarios.
    • Adjusted prerequisites to align with tenant user responsibilities.
  • content/en/docs/v1/operations/services/velero-backup-configuration.md
    • Added a new document dedicated to cluster administrators for configuring Velero backup infrastructure.
    • Included instructions for setting up S3 credentials, BackupStorageLocation, and VolumeSnapshotLocation.
    • Provided guidance on defining backup strategies and creating BackupClasses.
    • Explained how tenant users leverage these configurations.
Activity
  • No human activity (comments, reviews) was detected in this pull request.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
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 refactors the backup documentation by splitting it into a user-facing guide (backup-and-recovery.md) and an administrator guide (velero-backup-configuration.md). The changes are well-structured and make the documentation clearer for both audiences. I've added a couple of minor suggestions to improve the consistency of kubectl commands used in the examples.

--snapshot-move-data \
--wait
```bash
kubectl get backupclass -n cozy-velero -o yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For consistency with other commands in this document (e.g., on line 27), it's better to use the plural form backupclasses. While kubectl often accepts the singular form, using the plural is more idiomatic and consistent.

Suggested change
kubectl get backupclass -n cozy-velero -o yaml
kubectl get backupclasses -n cozy-velero -o yaml


```bash
kubectl get backupclasses
kubectl explain backupclass.spec --recursive
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

For consistency with the command on the previous line, it's better to use the plural form backupclasses. While kubectl explain accepts the singular form, using the plural is more consistent within this guide.

Suggested change
kubectl explain backupclass.spec --recursive
kubectl explain backupclasses.spec --recursive

@androndo androndo force-pushed the feat/backups-rework branch 3 times, most recently from c68c69e to 23cdb60 Compare February 28, 2026 05:06
…to ops or users

Signed-off-by: Andrey Kolkov <androndo@gmail.com>
@androndo androndo force-pushed the feat/backups-rework branch from 23cdb60 to 1156bc4 Compare February 28, 2026 05:18
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