-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs for deleting backups #4850
Conversation
Signed-off-by: Abigail McCarthy <[email protected]>
For this PR i'd like to make sure that each example is correct. And hopefully provide a better example for using DeleteBackupRequest. I have an issue to cover documenting DeleteBackupRequest, #4813, which are not mentioned in the docs at the moment. |
Codecov Report
@@ Coverage Diff @@
## main #4850 +/- ##
==========================================
- Coverage 41.41% 41.37% -0.05%
==========================================
Files 204 204
Lines 17948 18061 +113
==========================================
+ Hits 7434 7473 +39
- Misses 9970 10041 +71
- Partials 544 547 +3
Continue to review full report at Codecov.
|
|
||
* `kubectl delete backup <backupName> -n <veleroNamespace>` will delete the backup custom resource only and will not delete any associated data from object/block storage | ||
* `velero backup delete <backupName>` will delete the backup resource including all data in object/block storage | ||
* Creating a `DeleteBackupRequest` will delete the backup resource including all data in object/block storage. You can use kubectl to create a `DeleteBackupRequest`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There isn't any doc for DeleteBackupRequest
CR spec on Velero's official doc site, users don't know how to send the request without checking the code.
Suggest adding the DeleteBackupRequest
spec in our doc or just remove the line 92 as this is kind of internal implementation detial
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ywk253100 thanks for the background information about DeleteBackupRequest. I've removed it from this PR, please review again if you have a chance
Signed-off-by: Abigail McCarthy <[email protected]>
Signed-off-by: Abigail McCarthy [email protected]
Thank you for contributing to Velero!
Please add a summary of your change
This PR updates the backup reference page to include more information around deleting backups
Does your change fix a particular issue?
Fixes #1712
Please indicate you've done the following:
/kind changelog-not-required
as a comment on this pull request.site/content/docs/main
.