From 7f9b7991e902489efb3501a98a7d6998ca15a0a5 Mon Sep 17 00:00:00 2001 From: Werner Llácer Date: Fri, 31 Dec 2021 13:47:41 +0100 Subject: Btrfs2 (#787) * All the changes needed to make btrfs subvolumes work. It boils down to two points; the handling of the addressing of subvolumes re. physical partitions, and the small changes at the bootloader level * We added a new script only_hd for testing purposes. It only handles hadrd drive management * restoring an escape hatch during subvolume processing * hipercommented manage_btrfs_subvolumes * Ready to be able to select and process options in subvolume mounting * Separte nodatacow processing * Solving a flake8 complain * Use of bind names @ get_filesystem_type * compress mount option bypass * Preparations for encryption handling * Compatibility to master version re. encrypted btrfs volumes * Now we can create subvolumes and mountpoints inside an encrypted btrfs partition * changes for entries file generation with systemd-bootctl * flake8 corrections plus some comments Co-authored-by: Anton Hvornum --- examples/only_hd.py | 264 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 264 insertions(+) create mode 100644 examples/only_hd.py (limited to 'examples') diff --git a/examples/only_hd.py b/examples/only_hd.py new file mode 100644 index 00000000..151b71a8 --- /dev/null +++ b/examples/only_hd.py @@ -0,0 +1,264 @@ +import json +import logging +import os +import pathlib + +import archinstall +import glob + +def load_mirror(): + if archinstall.arguments.get('mirror-region', None) is not None: + if type(archinstall.arguments.get('mirror-region', None)) is dict: + archinstall.arguments['mirror-region'] = archinstall.arguments.get('mirror-region', None) + else: + selected_region = archinstall.arguments.get('mirror-region', None) + archinstall.arguments['mirror-region'] = {selected_region: archinstall.list_mirrors()[selected_region]} + +def load_localization(): + if archinstall.arguments.get('sys-language', None) is not None: + archinstall.arguments['sys-language'] = archinstall.arguments.get('sys-language', 'en_US') + if archinstall.arguments.get('sys-encoding', None) is not None: + archinstall.arguments['sys-encoding'] = archinstall.arguments.get('sys-encoding', 'utf-8') + +def load_harddrives(): + if archinstall.arguments.get('harddrives', None) is not None: + if type(archinstall.arguments['harddrives']) is str: + archinstall.arguments['harddrives'] = archinstall.arguments['harddrives'].split(',') + archinstall.arguments['harddrives'] = [archinstall.BlockDevice(BlockDev) for BlockDev in archinstall.arguments['harddrives']] + # Temporarily disabling keep_partitions if config file is loaded + +def load_disk_layouts(): + if archinstall.arguments.get('disk_layouts', None) is not None: + dl_path = pathlib.Path(archinstall.arguments['disk_layouts']) + if dl_path.exists(): # and str(dl_path).endswith('.json'): + try: + with open(dl_path) as fh: + archinstall.storage['disk_layouts'] = json.load(fh) + except Exception as e: + raise ValueError(f"--disk_layouts does not contain a valid JSON format: {e}") + else: + try: + archinstall.storage['disk_layouts'] = json.loads(archinstall.arguments['disk_layouts']) + except: + raise ValueError("--disk_layouts= needs either a JSON file or a JSON string given with a valid disk layout.") + +def ask_harddrives(): + # Ask which harddrives/block-devices we will install to + # and convert them into archinstall.BlockDevice() objects. + if archinstall.arguments.get('harddrives', None) is None: + archinstall.arguments['harddrives'] = archinstall.generic_multi_select(archinstall.all_disks(), + text="Select one or more harddrives to use and configure (leave blank to skip this step): ", + allow_empty=True) + + if not archinstall.arguments['harddrives']: + archinstall.log("You decided to skip harddrive selection",fg="red",level=logging.INFO) + archinstall.log(f"and will use whatever drive-setup is mounted at {archinstall.storage['MOUNT_POINT']} (experimental)",fg="red",level=logging.INFO) + archinstall.log("WARNING: Archinstall won't check the suitability of this setup",fg="red",level=logging.INFO) + if input("Do you wish to continue ? [Y/n]").strip().lower() == 'n': + exit(1) + else: + if archinstall.storage.get('disk_layouts', None) is None: + archinstall.storage['disk_layouts'] = archinstall.select_disk_layout(archinstall.arguments['harddrives'], archinstall.arguments.get('advanced', False)) + + # Get disk encryption password (or skip if blank) + if archinstall.arguments.get('!encryption-password', None) is None: + if passwd := archinstall.get_password(prompt='Enter disk encryption password (leave blank for no encryption): '): + archinstall.arguments['!encryption-password'] = passwd + + if archinstall.arguments.get('!encryption-password', None): + # If no partitions was marked as encrypted, but a password was supplied and we have some disks to format.. + # Then we need to identify which partitions to encrypt. This will default to / (root). + if len(list(archinstall.encrypted_partitions(archinstall.storage['disk_layouts']))) == 0: + archinstall.storage['disk_layouts'] = archinstall.select_encrypted_partitions(archinstall.storage['disk_layouts'], archinstall.arguments['!encryption-password']) + + # Ask which boot-loader to use (will only ask if we're in BIOS (non-efi) mode) + if not archinstall.arguments.get("bootloader", None): + archinstall.arguments["bootloader"] = archinstall.ask_for_bootloader(archinstall.arguments.get('advanced', False)) + + if not archinstall.arguments.get('swap', None): + archinstall.arguments['swap'] = archinstall.ask_for_swap() + +def load_profiles(): + if archinstall.arguments.get('profile', None) is not None: + if type(archinstall.arguments.get('profile', None)) is dict: + archinstall.arguments['profile'] = archinstall.Profile(None, archinstall.arguments.get('profile', None)['path']) + else: + archinstall.arguments['profile'] = archinstall.Profile(None, archinstall.arguments.get('profile', None)) + +def load_desktop_profiles(): + # Temporary workaround to make Desktop Environments work + archinstall.storage['_desktop_profile'] = archinstall.arguments.get('desktop-environment', None) + +def load_gfxdriver(): + if archinstall.arguments.get('gfx_driver', None) is not None: + archinstall.storage['gfx_driver_packages'] = archinstall.AVAILABLE_GFX_DRIVERS.get(archinstall.arguments.get('gfx_driver', None), None) + +def load_servers(): + if archinstall.arguments.get('servers', None) is not None: + archinstall.storage['_selected_servers'] = archinstall.arguments.get('servers', None) + + +def load_config(): + load_harddrives() + load_profiles() + load_desktop_profiles() + load_mirror() + load_localization() + load_gfxdriver() + load_servers() + load_disk_layouts() + +def ask_user_questions(): + """ + First, we'll ask the user for a bunch of user input. + Not until we're satisfied with what we want to install + will we continue with the actual installation steps. + """ + ask_harddrives() + + +def write_config_files(): + print() + print('This is your chosen configuration:') + archinstall.log("-- Guided template chosen (with below config) --", level=logging.DEBUG) + user_configuration = json.dumps(archinstall.arguments, indent=4, sort_keys=True, cls=archinstall.JSON) + archinstall.log(user_configuration, level=logging.INFO) + with open("/var/log/archinstall/user_configuration.json", "w") as config_file: + config_file.write(user_configuration) + if archinstall.storage.get('disk_layouts'): + user_disk_layout = json.dumps(archinstall.storage['disk_layouts'], indent=4, sort_keys=True, cls=archinstall.JSON) + archinstall.log(user_disk_layout, level=logging.INFO) + with open("/var/log/archinstall/user_disk_layout.json", "w") as disk_layout_file: + disk_layout_file.write(user_disk_layout) + print() + + if archinstall.arguments.get('dry-run'): + exit(0) + + # it is here so a dry run execution will not save the credentials file ¿? + user_credentials = {} + if archinstall.arguments.get('!users'): + user_credentials["!users"] = archinstall.arguments['!users'] + if archinstall.arguments.get('!superusers'): + user_credentials["!superusers"] = archinstall.arguments['!superusers'] + if archinstall.arguments.get('!encryption-password'): + user_credentials["!encryption-password"] = archinstall.arguments['!encryption-password'] + + with open("/var/log/archinstall/user_credentials.json", "w") as config_file: + config_file.write(json.dumps(user_credentials, indent=4, sort_keys=True, cls=archinstall.UNSAFE_JSON)) + +def perform_disk_operations(): + """ + Issue a final warning before we continue with something un-revertable. + We mention the drive one last time, and count from 5 to 0. + """ + if archinstall.arguments.get('harddrives', None): + print(f" ! Formatting {archinstall.arguments['harddrives']} in ", end='') + archinstall.do_countdown() + + """ + Setup the blockdevice, filesystem (and optionally encryption). + Once that's done, we'll hand over to perform_installation() + """ + mode = archinstall.GPT + if archinstall.has_uefi() is False: + mode = archinstall.MBR + + for drive in archinstall.arguments.get('harddrives', []): + if dl_disk := archinstall.storage.get('disk_layouts', {}).get(drive.path): + with archinstall.Filesystem(drive, mode) as fs: + fs.load_layout(dl_disk) + + +def create_subvolume(installation_mountpoint, subvolume_location): + """ + This function uses btrfs to create a subvolume. + + @installation: archinstall.Installer instance + @subvolume_location: a localized string or path inside the installation / or /boot for instance without specifying /mnt/boot + """ + if type(installation_mountpoint) == str: + installation_mountpoint_path = pathlib.Path(installation_mountpoint) + else: + installation_mountpoint_path = installation_mountpoint + # Set up the required physical structure + if type(subvolume_location) == str: + subvolume_location = pathlib.Path(subvolume_location) + + target = installation_mountpoint_path / subvolume_location.relative_to(subvolume_location.anchor) + + # Difference from mount_subvolume: + # We only check if the parent exists, since we'll run in to "target path already exists" otherwise + if not target.parent.exists(): + target.parent.mkdir(parents=True) + + if glob.glob(str(target / '*')): + raise archinstall.DiskError(f"Cannot create subvolume at {target} because it contains data (non-empty folder target)") + + # Remove the target if it exists. It is nor incompatible to the previous + if target.exists(): + target.rmdir() + + archinstall.log(f"Creating a subvolume on {target}", level=logging.INFO) + if (cmd := archinstall.SysCommand(f"btrfs subvolume create {target}")).exit_code != 0: + raise archinstall.DiskError(f"Could not create a subvolume at {target}: {cmd}") + +def perform_installation(mountpoint): + """ + Performs the installation steps on a block device. + Only requirement is that the block devices are + formatted and setup prior to entering this function. + """ + with archinstall.Installer(mountpoint, kernels=archinstall.arguments.get('kernels', 'linux')) as installation: + # Mount all the drives to the desired mountpoint + # This *can* be done outside of the installation, but the installer can deal with it. + if archinstall.storage.get('disk_layouts'): + installation.mount_ordered_layout(archinstall.storage['disk_layouts']) + + # Placing /boot check during installation because this will catch both re-use and wipe scenarios. + for partition in installation.partitions: + if partition.mountpoint == installation.target + '/boot': + if partition.size <= 0.25: # in GB + raise archinstall.DiskError(f"The selected /boot partition in use is not large enough to properly install a boot loader. Please resize it to at least 256MB and re-run the installation.") + + # For support reasons, we'll log the disk layout post installation (crash or no crash) + archinstall.log(f"Disk states after installing: {archinstall.disk_layouts()}", level=logging.DEBUG) + +def log_execution_environment(): + # Log various information about hardware before starting the installation. This might assist in troubleshooting + archinstall.log(f"Hardware model detected: {archinstall.sys_vendor()} {archinstall.product_name()}; UEFI mode: {archinstall.has_uefi()}", level=logging.DEBUG) + archinstall.log(f"Processor model detected: {archinstall.cpu_model()}", level=logging.DEBUG) + archinstall.log(f"Memory statistics: {archinstall.mem_available()} available out of {archinstall.mem_total()} total installed", level=logging.DEBUG) + archinstall.log(f"Virtualization detected: {archinstall.virtualization()}; is VM: {archinstall.is_vm()}", level=logging.DEBUG) + archinstall.log(f"Graphics devices detected: {archinstall.graphics_devices().keys()}", level=logging.DEBUG) + + # For support reasons, we'll log the disk layout pre installation to match against post-installation layout + archinstall.log(f"Disk states before installing: {archinstall.disk_layouts()}", level=logging.DEBUG) + + +if archinstall.arguments.get('help'): + print("See `man archinstall` for help.") + exit(0) +if os.getuid() != 0: + print("Archinstall requires root privileges to run. See --help for more.") + exit(1) + +log_execution_environment() + +if not archinstall.check_mirror_reachable(): + log_file = os.path.join(archinstall.storage.get('LOG_PATH', None), archinstall.storage.get('LOG_FILE', None)) + archinstall.log(f"Arch Linux mirrors are not reachable. Please check your internet connection and the log file '{log_file}'.", level=logging.INFO, fg="red") + exit(1) + +load_config() + +if not archinstall.arguments.get('silent'): + ask_user_questions() + +# YEP write_config_files() + +if not archinstall.arguments.get('silent'): + input('Press Enter to continue.') + +perform_disk_operations() +perform_installation(archinstall.storage.get('MOUNT_POINT', '/mnt')) -- cgit v1.2.3-70-g09d2