From a3bda5c49b034e5499ba24afc13a45be528a645e Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Mon, 9 Aug 2021 13:29:29 +0200 Subject: README: use latest krops version in example Signed-off-by: Matthias Beyer --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d696c5e..d11e315 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ Create a file named `krops.nix` (name doesn't matter) with following content: let krops = (import {}).fetchgit { url = https://cgit.krebsco.de/krops/; - rev = "v1.17.0"; - sha256 = "150jlz0hlb3ngf9a1c9xgcwzz1zz8v2lfgnzw08l3ajlaaai8smd"; + rev = "v1.25.0"; + sha256 = "07mg3iaqjf1w49vmwfchi7b1w55bh7rvsbgicp2m47gnj9alwdb6"; }; lib = import "${krops}/lib"; -- cgit v1.2.3 From c1b24328c42adc64983c18a718fd0a4cb0b9aeee Mon Sep 17 00:00:00 2001 From: lassulus Date: Mon, 25 Oct 2021 16:05:12 +0200 Subject: krops writeDeploy: deprecate fast parameter --- pkgs/krops/default.nix | 48 +++++++++++++++++++----------------------------- 1 file changed, 19 insertions(+), 29 deletions(-) diff --git a/pkgs/krops/default.nix b/pkgs/krops/default.nix index 8336b51..d773052 100644 --- a/pkgs/krops/default.nix +++ b/pkgs/krops/default.nix @@ -4,14 +4,6 @@ in { nix, openssh, populate, writers }: rec { - build = target: - runShell target (lib.concatStringsSep " " [ - "nix build" - "-I ${lib.escapeShellArg target.path}" - "--no-link -f ''" - "config.system.build.toplevel" - ]); - rebuild = args: target: runShell target "nixos-rebuild -I ${lib.escapeShellArg target.path} ${ lib.concatMapStringsSep " " lib.escapeShellArg args @@ -53,7 +45,7 @@ in backup ? false, buildTarget ? null, crossDeploy ? false, - fast ? false, + fast ? null, force ? false, source, target @@ -64,26 +56,24 @@ in else lib.mkTarget buildTarget; target' = lib.mkTarget target; in - writers.writeDash name '' - set -efu - ${lib.optionalString (buildTarget' != target') - (populate { inherit backup force source; target = buildTarget'; })} - ${populate { inherit backup force source; target = target'; }} - ${lib.optionalString (! fast) '' - ${rebuild ["dry-build"] buildTarget'} - ${build buildTarget'} - ''} - ${rebuild ([ - "switch" - ] ++ lib.optionals crossDeploy [ - "--no-build-nix" - ] ++ lib.optionals (buildTarget' != target') [ - "--build-host" "${buildTarget'.user}@${buildTarget'.host}" - "--target-host" "${target'.user}@${target'.host}" - ] ++ lib.optionals target'.sudo [ - "--use-remote-sudo" - ]) buildTarget'} - ''; + lib.traceIf (fast != null) "writeDeploy: it's now always fast, setting the `fast` attribute is deprecated and will be removed in future" ( + writers.writeDash name '' + set -efu + ${lib.optionalString (buildTarget' != target') + (populate { inherit backup force source; target = buildTarget'; })} + ${populate { inherit backup force source; target = target'; }} + ${rebuild ([ + "switch" + ] ++ lib.optionals crossDeploy [ + "--no-build-nix" + ] ++ lib.optionals (buildTarget' != target') [ + "--build-host" "${buildTarget'.user}@${buildTarget'.host}" + "--target-host" "${target'.user}@${target'.host}" + ] ++ lib.optionals target'.sudo [ + "--use-remote-sudo" + ]) buildTarget'} + '' + ); writeTest = name: { backup ? false, -- cgit v1.2.3 From d80cb74c7400962b08e77ff06153ace419693505 Mon Sep 17 00:00:00 2001 From: lassulus Date: Sat, 27 Mar 2021 20:25:31 +0100 Subject: runShell/writeCommand: add allocateTTY argument --- README.md | 4 ++++ pkgs/krops/default.nix | 11 +++++++---- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d11e315..a412ee1 100644 --- a/README.md +++ b/README.md @@ -185,6 +185,10 @@ pkgs.krops.writeCommand "deploy-with-swap" { [see `writeDeploy`](#writeDeploy) +### `allocateTTY` (optional, defaults to false) + +whether the ssh session should do a pseudo-terminal allocation. +sets `-t` on the ssh command. ## Source Types diff --git a/pkgs/krops/default.nix b/pkgs/krops/default.nix index d773052..d092307 100644 --- a/pkgs/krops/default.nix +++ b/pkgs/krops/default.nix @@ -5,11 +5,13 @@ in { nix, openssh, populate, writers }: rec { rebuild = args: target: - runShell target "nixos-rebuild -I ${lib.escapeShellArg target.path} ${ + runShell target {} "nixos-rebuild -I ${lib.escapeShellArg target.path} ${ lib.concatMapStringsSep " " lib.escapeShellArg args }"; - runShell = target: command: + runShell = target: { + allocateTTY ? false + }: command: let command' = if target.sudo then "sudo ${command}" else command; in @@ -20,7 +22,7 @@ in exec ${openssh}/bin/ssh ${lib.escapeShellArgs (lib.flatten [ (lib.optionals (target.user != "") ["-l" target.user]) "-p" target.port - "-T" + (if allocateTTY then "-t" else "-T") target.extraOptions target.host command'])} @@ -30,6 +32,7 @@ in command ? (targetPath: "echo ${targetPath}"), backup ? false, force ? false, + allocateTTY ? false, source, target }: let @@ -38,7 +41,7 @@ in writers.writeDash name '' set -efu ${populate { inherit backup force source; target = target'; }} - ${runShell target' (command target'.path)} + ${runShell target' { inherit allocateTTY; } (command target'.path)} ''; writeDeploy = name: { -- cgit v1.2.3 From 0fc8f1b2a64c61fed3c71ef7edbe57a9f3e2af64 Mon Sep 17 00:00:00 2001 From: tv Date: Tue, 26 Oct 2021 12:48:22 +0200 Subject: populate: add rsyncDefaultConfig --- pkgs/populate/default.nix | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/pkgs/populate/default.nix b/pkgs/populate/default.nix index 517b12e..d86d949 100644 --- a/pkgs/populate/default.nix +++ b/pkgs/populate/default.nix @@ -45,8 +45,8 @@ let ''; pop.file = target: source: let - configAttrs = ["useChecksum" "exclude" "filters" "deleteExcluded"]; - config = filterAttrs (name: _: elem name configAttrs) source; + config = rsyncDefaultConfig // sourceConfig; + sourceConfig = getAttrs (attrNames rsyncDefaultConfig) source; in rsync' target config (quote source.path); @@ -144,7 +144,7 @@ let echo "$local_pass_info" > "$tmp_dir"/.pass_info fi - ${rsync' target {} /* sh */ "$tmp_dir"} + ${rsync' target rsyncDefaultConfig /* sh */ "$tmp_dir"} ''; pop.pipe = target: source: /* sh */ '' @@ -172,17 +172,17 @@ let source_path=$source_path/ fi ${rsync}/bin/rsync \ - ${optionalString (config.useChecksum or false) /* sh */ "--checksum"} \ + ${optionalString config.useChecksum /* sh */ "--checksum"} \ ${optionalString target.sudo /* sh */ "--rsync-path=\"sudo rsync\""} \ ${concatMapStringsSep " " (pattern: /* sh */ "--exclude ${quote pattern}") - (config.exclude or [])} \ + config.exclude} \ ${concatMapStringsSep " " (filter: /* sh */ "--${filter.type} ${quote filter.pattern}") - (config.filters or [])} \ + config.filters} \ -e ${quote (ssh' target)} \ -vFrlptD \ - ${optionalString (config.deleteExcluded or true) /* sh */ "--delete-excluded"} \ + ${optionalString config.deleteExcluded /* sh */ "--delete-excluded"} \ "$source_path" \ ${quote ( optionalString (!isLocalTarget target) ( @@ -194,6 +194,13 @@ let >&2 ''; + rsyncDefaultConfig = { + useChecksum = false; + exclude = []; + filters = []; + deleteExcluded = true + }; + runShell = target: command: if isLocalTarget target then command -- cgit v1.2.3 From bdce88820baac0e9ebc5c660a8b1d009c14c357f Mon Sep 17 00:00:00 2001 From: tv Date: Tue, 26 Oct 2021 13:06:03 +0200 Subject: README: talk about systems --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a412ee1..74b6c4b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ krops is a lightweight toolkit to deploy NixOS systems, remotely or locally. ## Some Features - store your secrets in [password store](https://www.passwordstore.org/) -- build your system remotely +- build your systems remotely - minimal overhead (it's basically just `nixos-rebuild switch`!) - run from custom nixpkgs branch/checkout/fork -- cgit v1.2.3 From 53eda9cafee46a506053099c6ced393aa5675f86 Mon Sep 17 00:00:00 2001 From: tv Date: Tue, 26 Oct 2021 13:07:07 +0200 Subject: README: transfered -> transferred --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 74b6c4b..e9b15b3 100644 --- a/README.md +++ b/README.md @@ -210,7 +210,7 @@ using [`rsync`](https://rsync.samba.org/). Supported attributes: * `path` - - absolute path to files that should by transfered + absolute path to files that should by transferred. * `useChecksum` (optional) - boolean that controls whether file contents should be checked to decide -- cgit v1.2.3 From 6ef8900af4bca2901f00c718e3ac8ba457348451 Mon Sep 17 00:00:00 2001 From: tv Date: Tue, 26 Oct 2021 13:05:49 +0200 Subject: populate file: admit derivations --- README.md | 2 ++ ci.nix | 4 ++-- lib/types/populate.nix | 8 ++++++-- pkgs/populate/default.nix | 19 +++++++++++++++---- 4 files changed, 25 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e9b15b3..d868768 100644 --- a/README.md +++ b/README.md @@ -217,6 +217,8 @@ Supported attributes: whether a file has changed. This is useful when `path` points at files with mangled timestamps, e.g. the Nix store. + The default value is `true` if `path` is a derivation, and `false` otherwise. + * `filters` (optional) List of filters that should be passed to [`rsync`](https://rsync.samba.org/). Filters are specified as attribute sets with the attributes `type` and diff --git a/ci.nix b/ci.nix index 258a4e6..c57f4d7 100644 --- a/ci.nix +++ b/ci.nix @@ -5,7 +5,7 @@ let pkgs = import "${krops}/pkgs" {}; source = lib.evalSource [{ - nixos-config.file = toString (pkgs.writeText "nixos-config" '' + nixos-config.file = pkgs.writeText "nixos-config" '' { pkgs, ... }: { fileSystems."/" = { device = "/dev/sda1"; }; @@ -13,7 +13,7 @@ let services.openssh.enable = true; environment.systemPackages = [ pkgs.git ]; } - ''); + ''; nixpkgs.symlink = toString ; }]; in { diff --git a/lib/types/populate.nix b/lib/types/populate.nix index 894b8cc..18b5cd8 100644 --- a/lib/types/populate.nix +++ b/lib/types/populate.nix @@ -21,11 +21,15 @@ }; file = lib.mkOption { apply = x: - if lib.types.absolute-pathname.check x + if lib.types.absolute-pathname.check x || lib.types.package.check x then { path = x; } else x; default = null; - type = lib.types.nullOr (lib.types.either lib.types.absolute-pathname source-types.file); + type = lib.types.nullOr (lib.types.oneOf [ + lib.types.absolute-pathname + lib.types.package + source-types.file + ]); }; git = lib.mkOption { default = null; diff --git a/pkgs/populate/default.nix b/pkgs/populate/default.nix index d86d949..3be1932 100644 --- a/pkgs/populate/default.nix +++ b/pkgs/populate/default.nix @@ -45,10 +45,21 @@ let ''; pop.file = target: source: let - config = rsyncDefaultConfig // sourceConfig; - sourceConfig = getAttrs (attrNames rsyncDefaultConfig) source; + config = rsyncDefaultConfig // derivedConfig // sourceConfig; + derivedConfig = { + useChecksum = + if isDerivation source.path + then true + else rsyncDefaultConfig.useChecksum; + }; + sourceConfig = + filterAttrs (name: _: elem name (attrNames rsyncDefaultConfig)) source; + sourcePath = + if isDerivation source.path + then quote (toString source.path) + else quote source.path; in - rsync' target config (quote source.path); + rsync' target config sourcePath; pop.git = target: source: runShell target /* sh */ '' set -efu @@ -198,7 +209,7 @@ let useChecksum = false; exclude = []; filters = []; - deleteExcluded = true + deleteExcluded = true; }; runShell = target: command: -- cgit v1.2.3 From 05f0d3b5c1d38fbbd53142362a7821cc8bc1150a Mon Sep 17 00:00:00 2001 From: tv Date: Tue, 26 Oct 2021 19:36:12 +0200 Subject: populate file: isDerivation -> isStorePath --- pkgs/populate/default.nix | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkgs/populate/default.nix b/pkgs/populate/default.nix index 3be1932..ee2e5db 100644 --- a/pkgs/populate/default.nix +++ b/pkgs/populate/default.nix @@ -48,14 +48,14 @@ let config = rsyncDefaultConfig // derivedConfig // sourceConfig; derivedConfig = { useChecksum = - if isDerivation source.path + if isStorePath source.path then true else rsyncDefaultConfig.useChecksum; }; sourceConfig = filterAttrs (name: _: elem name (attrNames rsyncDefaultConfig)) source; sourcePath = - if isDerivation source.path + if isStorePath source.path then quote (toString source.path) else quote source.path; in -- cgit v1.2.3 From 9fc8cbf8e826d4c8a118f37202ab3f335341082a Mon Sep 17 00:00:00 2001 From: Erik Arvstedt Date: Fri, 19 Nov 2021 23:42:56 +0100 Subject: target: use default port from SSH config This is the expected behavior. The SSH config is also implicitly used for other SSH-related settings. --- lib/default.nix | 8 ++++++-- pkgs/krops/default.nix | 3 +-- pkgs/populate/default.nix | 3 +-- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/lib/default.nix b/lib/default.nix index 357f5b5..3bbd754 100644 --- a/lib/default.nix +++ b/lib/default.nix @@ -57,9 +57,9 @@ let { elemAt' = xs: i: if lib.length xs > i then lib.elemAt xs i else null; filterNull = lib.filterAttrs (n: v: v != null); in { - user = lib.getEnv "LOGNAME"; + user = lib.maybeEnv "LOGNAME" null; host = lib.maybeEnv "HOSTNAME" (lib.maybeHostName "localhost"); - port = "22"; + port = null; path = "/var/src"; sudo = false; extraOptions = []; @@ -70,6 +70,10 @@ let { path = elemAt' parse 6; } else s); + mkUserPortSSHOpts = target: + (lib.optionals (target.user != null) ["-l" target.user]) ++ + (lib.optionals (target.port != null) ["-p" target.port]); + shell = let isSafeChar = lib.testString "[-+./0-9:=A-Z_a-z]"; quoteChar = c: diff --git a/pkgs/krops/default.nix b/pkgs/krops/default.nix index d092307..7fe8370 100644 --- a/pkgs/krops/default.nix +++ b/pkgs/krops/default.nix @@ -20,8 +20,7 @@ in else writers.writeDash "krops.${target.host}.${lib.firstWord command}" '' exec ${openssh}/bin/ssh ${lib.escapeShellArgs (lib.flatten [ - (lib.optionals (target.user != "") ["-l" target.user]) - "-p" target.port + (lib.mkUserPortSSHOpts target) (if allocateTTY then "-t" else "-T") target.extraOptions target.host diff --git a/pkgs/populate/default.nix b/pkgs/populate/default.nix index ee2e5db..bf6f76d 100644 --- a/pkgs/populate/default.nix +++ b/pkgs/populate/default.nix @@ -224,8 +224,7 @@ let ssh' = target: concatMapStringsSep " " quote (flatten [ "${openssh}/bin/ssh" - (optionals (target.user != "") ["-l" target.user]) - "-p" target.port + (mkUserPortSSHOpts target) "-T" target.extraOptions ]); -- cgit v1.2.3