Struct MicroVMConfig

pub struct MicroVMConfig {

    pub logger: Option<Logger>,
    pub metrics: Option<Metrics>,
    pub boot_source: Option<BootSource>,
    pub drives: Option<Vec<Drive>>,
    pub network_interfaces: Option<Vec<NetworkInterface>>,
    pub vsock_devices: Option<Vec<Vsock>>,
    pub cpu_config: Option<CPUConfig>,
    pub machine_config: Option<MachineConfiguration>,
    pub vmid: Option<String>,
    pub net_ns: Option<String>,
    pub mmds_config: Option<MmdsConfig>,
    pub balloon: Option<Balloon>,
    pub entropy_device: Option<EntropyDevice>,
    pub init_metadata: Option<String>,
}

Configuration for a microVM instance

Fields

logger: Option<Logger>

The logger for microVM.

metrics: Option<Metrics>

The file path where the Firecracker metrics is located.

boot_source: Option<BootSource>

Kernel image path, initrd path (optional) and kernel args.

drives: Option<Vec<Drive>>

Block devices that should be made available to the microVM.

network_interfaces: Option<Vec<NetworkInterface>>

Tap devices that should be made available to the microVM.

vsock_devices: Option<Vec<Vsock>>

Vsock devices that should be made available to the microVM.

cpu_config: Option<CPUConfig>

CPU configuration of microVM.

machine_config: Option<MachineConfiguration>

Firecracker microVM process configuration.

vmid: Option<String>

(Optional) vmid is a unique identifier for this VM. It’s set to a random uuid if not provided by the user. It’s used to set Firecracker’s instance ID.

net_ns: Option<String>

The path to a network namespace handle. If present, the application will use this to join the associated network namespace

mmds_config: Option<MmdsConfig>

Mmds configuration.

balloon: Option<Balloon>

Balloon device that is to be put to the machine.

entropy_device: Option<EntropyDevice>

The entropy device.

init_metadata: Option<String>

Initial metadata that is to be assigned to the machine.

Implementations

impl MicroVMConfig

pub fn validate(&self) -> RtckResult<()>

Trait Implementations

impl Clone for MicroVMConfig

fn clone(&self) -> MicroVMConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MicroVMConfig

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

Formats the value using the given formatter.

impl Default for MicroVMConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MicroVMConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for MicroVMConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MicroVMConfig

fn cmp(&self, other: &MicroVMConfig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MicroVMConfig

fn eq(&self, other: &MicroVMConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MicroVMConfig

fn partial_cmp(&self, other: &MicroVMConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MicroVMConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MicroVMConfig

impl StructuralPartialEq for MicroVMConfig