From beb392e0db6dbdfc406e42ee59225a2f0169ed1d Mon Sep 17 00:00:00 2001 From: Tiger Kaovilai Date: Tue, 18 Feb 2025 15:49:46 -0600 Subject: [PATCH] doc updates Signed-off-by: Tiger Kaovilai --- .../main/backup-repository-configuration.md | 29 ++++++++++++++++++- .../docs/main/repository-maintenance.md | 28 ++---------------- 2 files changed, 31 insertions(+), 26 deletions(-) diff --git a/site/content/docs/main/backup-repository-configuration.md b/site/content/docs/main/backup-repository-configuration.md index 46301c54e..7eb0e5891 100644 --- a/site/content/docs/main/backup-repository-configuration.md +++ b/site/content/docs/main/backup-repository-configuration.md @@ -49,6 +49,33 @@ Below is the supported configurations by Velero and the specific backup reposito ***Kopia repository:*** `cacheLimitMB`: specifies the size limit(in MB) for the local data cache. The more data is cached locally, the less data may be downloaded from the backup storage, so the better performance may be achieved. Practically, you can specify any size that is smaller than the free space so that the disk space won't run out. This parameter is for repository connection, that is, you could change it before connecting to the repository. E.g., before a backup/restore/maintenance. +### Full Maintenance Interval customization +The full maintenance interval defaults to kopia defaults of 24 hours. Velero provide three override options under `fullMaintenanceInterval` configuration using `backup-repository-configmap` ConfigMap provided to velero install commands allowing for faster removal of deleted velero backups from kopia repo. +- normalGC: 24 hours +- fastGC: 12 hours +- eagerGC: 6 hours + +Example of the `backup-repository-configmap` ConfigMap for the above scenario is as below: +```yaml +apiVersion: v1 +kind: ConfigMap +metadata: + name: + namespace: velero +data: + : | + { + "fullMaintenanceInterval": fastGC + } + : | + { + "fullMaintenanceInterval": normalGC + } +``` + +Per kopia [Maintenance Safety](https://kopia.io/docs/advanced/maintenance/#maintenance-safety), it is expected that velero backup deletion will not result in immediate kopia repository data removal. Reducing full maintenance interval using above options should help reduce time taken to remove blobs not in use. + +On the other hand, the not-in-use data will be deleted permanently after the full maintenance, so shorter full maintenance intervals may weaken the data safety if they are used incorrectly. [1]: file-system-backup.md -[2]: csi-snapshot-data-movement.md \ No newline at end of file +[2]: csi-snapshot-data-movement.md diff --git a/site/content/docs/main/repository-maintenance.md b/site/content/docs/main/repository-maintenance.md index 21cff8d00..7a0bb53c6 100644 --- a/site/content/docs/main/repository-maintenance.md +++ b/site/content/docs/main/repository-maintenance.md @@ -51,7 +51,7 @@ For example, the following BackupRepository's key should be `test-default-kopia` You can still customize the maintenance job resource requests and limit when using the [velero install][1] CLI command. -The `LoadAffinity` structure is reused from design [node-agent affinity configuration](2). +The `LoadAffinity` structure is reused from design [node-agent affinity configuration][2]. ### Affinity Example It's possible that the users want to choose nodes that match condition A or condition B to run the job. @@ -131,33 +131,11 @@ velero install --default-repo-maintain-frequency For Kopia the default maintenance frequency is 1 hour, and Restic is 7 * 24 hours. ### Full Maintenance Interval customization -The full maintenance interval defaults to kopia defaults of 24 hours. Velero provide three override options under `fullMaintenanceInterval` configuration using `backup-repository-configmap` ConfigMap provided to velero install commands allowing for faster removal of deleted velero backups from kopia repo. -- normalGC: 24 hours -- fastGC: 12 hours -- eagerGC: 6 hours - -Example of the `backup-repository-configmap` ConfigMap for the above scenario is as below: -```yaml -apiVersion: v1 -kind: ConfigMap -metadata: - name: - namespace: velero -data: - : | - { - "fullMaintenanceInterval": fastGC - } - : | - { - "fullMaintenanceInterval": normalGC - } -``` - -Per kopia [Maintenance Safety](https://kopia.io/docs/advanced/maintenance/#maintenance-safety), it is expected that velero backup deletion will not result in immediate kopia repository data removal. Reducing full maintenance interval using above options should help reduce time taken to remove blobs not in use. +See [backup repository configuration][3] ### Others Maintenance jobs will inherit the labels, annotations, toleration, nodeSelector, service account, image, environment variables, cloud-credentials etc. from Velero deployment. [1]: velero-install.md#usage [2]: node-agent-concurrency.md +[3]: backup-repository-configuration.md#full-maintenance-interval-customization