Merge pull request #21 from jasonrm/machines-file

eval.nix: Adds meta.machinesFile option that is passed to Nix as builder option

README.md

@@ -54,6 +54,15 @@ Here is a sample `hive.nix` with two nodes, with some common configurations appl
     nodeNixpkgs = {
       node-b = ./another-nixos-checkout;
     };
+
+    # If your Colmena host has nix configured to allow for remote builds
+    # (for nix-daemon, your user being included in trusted-users)
+    # you can set a machines file that will be passed to the underlying
+    # nix-store command during derivation realization as a builders option.
+    # For example, if you support multiple orginizations each with their own
+    # build machine(s) you can ensure that builds only take place on your
+    # local machine and/or the machines specified in this file.
+    # machinesFile = ./machines.client-a;
   };
 
   defaults = { pkgs, ... }: {

src/command/apply.rs

@@ -121,6 +121,8 @@ pub async fn run(_global_args: &ArgMatches<'_>, local_args: &ArgMatches<'_>) {
     log::info!("Enumerating nodes...");
     let all_nodes = hive.deployment_info().await.unwrap();
 
+    let nix_options = hive.nix_options().await.unwrap();
+
     let selected_nodes = match local_args.value_of("on") {
         Some(filter) => {
             util::filter_nodes(&all_nodes, filter)
@@ -165,7 +167,7 @@ pub async fn run(_global_args: &ArgMatches<'_>, local_args: &ArgMatches<'_>) {
                 if build_only {
                     targets.insert(
                         node.clone(),
-                        Target::new(localhost(), config.clone()),
+                        Target::new(localhost(nix_options.clone()), config.clone()),
                     );
                 }
             }

src/command/apply_local.rs

@@ -100,13 +100,14 @@ pub async fn run(_global_args: &ArgMatches<'_>, local_args: &ArgMatches<'_>) {
 
     let target: Target = {
         if let Some(info) = hive.deployment_info_for(&hostname).await.unwrap() {
+            let nix_options = hive.nix_options().await.unwrap();
             if !info.allows_local_deployment() {
                 log::error!("Local deployment is not enabled for host {}.", hostname);
                 log::error!("Hint: Set deployment.allowLocalDeployment to true.");
                 quit::with_code(2);
             }
             Target::new(
-                host::local(),
+                host::local(nix_options),
                 info.clone(),
             )
         } else {

src/nix/deployment.rs

@@ -460,8 +460,9 @@ impl Deployment {
     }
 
     async fn build_profiles(self: Arc<Self>, chunk: &Vec<String>, derivation: StoreDerivation<ProfileMap>, progress: TaskProgress) -> Option<ProfileMap> {
+        let nix_options = self.hive.nix_options().await.unwrap();
         // FIXME: Remote build?
-        let mut builder = host::local();
+        let mut builder = host::local(nix_options);
 
         builder.set_progress_bar(progress.clone());
 

src/nix/eval.nix

@@ -48,6 +48,25 @@ let
         type = types.attrsOf types.unspecified;
         default = {};
       };
+      machinesFile = lib.mkOption {
+        description = ''
+          Use the machines listed in this file when building this hive configuration.
+
+          If your Colmena host has nix configured to allow for remote builds
+          (for nix-daemon, your user being included in trusted-users)
+          you can set a machines file that will be passed to the underlying
+          nix-store command during derivation realization as a builders option.
+          For example, if you support multiple orginizations each with their own
+          build machine(s) you can ensure that builds only take place on your
+          local machine and/or the machines specified in this file.
+
+          See https://nixos.org/manual/nix/stable/#chap-distributed-builds
+          for the machine specification format.
+        '';
+        default = null;
+        apply = value: if value == null then null else toString value;
+        type = types.nullOr types.path;
+      };
     };
   };
 
@@ -327,4 +346,5 @@ let
   };
 in {
   inherit nodes deploymentConfigJson toplevel buildAll buildSelected introspect;
+  meta = hive.meta;
 }

src/nix/hive.rs

@@ -42,6 +42,23 @@ impl Hive {
         self.show_trace = value;
     }
 
+    pub async fn nix_options(&self) -> NixResult<Vec<String>> {
+        let mut options:Vec<String> = Vec::new();
+        if let Some(machines_file) = self.machines_file().await.unwrap() {
+            options.append(&mut vec![
+                "--option".to_owned(),
+                "builders".to_owned(),
+                format!("@{}", machines_file).to_owned()
+            ]);
+        }
+
+        if self.show_trace {
+            options.push("--show-trace".to_owned())
+        }
+
+        Ok(options)
+    }
+
     pub fn as_path(&self) -> &Path {
         &self.hive
     }
@@ -62,6 +79,15 @@ impl Hive {
         Ok(configs)
     }
 
+    /// Retrieve machinesFile setting for the hive.
+    pub async fn machines_file(&self) -> NixResult<Option<String>> {
+        let expr = "toJSON (hive.meta.machinesFile or null)";
+        let s: String = self.nix_instantiate(&expr).eval()
+            .capture_json().await?;
+
+        Ok(serde_json::from_str(&s).unwrap())
+    }
+
     /// Retrieve deployment info for a single node.
     pub async fn deployment_info_for(&self, node: &str) -> NixResult<Option<NodeConfig>> {
         let expr = format!("toJSON (hive.nodes.\"{}\".config.deployment or null)", node);

src/nix/host/local.rs

@@ -18,13 +18,15 @@ use crate::progress::TaskProgress;
 pub struct Local {
     progress_bar: TaskProgress,
     logs: String,
+    nix_options: Vec<String>,
 }
 
 impl Local {
-    pub fn new() -> Self {
+    pub fn new(nix_options: Vec<String>) -> Self {
         Self {
             progress_bar: TaskProgress::default(),
             logs: String::new(),
+            nix_options,
         }
     }
 }
@@ -36,6 +38,8 @@ impl Host for Local {
     }
     async fn realize_remote(&mut self, derivation: &StorePath) -> NixResult<Vec<StorePath>> {
         let mut command = Command::new("nix-store");
+
+        command.args(self.nix_options.clone());
         command
             .arg("--no-gc-warning")
             .arg("--realise")

src/nix/host/mod.rs

@@ -13,8 +13,8 @@ pub use local::Local;
 
 mod key_uploader;
 
-pub(crate) fn local() -> Box<dyn Host + 'static> {
+pub(crate) fn local(nix_options: Vec<String>) -> Box<dyn Host + 'static> {
-    Box::new(Local::new())
+    Box::new(Local::new(nix_options))
 }
 
 #[derive(Copy, Clone, Debug)]