From ec3c25fac6ee666b19888c34d7f577b4c0546829 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Timoth=C3=A9e=20Ravier?= Date: Tue, 3 Dec 2024 20:03:55 +0100 Subject: [PATCH] migrate: Add GRUB static migration subcommand See: https://gitlab.com/fedora/ostree/sig/-/issues/35 See: https://pagure.io/workstation-ostree-config/pull-request/591 Fixes: https://github.com/coreos/bootupd/issues/789 --- src/bootupd.rs | 150 ++++++++++++++++++++++++++++++++++++++++++- src/cli/bootupctl.rs | 9 +++ 2 files changed, 158 insertions(+), 1 deletion(-) diff --git a/src/bootupd.rs b/src/bootupd.rs index c16a885c..2dea6157 100644 --- a/src/bootupd.rs +++ b/src/bootupd.rs @@ -12,7 +12,8 @@ use clap::crate_version; use serde::{Deserialize, Serialize}; use std::borrow::Cow; use std::collections::BTreeMap; -use std::path::Path; +use std::fs::{self, File}; +use std::path::{Path, PathBuf}; pub(crate) enum ConfigMode { None, @@ -489,6 +490,153 @@ pub(crate) fn client_run_validate() -> Result<()> { Ok(()) } +pub(crate) fn client_run_migrate() -> Result<()> { + // Used to condition execution of this unit at the systemd level + let stamp_file = "/boot/.bootupd-static-migration-complete"; + + // Did we already complete the migration? + let mut ostree_cmd = std::process::Command::new("ostree"); + let result = ostree_cmd + .args([ + "config", + "--repo=/sysroot/ostree/repo", + "get", + "sysroot.bootloader", + ]) + .output() + .with_context(|| "failed to call ostree command. Not performing migration")?; + if !result.status.success() { + // ostree will exit with a non zero return code if the key does not exists + println!("ostree repo 'sysroot.bootloader' config option not set yet."); + } else { + let bootloader = String::from_utf8(result.stdout) + .with_context(|| "decoding as UTF-8 output of ostree command")?; + if bootloader.trim_end() == "none" { + println!("ostree repo 'sysroot.bootloader' config option already set to 'none'."); + println!("Assuming that the migration is already complete."); + File::create(stamp_file)?; + return Ok(()); + } else { + println!( + "ostree repo 'sysroot.bootloader' config currently set to: {}", + bootloader.trim_end() + ); + } + } + + // Remount /boot read write just for this unit (we are called in a slave mount namespace by systemd) + ensure_writable_boot()?; + + let grub_config_dir = PathBuf::from("/boot/grub2"); + let Ok(dirfd) = openat::Dir::open(&grub_config_dir).with_context(|| "a") else { + anyhow::bail!( + "Could not open {}. Not performing migration.", + grub_config_dir.display() + ); + }; + + // Migrate /boot/grub2/grub.cfg to a static GRUB config if it is a symlink + let grub_config_filename = PathBuf::from("/boot/grub2/grub.cfg"); + match dirfd.read_link("grub.cfg") { + Err(_) => { + println!( + "'{}' is not a symlink. Nothing to migrate.", + grub_config_filename.display() + ); + } + Ok(path) => { + println!("Migrating to a static GRUB config..."); + + // Resolve symlink location + let mut current_config = grub_config_dir.clone(); + current_config.push(path); + + // Backup the current GRUB config which is hopefully working right now + let backup_config = PathBuf::from("/boot/grub2/grub.cfg.backup"); + println!( + "Creating a backup of the current GRUB config '{}' in '{}'...", + current_config.display(), + backup_config.display() + ); + fs::copy(¤t_config, &backup_config).map_err(|e| { + anyhow!( + "Could not backup the current GRUB config: {}. Not performing migration.", + e + ) + })?; + + // Copy it again alongside the current symlink + let current_config_copy = PathBuf::from("/boot/grub2/grub.cfg.current"); + fs::copy(¤t_config, ¤t_config_copy).map_err(|e| { + anyhow!( + "Could not copy the current GRUB config: {}. Not performing migration.", + e + ) + })?; + + // Atomically exchange the configs + dirfd.local_exchange("grub.cfg.current", "grub.cfg").map_err(|e| { + anyhow!( + "Could not exchange the symlink with the current GRUB config: {}. Not performing migration.", + e + ) + })?; + + // Remove the now unused symlink (optional cleanup, ignore any failures) + dirfd.remove_file("grub.cfg.current").unwrap_or_else(|e| { + println!( + "Could not remove now unused GRUB config symlink: {}. Ignoring error.", + e + ) + }); + + println!("GRUB config symlink successfully replaced with the current config."); + } + }; + + // If /etc/default/grub exists then we have to force the regeneration of the + // GRUB config to remove the ostree entries that duplicates the BLS ones + let grub_default = PathBuf::from("/etc/default/grub"); + if grub_default.exists() { + println!("Marking bootloader as BLS capable..."); + File::create("/boot/grub2/.grub2-blscfg-supported").map_err(|e| { + anyhow!( + "Could not remove mark bootloader as BLS capable: {}", + e + ) + })?; + + println!("Regenerating GRUB config with only BLS configs..."); + let status = std::process::Command::new("grub2-mkconfig") + .arg("-o") + .arg(grub_config_filename) + .status()?; + if !status.success() { + anyhow::bail!("Failed to regenerate GRUB config"); + } + } + + println!("Setting up 'sysroot.bootloader' to 'none' in ostree repo config..."); + let status = std::process::Command::new("ostree") + .args([ + "config", + "--repo=/sysroot/ostree/repo", + "set", + "sysroot.bootloader", + "none", + ]) + .status()?; + if !status.success() { + anyhow::bail!("Failed to set 'sysroot.bootloader' to 'none' in ostree repo config"); + } + + // Migration complete, let's write the stamp file + File::create(stamp_file)?; + + println!("Static GRUB config migration completed successfully!"); + Ok(()) +} + #[cfg(test)] mod tests { use super::*; diff --git a/src/cli/bootupctl.rs b/src/cli/bootupctl.rs index ab30decb..4ac934a3 100644 --- a/src/cli/bootupctl.rs +++ b/src/cli/bootupctl.rs @@ -58,6 +58,8 @@ pub enum CtlVerb { AdoptAndUpdate, #[clap(name = "validate", about = "Validate system state")] Validate, + #[clap(name = "migrate", about = "Migrate a system to static a GRUB config")] + Migrate, } #[derive(Debug, Parser)] @@ -95,6 +97,7 @@ impl CtlCommand { CtlVerb::Backend(CtlBackend::Install(opts)) => { super::bootupd::DCommand::run_install(opts) } + CtlVerb::Migrate => Self::run_migrate(), } } @@ -135,6 +138,12 @@ impl CtlCommand { ensure_running_in_systemd()?; bootupd::client_run_validate() } + + /// Runner for `migrate` verb. + fn run_migrate() -> Result<()> { + ensure_running_in_systemd()?; + bootupd::client_run_migrate() + } } /// Checks if the current process is (apparently at least)