larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix line wrap and admonitions in maintenance docs (#3838)

Browse Source 
No content changes


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

- [x] ⛔ No

#### Type of change

- [x] 🐛 Bugfix
- [x] 🗺️ Documentation
This commit is contained in:
Niraj Tolia 2023-07-18 09:00:38 -07:00 committed by GitHub
parent 9f82d1ffe1
commit 75a449fe6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
website/docs/setup/maintenance.md
View File

@ -4,37 +4,41 @@ description: "Repository maintenance."
# Repository maintenance # Repository maintenance
Repository maintenance helps optimize the Corso repository as backups are created and possibly deleted by the user. Repository maintenance helps optimize the Corso repository as backups are created and possibly deleted by the user.
Maintenance can also free up space by removing data no longer referenced by any backups from the repository. Maintenance can also free up space by removing data no longer referenced by any backups from the repository.
It's safe to run maintenance concurrently with backup, restore, and backup deletion operations. However, it's not safe It's safe to run maintenance concurrently with backup, restore, and backup deletion operations. However, it's not safe
to run maintenance operations concurrently on the same repository. Corso uses file locks and the idea of a repository to run maintenance operations concurrently on the same repository. Corso uses file locks and the idea of a repository
owner to try to detect concurrent maintenance operations. owner to try to detect concurrent maintenance operations.
## Repository owner ## Repository owner
The repository owner is set to the user and hostname of the machine that runs maintenance on the repo the first time. The repository owner is set to the user and hostname of the machine that runs maintenance on the repo the first time.
If the user and hostname of the machine running maintenance can change, use either the `--force` flag or the `--user` If the user and hostname of the machine running maintenance can change, use either the `--force` flag or the `--user`
and `--host` flags. and `--host` flags.
The `--force` flag updates the repository owner and runs maintenance. The `--force` flag updates the repository owner and runs maintenance.
The `--user` and `--host` flags act as if the given user/hostname owns the repository for the maintenance operation The `--user` and `--host` flags act as if the given user/hostname owns the repository for the maintenance operation but
but doesn't update repo owner info. doesn't update repo owner info.
*If any of these flags are passed the user must make sure no concurrent maintenance operations run on the same :::danger
repository. Concurrent maintenance operations a repository may result in data loss.*
If any of these flags are passed the user must make sure no concurrent maintenance operations run on the same
repository. Concurrent maintenance operations a repository may result in data loss.
:::
## Maintenance types ## Maintenance types
Corso allows for two different types of maintenance: `metadata` and `complete`. Corso allows for two different types of maintenance: `metadata` and `complete`.
Metadata maintenance runs quickly and optimizes indexing data. Complete maintenance takes more time but compacts data Metadata maintenance runs quickly and optimizes indexing data. Complete maintenance takes more time but compacts data in
in backups and removes unreferenced data from the repository. backups and removes unreferenced data from the repository.
As Corso allows concurrent backups during maintenance, running complete maintenance immediately after deleting a As Corso allows concurrent backups during maintenance, running complete maintenance immediately after deleting a backup
backup may not result in a reduction of objects in the storage service Corso is backing up to. may not result in a reduction of objects in the storage service Corso is backing up to.
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.