Skip to content

Commit

Permalink
clarify the deletion frequency for gc controller
Browse files Browse the repository at this point in the history
Signed-off-by: allenxu404 <[email protected]>
  • Loading branch information
allenxu404 committed Jun 21, 2023
1 parent ef443fe commit c1ca9a0
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelogs/unreleased/6414-allenxu404
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify the deletion frequency for gc controller
3 changes: 3 additions & 0 deletions site/content/docs/main/how-velero-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<DURATION>` flag.

If backup fails to delete, a label `velero.io/gc-failure=<Reason>` will be added to the backup custom resource.

You can use this label to filter and select backups that failed to delete.
Expand Down
3 changes: 3 additions & 0 deletions site/content/docs/v1.10/how-velero-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<DURATION>` flag.

If backup fails to delete, a label `velero.io/gc-failure=<Reason>` will be added to the backup custom resource.

You can use this label to filter and select backups that failed to delete.
Expand Down
3 changes: 3 additions & 0 deletions site/content/docs/v1.11/how-velero-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<DURATION>` flag.

If backup fails to delete, a label `velero.io/gc-failure=<Reason>` will be added to the backup custom resource.

You can use this label to filter and select backups that failed to delete.
Expand Down

0 comments on commit c1ca9a0

Please sign in to comment.