Merge pull request #483 from nix-community/create-pull-request/patch

Update flakes

Author: github-actions[bot]

docs/howtos/INDEX.md

@@ -10,6 +10,8 @@
 
 [Installing on a machine with no operating system](./no-os.md)
 
+[Kexec on systems with limited RAM](./limited-ram.md)
+
 [Copying files to the new installation](./extra-files.md)
 
 [Using your own kexec image](./custom-kexec.md)

docs/howtos/limited-ram.md

@@ -0,0 +1,29 @@
+# Kexec on Systems with Limited RAM
+
+When working with nixos-anywhere on systems with limited RAM (around 1GB), you
+can use the `--no-disko-deps` option to reduce memory usage during installation.
+
+## How it works
+
+The `--no-disko-deps` option uploads only the disko partitioning script without
+including its dependencies. This significantly reduces memory usage because:
+
+1. The installer normally stores all dependencies in memory
+2. Partitioning tools can be quite large when bundled with their dependencies
+
+## Usage example
+
+```bash
+nix run github:nix-community/nixos-anywhere -- --no-disko-deps --flake <path to configuration>#<configuration name> --target-host root@<ip address>
+```
+
+## Trade-off
+
+While this approach saves memory, it means the partitioning tools will be
+whatever versions are available on the target system, rather than the specific
+versions defined in your NixOS configuration. This could potentially lead to
+version inconsistencies between the partitioning tools and the NixOS system
+being installed.
+
+This trade-off is usually acceptable for memory-constrained environments where
+installation would otherwise fail due to insufficient RAM.

docs/howtos/use-without-flakes.md

@@ -78,5 +78,5 @@ step:
 Run `nixos-anywhere` as follows:
 
 ```bash
-nixos-anywhere --store-paths $(nix-build -A config.system.build.disko -A config.system.build.toplevel --no-out-link) root@machine
+nixos-anywhere --store-paths $(nix-build -A config.system.build.formatScript -A config.system.build.toplevel --no-out-link) root@machine
 ```

docs/reference.md

@@ -19,12 +19,17 @@ TODO: Populate this guide properly
 <!-- `$ bash ./src/nixos-anywhere.sh --help` -->
 
 ```
-Usage: nixos-anywhere [options] <ssh-host>
+Usage: nixos-anywhere [options] [<ssh-host>]
 
 Options:
 
 * -f, --flake <flake_uri>
-  set the flake to install the system from.
+  set the flake to install the system from. i.e.
+  nixos-anywhere --flake .#mymachine
+  Also supports variants:
+  nixos-anywhere --flake .#nixosConfigurations.mymachine.config.virtualisation.vmVariant
+* --target-host <ssh-host>
+  set the SSH target host to deploy onto.
 * -i <identity_file>
   selects which SSH private key file to use.
 * -p, --ssh-port <ssh_port>
@@ -43,6 +48,8 @@ Options:
   use another kexec tarball to bootstrap NixOS
 * --kexec-extra-flags
   extra flags to add into the call to kexec, e.g. "--no-sync"
+* --ssh-store-setting <key> <value>
+  ssh store settings appended to the store URI, e.g. "compress true". <value> needs to be URI encoded.
 * --post-kexec-ssh-port <ssh_port>
   after kexec is executed, use a custom ssh port to connect. Defaults to 22
 * --copy-host-keys
@@ -60,6 +67,8 @@ Options:
   disable passing --substitute-on-destination to nix-copy
 * --debug
   enable debug output
+* --show-trace
+  show nix build traces
 * --option <key> <value>
   nix option to pass to every nix related command
 * --from <store-uri>
@@ -80,8 +89,15 @@ Options:
 * --disko-mode disko|mount|format
   set the disko mode to format, mount or destroy. Default is disko.
   disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
-  mount: mount the partition at the specified root-mountpoint
-  format: create partition tables, zpools, lvms, raids and filesystems (Experimental: Can be run increntally, but use with caution and good backups)
+* --no-disko-deps
+  This will only upload the disko script and not the partitioning tools dependencies.
+  Installers usually have dependencies available.
+  Use this option if your target machine has not enough RAM to store the dependencies in memory.
+* --build-on auto|remote|local
+  sets the build on settings to auto, remote or local. Default is auto.
+  auto: tries to figure out, if the build is possible on the local host, if not falls back gracefully to remote build
+  local: will build on the local host
+  remote: will build on the remote host
 ```
 
 ## Explanation of known error messages

flake.lock

@@ -9,8 +9,10 @@ kexecExtraFlags=""
 sshStoreSettings=""
 enableDebug=""
 nixBuildFlags=()
+diskoAttr=""
 diskoScript=""
 diskoMode="disko"
+diskoDeps=y
 nixosSystem=""
 extraFiles=""
 vmTest="n"
@@ -137,6 +139,10 @@ Options:
 * --disko-mode disko|mount|format
   set the disko mode to format, mount or destroy. Default is disko.
   disko: first unmount and destroy all filesystems on the disks we want to format, then run the create and mount mode
+* --no-disko-deps
+  This will only upload the disko script and not the partitioning tools dependencies.
+  Installers usually have dependencies available.
+  Use this option if your target machine has not enough RAM to store the dependencies in memory.
 * --build-on auto|remote|local
   sets the build on settings to auto, remote or local. Default is auto.
   auto: tries to figure out, if the build is possible on the local host, if not falls back gracefully to remote build
@@ -255,6 +261,9 @@ parseArgs() {
 
       shift
       ;;
+    --no-disko-deps)
+      diskoDeps=n
+      ;;
     --build-on)
       case "$2" in
       auto | local | remote)
@@ -346,6 +355,12 @@ parseArgs() {
     shift
   done
 
+  diskoAttr="${diskoMode}Script"
+
+  if [[ ${diskoDeps} == "n" ]]; then
+    diskoAttr="${diskoAttr}NoDeps"
+  fi
+
   if [[ ${printBuildLogs} == "y" ]]; then
     nixOptions+=("-L")
   fi
@@ -659,7 +674,7 @@ runDisko() {
       --derivation --no-check-sigs
     # If we don't use ssh-ng here, we get `error: operation 'getFSAccessor' is not supported by store`
     diskoScript=$(
-      nixBuild "${flake}#${flakeAttr}.system.build.${diskoMode}Script" \
+      nixBuild "${flake}#${flakeAttr}.system.build.${diskoAttr}" \
         --eval-store auto --store "ssh-ng://$sshConnection?ssh-key=$sshKeyDir%2Fnixos-anywhere&$sshStoreSettings"
     )
   fi
@@ -756,7 +771,7 @@ main() {
   if [[ -n ${flake} ]]; then
     if [[ ${buildOn} == "local" ]] && [[ ${hardwareConfigBackend} == "none" ]]; then
       if [[ ${phases[disko]} == 1 ]]; then
-        diskoScript=$(nixBuild "${flake}#${flakeAttr}.system.build.${diskoMode}Script")
+        diskoScript=$(nixBuild "${flake}#${flakeAttr}.system.build.${diskoAttr}")
       fi
       if [[ ${phases[install]} == 1 ]]; then
         nixosSystem=$(nixBuild "${flake}#${flakeAttr}.system.build.toplevel")
@@ -831,7 +846,7 @@ main() {
 
   if [[ ${buildOn} != "remote" ]] && [[ -n ${flake} ]] && [[ -z ${diskoScript} ]]; then
     if [[ ${phases[disko]} == 1 ]]; then
-      diskoScript=$(nixBuild "${flake}#${flakeAttr}.system.build.${diskoMode}Script")
+      diskoScript=$(nixBuild "${flake}#${flakeAttr}.system.build.${diskoAttr}")
     fi
     if [[ ${phases[install]} == 1 ]]; then
       nixosSystem=$(nixBuild "${flake}#${flakeAttr}.system.build.toplevel")

src/nixos-anywhere.sh

@@ -15,7 +15,7 @@ in
   environment.systemPackages = [ inputs.nixos-anywhere ];
 
   environment.etc = {
-    "nixos-anywhere/disko".source = system-to-install.config.system.build.diskoScript;
+    "nixos-anywhere/disko".source = system-to-install.config.system.build.diskoScriptNoDeps;
     "nixos-anywhere/system-to-install".source = system-to-install.config.system.build.toplevel;
     "nixos-anywhere/kexec-installer".source = kexec-installer;
   };