Struct InstanceSpec 

pub struct InstanceSpec {

    pub box_id: String,
    pub vcpus: u8,
    pub memory_mib: u32,
    pub rootfs_path: PathBuf,
    pub exec_socket_path: PathBuf,
    pub pty_socket_path: PathBuf,
    pub attest_socket_path: PathBuf,
    pub port_forward_socket_path: PathBuf,
    pub fs_mounts: Vec<FsMount>,
    pub entrypoint: Entrypoint,
    pub ksm: bool,
    pub snapshot_mem_file: Option<String>,
    pub snapshot_sock: Option<String>,
    pub restore_from: Option<String>,
    pub console_output: Option<PathBuf>,
    pub workdir: String,
    pub tee_config: Option<TeeInstanceConfig>,
    pub port_map: Vec<String>,
    pub user: Option<String>,
    pub network: Option<NetworkInstanceConfig>,
    pub resource_limits: ResourceLimits,
    pub log_config: LogConfig,
}

Complete configuration for a VM instance.

Serialized and passed to the shim subprocess, which uses it to configure and start the VM via the underlying hypervisor.

Fields

box_id: String

Unique identifier for this box instance

vcpus: u8

Number of vCPUs (default: 2)

memory_mib: u32

Memory in MiB (default: 512)

rootfs_path: PathBuf

Path to the root filesystem

exec_socket_path: PathBuf

Path to the Unix socket for exec communication

pty_socket_path: PathBuf

Path to the Unix socket for PTY communication

attest_socket_path: PathBuf

Path to the Unix socket for TEE attestation communication

port_forward_socket_path: PathBuf

Path to the Unix socket for CRI port-forward control

fs_mounts: Vec<FsMount>

Filesystem mounts (virtio-fs shares)

entrypoint: Entrypoint

Guest agent entrypoint

ksm: bool

Mark guest memory KSM-mergeable (host page dedup across same-image VMs; Linux 6.4+, requires /sys/kernel/mm/ksm/run=1 on the host).

snapshot_mem_file: Option<String>

Snapshot-fork (per-VM): file-backed guest RAM path. When set (with snapshot_sock), this VM boots as a snapshot TEMPLATE — guest RAM is file-backed so it can be snapshotted on demand.

snapshot_sock: Option<String>

Snapshot-fork (per-VM): unix socket on which libkrun serves snapshot requests for this template VM.

restore_from: Option<String>

Snapshot-fork (per-VM): when set (with snapshot_mem_file), this VM is a RESTORE — it resumes the snapshotted template from this state file with MAP_PRIVATE CoW of the RAM file, instead of cold-booting. This is the per-VM seam that lets one process fork many VMs (the pool / fork daemon), which a process-global KRUN_RESTORE_FROM env cannot express.

console_output: Option<PathBuf>

Optional console output file path

workdir: String

Working directory inside the VM

tee_config: Option<TeeInstanceConfig>

TEE configuration (None for standard VM)

port_map: Vec<String>

TSI port mappings: [“host_port:guest_port”, …]

user: Option<String>

User to run as inside the VM (from OCI USER directive). Format: “uid”, “uid:gid”, “user”, or “user:group”

network: Option<NetworkInstanceConfig>

Network configuration for virtio-net networking. None = TSI mode (default), Some = virtio-net mode (passt on Linux, gvproxy on macOS).

resource_limits: ResourceLimits

Resource limits (PID limits, CPU pinning, ulimits, cgroup controls).

log_config: LogConfig

Logging driver config. The shim runs the log processor for the box’s lifetime (so detached run -d logs aren’t truncated when the CLI exits).

Trait Implementations

impl Clone for InstanceSpec

fn clone(&self) -> InstanceSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InstanceSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for InstanceSpec

fn default() -> InstanceSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InstanceSpec

fn deserialize<__D>( __deserializer: __D, ) -> Result<InstanceSpec, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for InstanceSpec

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.