Add recommendations on when to run maintenance (#4398)

#### Does this PR need a docs update or release note?

- [ ]  Yes, it's included
- [ ] 🕐 Yes, but in a later PR
- [x]  No

#### Type of change

- [ ] 🌻 Feature
- [ ] 🐛 Bugfix
- [x] 🗺️ Documentation
- [ ] 🤖 Supportability/Tests
- [ ] 💻 CI/Deployment
- [ ] 🧹 Tech Debt/Cleanup

#### Test Plan

- [x] 💪 Manual
- [ ]  Unit test
- [ ] 💚 E2E
This commit is contained in:
ashmrtn 2023-09-28 11:19:14 -07:00 committed by GitHub
parent 61de865660
commit 9767e08b39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -43,3 +43,15 @@ may not result in a reduction of objects in the storage service Corso is backing
Deletion of old objects in the storage service depends on both wall-clock time and running maintenance. Deletion of old objects in the storage service depends on both wall-clock time and running maintenance.
Later maintenance runs on the repository will remove the data. Later maintenance runs on the repository will remove the data.
## Maintenance guidelines
For the best experience, the recommendation is to run metadata maintenance every
20–30 backups. Complete maintenance should be run every 1–2 weeks
depending on how many backups are deleted from the repo. More backup deletions
means that complete maintenance should be run more often so that unneeded blobs
in storage get deleted.
Not running maintenance exactly according to the recommendations won't impact
the correctness of the data in the repo, but could result in decreased
performance.