propellor-4.4.0: property-based host configuration management in haskell

MaintainerFélix Sipma <felix+propellor@gueux.org>
Safe HaskellNone
LanguageHaskell98

Propellor.Property.Borg

Description

Support for the Borg backup tool https://github.com/borgbackup

Synopsis

Documentation

repoExists :: BorgRepo -> IO Bool Source #

init :: BorgRepo -> Property DebianLike Source #

Inits a new borg repository

restored :: FilePath -> BorgRepo -> Property DebianLike Source #

Restores a directory from an borg backup.

Only does anything if the directory does not exist, or exists, but is completely empty.

The restore is performed atomically; restoring to a temp directory and then moving it to the directory.

backup :: FilePath -> BorgRepo -> Times -> [BorgParam] -> [KeepPolicy] -> Property DebianLike Source #

Installs a cron job that causes a given directory to be backed up, by running borg with some parameters.

If the directory does not exist, or exists but is completely empty, this Property will immediately restore it from an existing backup.

So, this property can be used to deploy a directory of content to a host, while also ensuring any changes made to it get backed up. For example:

	& Borg.backup "/srv/git" "root@myserver:/mnt/backup/git.borg" Cron.Daily
		["--exclude=/srv/git/tobeignored"]
		[Borg.KeepDays 7, Borg.KeepWeeks 4, Borg.KeepMonths 6, Borg.KeepYears 1]

Note that this property does not make borg encrypt the backup repository.

Since borg uses a fair amount of system resources, only one borg backup job will be run at a time. Other jobs will wait their turns to run.

data KeepPolicy Source #

Policy for backup generations to keep. For example, KeepDays 30 will keep the latest backup for each day when a backup was made, and keep the last 30 such backups. When multiple KeepPolicies are combined together, backups meeting any policy are kept. See borg's man page for details.