sysvms: create a parent attrset for all system vms

Similar to how app vms are created and defined do the same for the
system vms. This will provide a consistent mechanism for interrogating
which system vms are available.

Signed-off-by: Brian McGillion <bmg.avoin@gmail.com>

Author: brianmcgillion

docs/src/content/docs/ghaf/dev/guides/creating-vms.mdx

@@ -406,9 +406,11 @@ The `vmConfig` parameter in `mkGhafConfiguration` allows per-target resource cus
 mkGhafConfiguration {
   # ... other params ...
   vmConfig = {
-    guivm = { mem = 4096; vcpu = 4; };
-    netvm = { mem = 512; vcpu = 1; };
-    myvm = { mem = 2048; vcpu = 2; };
+    sysvms = {
+      guivm = { mem = 4096; vcpu = 4; };
+      netvm = { mem = 512; vcpu = 1; };
+      myvm = { mem = 2048; vcpu = 2; };
+    };
   };
 }
 ```

docs/src/content/docs/ghaf/dev/library/vm-helpers.mdx

@@ -212,7 +212,7 @@ applyVmConfig :: { config, vmName } -> [ Module ]
 1. Base module (e.g., guivm-base.nix) - sets mkDefault values
 2. resourceModule - applies `vmConfig.mem`/`vcpu`
 3. hwModules - `hardware.definition.<vm>.extraModules`
-4. vmConfigModules - `vmConfig.<vm>.extraModules` (highest priority)
+4. vmConfigModules - `vmConfig.sysvms.<vm>.extraModules` (highest priority)
 
 **Example:**
 
@@ -229,7 +229,7 @@ guivmBase.extendModules {
 **What it returns:**
 
 ```nix
-# If vmConfig.guivm = { mem = 4096; vcpu = 4; extraModules = [ myModule ]; }
+# If vmConfig.sysvms.guivm = { mem = 4096; vcpu = 4; extraModules = [ myModule ]; }
 # And hardware.definition.guivm = { extraModules = [ hwModule ]; }
 # Returns:
 [

lib/builders/mkGhafConfiguration.nix

@@ -21,7 +21,7 @@
 #     extraModules = [ ... ];
 #     extraConfig = { ... };
 #     vmConfig = {
-#       guivm = { mem = 16384; vcpu = 8; };
+#       sysvms.guivm = { mem = 16384; vcpu = 8; };
 #     };
 #   }
 #
@@ -167,6 +167,31 @@ let
       # Helper: Extend a specific VM with additional modules
       extendVm =
         vmName: modules:
+        let
+          inSysvms = (vmConfig.sysvms or { }) ? ${vmName};
+          inAppvms = (vmConfig.appvms or { }) ? ${vmName};
+          updatedVmConfig =
+            if inSysvms then
+              vmConfig
+              // {
+                sysvms = vmConfig.sysvms // {
+                  ${vmName} = vmConfig.sysvms.${vmName} // {
+                    extraModules = (vmConfig.sysvms.${vmName}.extraModules or [ ]) ++ modules;
+                  };
+                };
+              }
+            else if inAppvms then
+              vmConfig
+              // {
+                appvms = vmConfig.appvms // {
+                  ${vmName} = vmConfig.appvms.${vmName} // {
+                    extraModules = (vmConfig.appvms.${vmName}.extraModules or [ ]) ++ modules;
+                  };
+                };
+              }
+            else
+              throw "extendVm: '${vmName}' not found in vmConfig.sysvms or vmConfig.appvms";
+        in
         mkGhafConfiguration' {
           inherit
             name
@@ -177,11 +202,7 @@ let
             extraModules
             extraConfig
             ;
-          vmConfig = vmConfig // {
-            ${vmName} = (vmConfig.${vmName} or { }) // {
-              extraModules = (vmConfig.${vmName}.extraModules or [ ]) ++ modules;
-            };
-          };
+          vmConfig = updatedVmConfig;
         };
 
       # Helper: Get a VM's final configuration

lib/global-config.nix

@@ -679,7 +679,7 @@ rec {
     #   1. Base module (guivm-base.nix) - sets mkDefault values
     #   2. resourceModule - applies vmConfig.mem/vcpu
     #   3. hwModules - hardware.definition.<vm>.extraModules
-    #   4. vmConfigModules - vmConfig.<vm>.extraModules (highest priority)
+    #   4. vmConfigModules - vmConfig.sysvms.<vm>.extraModules (highest priority)
     #
     # Arguments:
     #   config - Host configuration (with ghaf.hardware.definition and ghaf.virtualization.vmConfig)
@@ -698,7 +698,7 @@ rec {
       }:
       let
         hwDef = config.ghaf.hardware.definition.${vmName} or { };
-        vmCfg = config.ghaf.virtualization.vmConfig.${vmName} or { };
+        vmCfg = config.ghaf.virtualization.vmConfig.sysvms.${vmName} or { };
 
         hwModules = hwDef.extraModules or [ ];
         vmConfigModules = vmCfg.extraModules or [ ];

modules/hardware/definition.nix

@@ -359,7 +359,7 @@ in
       # These options allow hardware modules to specify VM-level configs
       # that profiles include via extendModules
       #
-      # NOTE: For resource allocation (mem, vcpu), use ghaf.virtualization.vmConfig.guivm
+      # NOTE: For resource allocation (mem, vcpu), use ghaf.virtualization.vmConfig.sysvms.guivm
       guivm = {
         extraModules = mkOption {
           description = ''
@@ -372,7 +372,7 @@ in
             - Device-specific drivers/services
 
             For resource allocation (memory, vCPUs) or profile-specific modules,
-            use ghaf.virtualization.vmConfig.guivm instead.
+            use ghaf.virtualization.vmConfig.sysvms.guivm instead.
           '';
           type = types.listOf types.unspecified;
           default = [ ];
@@ -389,7 +389,7 @@ in
       # These options allow hardware modules to specify VM-level configs
       # that profiles include via extendModules
       #
-      # NOTE: For resource allocation (mem, vcpu), use ghaf.virtualization.vmConfig.audiovm
+      # NOTE: For resource allocation (mem, vcpu), use ghaf.virtualization.vmConfig.sysvms.audiovm
       audiovm = {
         extraModules = mkOption {
           description = ''
@@ -402,7 +402,7 @@ in
             - Hardware detection modules
 
             For resource allocation (memory, vCPUs) or profile-specific modules,
-            use ghaf.virtualization.vmConfig.audiovm instead.
+            use ghaf.virtualization.vmConfig.sysvms.audiovm instead.
           '';
           type = types.listOf types.unspecified;
           default = [ ];
@@ -429,7 +429,7 @@ in
             - Custom kernel parameters
 
             For resource allocation (memory, vCPUs) or profile-specific modules,
-            use ghaf.virtualization.vmConfig.netvm instead.
+            use ghaf.virtualization.vmConfig.sysvms.netvm instead.
           '';
           type = types.listOf types.unspecified;
           default = [ ];

modules/microvm/vm-config.nix

@@ -25,7 +25,7 @@
 #   1. Base module (guivm-base.nix)                    <- mkDefault (sensible defaults)
 #   2. Feature modules (desktop-features)              <- profile features
 #   3. hardware.definition.guivm.extraModules          <- hardware-specific (GPU quirks)
-#   4. virtualization.vmConfig.guivm.extraModules      <- profile/downstream (highest priority)
+#   4. virtualization.vmConfig.sysvms.guivm.extraModules <- profile/downstream (highest priority)
 #
 {
   lib,
@@ -119,34 +119,19 @@ in
   _file = ./vm-config.nix;
 
   options.ghaf.virtualization.vmConfig = {
-    guivm = mkOption {
-      type = systemVmConfigType;
+    sysvms = mkOption {
+      type = types.attrsOf systemVmConfigType;
       default = { };
-      description = "GUI VM resource allocation and profile configuration.";
-    };
-
-    netvm = mkOption {
-      type = systemVmConfigType;
-      default = { };
-      description = "Network VM resource allocation and profile configuration.";
-    };
-
-    audiovm = mkOption {
-      type = systemVmConfigType;
-      default = { };
-      description = "Audio VM resource allocation and profile configuration.";
-    };
-
-    adminvm = mkOption {
-      type = systemVmConfigType;
-      default = { };
-      description = "Admin VM resource allocation and profile configuration.";
-    };
-
-    idsvm = mkOption {
-      type = systemVmConfigType;
-      default = { };
-      description = "IDS VM resource allocation and profile configuration.";
+      description = ''
+        Per-system-VM configuration. Keys should match system VM names
+        (e.g., guivm, netvm, audiovm, adminvm, idsvm).
+      '';
+      example = literalExpression ''
+        {
+          guivm = { mem = 16384; vcpu = 8; };
+          netvm = { extraModules = [ ./my-net-config.nix ]; };
+        }
+      '';
     };
 
     appvms = mkOption {

modules/reference/profiles/mvp-orinuser-trial.nix

@@ -31,7 +31,7 @@ in
 
         # Net VM profile-specific modules - use vmConfig for resource allocation and profile services
         # Hardware-specific modules should go in hardware.definition.netvm.extraModules
-        vmConfig.netvm.extraModules = [
+        vmConfig.sysvms.netvm.extraModules = [
           ../services
           ../personalize
           { ghaf.reference.personalize.keys.enable = true; }

targets/laptop/flake-module.nix

@@ -103,7 +103,7 @@ let
         };
       };
       vmConfig = {
-        guivm.mem = 6144;
+        sysvms.guivm.mem = 6144;
         appvms.flatpak.mem = 5120;
       };
     })
@@ -147,7 +147,7 @@ let
         partitioning.disko.enable = true;
       };
       vmConfig = {
-        guivm.mem = 6144;
+        sysvms.guivm.mem = 6144;
         appvms.flatpak.mem = 5120;
       };
     })
@@ -178,7 +178,7 @@ let
         partitioning.disko.enable = true;
       };
       vmConfig = {
-        guivm.mem = 2047;
+        sysvms.guivm.mem = 2047;
       };
     })
 
@@ -389,7 +389,7 @@ let
         };
       };
       vmConfig = {
-        guivm.mem = 6144;
+        sysvms.guivm.mem = 6144;
         appvms.flatpak.mem = 5120;
       };
     })
@@ -419,7 +419,7 @@ let
         partitioning.disko.enable = true;
       };
       vmConfig = {
-        guivm.mem = 6144;
+        sysvms.guivm.mem = 6144;
         appvms.flatpak.mem = 5120;
       };
     })