Skip to content

Update Velero documentation #319

@orcsin

Description

@orcsin

Is your enhancement request related to a specific problem in the documentation? Please describe.
The existing Velero documentation in KubeRocketCI is outdated.
It describes legacy installation and configuration steps that no longer match the recommended approach. The current documentation does not cover module-based installation, add-on integration, or updated best practices for IRSA and AWS configuration.

Describe the enhancement you'd like
I would like to update the Velero documentation to reflect the modern installation method using modules and add-ons.
The enhancement should include:

Updated installation steps using the new module/add-on approach

Revised IAM/IRSA configuration

Updated examples for backup/restore configuration

Removal or correction of outdated content

Clear guidance on how Velero integrates with KubeRocketCI in its current architecture

The updated content should fully replace the old Velero documentation.

Why is this enhancement beneficial to the KubeRocketCI documentation?
Users following the existing documentation may apply deprecated installation methods or run into errors caused by outdated configuration approaches.
Refreshing the Velero documentation will:

Reduce onboarding friction

Prevent misconfiguration issues

Provide a consistent, modern workflow across all KubeRocketCI modules

Improve reliability of cluster backup and disaster recovery processes

Describe alternatives you've considered
Keeping the existing documentation with a small correction was considered, but this would still leave major gaps due to the architectural change toward modules and add-ons.
External Velero guides also exist, but they do not cover the KubeRocketCI-specific module structure or integration patterns.

Propose a Draft (if possible)
Proposed structure of updated documentation:

Overview of Velero in KubeRocketCI

Installing Velero using modules and add-ons

Configuring IAM/IRSA (updated approach)

BackupStorageLocation and VolumeSnapshotLocation configuration

Scheduling backups

Restoring resources and PVs

Migration notes: differences from the old documentation

Troubleshooting and known limitations

Additional Context
The current Velero page(s) in the documentation reference deprecated installation steps.
Official Velero documentation:

https://velero.io/docs

https://github.com/vmware-tanzu/velero

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions