Add explicit --migrate option to generate-zbm
Conversion from INI to YAML is no longer fully automatic, but is instead accomplished by specifying --migrate with an optional path to the INI file to migrate. Combined with --config, this allows totally customizable migration sources and targets. generate-zbm always terminates immediately after attempted migration, with the exit code indicating success (zero) or failure (nonzero). Closes #65
This commit is contained in:
Andrew J. Hesford
parent
d9f3e9cc77
commit
3b2b2f0963
22
README.md
22
README.md
|
|
@ -189,12 +189,9 @@ Your distribution should have packages for these already.
|
|||
|
||||
## config.yaml
|
||||
|
||||
The YAML file `/etc/zfsbootmenu/config.yaml` is used to control the behavior of `generate-zbm`. In prior versions, an INI file was used; `generate-zbm` will convert an existing `config.ini` file if possible when no `config.yaml` is found.
|
||||
|
||||
An example YAML configuration file follows:
|
||||
The YAML file `/etc/zfsbootmenu/config.yaml` is used to control the behavior of `generate-zbm`. An example YAML configuration file follows:
|
||||
|
||||
```
|
||||
---
|
||||
Global:
|
||||
ManageImages: false
|
||||
BootMountPoint: /boot/efi
|
||||
|
|
@ -241,6 +238,23 @@ Kernel:
|
|||
* `Versions` Behaves similarly to `Components.Versions`, but acts on files matching the UEFI bundle naming scheme.
|
||||
* `Stub` This is the path to the stub loader used to boot the unified EFI image. If not set, a default of `/usr/lib/gummiboot/linuxx64.efi.stub` is assumed.
|
||||
|
||||
|
||||
## Conversion of legacy configurations
|
||||
|
||||
In prior versions of ZFS Boot Menu, an INI format was used for configuration. In general, migration to the new format is not automatic, but `generate-zbm` can perform the migration if your distribution package has not done it for you. To migrate an existing configuration, just run
|
||||
|
||||
```
|
||||
generate-zbm --migrate [ini-config] [--config yaml-config]
|
||||
```
|
||||
|
||||
By default, the output YAML will be written to `/etc/zfsbootmenu/config.yaml`; use the `--config` argument to customize the output location.
|
||||
|
||||
The argument `[ini-config]` to `--migrate` is optional. When it is not provided, `generate-zbm` will derive an input file by dropping the `.yaml` extension from the output file and appending a `.ini` extension.
|
||||
|
||||
If (and only if) `generate-zbm` is run without a `--config` option (*i.e.*, it attempts to load the default `/etc/zfsbootmenu/config.yaml`) and the default configuration does *not* exist. Under these circumstances, `generate-zbm` will behave as if it were passed the `--migrate /etc/zfsbootmenu/config.ini` option.
|
||||
|
||||
Whenever `generate-zbm` attempts to migrate configuraton files, it will exit immediately with a zero exit code on successful conversion and a nonzero exit code if problems were encountered during the conversion. No boot images will be produced in the same invocation as a migration attempt.
|
||||
|
||||
# Native encryption
|
||||
|
||||
ZFS Boot Menu can import pools or filesystems with native encryption enabled. If your boot environments are not encrypted but say /home is, you will not receive a decryption prompt. To ensure that you can decrypt your pool to load the kernel and initramfs, you'll need to you have the filesystem parameters configured correctly.
|
||||
|
|
|
|||
|
|
@ -51,8 +51,7 @@ BEGIN {
|
|||
}
|
||||
|
||||
my ( %runConf, %config );
|
||||
|
||||
my $configfile;
|
||||
my $default_config = "/etc/zfsbootmenu/config.yaml";
|
||||
|
||||
$runConf{bootdir} = "/boot";
|
||||
$runConf{confd} = "/etc/zfsbootmenu/dracut.conf.d";
|
||||
|
|
@ -65,7 +64,8 @@ GetOptions(
|
|||
"bootdir|b=s" => \$runConf{bootdir},
|
||||
"confd|C=s" => \$runConf{confd},
|
||||
"cmdline|l=s" => \$runConf{cmdline},
|
||||
"config|c=s" => \$configfile,
|
||||
"migrate|m:s" => \$runConf{migrate},
|
||||
"config|c=s" => \$runConf{config},
|
||||
"help|h" => sub {
|
||||
my $bin = basename($0);
|
||||
my $help = << "EOF";
|
||||
|
|
@ -78,54 +78,68 @@ Usage: $bin [options]
|
|||
-C|--confd Manually set the Dracut configuration directory
|
||||
-c|--config Manually set the configuration file
|
||||
-l|--cmdline Manually set the kernel command line
|
||||
-m|--migrate Migrate legacy INI file to new YAML format
|
||||
EOF
|
||||
print $help;
|
||||
exit;
|
||||
},
|
||||
);
|
||||
|
||||
unless ( nonempty $configfile ) {
|
||||
my $inifile = "/etc/zfsbootmenu/config.ini";
|
||||
my $iniconv = "${inifile}.converted";
|
||||
unless ( nonempty $runConf{config} ) {
|
||||
$runConf{config} = $default_config;
|
||||
|
||||
$configfile = "/etc/zfsbootmenu/config.yaml";
|
||||
|
||||
# Convert a default INI to YAML if no YAML config exists
|
||||
if ( -f $inifile and !-f $configfile ) {
|
||||
print "Converting $inifile to $configfile\n";
|
||||
convertConfig( $inifile, $configfile );
|
||||
|
||||
my $notice = <<"EOF";
|
||||
NOTICE: the legacy INI configuration file
|
||||
|
||||
$inifile
|
||||
|
||||
has been converted to YAML at
|
||||
|
||||
$configfile
|
||||
|
||||
Please verify the converted file.
|
||||
|
||||
EOF
|
||||
|
||||
print $notice;
|
||||
|
||||
if ( rename( $inifile, $iniconv ) ) {
|
||||
print "The prior configuration has been renamed to\n\n $iniconv\n\n";
|
||||
}
|
||||
# Implicitly request migration if default config does not exist
|
||||
unless ( defined $runConf{migrate} or -f $runConf{config} ) {
|
||||
printf "Configuration %s does not exist, attempting to migrate\n", $runConf{config};
|
||||
$runConf{migrate} = "/etc/zfsbootmenu/config.ini";
|
||||
}
|
||||
}
|
||||
|
||||
if ( -r $configfile ) {
|
||||
# If migration explicitly requested or no config file exists, convert it
|
||||
if ( defined $runConf{migrate} ) {
|
||||
my $inifile;
|
||||
|
||||
if ( nonempty $runConf{migrate} ) {
|
||||
$inifile = $runConf{migrate};
|
||||
} else {
|
||||
$inifile = $runConf{config};
|
||||
$inifile =~ s/(\.yaml)?$/.ini/i;
|
||||
}
|
||||
|
||||
# If possible, make a backup of an existing output file
|
||||
my $conf_backup = sprintf( "%s.backup", $runConf{config} );
|
||||
if ( -f $runConf{config} and safeCopy( $runConf{config}, $conf_backup ) ) {
|
||||
printf "Created backup %s -> %s\n", $runConf{config}, $conf_backup;
|
||||
}
|
||||
|
||||
convertConfig( $inifile, $runConf{config} ) or exit 1;
|
||||
exit 0;
|
||||
}
|
||||
|
||||
if ( -r $runConf{config} ) {
|
||||
eval {
|
||||
my $yaml = YAML::PP->new( boolean => 'boolean' )->load_file($configfile);
|
||||
my $yaml = YAML::PP->new( boolean => 'boolean' )->load_file( $runConf{config} );
|
||||
%config = %$yaml;
|
||||
} or do {
|
||||
printf "Unable to parse configuration %s as YAML\n", $configfile;
|
||||
my $error = <<"EOF";
|
||||
Unable to parse configuration $runConf{config} as YAML.
|
||||
|
||||
If this is a legacy configuration, migrate to the new format by running
|
||||
|
||||
$0 --migrate $runConf{config} [ --config <output> ],
|
||||
|
||||
where `<output>` is the desired location of the converted file. If you
|
||||
omit the `--config` option, an output location
|
||||
|
||||
$default_config
|
||||
|
||||
will be used by default.
|
||||
EOF
|
||||
print $error;
|
||||
exit 1;
|
||||
};
|
||||
} else {
|
||||
printf "Configuration %s does not exist or is unreadable\n", $configfile;
|
||||
printf "Configuration %s does not exist or is unreadable\n", $runConf{config};
|
||||
exit 1;
|
||||
}
|
||||
|
||||
|
|
@ -639,8 +653,14 @@ sub verboseUnlink {
|
|||
sub convertConfig {
|
||||
my ( $inifile, $configfile ) = @_;
|
||||
|
||||
my %ini_config;
|
||||
unless ( -r $inifile ) {
|
||||
printf "Unable to read legacy configuration file %s\n", $inifile;
|
||||
exit 1;
|
||||
}
|
||||
|
||||
print "Migrating $inifile to $configfile\n";
|
||||
|
||||
my %ini_config;
|
||||
tie %ini_config, 'Config::IniFiles', ( -file => $inifile );
|
||||
|
||||
my $yaml = YAML::PP->new(
|
||||
|
|
@ -662,6 +682,8 @@ sub convertConfig {
|
|||
delete $ini_config{syslinux};
|
||||
|
||||
$yaml->dump_file( $configfile, \%ini_config );
|
||||
|
||||
printf "Please verify the converted file %s\n", $configfile;
|
||||
}
|
||||
|
||||
sub convertImageConfig {
|
||||
|
|
|
|||
Loading…
Reference in New Issue