mirror of
https://github.com/NixOS/nixpkgs.git
synced 2025-07-08 19:45:42 +03:00
nixos/restic: nixfmt
This commit is contained in:
Tert0
parent
5224d91ed1
commit
54dba7bed8
1 changed files with 403 additions and 358 deletions
|
|
@ -1,4 +1,10 @@
|
||||||
{ config, lib, pkgs, utils, ... }:
|
{
|
||||||
|
config,
|
||||||
|
lib,
|
||||||
|
pkgs,
|
||||||
|
utils,
|
||||||
|
...
|
||||||
|
}:
|
||||||
let
|
let
|
||||||
# Type for a valid systemd unit option. Needed for correctly passing "timerConfig" to "systemd.timers"
|
# Type for a valid systemd unit option. Needed for correctly passing "timerConfig" to "systemd.timers"
|
||||||
inherit (utils.systemdUtils.unitOptions) unitOption;
|
inherit (utils.systemdUtils.unitOptions) unitOption;
|
||||||
|
|
@ -8,269 +14,288 @@ in
|
||||||
description = ''
|
description = ''
|
||||||
Periodic backups to create with Restic.
|
Periodic backups to create with Restic.
|
||||||
'';
|
'';
|
||||||
type = lib.types.attrsOf (lib.types.submodule ({ name, ... }: {
|
type = lib.types.attrsOf (
|
||||||
options = {
|
lib.types.submodule (
|
||||||
passwordFile = lib.mkOption {
|
{ name, ... }:
|
||||||
type = lib.types.str;
|
{
|
||||||
description = ''
|
options = {
|
||||||
Read the repository password from a file.
|
passwordFile = lib.mkOption {
|
||||||
'';
|
type = lib.types.str;
|
||||||
example = "/etc/nixos/restic-password";
|
description = ''
|
||||||
};
|
Read the repository password from a file.
|
||||||
|
'';
|
||||||
|
example = "/etc/nixos/restic-password";
|
||||||
|
};
|
||||||
|
|
||||||
environmentFile = lib.mkOption {
|
environmentFile = lib.mkOption {
|
||||||
type = with lib.types; nullOr str;
|
type = with lib.types; nullOr str;
|
||||||
default = null;
|
default = null;
|
||||||
description = ''
|
description = ''
|
||||||
file containing the credentials to access the repository, in the
|
file containing the credentials to access the repository, in the
|
||||||
format of an EnvironmentFile as described by {manpage}`systemd.exec(5)`
|
format of an EnvironmentFile as described by {manpage}`systemd.exec(5)`
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
||||||
rcloneOptions = lib.mkOption {
|
rcloneOptions = lib.mkOption {
|
||||||
type = with lib.types; nullOr (attrsOf (oneOf [ str bool ]));
|
type =
|
||||||
default = null;
|
with lib.types;
|
||||||
description = ''
|
nullOr (
|
||||||
Options to pass to rclone to control its behavior.
|
attrsOf (oneOf [
|
||||||
See <https://rclone.org/docs/#options> for
|
str
|
||||||
available options. When specifying option names, strip the
|
bool
|
||||||
leading `--`. To set a flag such as
|
])
|
||||||
`--drive-use-trash`, which does not take a value,
|
);
|
||||||
set the value to the Boolean `true`.
|
default = null;
|
||||||
'';
|
description = ''
|
||||||
example = {
|
Options to pass to rclone to control its behavior.
|
||||||
bwlimit = "10M";
|
See <https://rclone.org/docs/#options> for
|
||||||
drive-use-trash = "true";
|
available options. When specifying option names, strip the
|
||||||
|
leading `--`. To set a flag such as
|
||||||
|
`--drive-use-trash`, which does not take a value,
|
||||||
|
set the value to the Boolean `true`.
|
||||||
|
'';
|
||||||
|
example = {
|
||||||
|
bwlimit = "10M";
|
||||||
|
drive-use-trash = "true";
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
rcloneConfig = lib.mkOption {
|
||||||
|
type =
|
||||||
|
with lib.types;
|
||||||
|
nullOr (
|
||||||
|
attrsOf (oneOf [
|
||||||
|
str
|
||||||
|
bool
|
||||||
|
])
|
||||||
|
);
|
||||||
|
default = null;
|
||||||
|
description = ''
|
||||||
|
Configuration for the rclone remote being used for backup.
|
||||||
|
See the remote's specific options under rclone's docs at
|
||||||
|
<https://rclone.org/docs/>. When specifying
|
||||||
|
option names, use the "config" name specified in the docs.
|
||||||
|
For example, to set `--b2-hard-delete` for a B2
|
||||||
|
remote, use `hard_delete = true` in the
|
||||||
|
attribute set.
|
||||||
|
Warning: Secrets set in here will be world-readable in the Nix
|
||||||
|
store! Consider using the `rcloneConfigFile`
|
||||||
|
option instead to specify secret values separately. Note that
|
||||||
|
options set here will override those set in the config file.
|
||||||
|
'';
|
||||||
|
example = {
|
||||||
|
type = "b2";
|
||||||
|
account = "xxx";
|
||||||
|
key = "xxx";
|
||||||
|
hard_delete = true;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
rcloneConfigFile = lib.mkOption {
|
||||||
|
type = with lib.types; nullOr path;
|
||||||
|
default = null;
|
||||||
|
description = ''
|
||||||
|
Path to the file containing rclone configuration. This file
|
||||||
|
must contain configuration for the remote specified in this backup
|
||||||
|
set and also must be readable by root. Options set in
|
||||||
|
`rcloneConfig` will override those set in this
|
||||||
|
file.
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
inhibitsSleep = lib.mkOption {
|
||||||
|
default = false;
|
||||||
|
type = lib.types.bool;
|
||||||
|
example = true;
|
||||||
|
description = ''
|
||||||
|
Prevents the system from sleeping while backing up.
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
repository = lib.mkOption {
|
||||||
|
type = with lib.types; nullOr str;
|
||||||
|
default = null;
|
||||||
|
description = ''
|
||||||
|
repository to backup to.
|
||||||
|
'';
|
||||||
|
example = "sftp:backup@192.168.1.100:/backups/${name}";
|
||||||
|
};
|
||||||
|
|
||||||
|
repositoryFile = lib.mkOption {
|
||||||
|
type = with lib.types; nullOr path;
|
||||||
|
default = null;
|
||||||
|
description = ''
|
||||||
|
Path to the file containing the repository location to backup to.
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
paths = lib.mkOption {
|
||||||
|
# This is nullable for legacy reasons only. We should consider making it a pure listOf
|
||||||
|
# after some time has passed since this comment was added.
|
||||||
|
type = lib.types.nullOr (lib.types.listOf lib.types.str);
|
||||||
|
default = [ ];
|
||||||
|
description = ''
|
||||||
|
Which paths to backup, in addition to ones specified via
|
||||||
|
`dynamicFilesFrom`. If null or an empty array and
|
||||||
|
`dynamicFilesFrom` is also null, no backup command will be run.
|
||||||
|
This can be used to create a prune-only job.
|
||||||
|
'';
|
||||||
|
example = [
|
||||||
|
"/var/lib/postgresql"
|
||||||
|
"/home/user/backup"
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
exclude = lib.mkOption {
|
||||||
|
type = lib.types.listOf lib.types.str;
|
||||||
|
default = [ ];
|
||||||
|
description = ''
|
||||||
|
Patterns to exclude when backing up. See
|
||||||
|
https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for
|
||||||
|
details on syntax.
|
||||||
|
'';
|
||||||
|
example = [
|
||||||
|
"/var/cache"
|
||||||
|
"/home/*/.cache"
|
||||||
|
".git"
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
timerConfig = lib.mkOption {
|
||||||
|
type = lib.types.nullOr (lib.types.attrsOf unitOption);
|
||||||
|
default = {
|
||||||
|
OnCalendar = "daily";
|
||||||
|
Persistent = true;
|
||||||
|
};
|
||||||
|
description = ''
|
||||||
|
When to run the backup. See {manpage}`systemd.timer(5)` for
|
||||||
|
details. If null no timer is created and the backup will only
|
||||||
|
run when explicitly started.
|
||||||
|
'';
|
||||||
|
example = {
|
||||||
|
OnCalendar = "00:05";
|
||||||
|
RandomizedDelaySec = "5h";
|
||||||
|
Persistent = true;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
user = lib.mkOption {
|
||||||
|
type = lib.types.str;
|
||||||
|
default = "root";
|
||||||
|
description = ''
|
||||||
|
As which user the backup should run.
|
||||||
|
'';
|
||||||
|
example = "postgresql";
|
||||||
|
};
|
||||||
|
|
||||||
|
extraBackupArgs = lib.mkOption {
|
||||||
|
type = lib.types.listOf lib.types.str;
|
||||||
|
default = [ ];
|
||||||
|
description = ''
|
||||||
|
Extra arguments passed to restic backup.
|
||||||
|
'';
|
||||||
|
example = [
|
||||||
|
"--exclude-file=/etc/nixos/restic-ignore"
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
extraOptions = lib.mkOption {
|
||||||
|
type = lib.types.listOf lib.types.str;
|
||||||
|
default = [ ];
|
||||||
|
description = ''
|
||||||
|
Extra extended options to be passed to the restic --option flag.
|
||||||
|
'';
|
||||||
|
example = [
|
||||||
|
"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'"
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
initialize = lib.mkOption {
|
||||||
|
type = lib.types.bool;
|
||||||
|
default = false;
|
||||||
|
description = ''
|
||||||
|
Create the repository if it doesn't exist.
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
pruneOpts = lib.mkOption {
|
||||||
|
type = lib.types.listOf lib.types.str;
|
||||||
|
default = [ ];
|
||||||
|
description = ''
|
||||||
|
A list of options (--keep-\* et al.) for 'restic forget
|
||||||
|
--prune', to automatically prune old snapshots. The
|
||||||
|
'forget' command is run *after* the 'backup' command, so
|
||||||
|
keep that in mind when constructing the --keep-\* options.
|
||||||
|
'';
|
||||||
|
example = [
|
||||||
|
"--keep-daily 7"
|
||||||
|
"--keep-weekly 5"
|
||||||
|
"--keep-monthly 12"
|
||||||
|
"--keep-yearly 75"
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
runCheck = lib.mkOption {
|
||||||
|
type = lib.types.bool;
|
||||||
|
default = (builtins.length config.services.restic.backups.${name}.checkOpts > 0);
|
||||||
|
defaultText = lib.literalExpression ''builtins.length config.services.backups.${name}.checkOpts > 0'';
|
||||||
|
description = "Whether to run the `check` command with the provided `checkOpts` options.";
|
||||||
|
example = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
checkOpts = lib.mkOption {
|
||||||
|
type = lib.types.listOf lib.types.str;
|
||||||
|
default = [ ];
|
||||||
|
description = ''
|
||||||
|
A list of options for 'restic check'.
|
||||||
|
'';
|
||||||
|
example = [
|
||||||
|
"--with-cache"
|
||||||
|
];
|
||||||
|
};
|
||||||
|
|
||||||
|
dynamicFilesFrom = lib.mkOption {
|
||||||
|
type = with lib.types; nullOr str;
|
||||||
|
default = null;
|
||||||
|
description = ''
|
||||||
|
A script that produces a list of files to back up. The
|
||||||
|
results of this command are given to the '--files-from'
|
||||||
|
option. The result is merged with paths specified via `paths`.
|
||||||
|
'';
|
||||||
|
example = "find /home/matt/git -type d -name .git";
|
||||||
|
};
|
||||||
|
|
||||||
|
backupPrepareCommand = lib.mkOption {
|
||||||
|
type = with lib.types; nullOr str;
|
||||||
|
default = null;
|
||||||
|
description = ''
|
||||||
|
A script that must run before starting the backup process.
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
backupCleanupCommand = lib.mkOption {
|
||||||
|
type = with lib.types; nullOr str;
|
||||||
|
default = null;
|
||||||
|
description = ''
|
||||||
|
A script that must run after finishing the backup process.
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
|
||||||
|
package = lib.mkPackageOption pkgs "restic" { };
|
||||||
|
|
||||||
|
createWrapper = lib.mkOption {
|
||||||
|
type = lib.types.bool;
|
||||||
|
default = true;
|
||||||
|
description = ''
|
||||||
|
Whether to generate and add a script to the system path, that has the same environment variables set
|
||||||
|
as the systemd service. This can be used to e.g. mount snapshots or perform other opterations, without
|
||||||
|
having to manually specify most options.
|
||||||
|
'';
|
||||||
|
};
|
||||||
};
|
};
|
||||||
};
|
}
|
||||||
|
)
|
||||||
rcloneConfig = lib.mkOption {
|
);
|
||||||
type = with lib.types; nullOr (attrsOf (oneOf [ str bool ]));
|
|
||||||
default = null;
|
|
||||||
description = ''
|
|
||||||
Configuration for the rclone remote being used for backup.
|
|
||||||
See the remote's specific options under rclone's docs at
|
|
||||||
<https://rclone.org/docs/>. When specifying
|
|
||||||
option names, use the "config" name specified in the docs.
|
|
||||||
For example, to set `--b2-hard-delete` for a B2
|
|
||||||
remote, use `hard_delete = true` in the
|
|
||||||
attribute set.
|
|
||||||
Warning: Secrets set in here will be world-readable in the Nix
|
|
||||||
store! Consider using the `rcloneConfigFile`
|
|
||||||
option instead to specify secret values separately. Note that
|
|
||||||
options set here will override those set in the config file.
|
|
||||||
'';
|
|
||||||
example = {
|
|
||||||
type = "b2";
|
|
||||||
account = "xxx";
|
|
||||||
key = "xxx";
|
|
||||||
hard_delete = true;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
rcloneConfigFile = lib.mkOption {
|
|
||||||
type = with lib.types; nullOr path;
|
|
||||||
default = null;
|
|
||||||
description = ''
|
|
||||||
Path to the file containing rclone configuration. This file
|
|
||||||
must contain configuration for the remote specified in this backup
|
|
||||||
set and also must be readable by root. Options set in
|
|
||||||
`rcloneConfig` will override those set in this
|
|
||||||
file.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
inhibitsSleep = lib.mkOption {
|
|
||||||
default = false;
|
|
||||||
type = lib.types.bool;
|
|
||||||
example = true;
|
|
||||||
description = ''
|
|
||||||
Prevents the system from sleeping while backing up.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
repository = lib.mkOption {
|
|
||||||
type = with lib.types; nullOr str;
|
|
||||||
default = null;
|
|
||||||
description = ''
|
|
||||||
repository to backup to.
|
|
||||||
'';
|
|
||||||
example = "sftp:backup@192.168.1.100:/backups/${name}";
|
|
||||||
};
|
|
||||||
|
|
||||||
repositoryFile = lib.mkOption {
|
|
||||||
type = with lib.types; nullOr path;
|
|
||||||
default = null;
|
|
||||||
description = ''
|
|
||||||
Path to the file containing the repository location to backup to.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
paths = lib.mkOption {
|
|
||||||
# This is nullable for legacy reasons only. We should consider making it a pure listOf
|
|
||||||
# after some time has passed since this comment was added.
|
|
||||||
type = lib.types.nullOr (lib.types.listOf lib.types.str);
|
|
||||||
default = [ ];
|
|
||||||
description = ''
|
|
||||||
Which paths to backup, in addition to ones specified via
|
|
||||||
`dynamicFilesFrom`. If null or an empty array and
|
|
||||||
`dynamicFilesFrom` is also null, no backup command will be run.
|
|
||||||
This can be used to create a prune-only job.
|
|
||||||
'';
|
|
||||||
example = [
|
|
||||||
"/var/lib/postgresql"
|
|
||||||
"/home/user/backup"
|
|
||||||
];
|
|
||||||
};
|
|
||||||
|
|
||||||
exclude = lib.mkOption {
|
|
||||||
type = lib.types.listOf lib.types.str;
|
|
||||||
default = [ ];
|
|
||||||
description = ''
|
|
||||||
Patterns to exclude when backing up. See
|
|
||||||
https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files for
|
|
||||||
details on syntax.
|
|
||||||
'';
|
|
||||||
example = [
|
|
||||||
"/var/cache"
|
|
||||||
"/home/*/.cache"
|
|
||||||
".git"
|
|
||||||
];
|
|
||||||
};
|
|
||||||
|
|
||||||
timerConfig = lib.mkOption {
|
|
||||||
type = lib.types.nullOr (lib.types.attrsOf unitOption);
|
|
||||||
default = {
|
|
||||||
OnCalendar = "daily";
|
|
||||||
Persistent = true;
|
|
||||||
};
|
|
||||||
description = ''
|
|
||||||
When to run the backup. See {manpage}`systemd.timer(5)` for
|
|
||||||
details. If null no timer is created and the backup will only
|
|
||||||
run when explicitly started.
|
|
||||||
'';
|
|
||||||
example = {
|
|
||||||
OnCalendar = "00:05";
|
|
||||||
RandomizedDelaySec = "5h";
|
|
||||||
Persistent = true;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
user = lib.mkOption {
|
|
||||||
type = lib.types.str;
|
|
||||||
default = "root";
|
|
||||||
description = ''
|
|
||||||
As which user the backup should run.
|
|
||||||
'';
|
|
||||||
example = "postgresql";
|
|
||||||
};
|
|
||||||
|
|
||||||
extraBackupArgs = lib.mkOption {
|
|
||||||
type = lib.types.listOf lib.types.str;
|
|
||||||
default = [ ];
|
|
||||||
description = ''
|
|
||||||
Extra arguments passed to restic backup.
|
|
||||||
'';
|
|
||||||
example = [
|
|
||||||
"--exclude-file=/etc/nixos/restic-ignore"
|
|
||||||
];
|
|
||||||
};
|
|
||||||
|
|
||||||
extraOptions = lib.mkOption {
|
|
||||||
type = lib.types.listOf lib.types.str;
|
|
||||||
default = [ ];
|
|
||||||
description = ''
|
|
||||||
Extra extended options to be passed to the restic --option flag.
|
|
||||||
'';
|
|
||||||
example = [
|
|
||||||
"sftp.command='ssh backup@192.168.1.100 -i /home/user/.ssh/id_rsa -s sftp'"
|
|
||||||
];
|
|
||||||
};
|
|
||||||
|
|
||||||
initialize = lib.mkOption {
|
|
||||||
type = lib.types.bool;
|
|
||||||
default = false;
|
|
||||||
description = ''
|
|
||||||
Create the repository if it doesn't exist.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
pruneOpts = lib.mkOption {
|
|
||||||
type = lib.types.listOf lib.types.str;
|
|
||||||
default = [ ];
|
|
||||||
description = ''
|
|
||||||
A list of options (--keep-\* et al.) for 'restic forget
|
|
||||||
--prune', to automatically prune old snapshots. The
|
|
||||||
'forget' command is run *after* the 'backup' command, so
|
|
||||||
keep that in mind when constructing the --keep-\* options.
|
|
||||||
'';
|
|
||||||
example = [
|
|
||||||
"--keep-daily 7"
|
|
||||||
"--keep-weekly 5"
|
|
||||||
"--keep-monthly 12"
|
|
||||||
"--keep-yearly 75"
|
|
||||||
];
|
|
||||||
};
|
|
||||||
|
|
||||||
runCheck = lib.mkOption {
|
|
||||||
type = lib.types.bool;
|
|
||||||
default = (builtins.length config.services.restic.backups.${name}.checkOpts > 0);
|
|
||||||
defaultText = lib.literalExpression ''builtins.length config.services.backups.${name}.checkOpts > 0'';
|
|
||||||
description = "Whether to run the `check` command with the provided `checkOpts` options.";
|
|
||||||
example = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
checkOpts = lib.mkOption {
|
|
||||||
type = lib.types.listOf lib.types.str;
|
|
||||||
default = [ ];
|
|
||||||
description = ''
|
|
||||||
A list of options for 'restic check'.
|
|
||||||
'';
|
|
||||||
example = [
|
|
||||||
"--with-cache"
|
|
||||||
];
|
|
||||||
};
|
|
||||||
|
|
||||||
dynamicFilesFrom = lib.mkOption {
|
|
||||||
type = with lib.types; nullOr str;
|
|
||||||
default = null;
|
|
||||||
description = ''
|
|
||||||
A script that produces a list of files to back up. The
|
|
||||||
results of this command are given to the '--files-from'
|
|
||||||
option. The result is merged with paths specified via `paths`.
|
|
||||||
'';
|
|
||||||
example = "find /home/matt/git -type d -name .git";
|
|
||||||
};
|
|
||||||
|
|
||||||
backupPrepareCommand = lib.mkOption {
|
|
||||||
type = with lib.types; nullOr str;
|
|
||||||
default = null;
|
|
||||||
description = ''
|
|
||||||
A script that must run before starting the backup process.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
backupCleanupCommand = lib.mkOption {
|
|
||||||
type = with lib.types; nullOr str;
|
|
||||||
default = null;
|
|
||||||
description = ''
|
|
||||||
A script that must run after finishing the backup process.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
|
|
||||||
package = lib.mkPackageOption pkgs "restic" { };
|
|
||||||
|
|
||||||
createWrapper = lib.mkOption {
|
|
||||||
type = lib.types.bool;
|
|
||||||
default = true;
|
|
||||||
description = ''
|
|
||||||
Whether to generate and add a script to the system path, that has the same environment variables set
|
|
||||||
as the systemd service. This can be used to e.g. mount snapshots or perform other opterations, without
|
|
||||||
having to manually specify most options.
|
|
||||||
'';
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}));
|
|
||||||
default = { };
|
default = { };
|
||||||
example = {
|
example = {
|
||||||
localbackup = {
|
localbackup = {
|
||||||
|
|
@ -300,119 +325,139 @@ in
|
||||||
assertion = (v.repository == null) != (v.repositoryFile == null);
|
assertion = (v.repository == null) != (v.repositoryFile == null);
|
||||||
message = "services.restic.backups.${n}: exactly one of repository or repositoryFile should be set";
|
message = "services.restic.backups.${n}: exactly one of repository or repositoryFile should be set";
|
||||||
}) config.services.restic.backups;
|
}) config.services.restic.backups;
|
||||||
systemd.services =
|
systemd.services = lib.mapAttrs' (
|
||||||
lib.mapAttrs'
|
name: backup:
|
||||||
(name: backup:
|
let
|
||||||
let
|
extraOptions = lib.concatMapStrings (arg: " -o ${arg}") backup.extraOptions;
|
||||||
extraOptions = lib.concatMapStrings (arg: " -o ${arg}") backup.extraOptions;
|
inhibitCmd = lib.concatStringsSep " " [
|
||||||
inhibitCmd = lib.concatStringsSep " " [
|
"${pkgs.systemd}/bin/systemd-inhibit"
|
||||||
"${pkgs.systemd}/bin/systemd-inhibit"
|
"--mode='block'"
|
||||||
"--mode='block'"
|
"--who='restic'"
|
||||||
"--who='restic'"
|
"--what='sleep'"
|
||||||
"--what='sleep'"
|
"--why=${lib.escapeShellArg "Scheduled backup ${name}"} "
|
||||||
"--why=${lib.escapeShellArg "Scheduled backup ${name}"} "
|
];
|
||||||
];
|
resticCmd = "${lib.optionalString backup.inhibitsSleep inhibitCmd}${backup.package}/bin/restic${extraOptions}";
|
||||||
resticCmd = "${lib.optionalString backup.inhibitsSleep inhibitCmd}${backup.package}/bin/restic${extraOptions}";
|
excludeFlags = lib.optional (
|
||||||
excludeFlags = lib.optional (backup.exclude != []) "--exclude-file=${pkgs.writeText "exclude-patterns" (lib.concatStringsSep "\n" backup.exclude)}";
|
backup.exclude != [ ]
|
||||||
filesFromTmpFile = "/run/restic-backups-${name}/includes";
|
) "--exclude-file=${pkgs.writeText "exclude-patterns" (lib.concatStringsSep "\n" backup.exclude)}";
|
||||||
doBackup = (backup.dynamicFilesFrom != null) || (backup.paths != null && backup.paths != []);
|
filesFromTmpFile = "/run/restic-backups-${name}/includes";
|
||||||
pruneCmd = lib.optionals (builtins.length backup.pruneOpts > 0) [
|
doBackup = (backup.dynamicFilesFrom != null) || (backup.paths != null && backup.paths != [ ]);
|
||||||
(resticCmd + " forget --prune " + (lib.concatStringsSep " " backup.pruneOpts))
|
pruneCmd = lib.optionals (builtins.length backup.pruneOpts > 0) [
|
||||||
];
|
(resticCmd + " forget --prune " + (lib.concatStringsSep " " backup.pruneOpts))
|
||||||
checkCmd = lib.optionals backup.runCheck [
|
];
|
||||||
(resticCmd + " check " + (lib.concatStringsSep " " backup.checkOpts))
|
checkCmd = lib.optionals backup.runCheck [
|
||||||
];
|
(resticCmd + " check " + (lib.concatStringsSep " " backup.checkOpts))
|
||||||
# Helper functions for rclone remotes
|
];
|
||||||
rcloneRemoteName = builtins.elemAt (lib.splitString ":" backup.repository) 1;
|
# Helper functions for rclone remotes
|
||||||
rcloneAttrToOpt = v: "RCLONE_" + lib.toUpper (builtins.replaceStrings [ "-" ] [ "_" ] v);
|
rcloneRemoteName = builtins.elemAt (lib.splitString ":" backup.repository) 1;
|
||||||
rcloneAttrToConf = v: "RCLONE_CONFIG_" + lib.toUpper (rcloneRemoteName + "_" + v);
|
rcloneAttrToOpt = v: "RCLONE_" + lib.toUpper (builtins.replaceStrings [ "-" ] [ "_" ] v);
|
||||||
toRcloneVal = v: if lib.isBool v then lib.boolToString v else v;
|
rcloneAttrToConf = v: "RCLONE_CONFIG_" + lib.toUpper (rcloneRemoteName + "_" + v);
|
||||||
in
|
toRcloneVal = v: if lib.isBool v then lib.boolToString v else v;
|
||||||
lib.nameValuePair "restic-backups-${name}" ({
|
in
|
||||||
environment = {
|
lib.nameValuePair "restic-backups-${name}" (
|
||||||
|
{
|
||||||
|
environment =
|
||||||
|
{
|
||||||
# not %C, because that wouldn't work in the wrapper script
|
# not %C, because that wouldn't work in the wrapper script
|
||||||
RESTIC_CACHE_DIR = "/var/cache/restic-backups-${name}";
|
RESTIC_CACHE_DIR = "/var/cache/restic-backups-${name}";
|
||||||
RESTIC_PASSWORD_FILE = backup.passwordFile;
|
RESTIC_PASSWORD_FILE = backup.passwordFile;
|
||||||
RESTIC_REPOSITORY = backup.repository;
|
RESTIC_REPOSITORY = backup.repository;
|
||||||
RESTIC_REPOSITORY_FILE = backup.repositoryFile;
|
RESTIC_REPOSITORY_FILE = backup.repositoryFile;
|
||||||
} // lib.optionalAttrs (backup.rcloneOptions != null) (lib.mapAttrs'
|
}
|
||||||
(name: value:
|
// lib.optionalAttrs (backup.rcloneOptions != null) (
|
||||||
lib.nameValuePair (rcloneAttrToOpt name) (toRcloneVal value)
|
lib.mapAttrs' (
|
||||||
)
|
name: value: lib.nameValuePair (rcloneAttrToOpt name) (toRcloneVal value)
|
||||||
backup.rcloneOptions) // lib.optionalAttrs (backup.rcloneConfigFile != null) {
|
) backup.rcloneOptions
|
||||||
|
)
|
||||||
|
// lib.optionalAttrs (backup.rcloneConfigFile != null) {
|
||||||
RCLONE_CONFIG = backup.rcloneConfigFile;
|
RCLONE_CONFIG = backup.rcloneConfigFile;
|
||||||
} // lib.optionalAttrs (backup.rcloneConfig != null) (lib.mapAttrs'
|
}
|
||||||
(name: value:
|
// lib.optionalAttrs (backup.rcloneConfig != null) (
|
||||||
lib.nameValuePair (rcloneAttrToConf name) (toRcloneVal value)
|
lib.mapAttrs' (
|
||||||
)
|
name: value: lib.nameValuePair (rcloneAttrToConf name) (toRcloneVal value)
|
||||||
backup.rcloneConfig);
|
) backup.rcloneConfig
|
||||||
path = [ config.programs.ssh.package ];
|
);
|
||||||
restartIfChanged = false;
|
path = [ config.programs.ssh.package ];
|
||||||
wants = [ "network-online.target" ];
|
restartIfChanged = false;
|
||||||
after = [ "network-online.target" ];
|
wants = [ "network-online.target" ];
|
||||||
serviceConfig = {
|
after = [ "network-online.target" ];
|
||||||
|
serviceConfig =
|
||||||
|
{
|
||||||
Type = "oneshot";
|
Type = "oneshot";
|
||||||
ExecStart = (lib.optionals doBackup [ "${resticCmd} backup ${lib.concatStringsSep " " (backup.extraBackupArgs ++ excludeFlags)} --files-from=${filesFromTmpFile}" ])
|
ExecStart =
|
||||||
++ pruneCmd ++ checkCmd;
|
(lib.optionals doBackup [
|
||||||
|
"${resticCmd} backup ${
|
||||||
|
lib.concatStringsSep " " (backup.extraBackupArgs ++ excludeFlags)
|
||||||
|
} --files-from=${filesFromTmpFile}"
|
||||||
|
])
|
||||||
|
++ pruneCmd
|
||||||
|
++ checkCmd;
|
||||||
User = backup.user;
|
User = backup.user;
|
||||||
RuntimeDirectory = "restic-backups-${name}";
|
RuntimeDirectory = "restic-backups-${name}";
|
||||||
CacheDirectory = "restic-backups-${name}";
|
CacheDirectory = "restic-backups-${name}";
|
||||||
CacheDirectoryMode = "0700";
|
CacheDirectoryMode = "0700";
|
||||||
PrivateTmp = true;
|
PrivateTmp = true;
|
||||||
} // lib.optionalAttrs (backup.environmentFile != null) {
|
}
|
||||||
|
// lib.optionalAttrs (backup.environmentFile != null) {
|
||||||
EnvironmentFile = backup.environmentFile;
|
EnvironmentFile = backup.environmentFile;
|
||||||
};
|
};
|
||||||
} // lib.optionalAttrs (backup.initialize || doBackup || backup.backupPrepareCommand != null) {
|
}
|
||||||
preStart = ''
|
// lib.optionalAttrs (backup.initialize || doBackup || backup.backupPrepareCommand != null) {
|
||||||
${lib.optionalString (backup.backupPrepareCommand != null) ''
|
preStart = ''
|
||||||
${pkgs.writeScript "backupPrepareCommand" backup.backupPrepareCommand}
|
${lib.optionalString (backup.backupPrepareCommand != null) ''
|
||||||
''}
|
${pkgs.writeScript "backupPrepareCommand" backup.backupPrepareCommand}
|
||||||
${lib.optionalString (backup.initialize) ''
|
''}
|
||||||
${resticCmd} cat config > /dev/null || ${resticCmd} init
|
${lib.optionalString (backup.initialize) ''
|
||||||
''}
|
${resticCmd} cat config > /dev/null || ${resticCmd} init
|
||||||
${lib.optionalString (backup.paths != null && backup.paths != []) ''
|
''}
|
||||||
cat ${pkgs.writeText "staticPaths" (lib.concatLines backup.paths)} >> ${filesFromTmpFile}
|
${lib.optionalString (backup.paths != null && backup.paths != [ ]) ''
|
||||||
''}
|
cat ${pkgs.writeText "staticPaths" (lib.concatLines backup.paths)} >> ${filesFromTmpFile}
|
||||||
${lib.optionalString (backup.dynamicFilesFrom != null) ''
|
''}
|
||||||
${pkgs.writeScript "dynamicFilesFromScript" backup.dynamicFilesFrom} >> ${filesFromTmpFile}
|
${lib.optionalString (backup.dynamicFilesFrom != null) ''
|
||||||
''}
|
${pkgs.writeScript "dynamicFilesFromScript" backup.dynamicFilesFrom} >> ${filesFromTmpFile}
|
||||||
'';
|
''}
|
||||||
} // lib.optionalAttrs (doBackup || backup.backupCleanupCommand != null) {
|
'';
|
||||||
postStop = ''
|
}
|
||||||
${lib.optionalString (backup.backupCleanupCommand != null) ''
|
// lib.optionalAttrs (doBackup || backup.backupCleanupCommand != null) {
|
||||||
${pkgs.writeScript "backupCleanupCommand" backup.backupCleanupCommand}
|
postStop = ''
|
||||||
''}
|
${lib.optionalString (backup.backupCleanupCommand != null) ''
|
||||||
${lib.optionalString doBackup ''
|
${pkgs.writeScript "backupCleanupCommand" backup.backupCleanupCommand}
|
||||||
rm ${filesFromTmpFile}
|
''}
|
||||||
''}
|
${lib.optionalString doBackup ''
|
||||||
'';
|
rm ${filesFromTmpFile}
|
||||||
})
|
''}
|
||||||
)
|
'';
|
||||||
config.services.restic.backups;
|
}
|
||||||
systemd.timers =
|
)
|
||||||
lib.mapAttrs'
|
) config.services.restic.backups;
|
||||||
(name: backup: lib.nameValuePair "restic-backups-${name}" {
|
systemd.timers = lib.mapAttrs' (
|
||||||
wantedBy = [ "timers.target" ];
|
name: backup:
|
||||||
timerConfig = backup.timerConfig;
|
lib.nameValuePair "restic-backups-${name}" {
|
||||||
})
|
wantedBy = [ "timers.target" ];
|
||||||
(lib.filterAttrs (_: backup: backup.timerConfig != null) config.services.restic.backups);
|
timerConfig = backup.timerConfig;
|
||||||
|
}
|
||||||
|
) (lib.filterAttrs (_: backup: backup.timerConfig != null) config.services.restic.backups);
|
||||||
|
|
||||||
# generate wrapper scripts, as described in the createWrapper option
|
# generate wrapper scripts, as described in the createWrapper option
|
||||||
environment.systemPackages = lib.mapAttrsToList (name: backup: let
|
environment.systemPackages = lib.mapAttrsToList (
|
||||||
extraOptions = lib.concatMapStrings (arg: " -o ${arg}") backup.extraOptions;
|
name: backup:
|
||||||
resticCmd = "${backup.package}/bin/restic${extraOptions}";
|
let
|
||||||
in pkgs.writeShellScriptBin "restic-${name}" ''
|
extraOptions = lib.concatMapStrings (arg: " -o ${arg}") backup.extraOptions;
|
||||||
set -a # automatically export variables
|
resticCmd = "${backup.package}/bin/restic${extraOptions}";
|
||||||
${lib.optionalString (backup.environmentFile != null) "source ${backup.environmentFile}"}
|
in
|
||||||
# set same environment variables as the systemd service
|
pkgs.writeShellScriptBin "restic-${name}" ''
|
||||||
${lib.pipe config.systemd.services."restic-backups-${name}".environment [
|
set -a # automatically export variables
|
||||||
(lib.filterAttrs (n: v: v != null && n != "PATH"))
|
${lib.optionalString (backup.environmentFile != null) "source ${backup.environmentFile}"}
|
||||||
(lib.mapAttrsToList (n: v: "${n}=${v}"))
|
# set same environment variables as the systemd service
|
||||||
(lib.concatStringsSep "\n")
|
${lib.pipe config.systemd.services."restic-backups-${name}".environment [
|
||||||
]}
|
(lib.filterAttrs (n: v: v != null && n != "PATH"))
|
||||||
PATH=${config.systemd.services."restic-backups-${name}".environment.PATH}:$PATH
|
(lib.mapAttrsToList (n: v: "${n}=${v}"))
|
||||||
|
(lib.concatStringsSep "\n")
|
||||||
|
]}
|
||||||
|
PATH=${config.systemd.services."restic-backups-${name}".environment.PATH}:$PATH
|
||||||
|
|
||||||
exec ${resticCmd} "$@"
|
exec ${resticCmd} "$@"
|
||||||
'') (lib.filterAttrs (_: v: v.createWrapper) config.services.restic.backups);
|
''
|
||||||
|
) (lib.filterAttrs (_: v: v.createWrapper) config.services.restic.backups);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue