kmorph.conf.example

# kmorph configuration. Install as /etc/kmorph/kmorph.conf on the
# predecessor and at the same path in the successor initramfs; kmorph
# and kmorphd read the same file.
#
# kernel, cpus and memory are required to arm. Every other key is
# optional and shown at its default.

# --- Successor (predecessor side, read by kmorph) ---

# Kernel image: an ELF vmlinux or a bzImage; an Image on arm64.
kernel  = /boot/vmlinuz

# An image of your own for the successor, loaded as it is. Unset: the
# distro's initramfs with kmorphd, which kmorph arm builds with dracut or
# mkinitramfs when it is missing or stale.
#initrd = /boot/successor.img

# CPUs for the successor, e.g. 1 or 12-15,20. CPU n is the n-th of the
# machine's CPUs in physical id order (APIC id on x86, MPIDR on arm64),
# counting from 0, so the same number names the same CPU in every
# generation. kmorph arm prints the physical ids.
cpus    = 1

# Memory for the successor, e.g. 512MB or 4GB. It must hold the unpacked
# successor image.
memory  = 512MB

# Parameters for the successor on top of this kernel's own command line,
# which kmorph copies less what describes this kernel's own resources and
# boot (BOOT_IMAGE, initrd, crashkernel, mem, hugepages, isolcpus, the
# consoles and the like). A parameter here replaces the copied ones of the
# same name. With console set, kmorph adds an earlycon for that line
# unless this already has an early console.
#cmdline = loglevel=7 printk.devkmsg=on

# Further parameter names left out of the copy. * copies nothing, so that
# cmdline is the whole command line.
#cmdline_drop = splash

# Devices the successor owns from boot, comma separated: PCI addresses
# or the names sysfs knows them by (a network interface, a block device,
# a framebuffer, a USB bus). It adopts every other device at the takeover.
#devices = enp9s0

# Kernel modules the distro image builders add to the successor image,
# comma separated: the vsock transport when it is a module, drivers for
# devices handed to the successor. Ignored with initrd.
#modules = mk_transport

# systemd units the successor runs before the takeover, from a standby
# image kmorph arm builds, so that they are already up when it happens.
# They must start without the disk and the network.
#standby = nginx.service

# Further paths the standby image carries.
#standby_files = /usr/lib64/nginx/modules

# yes when the root is on the network, so that the successor image keeps
# dracut's own networking to mount it. Otherwise kmorphd alone brings the network up until the disk's
# network manager takes it over.
#network_root = no

# --- Detection and takeover (successor side, read by kmorphd) ---

# How often the predecessor is probed.
#probe_interval = 100ms

# Consecutive timed-out probes before the predecessor is declared dead.
#probe_timeouts = 5

# Retries of a fence that could not park every CPU.
#fence_retries = 3

# File to receive the predecessor's memory as a vmcore before it is
# reclaimed. A FIFO works. Unset: reclaim at once.
#dump = /var/crash/predecessor.vmcore

# Reset each adopted device before its driver binds, or clear its bus
# mastering if it cannot be reset. no: leave it as the crash left it.
#reset_devices = yes

# Serial line that shows the successor's kernel messages, from its boot
# through the takeover, e.g. ttyS0 or ttyAMA0, or tty0 for the screen,
# such as the one a BMC's remote KVM shows.
#console = ttyS0

# Speed of that line.
#console_baud = 115200

# Program run on that line after the takeover, e.g. /bin/sh for an image
# without accounts. Needs an 8250 UART. Unset: no login.
#console_login = /bin/sh