From c1ca9a0245b13fc188f850b99b049a1d32eed26f Mon Sep 17 00:00:00 2001 From: allenxu404 Date: Wed, 21 Jun 2023 19:09:10 +0800 Subject: [PATCH] clarify the deletion frequency for gc controller Signed-off-by: allenxu404 --- changelogs/unreleased/6414-allenxu404 | 1 + site/content/docs/main/how-velero-works.md | 3 +++ site/content/docs/v1.10/how-velero-works.md | 3 +++ site/content/docs/v1.11/how-velero-works.md | 3 +++ 4 files changed, 10 insertions(+) create mode 100644 changelogs/unreleased/6414-allenxu404 diff --git a/changelogs/unreleased/6414-allenxu404 b/changelogs/unreleased/6414-allenxu404 new file mode 100644 index 000000000..c8b1b8003 --- /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 19fc89a94..0f2fa10b9 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 19fc89a94..0f2fa10b9 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 19fc89a94..0f2fa10b9 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.