FLAKE-CTL-FIRECRACKER-REGISTER(8)

💅 NAME 💅

FLAKE-CTL-FIRECRACKER-REGISTER(8) —

---

✨ NAME ✨

flake-ctl firecracker register — Register VM application 🎀

okay so quick vibe check: this is the manual page for <hotpink>flake-ctl firecracker register</hotpink>, and it lives in section 8 of the manual. Welcome, bestie 🫶

🔥 SYNOPSIS 🔥

Here's the whole shape of it, verbatim, no cap:

USAGE:
    flake-ctl firecracker register [OPTIONS] --vm <VM> --app <APP>

OPTIONS:
    --app <APP>
    --force
    --include-tar <INCLUDE_TAR>...
    --include-path <INCLUDE_PATH>...
    --no-net
    --pilot-option <PILOT_OPTION>...
    --resume
    --force-vsock
    --overlay-size <OVERLAY_SIZE>
    --run-as <RUN_AS>
    --target <TARGET>
    --vm <VM>

🌸 DESCRIPTION 🌸

So you wanna register the given application to run inside of the specified firecracker virtual machine. Iconic. The registration process is two fold, bestie:

1. Create the application symlink pointing to /usr/bin/firecracker-pilot
2. Create the application default configuration below /usr/share/flakes. Each application registered is called a flake ✨

The registry to register in is detected from the caller. Called as any user other than root, the registration is done in the user specific, rootless registry of that user. The flake configuration is created below ~/.config/flakes and the VM is looked up in ~/.config/flakes/firecracker/images 🦋

On successful completion the registered --app name can be called like a normal application on this host. literally main character energy 👑

For further details about the flake configuration please refer to the firecracker-pilot manual page.

---

🎀 OPTIONS 🎀

• --app <APP> — An absolute path to the application on the host. If not specified via the --target option, the application will be called with that path inside of the VM.
• --force — Force writing the registration even if a registration of the same name already exists. This is done by deleting an eventual existing registration prior to creating the new registration. ⚠️ Please have in mind that a failed registration still causes an eventual existing former registration to be deleted in this case ! like, it's giving destructive, be so careful 💀
• --include-tar <INCLUDE_TAR>... — Name of a tar file to be included on top of the VM instance. This option can be specified multiple times.
• --include-path <INCLUDE_PATH>... — Name of a file or directory to be included on top of the VM instance. This option can be specified multiple times.
• --no-net — Disable networking. The ip= option is deleted from the kernel commandline of the VM. Without it the VM is not connected, the pilot creates no TAP device setup for it and passes no network-interfaces section to firecracker. The setup can be created later on with

**
flake-ctl-firecracker-network-add**(8)

lowkey the docs build got mad at this exact spot 🙈 here's the verbatim system message from the original page, ./flake-ctl-firecracker-register.rst line 84: System Message: WARNING/2 (./flake-ctl-firecracker-register.rst:, line 84) Inline strong start-string without end-string.

• --overlay-size <OVERLAY_SIZE> — Size of overlay write space in bytes. Optional suffixes are: KiB/MiB/GiB/TiB (1024) or KB/MB/GB/TB (1000). math girlies rise 🌈
• --pilot-option <PILOT_OPTION>... — Pilot option, and optional value, in the format %name or %name:value. Pilot options are not passed to the application call but control the behavior of firecracker-pilot. An option registered here is always effective and does not have to be given at call time. Passing the option at call time takes precedence over the registered value. This option can be specified multiple times. For the list of available pilot options please refer to the firecracker-pilot manual page.
• --resume — Resume the VM from previous execution. If the VM is still running, the app will be executed inside of this VM instance.
• --force-vsock — Force using a vsock to communicate between guest and host if resume is set to false. In resume mode the vsock setup is always required.
• --run-as <RUN_AS> — Name of the user to run firecracker.
• --target <TARGET> — An absolute path to the application in the VM. Use this option if the application path on the host should be different to the application path inside of the VM.
• --vm <VM> — A virtual machine name. The name must match with a name in the local firecracker registry.

---

🗂️ FILES 🗂️

• /usr/share/flakes
• ~/.config/flakes
• /etc/flakes.yml

🧚 EXAMPLE 🧚

$ flake-ctl firecracker register --vm NAME \
    --overlay-size 20g \
    --app /usr/bin/apt-get

$ flake-ctl firecracker register --vm NAME \
    --app /usr/bin/apt-get \
    --resume \
    --pilot-option '%port:2000'

💖 AUTHOR 💖

Marcus Schäfer 👑

⭐ COPYRIGHT ⭐

(c) 2022, Elektrobit Automotive GmbH (c) 2023, Marcus Schäfer

---

and that's the whole page, bestie, we ate and left no crumbs 🍓 the footer situation is FLAKE-CTL-FIRECRACKER-REGISTER(8)() — manual name, empty version field, no date on this one — so consider this your cute little sign-off: same manual name, same section, slay 💅