Class FirecrackerMicroVM

Represents a running Firecracker microVM instance.

Use the static create() method to spawn and boot a microVM. This class only exposes post-boot methods.

Index

Methods

buildFirecrackerArgs cleanup getInstanceInfo getMachineConfiguration updateDriveProperties create

Methods

`Protected`buildFirecrackerArgs

buildFirecrackerArgs(): string[]
Builds the command line arguments array for the Firecracker binary based on firecrackerInitParams. This follows the same logic as the Rust ArgParser in the Firecracker source.

Returns string[]
See
https://github.com/firecracker-microvm/firecracker/blob/f0691f8253d4bde225b9f70ecabf39b7ad796935/src/firecracker/src/main.rs#L144
- Defined in core/firecracker-microvm.ts:80

cleanup

cleanup(): Promise<void>
Stops the Firecracker microVM and cleans up resources. This kills the Firecracker process, removes the socket file and closes the API client connection.

After calling this method, the instance is no longer usable. Any subsequent method calls will throw an error.

Returns Promise<void>
- Defined in core/firecracker-microvm.ts:334

getInstanceInfo

getInstanceInfo(): Promise<InstanceInfo>
Returns general information about the running instance.

Returns Promise<InstanceInfo>
The instance information

Throws
If the VM has been stopped
- Defined in core/firecracker-microvm.ts:301

getMachineConfiguration

getMachineConfiguration(): Promise<MachineConfiguration>
Gets the machine configuration of the VM.

Returns Promise<MachineConfiguration>
The machine configuration

Throws
If the VM has been stopped
- Defined in core/firecracker-microvm.ts:311

updateDriveProperties

updateDriveProperties(partialDrive: PartialDrive): Promise<void>
Updates the properties of a drive. This can be used to change the backing file or rate limiter of a drive post-boot.
Parameters
- partialDrive: PartialDrive
  The drive properties to update
Returns Promise<void>
Throws
If the VM has been stopped
- Defined in core/firecracker-microvm.ts:322

`Static`create

create(
    firecrackerInitParams: FirecrackerInitParams,
    microVMConfig: MicroVMConfig,
    cleanupExistingSocket?: boolean,
): Promise<FirecrackerMicroVM>
Creates and boots a new Firecracker microVM.

This method:
1. Creates a new FirecrackerMicroVM instance which internally
  - Spawns the Firecracker process
  - Creates the API client to communicate with the process
2. Then, waits for the API to be ready
3. Configures boot source, drives, and machine configuration
4. Starts the microVM and returns a running instance
Parameters
- firecrackerInitParams: FirecrackerInitParams
  Firecracker process initialization parameters
- microVMConfig: MicroVMConfig
- cleanupExistingSocket: boolean = true
  Whether to clean up an existing socket file before starting the VM (default: true)
Returns Promise<FirecrackerMicroVM>
A running FirecrackerMicroVM instance

Throws
If the configuration is invalid or if the API/VM fails to start
- Defined in core/firecracker-microvm.ts:240