danvics/selfhostblocks
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

rename backup hook attributes (#371)

Browse source 
Co-authored-by: ibizaman <ibizapeanut@gmail.com>
This commit is contained in:
Pierre Penninckx 2024-11-26 20:15:36 +01:00 committed by GitHub
parent 54b0cb6526
commit ba1e60a45e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 36 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -14,6 +14,11 @@ Template:
# Upcoming Release # Upcoming Release
## Breaking Changes
- Options `before_backup` and `after_backup` for backup contract have been renamed to
`beforeBackup` and `afterBackup`.
## Other Changes ## Other Changes
- Show how to pin Self Host Blocks flake input to a tag. - Show how to pin Self Host Blocks flake input to a tag.

40
docs/redirects.json
View file

@ -188,11 +188,11 @@
"blocks-restic-options-shb.restic.instances._name_.request.hooks": [ "blocks-restic-options-shb.restic.instances._name_.request.hooks": [
"blocks-restic.html#blocks-restic-options-shb.restic.instances._name_.request.hooks" "blocks-restic.html#blocks-restic-options-shb.restic.instances._name_.request.hooks"
], ],
"blocks-restic-options-shb.restic.instances._name_.request.hooks.after_backup": [ "blocks-restic-options-shb.restic.instances._name_.request.hooks.afterBackup": [
"blocks-restic.html#blocks-restic-options-shb.restic.instances._name_.request.hooks.after_backup" "blocks-restic.html#blocks-restic-options-shb.restic.instances._name_.request.hooks.afterBackup"
], ],
"blocks-restic-options-shb.restic.instances._name_.request.hooks.before_backup": [ "blocks-restic-options-shb.restic.instances._name_.request.hooks.beforeBackup": [
"blocks-restic.html#blocks-restic-options-shb.restic.instances._name_.request.hooks.before_backup" "blocks-restic.html#blocks-restic-options-shb.restic.instances._name_.request.hooks.beforeBackup"
], ],
"blocks-restic-options-shb.restic.instances._name_.request.sourceDirectories": [ "blocks-restic-options-shb.restic.instances._name_.request.sourceDirectories": [
"blocks-restic.html#blocks-restic-options-shb.restic.instances._name_.request.sourceDirectories" "blocks-restic.html#blocks-restic-options-shb.restic.instances._name_.request.sourceDirectories"
@ -581,11 +581,11 @@
"contracts-backup-options-shb.contracts.backup.request.hooks": [ "contracts-backup-options-shb.contracts.backup.request.hooks": [
"contracts-backup.html#contracts-backup-options-shb.contracts.backup.request.hooks" "contracts-backup.html#contracts-backup-options-shb.contracts.backup.request.hooks"
], ],
"contracts-backup-options-shb.contracts.backup.request.hooks.after_backup": [ "contracts-backup-options-shb.contracts.backup.request.hooks.afterBackup": [
"contracts-backup.html#contracts-backup-options-shb.contracts.backup.request.hooks.after_backup" "contracts-backup.html#contracts-backup-options-shb.contracts.backup.request.hooks.afterBackup"
], ],
"contracts-backup-options-shb.contracts.backup.request.hooks.before_backup": [ "contracts-backup-options-shb.contracts.backup.request.hooks.beforeBackup": [
"contracts-backup.html#contracts-backup-options-shb.contracts.backup.request.hooks.before_backup" "contracts-backup.html#contracts-backup-options-shb.contracts.backup.request.hooks.beforeBackup"
], ],
"contracts-backup-options-shb.contracts.backup.request.sourceDirectories": [ "contracts-backup-options-shb.contracts.backup.request.sourceDirectories": [
"contracts-backup.html#contracts-backup-options-shb.contracts.backup.request.sourceDirectories" "contracts-backup.html#contracts-backup-options-shb.contracts.backup.request.sourceDirectories"
@ -857,11 +857,11 @@
"services-forgejo-options-shb.forgejo.backup.hooks": [ "services-forgejo-options-shb.forgejo.backup.hooks": [
"services-forgejo.html#services-forgejo-options-shb.forgejo.backup.hooks" "services-forgejo.html#services-forgejo-options-shb.forgejo.backup.hooks"
], ],
"services-forgejo-options-shb.forgejo.backup.hooks.after_backup": [ "services-forgejo-options-shb.forgejo.backup.hooks.afterBackup": [
"services-forgejo.html#services-forgejo-options-shb.forgejo.backup.hooks.after_backup" "services-forgejo.html#services-forgejo-options-shb.forgejo.backup.hooks.afterBackup"
], ],
"services-forgejo-options-shb.forgejo.backup.hooks.before_backup": [ "services-forgejo-options-shb.forgejo.backup.hooks.beforeBackup": [
"services-forgejo.html#services-forgejo-options-shb.forgejo.backup.hooks.before_backup" "services-forgejo.html#services-forgejo-options-shb.forgejo.backup.hooks.beforeBackup"
], ],
"services-forgejo-options-shb.forgejo.backup.sourceDirectories": [ "services-forgejo-options-shb.forgejo.backup.sourceDirectories": [
"services-forgejo.html#services-forgejo-options-shb.forgejo.backup.sourceDirectories" "services-forgejo.html#services-forgejo-options-shb.forgejo.backup.sourceDirectories"
@ -1331,11 +1331,11 @@
"services-nextcloudserver-options-shb.nextcloud.backup.hooks": [ "services-nextcloudserver-options-shb.nextcloud.backup.hooks": [
"services-nextcloud.html#services-nextcloudserver-options-shb.nextcloud.backup.hooks" "services-nextcloud.html#services-nextcloudserver-options-shb.nextcloud.backup.hooks"
], ],
"services-nextcloudserver-options-shb.nextcloud.backup.hooks.after_backup": [ "services-nextcloudserver-options-shb.nextcloud.backup.hooks.afterBackup": [
"services-nextcloud.html#services-nextcloudserver-options-shb.nextcloud.backup.hooks.after_backup" "services-nextcloud.html#services-nextcloudserver-options-shb.nextcloud.backup.hooks.afterBackup"
], ],
"services-nextcloudserver-options-shb.nextcloud.backup.hooks.before_backup": [ "services-nextcloudserver-options-shb.nextcloud.backup.hooks.beforeBackup": [
"services-nextcloud.html#services-nextcloudserver-options-shb.nextcloud.backup.hooks.before_backup" "services-nextcloud.html#services-nextcloudserver-options-shb.nextcloud.backup.hooks.beforeBackup"
], ],
"services-nextcloudserver-options-shb.nextcloud.backup.sourceDirectories": [ "services-nextcloudserver-options-shb.nextcloud.backup.sourceDirectories": [
"services-nextcloud.html#services-nextcloudserver-options-shb.nextcloud.backup.sourceDirectories" "services-nextcloud.html#services-nextcloudserver-options-shb.nextcloud.backup.sourceDirectories"
@ -1481,11 +1481,11 @@
"services-vaultwarden-options-shb.vaultwarden.backup.hooks": [ "services-vaultwarden-options-shb.vaultwarden.backup.hooks": [
"services-vaultwarden.html#services-vaultwarden-options-shb.vaultwarden.backup.hooks" "services-vaultwarden.html#services-vaultwarden-options-shb.vaultwarden.backup.hooks"
], ],
"services-vaultwarden-options-shb.vaultwarden.backup.hooks.after_backup": [ "services-vaultwarden-options-shb.vaultwarden.backup.hooks.afterBackup": [
"services-vaultwarden.html#services-vaultwarden-options-shb.vaultwarden.backup.hooks.after_backup" "services-vaultwarden.html#services-vaultwarden-options-shb.vaultwarden.backup.hooks.afterBackup"
], ],
"services-vaultwarden-options-shb.vaultwarden.backup.hooks.before_backup": [ "services-vaultwarden-options-shb.vaultwarden.backup.hooks.beforeBackup": [
"services-vaultwarden.html#services-vaultwarden-options-shb.vaultwarden.backup.hooks.before_backup" "services-vaultwarden.html#services-vaultwarden-options-shb.vaultwarden.backup.hooks.beforeBackup"
], ],
"services-vaultwarden-options-shb.vaultwarden.backup.sourceDirectories": [ "services-vaultwarden-options-shb.vaultwarden.backup.sourceDirectories": [
"services-vaultwarden.html#services-vaultwarden-options-shb.vaultwarden.backup.sourceDirectories" "services-vaultwarden.html#services-vaultwarden-options-shb.vaultwarden.backup.sourceDirectories"

12
modules/blocks/borgbackup.nix
View file

@ -90,13 +90,13 @@ let
default = {}; default = {};
type = lib.types.submodule { type = lib.types.submodule {
options = { options = {
before_backup = lib.mkOption { beforeBackup = lib.mkOption {
description = "Hooks to run before backup"; description = "Hooks to run before backup";
type = lib.types.listOf lib.types.str; type = lib.types.listOf lib.types.str;
default = []; default = [];
}; };
after_backup = lib.mkOption { afterBackup = lib.mkOption {
description = "Hooks to run after backup"; description = "Hooks to run after backup";
type = lib.types.listOf lib.types.str; type = lib.types.listOf lib.types.str;
default = []; default = [];
@ -279,11 +279,11 @@ in
lib.attrsets.mapAttrsToList mkCheck instance.consistency; lib.attrsets.mapAttrsToList mkCheck instance.consistency;
# hooks = lib.mkMerge [ # hooks = lib.mkMerge [
# lib.optionalAttrs (builtins.length instance.hooks.before_backup > 0) { # lib.optionalAttrs (builtins.length instance.hooks.beforeBackup > 0) {
# inherit (instance.hooks) before_backup; # inherit (instance.hooks) beforeBackup;
# } # }
# lib.optionalAttrs (builtins.length instance.hooks.after_backup > 0) { # lib.optionalAttrs (builtins.length instance.hooks.afterBackup > 0) {
# inherit (instance.hooks) after_backup; # inherit (instance.hooks) afterBackup;
# } # }
# ]; # ];
}; };

4
modules/blocks/restic.nix
View file

@ -272,9 +272,9 @@ in
"--${builtins.replaceStrings ["_"] ["-"] name} ${builtins.toString value}" "--${builtins.replaceStrings ["_"] ["-"] name} ${builtins.toString value}"
) instance.settings.retention; ) instance.settings.retention;
backupPrepareCommand = concatStringsSep "\n" instance.request.hooks.before_backup; backupPrepareCommand = concatStringsSep "\n" instance.request.hooks.beforeBackup;
backupCleanupCommand = concatStringsSep "\n" instance.request.hooks.after_backup; backupCleanupCommand = concatStringsSep "\n" instance.request.hooks.afterBackup;
extraBackupArgs = extraBackupArgs =
(optionals (instance.settings.limitUploadKiBs != null) [ (optionals (instance.settings.limitUploadKiBs != null) [

4
modules/contracts/backup.nix
View file

@ -29,13 +29,13 @@ in
default = {}; default = {};
type = submodule { type = submodule {
options = { options = {
before_backup = mkOption { beforeBackup = mkOption {
description = "Hooks to run before backup."; description = "Hooks to run before backup.";
type = listOf str; type = listOf str;
default = []; default = [];
}; };
after_backup = mkOption { afterBackup = mkOption {
description = "Hooks to run after backup."; description = "Hooks to run after backup.";
type = listOf str; type = listOf str;
default = []; default = [];

2
test/blocks/restic.nix
View file

@ -69,7 +69,7 @@ let
"/opt/files/B" "/opt/files/B"
]; ];
hooks.before_backup = ['' hooks.beforeBackup = [''
echo $RUNTIME_DIRECTORY echo $RUNTIME_DIRECTORY
if [ "$RUNTIME_DIRECTORY" = /run/restic-backups-testinstance_opt_repos_A ]; then if [ "$RUNTIME_DIRECTORY" = /run/restic-backups-testinstance_opt_repos_A ]; then
if ! [ -f /run/secrets_restic/restic-backups-testinstance_opt_repos_A ]; then if ! [ -f /run/secrets_restic/restic-backups-testinstance_opt_repos_A ]; then