Use context.package_cache_dir in one more place

Add example usage of QemuDrives= to the man page

Rename copy_package_manager_state() to copy_repository_metadata()

This matches better with sync_repository_metadata().

Fix execution workflow section

Fix typo

Don't copy repository metadata when reusing a cached image

When reusing a cache we reuse the snapshot from the cache and there's
no need to copy repository metadata.

While we're at it, also remove the outdated comment.

Only copy repository metadata snapshot if /mkosi is empty

Otherwise we might be building using a base tree and there's no
need to copy anything.

Fix custom distribution builds

Merge pull request #2336 from DaanDeMeyer/cache

Rework package manager caching

Implement CacheOnly=metadata

We make CacheOnly= take an enum but keep backwards compat with the
boolean argument as well.

CacheOnly=metadata means we'll download packages but we won't sync
repository metadata. We also enable this in the kernel-install so that
our built initrds use exactly the same package versions as the host
system.

While we're at it we rename the internal variable to cacheonly instead
of cache_only (to match dnf's --cacheonly option). We keep the user
facing stuff the same to not break backwards compat.

We also make all of our enum functions take StrEnum as argument instead
of the generic enum.Enum.

kernel-install: Prefer dnf over dnf5

Rework package manager caching

Currently, CacheDirectory= is used for all caching, both incremental
images and package manager cache. While this works great for incremental
images, there's a few issues with using CacheDirectory= for all package
manager caching:

- By default we don't do any caching, this has to be explicitly
  configured by setting CacheDirectory=mkosi.cache or telling users
  to manually create mkosi.cache. This means new users might be frustrated
  by their image builds downloading everything again on subsequent builds.

- By doing package manager caches per individual mkosi project, we
  unnecessarily download multiple copies of the same repo metadata and
  packages.

- When using incremental images, if the post-install or finalize scripts
  install extra packages, these packages can trigger repository metadata
  updates, which will result in the image being built from two repository
  metadata snapshots, one from when the incremental image was built, the
  other from the new packages installed using the refreshed repository
  metadata. Even if the scripts don't trigger repository metadata updates
  themselves, because the cache is shared, the repository metadata could
  already have been updated during another image build.

- When using base trees, any images using the base tree might trigger a
  repository metadata update as well, resulting in the same issue, where
  the image is built from multiple different snapshots of the repository
  metadata.

To fix the first two issues, we introduce a new setting PackageCacheDirectory=
and make its default either a system or per user cache directory depending
on how mkosi is invoked. This makes sure we cache by default and use a shared
package manager cache directory so that we do not unnecessarily download duplicate
copies of repository metadata and packages

To fix the two remaining issues, we need to make sure we only sync repository
metadata once for each image. We opt to do this at the start of each image build
and configure the package manager commands to not do any metadata syncing by
default. To make sure the repository metadata snapshot stays available for
extension images and for incremental images, we copy the repository metadata from
the shared cache into the image itself at /mkosi/cache/<subdir>. This makes sure
that even if the repository metadata in the shared cache is refreshed by another
image build it won't remove the old snapshot for incremental builds or images
intended to be used as base trees.

To make sure the actual packages downloaded during the image build are still
written into the shared package cache, in finalize_package_manager_mounts(), we
bind mounts the relevant directories from the shared package cache instead of
from /mkosi/cache/<subdir> in the image to make sure that other image builds can
take advantage of the downloaded packages.

The /mkosi/ directory is removed from the image at the end of each image build
before packaging up the result unless we're building a directory or tar image
and CleanPackageMetadata= is explicitly disabled.

The initial sync we do at the start of each image build operates on the shared
package cache directory so that repository metadata is only refreshed once and
can be reused by other image builds.

Because package managers now prevent automatic syncing by default, we have to
rework the local package repositories slightly to make sure the local package
repository is still synced whenever it is updated. We get rid of the localrepo()
functions and opt to again write the repo definitions for the local package
repository inline to keep things simple and localized.

To avoid pacman from writing packages from the local package repository to the
shared package cache directory, we configure the local repository itself as an
additional read-only cache directory, which makes sure that pacman will read cached
packages from this directory but won't write any new packages to this directory.

For zypper we disable "keeppackages" for the local package repository to prevent
those packages from getting cached.

For dnf, we don't mount in any directory from the shared package cache for the
mkosi-packages repository to make sure it stays local to the image.

Apt doesn't support any mechanism that allows us to prevent packages from the
local repository from getting cached so we allow these to be written to the
shared package cache.

We also take the opportunity to rename the mkosi-packages repo to the mkosi repo,
and rename the accompanying config files as well;

Because pacman does not employ any sort of cache key for its repository metadata,
when using the default shared package cache directory, we use a subdirectory based
on the distribution, release and architecture that we're building for to prevent
any possible conflicts in the cache directory when different pacman based distributions
use the same repo identifiers.

To avoid issues when two instances of mkosi operate on the same package cache directory,
we take an advisory BSD lock on the cache subdirectory that we're going to sync or copy.

When building the default initrd, we make sure it uses the same repository snapshot
as the associated image.

Introduce PackageManager interface

Let's start introducing a common interface for package manager
implementations. This will allow us to slowly get rid of the
functions where we do logic for each package manager because we
don't know the one that's being used. For example we add scripts
for each package manager right now which we can get rid of with a
package manager interface.

This also allows for more intuitive naming of package manager functions,
instead of invoke_dnf() we can now write Dnf.invoke().

Fix mkosi clean

Have all tree functions return the destination path

Rename build_initrd() to build_default_initrd()

Introduce want_initrd()

Debug log in flock()

Write early apt config instead of /etc in package manager tree

This saves us from having to mount it separately as it will be mounted
as part of mounting the package manager tree.

Remove command argument from invoke_apt()

This is always "apt-get" so let's remove the argument.

Also rename "command" and "verb" arguments for other other invoke()
functions to "operation" to be consistent in our naming.

Simplify arch repositories() function a bit

Add newline between zypper repo definitions

Ensure opensuse repo id is unique

The repo ID is used as a cache key so let's make sure it is unique
based on the used url, similar to how dnf does it.

Stop using file provides in mkosi-initrd

These require extra metadata to be downloaded by dnf so let's instead
refer to the packages by name.

Make options= argument for invoke_zypper() keyword-only

Disable filelists on Fedora

This was accidentally removed in a previous commit.

Simplify clean_package_manager_metadata()

Use find_rpm_gpgkey() for OpenSUSE Tumbleweed rpm keys

There's no direct url to configure for these so we modify
find_rpm_gpgkey() so that we don't pass in a url anymore.

Introduce INVOKING_USER.mkdir()

This function creates a directory as the appropriate user depending
on where the directory is being created.

Remove outdated comment

We don't mount tools anymore at the start of the build. Mounting
them is done as part of setting the sandbox.

Install local packages later

Let's set these up after we've configured the package manager so
that any necessary directories exist.

Check if we can write to the cache directory before using it as the workspace

Simplify cache directory calculation

Move Context creation out of build_image()

This allows us to reduce the indentation level of build_image().

Add missing log message about local repository

Introduce have_cache()

Let's split of the logic to check whether we have a cached image
from reuse_cache().

Add missing license header

Clean package manager metadata on initrd-style output formats

Let's keep the size of these manageable by always removing package
manager metadata.

Debugging improvements

Make sure /var/log from the sandbox is persisted so we can access logs
more easily. Also enable dnf debug logging if ARG_DEBUG is set.

Revert "Use shared package cache directory by default"

At least pacman isn't ready just yet for cache sharing, so let's
temporarily revert this commit. We'll reintroduce it in a later
PR.

This reverts commit 98a29486b68b0aee05eefb49e129433634d4446b.

Merge pull request #2333 from DaanDeMeyer/fix

Introduce want_local_repo()

Use shared package cache directory by default

Instead of having a separate package cache for each mkosi project,
let's default to having a shared package cache directory that can
also be configured separately from the incremental cache directory.

Add back missing call to createrepo()

Drop Gentoo support

Gentoo has completely stopped working and nobody has stepped up to
maintain it. It also keeps hindering refactoring so let's remove the
gentoo support so the upcoming work is easier.

Move user related stuff to user.py

Rework find_grub_binary()

Instead of replacing grub with grub2, let's simply pass the binary
name without grub into the function.

Introduce want_local_repo()

Merge pull request #2331 from DaanDeMeyer/upgrade

Run distribution upgrade automatically in some scenarios

Have mageia and openmandriva inherit from Fedora

These are similar enough to Fedora so let's have them inherit from
Fedora.

Rework local repository

Let's have each createrepo function return the repository to use to
access the local packages and let's call this function from the setup()
functions of each distribution.

Use generators for all repository methods

Let's use generators and a repositories() method everywhere to make
things consistent.

apt: Switch to deb822 format

pacman: Make sure we pass packages to repo-add in right order

According to https://wiki.archlinux.org/title/pacman/Tips_and_tricks,
the newest version has to be added last, so let's make sure we sort
the paths we pass to repo-add.

Make sure we remove cached default initrd entries if needed

Create CNAME

Delete CNAME

Create CNAME

Merge pull request #2324 from neighbourhoodie/github-page-website

Add GitHub Page website from docs

Add CompressLevel= setting

Let's allow configuring the compression level.

man: Add a note on reserved prefixes

Merge pull request #2326 from DaanDeMeyer/news

Update NEWS.md

Update kernel-install plugin installation instructions

Update NEWS.md

Website: Rename Categories and change order

Update link to mkosi introduction blog post

Let's stop linking the old blog from 2017 and link the newer one
that was just published instead. The old one isn't really useful
as it uses tons of features that have been removed since.

Merge pull request #2310 from behrmann/hostonlyucode

Add MicrocodeHost= option

Add GitHub Page website from docs

Merge pull request #2323 from DaanDeMeyer/tmp

Use a subdirectory of TMPDIR as the sandbox's /var/tmp

kernel-install: Use CPU detection to find host-specific microcode

Add MicrocodeHost option

Only build microcode when on x86_64

Use a subdirectory of TMPDIR as the sandbox's /var/tmp

Let's take TMPDIR into account instead of always using /var/tmp. We
also make sure we override TMPDIR to /var/tmp in the sandbox.

Merge pull request #2322 from DaanDeMeyer/useradd

Add FAQ entry on how to add regular users to image

Add FAQ entry on how to add regular users to image

Fixes #2320

Fix FAQ indentation

Use a subdirectory of the workspace as TMPDIR

Let's properly distinguish temporary files from workspace files by
putting the temporary files in a subdirectory of the workspace.

Use compression extension

When `SplitArtifacts=yes` and `CompressOutput=zstd`, the file extensions should be `.zst` instead of `.zstd`.

Follow up for: 9f9426ac70bbefffa657ce4d92022231b524b870

Fix MinimumVersion= check

Add markdown contents for "A re-introduction to mkosi" blog post

Let's keep this in the repo so it can be reviewed and so we can update
it later if needed.

man: `--debug-shell=` -> `--debug-shell`

`--debug-shell` refuses to take an argument, so the equal sign is misleading (aka. `--debug-shell=yes` errors out), so let's remove it from the `man` page.

Merge pull request #2316 from DaanDeMeyer/ssh

Don't use a tools tree for verbs that don't need a build

Only use tools trees for verbs that need a build

Currently we try to use a tools tree that isn't there for verbs
that don't need a build. Let's instead opt to not use one altogether
since building an entire image just to run ssh is kind of overkill.

Don't require a build for journalctl and coredumctl

These only make sense after we've booted the image, so requiring a
build is kind of backwards.

Merge pull request #2313 from DaanDeMeyer/resources

Allow including builtin configs

Merge pull request #2317 from keszybz/pythonesque-tweaks

Minor cleanups to code

kernel-install: Use builtin mkosi-initrd configuration

Allow including builtin configs

Let's make it possible to include builtin configurations using
e.g. Include=mkosi-initrd. This allows building the default initrd
or default tools tree independently whereas currently these can only
be built as part of another image.

Rename inner parse_config() to parse_config_one()

Let's not use the same function name for the inner and outer function.

Extract mkosi.resources once

Instead of extracting individual files and directories when we need
them, let's extract the resources once and pass the extracted path
around so that we don't have to deal with context managers every time
we want to use resources.

Extract full resources instead of specific paths

Drop unnecessary parentheses around conditionals

Drop unneeded inner function

The result should be exactly the same.

One of the loops was using inverted logic (continue-if-not-else-yield instead
of yield-if), so invert that for consistency.

sandbox: Deal correctly with unmerged-usr

If /bin and such are directories instead of symlinks, bind mount
them in to the sandbox.

Fixes #2314

Release 20.2

Update NEWS

Use an r-string for regexp

I think we should do so everywhere to avoid double escaping,
even if here the string is the same length in both cases.

Implement RepositoryKeyCheck= for apt

Update NEWS

Handle builds that run from directories with less than two parent dirs

Fixes #2302

Merge pull request #2301 from DaanDeMeyer/depmod

Improve check for whether we have to rerun depmod