diff --git a/changelogs/unreleased/8747-Lyndon-Li b/changelogs/unreleased/8747-Lyndon-Li new file mode 100644 index 000000000..d1e20aab1 --- /dev/null +++ b/changelogs/unreleased/8747-Lyndon-Li @@ -0,0 +1 @@ +Add doc for maintenance history \ No newline at end of file diff --git a/site/content/docs/main/repository-maintenance.md b/site/content/docs/main/repository-maintenance.md index 7a0bb53c6..3223cffba 100644 --- a/site/content/docs/main/repository-maintenance.md +++ b/site/content/docs/main/repository-maintenance.md @@ -131,10 +131,32 @@ 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 -See [backup repository configuration][3] +See [backup repository configuration][3] + +### Maintenance History +You can view the maintenance history by describing the corresponding backupRepository CR: + +``` +Status: + Last Maintenance Time: + Recent Maintenance: + Complete Timestamp: + Result: Succeeded + Start Timestamp: + Complete Timestamp: + Result: Succeeded + Start Timestamp: + Message: + Result: Failed + Start Timestamp: +``` + +- `Last Maintenance Time` indicates the time of the latest successful maintenance job +- `Recent Maintenance` keeps the status of the recent 3 maintenance jobs, including its start time, result (succeeded/failed), completion time (if the maintenance job succeeded), or error message (if the maintenance failed) ### Others -Maintenance jobs will inherit the labels, annotations, toleration, nodeSelector, service account, image, environment variables, cloud-credentials etc. from Velero deployment. +Maintenance jobs will inherit the labels, annotations, toleration, nodeSelector, service account, image, environment variables, cloud-credentials etc. from Velero deployment. +Maintenance jobs will not run for backup repositories whose backup storage location is set as readOnly. [1]: velero-install.md#usage [2]: node-agent-concurrency.md