From 44d430c8be63cb7abde56870386e9ec65da85fd7 Mon Sep 17 00:00:00 2001 From: blackandred Date: Sun, 20 Feb 2022 21:58:29 +0100 Subject: [PATCH] docs: #164 add docs --- server-go/README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/server-go/README.md b/server-go/README.md index fce5d540..e2db7630 100644 --- a/server-go/README.md +++ b/server-go/README.md @@ -122,8 +122,11 @@ func (c Collection) CanUploadToMe(user *users.User) bool { Quota ----- -System is fully multi-tenant. `System administrator` can create a collection with specified storage limits on single file, whole collection, select a rotation strategy. -Concept is simple - there ca be stored X versions of Y size in given collection. Additionally, there is such thing as `extra space` which allows to upload a file that exceeds the limit to not break +`System administrator` can create a collection with specified storage limits on single file, whole collection, select a rotation strategy. + +Concept is simple - there can be stored X versions of Y size in given collection. + +Additionally, there is such thing as `extra space` which allows to upload a file that exceeds the limit to not break the backup pipeline. Such situation is immediately reported in a collection health check as a warning. ```yaml @@ -138,7 +141,7 @@ spec: maxCollectionSize: 5M ``` -#### Extra space +### Extra space The following example allows uploading files of 1 MB size normally, but optionally allows uploading larger files that could in summary take additional 5MB. For example one of uploaded versions can be a 5MB file, or there could be two versions of 2,5MB file each - both exceeding the soft limit of `maxOneVersionSize`. The `maxCollectionSize` is a hard limit. @@ -163,3 +166,21 @@ spec: maxOneVersionSize: 1M maxCollectionSize: 10M ``` + +### Rotation + +Rotation Strategies gives control over backup versioning. + +#### `fifo` + +First in first out. When adding a new version deletes oldest. + +``` +--- +apiVersion: backups.riotkit.org/v1alpha1 +kind: BackupCollection +# ... +spec: +# ... + strategyName: fifo +```