From 2e7355ff13a58347ff3ddc1139413b89ea313bf9 Mon Sep 17 00:00:00 2001 From: Alex Brandt Date: Sun, 21 Jul 2019 08:28:34 -0700 Subject: [PATCH 1/3] pythonPackages.stringcase: init at version 1.2.0 Needed by zfs-replicate. --- .../python-modules/stringcase/default.nix | 22 +++++++++++++++++++ pkgs/top-level/python-packages.nix | 2 ++ 2 files changed, 24 insertions(+) create mode 100644 pkgs/development/python-modules/stringcase/default.nix diff --git a/pkgs/development/python-modules/stringcase/default.nix b/pkgs/development/python-modules/stringcase/default.nix new file mode 100644 index 000000000000..79f05f9b72d6 --- /dev/null +++ b/pkgs/development/python-modules/stringcase/default.nix @@ -0,0 +1,22 @@ +{ buildPythonPackage, fetchPypi, stdenv +}: + +buildPythonPackage rec { + pname = "stringcase"; + version = "1.2.0"; + + src = fetchPypi { + inherit pname version; + sha256 = "023hv3gknblhf9lx5kmkcchzmbhkdhmsnknkv7lfy20rcs06k828"; + }; + + # PyPi package does not include tests. + doCheck = false; + + meta = with stdenv.lib; { + homepage = https://github.com/okunishinishi/python-stringcase; + description = "Convert string cases between camel case, pascal case, snake case etc…"; + license = licenses.mit; + maintainers = with maintainers; [ alunduil ]; + }; +} diff --git a/pkgs/top-level/python-packages.nix b/pkgs/top-level/python-packages.nix index 180de8ed8a5b..e7c646802176 100644 --- a/pkgs/top-level/python-packages.nix +++ b/pkgs/top-level/python-packages.nix @@ -6075,6 +6075,8 @@ in { pydantic = callPackage ../development/python-modules/pydantic { }; fastapi = callPackage ../development/python-modules/fastapi { }; + + stringcase = callPackage ../development/python-modules/stringcase { }; }); in fix' (extends overrides packages) From 29bdb1c67253054982448f6c4e8bc3d5c5ee3c8a Mon Sep 17 00:00:00 2001 From: Alex Brandt Date: Sun, 21 Jul 2019 08:29:39 -0700 Subject: [PATCH 2/3] zfs-replicate: init at 1.1.11 Used by zfs.autoReplication module. --- pkgs/tools/backup/zfs-replicate/default.nix | 42 +++++++++++++++++++++ pkgs/top-level/all-packages.nix | 2 + 2 files changed, 44 insertions(+) create mode 100644 pkgs/tools/backup/zfs-replicate/default.nix diff --git a/pkgs/tools/backup/zfs-replicate/default.nix b/pkgs/tools/backup/zfs-replicate/default.nix new file mode 100644 index 000000000000..83fa76b0800e --- /dev/null +++ b/pkgs/tools/backup/zfs-replicate/default.nix @@ -0,0 +1,42 @@ +{ buildPythonApplication, click, fetchPypi, hypothesis, mypy, pytest +, pytestcov, pytestrunner, stdenv, stringcase +}: + +buildPythonApplication rec { + pname = "zfs-replicate"; + version = "1.1.11"; + + src = fetchPypi { + inherit pname version; + sha256 = "0386xc6rw6bhzw2a08g90afb3snqhm1ikx65bjfh22ha69fwmga8"; + }; + + checkInputs = [ + hypothesis + mypy + pytest + pytestcov + ]; + + buildInputs = [ + pytestrunner + ]; + + propagatedBuildInputs = [ + click + stringcase + ]; + + doCheck = true; + + checkPhase = '' + pytest --doctest-modules + ''; + + meta = with stdenv.lib; { + homepage = https://github.com/alunduil/zfs-replicate; + description = "ZFS Snapshot Replication"; + license = licenses.bsd2; + maintainers = with maintainers; [ alunduil ]; + }; +} diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index 1d4295586fa2..8f781dae9c35 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -24563,4 +24563,6 @@ in dapper = callPackage ../development/tools/dapper { }; kube3d = callPackage ../applications/networking/cluster/kube3d {}; + + zfs-replicate = python3Packages.callPackage ../tools/backup/zfs-replicate { }; } From bdd7b5a3abbc6f826f608dd68f5c0ed18fcff9cb Mon Sep 17 00:00:00 2001 From: Alex Brandt Date: Thu, 25 Jul 2019 21:30:59 -0700 Subject: [PATCH 3/3] nixos/zfs: add autoReplication functionality This adds a simple configuration for sending snapshots to a remote system using zfs-replicate that ties into the autoSnapshot settings already present in services.zfs.autoSnapshot. --- .../services/backup/zfs-replication.nix | 90 +++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 nixos/modules/services/backup/zfs-replication.nix diff --git a/nixos/modules/services/backup/zfs-replication.nix b/nixos/modules/services/backup/zfs-replication.nix new file mode 100644 index 000000000000..785cedb98694 --- /dev/null +++ b/nixos/modules/services/backup/zfs-replication.nix @@ -0,0 +1,90 @@ +{ lib, pkgs, config, ... }: + +with lib; + +let + cfg = config.services.zfs.autoReplication; + recursive = optionalString cfg.recursive " --recursive"; + followDelete = optionalString cfg.followDelete " --follow-delete"; +in { + options = { + services.zfs.autoReplication = { + enable = mkEnableOption "ZFS snapshot replication."; + + followDelete = mkOption { + description = "Remove remote snapshots that don't have a local correspondant."; + default = true; + type = types.bool; + }; + + host = mkOption { + description = "Remote host where snapshots should be sent."; + example = "example.com"; + type = types.str; + }; + + identityFilePath = mkOption { + description = "Path to SSH key used to login to host."; + example = "/home/username/.ssh/id_rsa"; + type = types.path; + }; + + localFilesystem = mkOption { + description = "Local ZFS fileystem from which snapshots should be sent. Defaults to the attribute name."; + example = "pool/file/path"; + type = types.str; + }; + + remoteFilesystem = mkOption { + description = "Remote ZFS filesystem where snapshots should be sent."; + example = "pool/file/path"; + type = types.str; + }; + + recursive = mkOption { + description = "Recursively discover snapshots to send."; + default = true; + type = types.bool; + }; + + username = mkOption { + description = "Username used by SSH to login to remote host."; + example = "username"; + type = types.str; + }; + }; + }; + + config = lib.mkIf cfg.enable { + environment.systemPackages = [ + pkgs.lz4 + ]; + + systemd.services."zfs-replication" = { + after = [ + "zfs-snapshot-daily.service" + "zfs-snapshot-frequent.service" + "zfs-snapshot-hourly.service" + "zfs-snapshot-monthly.service" + "zfs-snapshot-weekly.service" + ]; + description = "ZFS Snapshot Replication"; + documentation = [ + "https://github.com/alunduil/zfs-replicate" + ]; + restartIfChanged = false; + serviceConfig.ExecStart = "${pkgs.zfs-replicate}/bin/zfs-replicate${recursive} -l ${escapeShellArg cfg.username} -i ${escapeShellArg cfg.identityFilePath}${followDelete} ${escapeShellArg cfg.host} ${escapeShellArg cfg.remoteFilesystem} ${escapeShellArg cfg.localFilesystem}"; + wantedBy = [ + "zfs-snapshot-daily.service" + "zfs-snapshot-frequent.service" + "zfs-snapshot-hourly.service" + "zfs-snapshot-monthly.service" + "zfs-snapshot-weekly.service" + ]; + }; + }; + + meta = { + maintainers = with lib.maintainers; [ alunduil ]; + }; +}