Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

Commit

Permalink
docs: #164 add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
blackandred committed Feb 20, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent a6d4fc0 commit 44d430c
Showing 1 changed file with 24 additions and 3 deletions.
27 changes: 24 additions & 3 deletions server-go/README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 44d430c

Please sign in to comment.