toolshed/docs.coopcloud.tech
toolshed/docs.coopcloud.tech
3
1
Fork 21
Code Issues 4 Pull Requests 1 Packages Releases Activity

review

Browse Source
This commit is contained in:
p4u1 2024-04-14 12:29:47 +02:00 committed by decentral1se
parent ee82b512f9
commit 3b20550821
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Specification.md
View File

@ -6,9 +6,7 @@ Creating automated backups of docker swarm services is an often needed task. Thi
## Requirements
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this specification are to be interpreted as described in [RFC-2119].
When backing up a docker stack you MUST first check if the `backupbot.backup`. It MUST be set to true, for the backup to happen.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this specification are to be interpreted as described in [RFC-2119](https://datatracker.ietf.org/doc/html/rfc2119).
## Backup
@ -16,8 +14,8 @@ To enable backups for a docker stack, the `backupbot.backup=true` label MUST be
### Volumes and paths
By default all volumes MUST be backed up. A volume MAY be excluded from the backup when `backupbot.backup.volumes.{volume_name}=false` is set, where `{volume_name}` is the name of the volume.
By default all files MUST be backed up on a volume. `backupbot.backup.volumes.{volume_name}.path` MAY be set to limit the paths for that volume. The value MUST be a valid path relative to the volume root. It MAY contain multiple paths which get seperated by a comma.
By default all volumes MUST be backed up. A volume MUST be excluded from the backup when `backupbot.backup.volumes.{volume_name}=false` is set, where `{volume_name}` is the name of the volume.
By default all files MUST be backed up on a volume. `backupbot.backup.volumes.{volume_name}.path` MAY be set to limit the paths for that volume. The value MUST be a valid path relative to the volume root. It MAY contain multiple paths which get separated by a comma.
### Pre/Post Hooks
@ -44,7 +42,7 @@ There is no guaranteed order in which different hooks MUST be executed.
**Type:** boolean
**Default:** false
**Description:**
Enables backupbot for this compose stack. The labe should be added to the main service of the compose stack.
Enables backups for this compose stack. The label should be added to the main service of the compose stack.
**Example:**
@ -69,7 +67,7 @@ backupbot.backup.volumes.{volume_name}: false
**Type:** string
**Default:** ""
**Description:**
A comma seperated list of paths. When one or more paths are set, it only backups up those on the given volume instead of the whole volume.
A comma seperated list of paths. When one or more paths are set, it only backs up those on the given volume instead of the whole volume.
**Example:**
@ -95,7 +93,7 @@ backupbot.backup.pre-hook: 'mysqldump -u root -p"$(cat /run/secrets/db_root_pass
**Type:** string
**Default:** ""
**Description:**
A command, that gets executed after the files are backuped.
A command, that gets executed after the files are backed up.
**Example:**