1. Manuals
  2. Tumbleweed
  3. flake-pilot-firecracker
  4. flake-ctl-firecracker-register(8)

Scroll to navigation

FLAKE-CTL-FIRECRACKER-REGISTER(8)() FLAKE-CTL-FIRECRACKER-REGISTER(8)()

Name

FLAKE-CTL-FIRECRACKER-REGISTER(8) -

NAME

flake-ctl firecracker register - Register VM application

SYNOPSIS

USAGE:


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


    --app <APP>


    --force


    --include-tar <INCLUDE_TAR>...


    --include-path <INCLUDE_PATH>...


    --no-net


    --resume


    --force-vsock


    --overlay-size <OVERLAY_SIZE>


    --run-as <RUN_AS>


    --target <TARGET>


    --user


    --vm <VM>


DESCRIPTION

Register the given application to run inside of the specified firecracker virtual machine. The registration process is two fold:

1.
Create the application symlink pointing to /usr/bin/firecracker-pilot
2.
Create the application default configuration below /usr/share/flakes. In user mode the configuration is created below ~/.config/flakes and refers to a VM of the registry of the calling user. Each application registered is called a flake

On successful completion the registered --app name can be called like a normal application on this host.

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

OPTIONS

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 writing the registration even if a registration of the same name already exists. This is done by deleting an eventual existing registration prio 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 !

--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


Disable networking
Size of overlay write space in bytes. Optional suffixes are: KiB/MiB/GiB/TiB (1024) or KB/MB/GB/TB (1000)
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.
Name of the user to run firecracker
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
Register in the user specific registry, rootless mode. The flake configuration is created below ~/.config/flakes and the VM is looked up in ~/.config/flakes/firecracker/images. Requesting user mode as the root user has no effect
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


AUTHOR

Marcus Schäfer

COPYRIGHT

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