return KeySource(type=type, source=source)
+class SettingScope(StrEnum):
+ # Not passed down to subimages
+ local = enum.auto()
+ # Passed down to subimages, cannot be overridden
+ universal = enum.auto()
+ # Passed down to subimages, can be overridden
+ inherit = enum.auto()
+
+
@dataclasses.dataclass(frozen=True)
class ConfigSetting:
dest: str
path_read_text: bool = False
path_secret: bool = False
specifier: str = ""
- universal: bool = False
+ scope: SettingScope = SettingScope.local
# settings for argparse
short: Optional[str] = None
help="Build the specified profile",
parse=config_parse_profile,
match=config_make_string_matcher(),
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="dependencies",
default_factory=config_default_distribution,
choices=Distribution.choices(),
help="Distribution to install",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="release",
default_factory=config_default_release,
default_factory_depends=("distribution",),
help="Distribution release to install",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="architecture",
default=Architecture.native(),
choices=Architecture.choices(),
help="Override the architecture of installation",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="mirror",
short="-m",
section="Distribution",
help="Distribution mirror to use",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="local_mirror",
section="Distribution",
help="Use a single local, flat and plain mirror to build the image",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="repository_key_check",
default=True,
parse=config_parse_boolean,
help="Controls signature and key checks on repositories",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="repository_key_fetch",
default_factory=config_default_repository_key_fetch,
parse=config_parse_boolean,
help="Controls whether distribution GPG keys can be fetched remotely",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="repositories",
parse=config_make_list_parser(delimiter=","),
match=config_match_repositories,
help="Repositories to use",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="cacheonly",
default=Cacheonly.auto,
help="Only use the package cache when installing packages",
choices=Cacheonly.choices(),
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="package_manager_trees",
default_factory_depends=("skeleton_trees",),
help="Use a package manager tree to configure the package manager",
paths=("mkosi.pkgmngr", "mkosi.pkgmngr.tar",),
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
parse=config_make_path_parser(required=False),
paths=("mkosi.output",),
help="Output directory",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="workspace_dir",
section="Output",
parse=config_make_path_parser(required=False),
help="Workspace directory",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="cache_dir",
parse=config_make_path_parser(required=False),
paths=("mkosi.cache",),
help="Incremental cache directory",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="package_cache_dir",
section="Output",
parse=config_make_path_parser(required=False),
help="Package cache directory",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="build_dir",
parse=config_make_path_parser(required=False),
paths=("mkosi.builddir",),
help="Path to use as persistent build directory",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="image_version",
help="Set version for image",
paths=("mkosi.version",),
path_read_text=True,
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="image_id",
section="Output",
specifier="i",
help="Set ID for image",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="split_artifacts",
section="Output",
parse=config_parse_sector_size,
help="Set the disk image sector size",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="repart_offline",
parse=config_parse_boolean,
help="Build disk images without using loopback devices",
default=True,
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="overlay",
section="Output",
parse=config_parse_feature,
help="Use btrfs subvolumes for faster directory operations where possible",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="seed",
parse=config_make_list_parser(delimiter=",", parse=make_path_parser()),
paths=("mkosi.packages",),
help="Specify a directory containing extra packages",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="volatile_package_directories",
section="Content",
parse=config_make_list_parser(delimiter=",", parse=make_path_parser()),
help="Specify a directory containing extra volatile packages",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="with_recommends",
default_factory=config_default_source_date_epoch,
default_factory_depends=("environment",),
help="Set the $SOURCE_DATE_EPOCH timestamp",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="sync_scripts",
match=config_match_build_sources,
default_factory=lambda ns: [ConfigTree(ns.directory, None)] if ns.directory else [],
help="Path for sources to build",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="build_sources_ephemeral",
section="Content",
parse=config_parse_boolean,
help="Make build sources ephemeral when running scripts",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="environment",
parse=config_parse_boolean,
default=True,
help="Do not run tests as part of build scripts, if supported",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="with_network",
section="Content",
parse=config_parse_boolean,
help="Run build and postinst scripts with network access (instead of private network)",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="bootable",
parse=config_parse_key,
paths=("mkosi.key",),
help="Private key for signing verity signature",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="verity_key_source",
parse=config_parse_key_source,
default=KeySource(type=KeySource.Type.file),
help="The source to use to retrieve the verity signing key",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="verity_certificate",
parse=config_make_path_parser(),
paths=("mkosi.crt",),
help="Certificate for signing verity signature in X509 format",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="sign_expected_pcr",
default_factory_depends=("environment",),
metavar="URL",
help="Set the proxy to use",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="proxy_exclude",
metavar="HOST",
parse=config_make_list_parser(delimiter=","),
help="Don't use the configured proxy for the specified host(s)",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="proxy_peer_certificate",
"/etc/ssl/certs/ca-certificates.crt",
),
help="Set the proxy peer certificate",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="proxy_client_certificate",
section="Host",
parse=config_make_path_parser(secret=True),
help="Set the proxy client certificate",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="proxy_client_key",
default_factory_depends=("proxy_client_certificate",),
parse=config_make_path_parser(secret=True),
help="Set the proxy client key",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="incremental",
section="Host",
parse=config_parse_boolean,
help="Make use of and generate intermediary cache images",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="nspawn_settings",
section="Host",
parse=config_make_list_parser(delimiter=",", parse=make_path_parser()),
help="List of comma-separated paths to look for programs before looking in PATH",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="ephemeral",
section="Host",
parse=config_parse_boolean,
help="Set ACLs on generated directories to permit the user running mkosi to remove them",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="tools_tree",
help="Look up programs to execute inside the given tree",
nargs="?",
const="default",
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="tools_tree_distribution",
parse=config_parse_boolean,
help="Use certificates from the tools tree",
default=True,
- universal=True,
+ scope=SettingScope.universal,
),
ConfigSetting(
dest="runtime_trees",
if not (s := SETTINGS_LOOKUP_BY_NAME.get(name)):
die(f"Unknown setting {name}")
if (
- s.universal and
+ s.scope == SettingScope.universal and
not isinstance(s.parse(None, None), (list, set, dict)) and
(image := getattr(self.config, "image", None)) is not None
):
for s in SETTINGS:
setattr(context.config, s.dest, context.finalize_value(s))
- # Load the configuration for the main image.
- config = load_config(context.config)
-
+ config = copy.deepcopy(context.config)
images = []
if args.directory is not None and Path("mkosi.images").exists():
# were specified on the CLI by copying them to the CLI namespace. Any settings
# that are not marked as "universal" are deleted from the CLI namespace.
for s in SETTINGS:
- if s.universal:
- setattr(context.cli, s.dest, getattr(context.config, s.dest))
+ if s.scope == SettingScope.universal:
+ setattr(context.cli, s.dest, copy.deepcopy(getattr(config, s.dest)))
elif hasattr(context.cli, s.dest):
delattr(context.cli, s.dest)
context.cli,
"environment",
{
- name: getattr(context.config, "environment")[name]
- for name in getattr(context.config, "pass_environment", {})
- if name in getattr(context.config, "environment", {})
+ name: getattr(config, "environment")[name]
+ for name in getattr(config, "pass_environment", {})
+ if name in getattr(config, "environment", {})
}
)
setattr(context.config, "image", name)
setattr(context.config, "directory", args.directory)
+ # Settings that are marked as "inherit" are passed down to subimages but can
+ # be overridden, so we copy these to the config namespace so that they'll be
+ # overridden if the setting is explicitly configured by the subimage.
+ for s in SETTINGS:
+ if s.scope == SettingScope.inherit and hasattr(config, s.dest):
+ setattr(context.config, s.dest, copy.deepcopy(getattr(config, s.dest)))
+
# Allow subimage configuration to include everything again.
context.includes = set()
images = resolve_deps(images, config.dependencies)
images = [load_config(ns) for ns in images]
- return args, tuple(images + [config])
+ return args, tuple(images + [load_config(config)])
def load_credentials(args: argparse.Namespace) -> dict[str, str]:
projects / thirdparty / mkosi.git / commitdiff
