From 9767e08b39cf97765bd6b004059ca18ed1d8c6a9 Mon Sep 17 00:00:00 2001 From: ashmrtn <3891298+ashmrtn@users.noreply.github.com> Date: Thu, 28 Sep 2023 11:19:14 -0700 Subject: [PATCH] Add recommendations on when to run maintenance (#4398) #### Does this PR need a docs update or release note? - [ ] :white_check_mark: Yes, it's included - [ ] :clock1: Yes, but in a later PR - [x] :no_entry: No #### Type of change - [ ] :sunflower: Feature - [ ] :bug: Bugfix - [x] :world_map: Documentation - [ ] :robot: Supportability/Tests - [ ] :computer: CI/Deployment - [ ] :broom: Tech Debt/Cleanup #### Test Plan - [x] :muscle: Manual - [ ] :zap: Unit test - [ ] :green_heart: E2E --- website/docs/setup/maintenance.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/website/docs/setup/maintenance.md b/website/docs/setup/maintenance.md index a2ec6b1ed..51563d492 100644 --- a/website/docs/setup/maintenance.md +++ b/website/docs/setup/maintenance.md @@ -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. 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.