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.

Sign up for GitHub

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

Add docs for deleting backups #4850

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f08d99
Add docs for deleting backups
Apr 20, 2022
dca7497
Remove DeletedBackupRequest information
Apr 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion site/content/docs/main/backup-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,16 @@ If there is possibility the schedule will be disable to not create backup anymor

## Kubernetes API Pagination

By default, Velero will paginate the LIST API call for each resource type in the Kubernetes API when collecting items into a backup. The `--client-page-size` flag for the Velero server configures the size of each page.
By default, Velero will paginate the LIST API call for each resource type in the Kubernetes API when collecting items into a backup. The `--client-page-size` flag for the Velero server configures the size of each page.

Depending on the cluster's scale, tuning the page size can improve backup performance. You can experiment with higher values, noting their impact on the relevant `apiserver_request_duration_seconds_*` metrics from the Kubernetes apiserver.

Pagination can be entirely disabled by setting `--client-page-size` to `0`. This will request all items in a single unpaginated LIST call.

## Deleting Backups

Use the following commands to delete Velero backups and data:

* `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