From d0c86650424ae60209767a90d5c93012c95b0fec Mon Sep 17 00:00:00 2001 From: Philipp Herzog Date: Wed, 14 Sep 2022 12:38:08 +0200 Subject: Add option to build on the remote host --- README.md | 5 ++ src/cli.rs | 13 ++-- src/data.rs | 2 + src/lib.rs | 13 ++-- src/push.rs | 194 ++++++++++++++++++++++++++++++++++++++++++------------------ 5 files changed, 158 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index c06bd49..5ba6e8a 100644 --- a/README.md +++ b/README.md @@ -183,6 +183,11 @@ This is a set of options that can be put in any of the above definitions, with t # If not specified, this will default to `/tmp` # (if `magicRollback` is in use, this _must_ be writable by `user`) tempPath = "/home/someuser/.deploy-rs"; + + # Build the derivation on the target system. + # Will also fetch all external dependencies from the target system's substituters. + # This default to `false` + remoteBuild = true; } ``` diff --git a/src/cli.rs b/src/cli.rs index a32f8c5..08633d8 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -56,6 +56,10 @@ pub struct Opts { #[clap(short, long)] skip_checks: bool, + /// Build on remote host + #[clap(long)] + remote_build: bool, + /// Override the SSH user with the given value #[clap(long)] ssh_user: Option, @@ -138,9 +142,7 @@ async fn check_deployment( .arg(format!("let r = import {}/.; x = (if builtins.isFunction r then (r {{}}) else r); in if x ? checks then x.checks.${{builtins.currentSystem}} else {{}}", repo)); } - for extra_arg in extra_build_args { - check_command.arg(extra_arg); - } + check_command.args(extra_build_args); let check_status = check_command.status().await?; @@ -239,9 +241,7 @@ async fn get_deployment_data( .arg(format!("let r = import {}/.; in if builtins.isFunction r then (r {{}}).deploy else r.deploy", flake.repo)) }; - for extra_arg in extra_build_args { - c.arg(extra_arg); - } + c.args(extra_build_args); let build_child = c .stdout(Stdio::piped()) @@ -640,6 +640,7 @@ pub async fn run(args: Option<&ArgMatches>) -> Result<(), RunError> { temp_path: opts.temp_path, confirm_timeout: opts.confirm_timeout, dry_activate: opts.dry_activate, + remote_build: opts.remote_build, sudo: opts.sudo, }; diff --git a/src/data.rs b/src/data.rs index b00a4d0..90ea331 100644 --- a/src/data.rs +++ b/src/data.rs @@ -30,6 +30,8 @@ pub struct GenericSettings { pub magic_rollback: Option, #[serde(rename(deserialize = "sudo"))] pub sudo: Option, + #[serde(default,rename(deserialize = "remoteBuild"))] + pub remote_build: Option, } #[derive(Deserialize, Debug, Clone)] diff --git a/src/lib.rs b/src/lib.rs index 39bc3aa..738fa81 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -163,6 +163,7 @@ pub struct CmdOverrides { pub confirm_timeout: Option, pub sudo: Option, pub dry_activate: bool, + pub remote_build: bool, } #[derive(PartialEq, Debug)] @@ -395,10 +396,10 @@ impl<'a> DeployData<'a> { } fn get_sudo(&'a self) -> String { - return match self.merged_settings.sudo { - Some(ref x) => x.clone(), - None => "sudo -u".to_string() - }; + match self.merged_settings.sudo { + Some(ref x) => x.clone(), + None => "sudo -u".to_string(), + } } } @@ -416,6 +417,10 @@ pub fn make_deploy_data<'a, 's>( merged_settings.merge(node.generic_settings.clone()); merged_settings.merge(top_settings.clone()); + // build all machines remotely when the command line flag is set + if cmd_overrides.remote_build { + merged_settings.remote_build = Some(cmd_overrides.remote_build); + } if cmd_overrides.ssh_user.is_some() { merged_settings.ssh_user = cmd_overrides.ssh_user.clone(); } diff --git a/src/push.rs b/src/push.rs index 69eba0d..0801bd9 100644 --- a/src/push.rs +++ b/src/push.rs @@ -41,6 +41,8 @@ pub enum PushProfileError { Copy(std::io::Error), #[error("Nix copy command resulted in a bad exit code: {0:?}")] CopyExit(Option), + #[error("The remote building option is not supported when using legacy nix")] + RemoteBuildWithLegacyNix, } pub struct PushProfileData<'a> { @@ -54,40 +56,7 @@ pub struct PushProfileData<'a> { pub extra_build_args: &'a [String], } -pub async fn push_profile(data: PushProfileData<'_>) -> Result<(), PushProfileError> { - debug!( - "Finding the deriver of store path for {}", - &data.deploy_data.profile.profile_settings.path - ); - - // `nix-store --query --deriver` doesn't work on invalid paths, so we parse output of show-derivation :( - let mut show_derivation_command = Command::new("nix"); - - show_derivation_command - .arg("show-derivation") - .arg(&data.deploy_data.profile.profile_settings.path); - - let show_derivation_output = show_derivation_command - .output() - .await - .map_err(PushProfileError::ShowDerivation)?; - - match show_derivation_output.status.code() { - Some(0) => (), - a => return Err(PushProfileError::ShowDerivationExit(a)), - }; - - let derivation_info: HashMap<&str, serde_json::value::Value> = serde_json::from_str( - std::str::from_utf8(&show_derivation_output.stdout) - .map_err(PushProfileError::ShowDerivationUtf8)?, - ) - .map_err(PushProfileError::ShowDerivationParse)?; - - let derivation_name = derivation_info - .keys() - .next() - .ok_or(PushProfileError::ShowDerivationEmpty)?; - +pub async fn build_profile_locally(data: &PushProfileData<'_>, derivation_name: &str) -> Result<(), PushProfileError> { info!( "Building profile `{}` for node `{}`", data.deploy_data.profile_name, data.deploy_data.node_name @@ -118,9 +87,7 @@ pub async fn push_profile(data: PushProfileData<'_>) -> Result<(), PushProfileEr (false, true) => build_command.arg("--no-link"), }; - for extra_arg in data.extra_build_args { - build_command.arg(extra_arg); - } + build_command.args(data.extra_build_args); let build_exit_status = build_command // Logging should be in stderr, this just stops the store path from printing for no reason @@ -179,22 +146,77 @@ pub async fn push_profile(data: PushProfileData<'_>) -> Result<(), PushProfileEr a => return Err(PushProfileError::SignExit(a)), }; } + Ok(()) +} +pub async fn build_profile_remotely(data: &PushProfileData<'_>, derivation_name: &str) -> Result<(), PushProfileError> { info!( - "Copying profile `{}` to node `{}`", + "Building profile `{}` for node `{}` on remote host", data.deploy_data.profile_name, data.deploy_data.node_name ); - let mut copy_command = Command::new("nix"); - copy_command.arg("copy"); + let store_address = format!("ssh-ng://{}@{}", + if data.deploy_data.profile.generic_settings.ssh_user.is_some() { + &data.deploy_data.profile.generic_settings.ssh_user.as_ref().unwrap() + } else { + &data.deploy_defs.ssh_user + }, + data.deploy_data.node.node_settings.hostname + ); - if data.deploy_data.merged_settings.fast_connection != Some(true) { - copy_command.arg("--substitute-on-destination"); - } + let ssh_opts_str = data.deploy_data.merged_settings.ssh_opts.join(" "); - if !data.check_sigs { - copy_command.arg("--no-check-sigs"); - } + + // copy the derivation to remote host so it can be built there + let copy_command_status = Command::new("nix").arg("copy") + .arg("-s") // fetch dependencies from substitures, not localhost + .arg("--to").arg(&store_address) + .arg("--derivation").arg(derivation_name) + .env("NIX_SSHOPTS", ssh_opts_str.clone()) + .stdout(Stdio::null()) + .status() + .await + .map_err(PushProfileError::Copy)?; + + match copy_command_status.code() { + Some(0) => (), + a => return Err(PushProfileError::CopyExit(a)), + }; + + let mut build_command = Command::new("nix"); + build_command + .arg("build").arg(derivation_name) + .arg("--eval-store").arg("auto") + .arg("--store").arg(&store_address) + .args(data.extra_build_args) + .env("NIX_SSHOPTS", ssh_opts_str.clone()); + + debug!("build command: {:?}", build_command); + + let build_exit_status = build_command + // Logging should be in stderr, this just stops the store path from printing for no reason + .stdout(Stdio::null()) + .status() + .await + .map_err(PushProfileError::Build)?; + + match build_exit_status.code() { + Some(0) => (), + a => return Err(PushProfileError::BuildExit(a)), + }; + + + Ok(()) +} + +pub async fn push_profile(data: PushProfileData<'_>) -> Result<(), PushProfileError> { + debug!( + "Finding the deriver of store path for {}", + &data.deploy_data.profile.profile_settings.path + ); + + // `nix-store --query --deriver` doesn't work on invalid paths, so we parse output of show-derivation :( + let mut show_derivation_command = Command::new("nix"); let ssh_opts_str = data .deploy_data @@ -206,24 +228,78 @@ pub async fn push_profile(data: PushProfileData<'_>) -> Result<(), PushProfileEr // .collect::>() .join(" "); - let hostname = match data.deploy_data.cmd_overrides.hostname { - Some(ref x) => x, - None => &data.deploy_data.node.node_settings.hostname, - }; - let copy_exit_status = copy_command - .arg("--to") - .arg(format!("ssh://{}@{}", data.deploy_defs.ssh_user, hostname)) - .arg(&data.deploy_data.profile.profile_settings.path) - .env("NIX_SSHOPTS", ssh_opts_str) - .status() + show_derivation_command + .arg("show-derivation") + .arg(&data.deploy_data.profile.profile_settings.path); + + let show_derivation_output = show_derivation_command + .output() .await - .map_err(PushProfileError::Copy)?; + .map_err(PushProfileError::ShowDerivation)?; - match copy_exit_status.code() { + match show_derivation_output.status.code() { Some(0) => (), - a => return Err(PushProfileError::CopyExit(a)), + a => return Err(PushProfileError::ShowDerivationExit(a)), }; + let derivation_info: HashMap<&str, serde_json::value::Value> = serde_json::from_str( + std::str::from_utf8(&show_derivation_output.stdout) + .map_err(PushProfileError::ShowDerivationUtf8)?, + ) + .map_err(PushProfileError::ShowDerivationParse)?; + + let derivation_name = derivation_info + .keys() + .next() + .ok_or(PushProfileError::ShowDerivationEmpty)?; + + if data.deploy_data.merged_settings.remote_build.unwrap_or(false) { + if !data.supports_flakes { + return Err(PushProfileError::RemoteBuildWithLegacyNix) + } + + // remote building guarantees that the resulting derivation is stored on the target system + // no need to copy after building + build_profile_remotely(&data, derivation_name).await?; + } else { + build_profile_locally(&data, derivation_name).await?; + + info!( + "Copying profile `{}` to node `{}`", + data.deploy_data.profile_name, data.deploy_data.node_name + ); + + let mut copy_command = Command::new("nix"); + copy_command.arg("copy"); + + if data.deploy_data.merged_settings.fast_connection != Some(true) { + copy_command.arg("--substitute-on-destination"); + } + + if !data.check_sigs { + copy_command.arg("--no-check-sigs"); + } + + let hostname = match data.deploy_data.cmd_overrides.hostname { + Some(ref x) => x, + None => &data.deploy_data.node.node_settings.hostname, + }; + + let copy_exit_status = copy_command + .arg("--to") + .arg(format!("ssh://{}@{}", data.deploy_defs.ssh_user, hostname)) + .arg(&data.deploy_data.profile.profile_settings.path) + .env("NIX_SSHOPTS", ssh_opts_str) + .status() + .await + .map_err(PushProfileError::Copy)?; + + match copy_exit_status.code() { + Some(0) => (), + a => return Err(PushProfileError::CopyExit(a)), + }; + } + Ok(()) } -- cgit v1.2.3