firecracker-node
    Preparing search index...

    Interface MachineConfiguration

    Describes the number of vCPUs, memory size, SMT capabilities, huge page configuration and the CPU template.

    https://github.com/firecracker-microvm/firecracker/blob/f0691f8253d4bde225b9f70ecabf39b7ad796935/src/firecracker/swagger/firecracker.yaml#L1376

    interface MachineConfiguration {
        cpu_template?: CPUTemplate;
        huge_pages?: HugePagesConfig;
        mem_size_mib: number;
        smt?: boolean;
        track_dirty_pages?: boolean;
        vcpu_count: number;
    }
    Index

    Properties

    cpu_template? huge_pages? mem_size_mib smt? track_dirty_pages? vcpu_count

    Properties

    cpu_template?: CPUTemplate

    The CPU Template defines a set of flags to be disabled from the microvm so that the features exposed to the guest are the same as in the selected instance type. This parameter has been deprecated and it will be removed in future Firecracker release.

    "None"

    https://github.com/firecracker-microvm/firecracker/blob/f0691f8253d4bde225b9f70ecabf39b7ad796935/src/firecracker/swagger/firecracker.yaml#L1046

    huge_pages?: HugePagesConfig

    Which huge pages configuration (if any) should be used to back guest memory.

    None
    mem_size_mib: number

    Memory size of VM

    128
    smt?: boolean

    Flag for enabling/disabling simultaneous multithreading. Can be enabled only on x86.

    false
    track_dirty_pages?: boolean

    Enable dirty page tracking. If this is enabled, then incremental guest memory snapshots can be created. These belong to diff snapshots, which contain, besides the microVM state, only the memory dirtied since a previous snapshot. Full snapshots each contain a full copy of the guest memory.

    false
    vcpu_count: number

    Number of vCPUs (either 1 or an even number)

    1
    - Minimum: 1
    - Maximum: 32

    Settings

    Member Visibility

    On This Page

    Properties