Skip to content
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

Merged
merged 2 commits into from
Apr 26, 2022
Merged

Conversation

a-mccarthy
Copy link
Contributor

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:

  • Accepted the DCO. Commits without the DCO will delay acceptance.
  • Created a changelog file or added /kind changelog-not-required as a comment on this pull request.
  • Updated the corresponding documentation in site/content/docs/main.

Signed-off-by: Abigail McCarthy <[email protected]>
@a-mccarthy a-mccarthy added the kind/changelog-not-required PR does not require a user changelog. Often for docs, website, or build changes label Apr 20, 2022
@a-mccarthy
Copy link
Contributor Author

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-commenter
Copy link

codecov-commenter commented Apr 20, 2022

Codecov Report

Merging #4850 (dca7497) into main (65db258) will decrease coverage by 0.04%.
The diff coverage is n/a.

@@            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     
Impacted Files Coverage Δ
pkg/controller/backup_sync_controller.go 61.53% <0.00%> (-3.33%) ⬇️
pkg/persistence/object_store.go 57.77% <0.00%> (-2.73%) ⬇️
pkg/controller/backup_controller.go 57.37% <0.00%> (-1.78%) ⬇️
pkg/restic/exec_commands.go 15.38% <0.00%> (-0.81%) ⬇️
pkg/controller/pod_volume_restore_controller.go 23.34% <0.00%> (-0.53%) ⬇️
pkg/cmd/server/server.go 6.75% <0.00%> (-0.04%) ⬇️
pkg/restic/command_factory.go 93.50% <0.00%> (+0.08%) ⬆️
pkg/controller/pod_volume_backup_controller.go 44.91% <0.00%> (+0.16%) ⬆️
pkg/persistence/object_store_layout.go 91.83% <0.00%> (+0.34%) ⬆️
pkg/restore/restore.go 66.69% <0.00%> (+0.69%) ⬆️
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 65db258...dca7497. Read the comment docs.

@reasonerjt reasonerjt requested a review from ywk253100 April 25, 2022 07:19

* `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`.
Copy link
Contributor

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

Copy link
Contributor Author

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

@a-mccarthy a-mccarthy requested a review from ywk253100 April 25, 2022 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation kind/changelog-not-required PR does not require a user changelog. Often for docs, website, or build changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Removing backups with kubectl does not trigger velero-server backup removal
4 participants