Enhance File System Backup documentation with details on volume snapshot behavior and backup method decision flow #9091
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kaovilai
added
the
kind/changelog-not-required
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9091 +/- ##
=======================================
Coverage 60.07% 60.07%
=======================================
Files 378 378
Lines 42905 42905
=======================================
Hits 25776 25776
Misses 15583 15583
Partials 1546 1546 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
blackpiglet
previously approved these changes
Jul 17, 2025
sseago
requested changes
Jul 17, 2025
Collaborator
sseago
left a comment
sseago
left a comment
There was a problem hiding this comment.
Some clarifications needed, as noted in comments, around VSL vs. CSI. As-written, some of the new text implies that VSL is required for any snapshotting, but it's only required for non-CSI snapshots.
| - Hostpath volumes | ||
| - **Volumes explicitly excluded using annotations** (see below) | ||
|
|
||
| **Important:** When you exclude a volume from FSB using annotations, Velero will attempt to back it up using volume snapshots instead (if properly configured with VolumeSnapshotLocation). |
Collaborator
There was a problem hiding this comment.
"(if CSI snapshots are enabled and the volume is a CSI volume or if properly configured with a compatible VolumeSnapshotLocation)"
| **Note:** Volumes not annotated for FSB will be considered for volume snapshots if: | ||
| - `--snapshot-volumes` is not set to `false` | ||
| - A VolumeSnapshotLocation is configured | ||
| - The volume type supports snapshots |
Collaborator
There was a problem hiding this comment.
- the volume supports snapshots (either CSI or native)
- either the volume is a CSI volume and CSI snapshots are enabled or there is a compatible VolumeSnapshotLocation configured
| - No → Attempt volume snapshot (if configured) | ||
|
|
||
| 3. **For volume snapshots to succeed:** | ||
| - VolumeSnapshotLocation must be configured |
Collaborator
There was a problem hiding this comment.
CSI snapshots must be enabled for CSI volume or compatible VolumeSnapshotLocation must be configured.
sseago
approved these changes
Jul 17, 2025
…hot behavior and backup method decision flow Fixes: Velero AWS snapshots not occurring with the AWS plugin vmware-tanzu#9090 Signed-off-by: Tiger Kaovilai <[email protected]>
…enhance decision flow for volume snapshots Signed-off-by: Tiger Kaovilai <[email protected]>
blackpiglet
force-pushed
the
fsb-snapshot-clariffy
branch
from
233c0a2 to
b12f66c
Compare
Lyndon-Li
approved these changes
Jul 25, 2025
3 tasks
MaloLelandais
pushed a commit
to MaloLelandais/velero
that referenced
this pull request
Jul 28, 2025
…hot behavior and backup method decision flow (vmware-tanzu#9091) * Enhance File System Backup documentation with details on volume snapshot behavior and backup method decision flow Fixes: Velero AWS snapshots not occurring with the AWS plugin vmware-tanzu#9090 Signed-off-by: Tiger Kaovilai <[email protected]> * Clarify conditions for excluding volumes from File System Backup and enhance decision flow for volume snapshots Signed-off-by: Tiger Kaovilai <[email protected]> --------- Signed-off-by: Tiger Kaovilai <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: Velero AWS snapshots not occurring with the AWS plugin #9090
Signed-off-by: Tiger Kaovilai [email protected]
Thank you for contributing to Velero!
Please add a summary of your change
Does your change fix a particular issue?
Fixes #9090
Please indicate you've done the following:
make new-changelog) or comment/kind changelog-not-requiredon this PR.site/content/docs/main.