clan-core/nixosModules/clanCore/backups.nix

{ lib, ... }:
{
  options.clanCore.state = lib.mkOption {
    default = { };
    type = lib.types.attrsOf
      (lib.types.submodule ({ ... }: {
        options = {
          folders = lib.mkOption {
            type = lib.types.listOf lib.types.str;
            description = ''
              Folder where state resides in
            '';
          };
          preRestoreScript = lib.mkOption {
            type = lib.types.str;
            default = ":";
            description = ''
              script to run before restoring the state dir from a backup
            '';
          };
          postRestoreScript = lib.mkOption {
            type = lib.types.str;
            default = ":";
            description = ''
              script to restore the service after the state dir was restored from a backup
            '';
          };
        };
      }));
  };
  options.clanCore.backups = {
    providers = lib.mkOption {
      type = lib.types.attrsOf (lib.types.submodule ({ name, ... }: {
        options = {
          name = lib.mkOption {
            type = lib.types.str;
            default = name;
            description = ''
              Name of the backup provider
            '';
          };
          list = lib.mkOption {
            type = lib.types.str;
            description = ''
              script to list backups
            '';
          };
          restore = lib.mkOption {
            type = lib.types.str;
            description = ''
              script to restore a backup
              should take an optional service name as argument
            '';
          };
          start = lib.mkOption {
            type = lib.types.str;
            description = ''
              script to start a backup
            '';
          };
        };
      }));
      default = { };
      description = ''
        Configured backup providers which are used by this machine
      '';
    };
  };
}