This backup solution has been created to backup data to S3 buckets using restic. As a wrapper it takes care of scheduling backups and collecting backup and S3 metrics in order to make backup status more visible.
Features:
- Backups are encrypted (restic)
- Backups are stored in S3 buckets (restic)
- Backups are incremental (restic)
- Data is deduplicated (restic)
- Backups are versioned (restic)
- Data retention can be defined (restic)
- Backups are performed regularly (mcs-backup)
- Backup metrics are provided (mcs-backup)
- Stale locks can be automatically removed (mcs-backup)
- Hooks (pre, post, pipe-in/out) (mcs-backup)
As MCS-Backup is scheduling backups and provides prometheus metrics, it should be started as a service. In a kubernetes context it can run as sidecar container or stand-alone deployment, depending on the usage scenario.
In order to backup plain files, mcs-backup needs to be able to access the file
system to be backed up. In a Kubernetes context, it is therefore best used as a
sidecar container to the main application, as this provides easy access to all
volumes mounted in the application container (example).
For example, if a mariadb is to be backed up, mcs-backup calls a hook
script which then calls mysqldump. The dump can either be written to the file
system (pre-backup-hook) and then be backed up as a regular file, or directly to
stdout (pipe-in-hook), in that case piping the data directly into restic (-->
see hooks). Since in this case no direct access to the database volume
is necessary, mcs-backup should be deployed separately from the database, i.e.
in the Kubernetes context it should run as an independant deployment.
Since restoring data is the most important part of backup, and usually has to be
done at the most inconvenient times, possibly under time pressure, this process
should be as easy to perform as possible. With a properly configured mcs-backup
a simple mcs-backup restore latest command is sufficient.
Backups are scheduled with cron-like expressions (e.g. 0 */2 * * *)
In case you want to disable automatically scheduled backups for a maintenance
window, you can do this manually. For example, mcs-backup backup --maintenance 1h disables the backup for 1 hour. After the specified time, backup is
automatically reactivated.
Detailed configuration documentation and integration examples are available in the docs directory.
v1.5.0Initial public releasev1.5.1Cleanup Paths in Dockerfilev1.5.2Make https the defaultv1.5.3Fix 'restore' for split repo-url (base/path)v1.5.4Fix uncaught error when pipe cmd fails in restorev1.6.0Allow to configure prune interval, update depsv1.6.1routine update of depsv1.6.2routine update of depsv1.6.3routine update of depsv1.6.4routine update of depsv1.6.5routine update of Dockerfilev1.7.0correct cron execution even when host was suspended between runsv1.7.1skip backup when next run is in the pastv1.7.2update restic in Docker imagev1.7.3update base Docker imagev1.7.4update base Docker imagev1.7.5update base Docker image