firecracker

Documentation

Overview

Package firecracker deals with anything related to Firecracker virtual machines. This involves creating, deleting, It also deals with keeping track of network interfaces, socket files.

Index

• Constants
• func GenerateSocketFile(n int) string
• func NewClient(sockFile string) *http.Client
• func RunPreviouslyRunningVMs() error
• func StartCustom(ctx context.Context, custom CustomVM) error
• func StartDefault(ctx context.Context, def DefaultVM) error
• type CustomVM
• type DefaultVM

Constants

const (
	ERR_ACTIONS_REQ           = "Error in making PUT request to /actions with give body"
	ERR_BOOTSOURCE_REQ        = "Error in making PUT request to /boot-source with give body"
	ERR_DRIVES_REQ            = "Error in making PUT request to /drives with give body"
	ERR_MACHINE_CONFIG_REQ    = "Error in making PUT request to /machine-config with give body"
	ERR_NETWORK_INTERFACE_REQ = "Error in making PUT request to /network-interfaces with give body"
	ERR_MMDS_CONFIG           = "Error in making PUT request to /mmds/config with given body"
	ERR_MMDS_MSG              = "Error in making PUT request to /mmds with given body"
)

Functions

func GenerateSocketFile

func GenerateSocketFile(n int) string

GenerateSocketFile generates a path for socket file to be used for communication with firecracker.

func NewClient

func NewClient(sockFile string) *http.Client

func RunPreviouslyRunningVMs

func RunPreviouslyRunningVMs() error

RunPreviouslyRunningVMs runs `runFromConfig` for every firecracker VM record found in local DB which are marked `running`.

func StartCustom

func StartCustom(ctx context.Context, custom CustomVM) error

func StartDefault

func StartDefault(ctx context.Context, def DefaultVM) error

Types

type CustomVM

type CustomVM struct {
	KernelImagePath string `json:"kernel_image_path"`
	FilesystemPath  string `json:"filesystem_path"`
	VCPUCount       int    `json:"vcpu_count"`
	MemSizeMib      int    `json:"mem_size_mib"`
	TapDevice       string `json:"tap_device"`
}

type DefaultVM

type DefaultVM struct {
	KernelImagePath string `json:"kernel_image_path"`
	FilesystemPath  string `json:"filesystem_path"`
	PublicKey       string `json:"public_key"`
	NodeID          string `json:"node_id"`
}