diff --git a/changelogs/unreleased/6414-allenxu404 b/changelogs/unreleased/6414-allenxu404 new file mode 100644 index 0000000000..c8b1b80035 --- /dev/null +++ b/changelogs/unreleased/6414-allenxu404 @@ -0,0 +1 @@ +Clarify the deletion frequency for gc controller \ No newline at end of file diff --git a/site/content/docs/main/how-velero-works.md b/site/content/docs/main/how-velero-works.md index 19fc89a94f..0f2fa10b91 100644 --- a/site/content/docs/main/how-velero-works.md +++ b/site/content/docs/main/how-velero-works.md @@ -88,6 +88,9 @@ When you create a backup, you can specify a TTL (time to live) by adding the fla The TTL flag allows the user to specify the backup retention period with the value specified in hours, minutes and seconds in the form `--ttl 24h0m0s`. If not specified, a default TTL value of 30 days will be applied. +The effects of expiration are not applied immediately, they are applied when the gc-controller runs its reconciliation loop every hour by default. If needed, you can adjust the frequency of the reconciliation loop using the `--garbage-collection-frequency +` flag. + If backup fails to delete, a label `velero.io/gc-failure=` will be added to the backup custom resource. You can use this label to filter and select backups that failed to delete. diff --git a/site/content/docs/v1.10/how-velero-works.md b/site/content/docs/v1.10/how-velero-works.md index 19fc89a94f..0f2fa10b91 100644 --- a/site/content/docs/v1.10/how-velero-works.md +++ b/site/content/docs/v1.10/how-velero-works.md @@ -88,6 +88,9 @@ When you create a backup, you can specify a TTL (time to live) by adding the fla The TTL flag allows the user to specify the backup retention period with the value specified in hours, minutes and seconds in the form `--ttl 24h0m0s`. If not specified, a default TTL value of 30 days will be applied. +The effects of expiration are not applied immediately, they are applied when the gc-controller runs its reconciliation loop every hour by default. If needed, you can adjust the frequency of the reconciliation loop using the `--garbage-collection-frequency +` flag. + If backup fails to delete, a label `velero.io/gc-failure=` will be added to the backup custom resource. You can use this label to filter and select backups that failed to delete. diff --git a/site/content/docs/v1.11/how-velero-works.md b/site/content/docs/v1.11/how-velero-works.md index 19fc89a94f..0f2fa10b91 100644 --- a/site/content/docs/v1.11/how-velero-works.md +++ b/site/content/docs/v1.11/how-velero-works.md @@ -88,6 +88,9 @@ When you create a backup, you can specify a TTL (time to live) by adding the fla The TTL flag allows the user to specify the backup retention period with the value specified in hours, minutes and seconds in the form `--ttl 24h0m0s`. If not specified, a default TTL value of 30 days will be applied. +The effects of expiration are not applied immediately, they are applied when the gc-controller runs its reconciliation loop every hour by default. If needed, you can adjust the frequency of the reconciliation loop using the `--garbage-collection-frequency +` flag. + If backup fails to delete, a label `velero.io/gc-failure=` will be added to the backup custom resource. You can use this label to filter and select backups that failed to delete.