yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

clan.core.state: wrap all commands in shell scripts

Browse Source 
Otherwise we cannot execute them via ssh and also have nix store
dependencies.
This commit is contained in:
Jörg Thalheim
2024-06-19 11:42:14 +02:00
parent 117aed49e3
commit ef9ed1ebea
6 changed files with 117 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
nixosModules/clanCore/state.nix
View File

@@ -1,18 +1,20 @@
{ lib, ... }:
{
# defaults
config.clan.core.state.HOME.folders = [ "/home" ];
lib,
pkgs,
config,
...
}:
{
# interface
options.clan.core.state = lib.mkOption {
default = { };
type = lib.types.attrsOf (
lib.types.submodule (
{ name, ... }:
{ name, config, ... }:
{
options = {
name = lib.mkOption {
type = lib.types.str;
type = lib.types.strMatching "^[a-zA-Z0-9_-]+$";
default = name;
description = ''
Name of the state
@@ -24,8 +26,9 @@
Folder where state resides in
'';
};
preBackupCommand = lib.mkOption {
type = lib.types.nullOr lib.types.str;
preBackupScript = lib.mkOption {
type = lib.types.nullOr lib.types.lines;
default = null;
description = ''
script to run before backing up the state dir
@@ -34,6 +37,15 @@
'';
};
preBackupCommand = lib.mkOption {
type = lib.types.nullOr lib.types.str;
default = if config.preBackupScript == null then null else "pre-backup-${name}";
readOnly = true;
description = ''
Use this command in backup providers. It contains the content of preBackupScript.
'';
};
# TODO: implement this
#stopOnRestore = lib.mkOption {
# type = lib.types.listOf lib.types.str;
@@ -45,8 +57,8 @@
# '';
#};
preRestoreCommand = lib.mkOption {
type = lib.types.nullOr lib.types.str;
preRestoreScript = lib.mkOption {
type = lib.types.nullOr lib.types.lines;
default = null;
description = ''
script to run before restoring the state dir from a backup
@@ -55,8 +67,18 @@
'';
};
postRestoreCommand = lib.mkOption {
preRestoreCommand = lib.mkOption {
type = lib.types.nullOr lib.types.str;
default = if config.preRestoreScript == null then null else "pre-restore-${name}";
readOnly = true;
description = ''
This command can be called to restore the state dir from a backup.
It contains the content of preRestoreScript.
'';
};
postRestoreScript = lib.mkOption {
type = lib.types.nullOr lib.types.lines;
default = null;
description = ''
script to restore the service after the state dir was restored from a backup
@@ -64,9 +86,47 @@
Utilize this to start services which were previously stopped
'';
};
postRestoreCommand = lib.mkOption {
type = lib.types.nullOr lib.types.str;
default = if config.postRestoreScript == null then null else "post-restore-${name}";
readOnly = true;
description = ''
This command is called after a restore of the state dir from a backup.
It contains the content of postRestoreScript.
'';
};
};
}
)
);
};
# defaults
config.clan.core.state.HOME.folders = [ "/home" ];
config.environment.systemPackages = lib.optional (config.clan.core.state != { }) (
pkgs.runCommand "state-commands" { } ''
${builtins.concatStringsSep "\n" (
builtins.map (state: ''
writeShellScript() {
local name=$1
local content=$2
printf "#!${pkgs.runtimeShell}\nset -eu -o pipefail\n%s" "$content" > $out/bin/$name
}
mkdir -p $out/bin/
${lib.optionalString (state.preBackupCommand != null) ''
writeShellScript ${lib.escapeShellArg state.preBackupCommand} ${lib.escapeShellArg state.preBackupScript}
''}
${lib.optionalString (state.preRestoreCommand != null) ''
writeShellScript ${lib.escapeShellArg state.preRestoreCommand} ${lib.escapeShellArg state.preRestoreScript}
''}
${lib.optionalString (state.postRestoreCommand != null) ''
writeShellScript ${lib.escapeShellArg state.postRestoreCommand} ${lib.escapeShellArg state.postRestoreScript}
''}
find $out/bin/ -type f -print0 | xargs --no-run-if-empty -0 chmod 755
'') (builtins.attrValues config.clan.core.state)
)}
''
);
}