Merge pull request #74 from desultory/automount

add automounts

Author: desultory

docs/configuration.md

@@ -155,6 +155,10 @@ destination = "/mnt/extra"
 label = "extra"
 ```
 
+##### auto_mounts
+
+Paths added to `auto_mounts` will be auto-configured to mount before `init_main` is run.
+
 #### ugrd.fs.fakeudev
 
 This module is used to create fake udev entries for DM devices.

src/ugrd/crypto/cryptsetup.py

@@ -70,7 +70,11 @@ def _validate_crypysetup_key(self, key_paramters: dict) -> None:
 
 
 @contains('validate', "Skipping cryptsetup configuration validation.", log_level=30)
-def _validate_cryptsetup_config(self, mapped_name: str, config: dict) -> None:
+def _validate_cryptsetup_config(self, mapped_name: str) -> None:
+    try:
+        config = self['cryptsetup'][mapped_name]
+    except KeyError:
+        raise KeyError("No cryptsetup configuration found for: %s" % mapped_name)
     self.logger.log(5, "[%s] Validating cryptsetup configuration: %s" % (mapped_name, config))
     for parameter in config:
         if parameter not in CRYPTSETUP_PARAMETERS:
@@ -92,7 +96,6 @@ def _validate_cryptsetup_config(self, mapped_name: str, config: dict) -> None:
 def _process_cryptsetup_multi(self, mapped_name: str, config: dict) -> None:
     """ Processes the cryptsetup configuration """
     config = _merge_cryptsetup(self, mapped_name, config)  # Merge the config with the existing configuration
-    _validate_cryptsetup_config(self, mapped_name, config)  # Validate the configuration
     self.logger.debug("[%s] Processing cryptsetup configuration: %s" % (mapped_name, config))
     # Check if the key type is defined in the configuration, otherwise use the default, check if it's valid
     if key_type := config.get('key_type', self.get('cryptsetup_key_type')):
@@ -118,21 +121,21 @@ def _process_cryptsetup_multi(self, mapped_name: str, config: dict) -> None:
 
 
 @contains('validate', "Skipping cryptsetup configuration validation.", log_level=30)
-def _validate_luks_source(self, mapped_name: str) -> None:
-    """ Checks that a LUKS source device is valid """
+def _validate_luks_config(self, mapped_name: str) -> None:
+    """ Checks that a LUKS config portion is valid. """
     for _dm_info in self['_dm_info'].values():
         if _dm_info['name'] == mapped_name:
-            dm_info = _dm_info
+            dm_info = _dm_info  # Get the device mapper information
             break
     else:
         raise ValueError("No device mapper information found for: %s" % mapped_name)
 
-    cryptsetup_info = self['cryptsetup'][mapped_name]
+    cryptsetup_info = self['cryptsetup'][mapped_name]  # Get the cryptsetup information
 
-    if not dm_info['uuid'].startswith('CRYPT-LUKS'):
+    if not dm_info['uuid'].startswith('CRYPT-LUKS'):  # Ensure the device is a crypt device
         raise ValueError("Device is not a crypt device: %s" % dm_info)
 
-    slave_source = dm_info['slaves'][0]
+    slave_source = dm_info['slaves'][0]  # Get the slave source
 
     try:
         blkid_info = self['_blkid_info'][f'/dev/{slave_source}']
@@ -147,18 +150,19 @@ def _validate_luks_source(self, mapped_name: str) -> None:
             break
     else:
         raise ValueError("[%s] Unable to validate LUKS source: %s" % (mapped_name, cryptsetup_info))
+    _validate_cryptsetup_config(self, mapped_name)
 
 
 def export_crypt_sources(self) -> list[str]:
     """
-    Validates the cryptsetup configuration.
+    Validates the cryptsetup configuration (if enabled).
     Adds the cryptsetup source and token to the exports.
     Sets the token to the partuuid or uuid if it exists.
     Sets the SOURCE when using a path.
     Only allows using the path if validation is disabled.
     """
     for name, parameters in self['cryptsetup'].items():
-        _validate_luks_source(self, name)
+        _validate_luks_config(self, name)
         if parameters.get('path'):
             if not self['validate']:
                 self.logger.warning("Using device paths is unreliable and can result in boot failures. Consider using partuuid.")

src/ugrd/fs/mounts.py

@@ -1,5 +1,5 @@
 __author__ = 'desultory'
-__version__ = '4.12.2'
+__version__ = '4.13.0'
 
 from pathlib import Path
 from zenlib.util import contains, pretty_print
@@ -443,25 +443,41 @@ def autodetect_root(self) -> None:
         root_dev = _resolve_root_dev(self)
     if root_dev not in self['_blkid_info']:
         get_blkid_info(self, root_dev)
-    autodetect_mount_kmods(self, root_dev)  # Get kmods for the root device
-
-    root_mount_info = self['_blkid_info'][root_dev]
-    self.logger.debug("Detected root mount info: %s" % root_mount_info)
-    mount_info = {'root': {'type': 'auto', 'base_mount': False}}
-
-    if mount_type := root_mount_info.get('type'):  # Attempt to autodetect the root type
-        self.logger.info("Autodetected root type: %s" % mount_type)
-        mount_info['root']['type'] = mount_type.lower()
+    self['mounts'] = _autodetect_mount(self, '/')
+
+
+def _autodetect_mount(self, mountpoint) -> dict:
+    """ Returns mount config based on the mount at the specified mountpoint. """
+    if mountpoint not in self['_mounts']:
+        raise FileNotFoundError("auto_mount mountpointpoint not found in host mounts: %s" % mountpoint)
+    if self['_mounts'][mountpoint]['device'] not in self['_blkid_info']:
+        get_blkid_info(self, self['_mounts'][mountpoint]['device'])
+    mount_device = self['_mounts'][mountpoint]['device']
+    mount_info = self['_blkid_info'][mount_device]
+    autodetect_mount_kmods(self, mount_device)
+    mount_name = 'root' if mountpoint == '/' else mountpoint.removeprefix('/')
+    mount_config = {mount_name: {'type': 'auto'}}
+    if mount_type := mount_info.get('type'):
+        self.logger.info("Autodetected mount type: %s" % mount_type)
+        mount_config[mount_name]['type'] = mount_type.lower()
 
     for source_type in SOURCE_TYPES:
-        if source := root_mount_info.get(source_type):
-            self.logger.info("Autodetected root source: %s=%s" % (source_type, source))
-            mount_info['root'][source_type] = source
+        if source := mount_info.get(source_type):
+            self.logger.info("[%s] Autodetected mount source: %s=%s" % (mount_name, source_type, source))
+            mount_config[mount_name][source_type] = source
             break
     else:
-        raise ValueError("Failed to autodetect root mount source.")
+        raise ValueError("[%s] Failed to autodetect mount source." % mountpoint)
+
+    return mount_config
 
-    self['mounts'] = mount_info
+
+@contains('auto_mounts', "Skipping auto mounts, auto_mounts is empty.", log_level=10)
+@contains('hostonly', "Skipping mount autodetection, hostonly mode is enabled.", log_level=30)
+def autodetect_mounts(self) -> None:
+    """ Configured the mount config for a device based on the host mount config. """
+    for mountpoint in self['auto_mounts']:
+        self['mounts'] = _autodetect_mount(self, mountpoint)
 
 
 def mount_base(self) -> list[str]:

src/ugrd/fs/mounts.toml

@@ -20,7 +20,7 @@ late_fstab = "/etc/fstab.late"
 "ugrd.fs.mounts" = [ "_process_mounts_multi", "_process_late_mounts_multi", "_process_mount_timeout" ]
 
 [imports.build_pre]
-"ugrd.fs.mounts" = [ "get_mounts_info", "get_dm_info", "get_blkid_info", "autodetect_root", "autodetect_root_dm" ]
+"ugrd.fs.mounts" = [ "get_mounts_info", "get_dm_info", "get_blkid_info", "autodetect_root", "autodetect_mounts", "autodetect_root_dm" ]
 
 [imports.build_tasks]
 "ugrd.fs.mounts" = [ "autodetect_init_mount", "export_mount_info", "export_root_target" ]
@@ -44,6 +44,7 @@ late_fstab = "/etc/fstab.late"
 mounts = "dict"  # Add the mounts property, used to define the mounts to be made in the fstab
 late_mounts = "dict"  # Like mounts, but run after the root is mounted
 late_fstab = "str"  # The path to the late_fstab file
+auto_mounts = "NoDupFlatList"  # A list of mounts to be automatically added to the mounts list
 mount_wait = "bool"  # Add the mount_wait property, if defined, user input will be required before attempting to mount entries
 mount_timeout = "float"  # Add the mount_timeout property, used to define the timeout for mount_wait
 mount_retries = "int"  # The number of times to re-attempt mounting the fstab