firecracker

package module

Go to main page

Versions in this module

v1

v1.0.0

Aug 31, 2022

Changes in this version

+ const ConfigMmdsHandlerName

+ const CreateBalloonHandlerName

+ const LoadSnapshotHandlerName

+ const MMDSv1

+ const MMDSv2

+ const ValidateLoadSnapshotCfgHandlerName

+ var ConfigMmdsHandler = Handler

+ var LoadSnapshotConfigValidationHandler = Handler

+ var LoadSnapshotHandler = Handler

+ type BalloonDevice struct

+ func NewBalloonDevice(amountMib int64, deflateOnOom bool, opts ...BalloonOpt) BalloonDevice

+ func (b BalloonDevice) Build() models.Balloon

+ func (b BalloonDevice) UpdateAmountMib(amountMib int64) BalloonDevice

+ func (b BalloonDevice) UpdateStatsPollingIntervals(statsPollingIntervals int64) BalloonDevice

+ type BalloonOpt func(*models.Balloon)

+ func WithStatsPollingIntervals(statsPollingIntervals int64) BalloonOpt

type Client

+ func (f *Client) CreateSnapshot(ctx context.Context, snapshotParams *models.SnapshotCreateParams, ...) (*ops.CreateSnapshotNoContent, error)

+ func (f *Client) DescribeBalloonConfig(ctx context.Context) (*ops.DescribeBalloonConfigOK, error)

+ func (f *Client) DescribeBalloonStats(ctx context.Context) (*ops.DescribeBalloonStatsOK, error)

+ func (f *Client) GetExportVMConfig(opts ...GetExportVMConfigOpt) (*ops.GetExportVMConfigOK, error)

+ func (f *Client) GetFirecrackerVersion(ctx context.Context, opts ...GetFirecrackerVersionOpt) (*ops.GetFirecrackerVersionOK, error)

+ func (f *Client) GetInstanceInfo(ctx context.Context, opts ...DescribeInstanceOpt) (*ops.DescribeInstanceOK, error)

+ func (f *Client) LoadSnapshot(ctx context.Context, snapshotParams *models.SnapshotLoadParams, ...) (*ops.LoadSnapshotNoContent, error)

+ func (f *Client) PatchBalloon(ctx context.Context, ballonUpdate *models.BalloonUpdate, ...) (*ops.PatchBalloonNoContent, error)

+ func (f *Client) PatchBalloonStatsInterval(ctx context.Context, balloonStatsUpdate *models.BalloonStatsUpdate, ...) (*ops.PatchBalloonStatsIntervalNoContent, error)

+ func (f *Client) PatchVM(ctx context.Context, vm *models.VM, opts ...PatchVMOpt) (*ops.PatchVMNoContent, error)

+ func (f *Client) PutBalloon(ctx context.Context, balloon *models.Balloon, opts ...PutBalloonOpt) (*ops.PutBalloonNoContent, error)

+ func (f *Client) PutMmdsConfig(ctx context.Context, config *models.MmdsConfig) (*ops.PutMmdsConfigNoContent, error)

type Config

+ MmdsAddress net.IP

+ MmdsVersion MMDSVersion

+ Seccomp SeccompConfig

+ Snapshot SnapshotConfig

+ func (cfg *Config) ValidateLoadSnapshot() error

+ type CreateSnapshotOpt func(*ops.CreateSnapshotParams)

+ type DescribeInstanceOpt func(*ops.DescribeInstanceParams)

type DriveOpt

+ func WithCacheType(cacheType string) DriveOpt

+ func WithIoEngine(ioEngine string) DriveOpt

+ type GetExportVMConfigOpt func(*ops.GetExportVMConfigParams)

+ type GetFirecrackerVersionOpt func(*ops.GetFirecrackerVersionParams)

type Handler

+ func NewCreateBalloonHandler(amountMib int64, deflateOnOom bool, StatsPollingIntervals int64) Handler

type JailerCommandBuilder

+ func (b JailerCommandBuilder) WithCgroupVersion(version string) JailerCommandBuilder

type JailerConfig

+ CgroupVersion string

+ type LoadSnapshotOpt func(*ops.LoadSnapshotParams)

+ type MMDSVersion string

type Machine

+ func (m *Machine) CreateBalloon(ctx context.Context, amountMib int64, deflateOnOom bool, ...) error

+ func (m *Machine) CreateSnapshot(ctx context.Context, memFilePath, snapshotPath string, ...) error

+ func (m *Machine) DescribeInstanceInfo(ctx context.Context) (models.InstanceInfo, error)

+ func (m *Machine) GetBalloonConfig(ctx context.Context) (models.Balloon, error)

+ func (m *Machine) GetBalloonStats(ctx context.Context) (models.BalloonStats, error)

+ func (m *Machine) GetFirecrackerVersion(ctx context.Context) (string, error)

+ func (m *Machine) PauseVM(ctx context.Context, opts ...PatchVMOpt) error

+ func (m *Machine) ResumeVM(ctx context.Context, opts ...PatchVMOpt) error

+ func (m *Machine) UpdateBalloon(ctx context.Context, amountMib int64, opts ...PatchBalloonOpt) error

+ func (m *Machine) UpdateBalloonStats(ctx context.Context, statsPollingIntervals int64, ...) error

type Opt

+ func WithSnapshot(memFilePath, snapshotPath string, opts ...WithSnapshotOpt) Opt

+ type PatchBalloonOpt func(*ops.PatchBalloonParams)

+ type PatchBalloonStatsIntervalOpt func(*ops.PatchBalloonStatsIntervalParams)

+ type PatchVMOpt func(*ops.PatchVMParams)

+ type PutBalloonOpt func(*ops.PutBalloonParams)

+ type SeccompConfig struct

+ Enabled bool

+ Filter string

+ type SnapshotConfig struct

+ EnableDiffSnapshots bool

+ MemFilePath string

+ ResumeVM bool

+ SnapshotPath string

+ type WithSnapshotOpt func(*SnapshotConfig)

v0

v0.22.0

Oct 23, 2020

Changes in this version

type Client

+ func (f *Client) PutMetrics(ctx context.Context, metrics *models.Metrics, opts ...PutMetricsOpt) (*ops.PutMetricsNoContent, error)

type Config

+ LogPath string

+ MetricsPath string

+ type PutMetricsOpt func(*ops.PutMetricsParams)

v0.21.0

Mar 3, 2020

Changes in this version

type CNIConfiguration

+ NetworkConfig *libcni.NetworkConfigList

+ VMIfName string

type Config

+ InitrdPath string

+ SeccompLevel SeccompLevelValue

type IPConfiguration

+ IfName string

type JailerCommandBuilder

+ func (b JailerCommandBuilder) WithFirecrackerArgs(args ...string) JailerCommandBuilder

type SeccompLevelValue

+ func (level SeccompLevelValue) String() string

v0.20.0

Jan 8, 2020

Changes in this version

type CNIConfiguration

+ Force bool

type Config

+ ForwardSignals []os.Signal

+ NetNS string

v0.19.0

Nov 7, 2019

Changes in this version

+ const SetupKernelArgsHandlerName

+ const SetupNetworkHandlerName

+ const ValidateNetworkCfgHandlerName

+ var NetworkConfigValidationHandler = Handler

+ var SetupKernelArgsHandler = Handler

+ var SetupNetworkHandler = Handler

+ type CNIConfiguration struct

+ Args [][2]string

+ BinPath []string

+ CacheDir string

+ ConfDir string

+ IfName string

+ NetworkName string

type Client

+ func (f *Client) GetMmds(ctx context.Context, opts ...GetMmdsOpt) (*ops.GetMmdsOK, error)

+ func (f *Client) PatchMmds(ctx context.Context, metadata interface{}, opts ...PatchMmdsOpt) (*ops.PatchMmdsNoContent, error)

+ func (f *Client) PutGuestVsock(ctx context.Context, vsock *models.Vsock, opts ...PutGuestVsockOpt) (*ops.PutGuestVsockNoContent, error)

type Config

+ VMID string

+ func (cfg *Config) ValidateNetwork() error

type DriveOpt

+ func WithDriveID(id string) DriveOpt

+ func WithPartuuid(uuid string) DriveOpt

+ func WithRateLimiter(limiter models.RateLimiter) DriveOpt

+ func WithReadOnly(flag bool) DriveOpt

+ type GetMmdsOpt func(*ops.GetMmdsParams)

type HandlerList

+ func (l HandlerList) Prepend(handlers ...Handler) HandlerList

+ type IPConfiguration struct

+ Gateway net.IP

+ IPAddr net.IPNet

+ Nameservers []string

type Machine

+ Cfg Config

+ func (m *Machine) GetMetadata(ctx context.Context, v interface{}) error

+ func (m *Machine) UpdateMetadata(ctx context.Context, metadata interface{}) error

type NetworkInterface

+ CNIConfiguration *CNIConfiguration

+ StaticConfiguration *StaticNetworkConfiguration

+ type NetworkInterfaces []NetworkInterface

+ type PatchMmdsOpt func(*ops.PatchMmdsParams)

+ type PutGuestVsockOpt func(params *ops.PutGuestVsockParams)

+ type StaticNetworkConfiguration struct

+ HostDevName string

+ IPConfiguration *IPConfiguration

+ MacAddress string

type VsockDevice

+ ID string

v0.17.0

Aug 6, 2019

Changes in this version

+ const CreateLogFilesHandlerName

+ var CreateLogFilesHandler = Handler

+ var ErrMissingJailerConfig = fmt.Errorf("JailerConfig was not set for use.")

+ var ErrRequiredHandlerMissing = fmt.Errorf("required handler is missing from FcInit's list")

type Client

+ func (f *Client) GetMachineConfiguration(opts ...GetMachineConfigurationOpt) (*ops.GetMachineConfigurationOK, error)

+ func (f *Client) PatchGuestNetworkInterfaceByID(ctx context.Context, ifaceID string, ifaceCfg *models.PartialNetworkInterface, ...) (*ops.PatchGuestNetworkInterfaceByIDNoContent, error)

+ type GetMachineConfigurationOpt func(*ops.GetMachineConfigurationParams)

type JailerConfig

+ JailerBinary string

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

type Machine

+ func (m *Machine) PID() (int, error)

+ func (m *Machine) UpdateGuestNetworkInterfaceRateLimit(ctx context.Context, ifaceID string, rateLimiters RateLimiterSet, ...) error

+ type MachineIface interface

+ SetMetadata func(context.Context, interface{}) error

+ Shutdown func(context.Context) error

+ Start func(context.Context) error

+ StopVMM func() error

+ UpdateGuestDrive func(context.Context, string, string, ...PatchGuestDriveByIDOpt) error

+ UpdateGuestNetworkInterfaceRateLimit func(context.Context, string, RateLimiterSet, ...PatchGuestNetworkInterfaceByIDOpt) error

+ Wait func(context.Context) error

+ type PatchGuestNetworkInterfaceByIDOpt func(*ops.PatchGuestNetworkInterfaceByIDParams)

+ type RateLimiterSet struct

+ InRateLimiter *models.RateLimiter

+ OutRateLimiter *models.RateLimiter

v0.15.1

Mar 6, 2019

Changes in this version

type Machine

+ func (m *Machine) Shutdown(ctx context.Context) error

v0.15.0

Feb 28, 2019

Changes in this version

+ const AddVsocksHandlerName

+ const AttachDrivesHandlerName

+ const BootstrapLoggingHandlerName

+ const CreateBootSourceHandlerName

+ const CreateMachineHandlerName

+ const CreateNetworkInterfacesHandlerName

+ const LinkFilesToRootFSHandlerName

+ const SetMetadataHandlerName

+ const StartVMMHandlerName

+ const ValidateCfgHandlerName

+ const ValidateJailerCfgHandlerName

+ const Version

+ var AddVsocksHandler = Handler

+ var AttachDrivesHandler = Handler

+ var BootstrapLoggingHandler = Handler

+ var ConfigValidationHandler = Handler

+ var CreateBootSourceHandler = Handler

+ var CreateMachineHandler = Handler

+ var CreateNetworkInterfacesHandler = Handler

+ var ErrAlreadyStarted = errors.New("firecracker: machine already started")

+ var ErrCreateMachineHandlerMissing = fmt.Errorf("%s is missing from FcInit's list", CreateMachineHandlerName)

+ var JailerConfigValidationHandler = Handler

+ var StartVMMHandler = Handler

+ func Bool(b bool) *bool

+ func BoolValue(b *bool) bool

+ func Int(v int) *int

+ func Int64(v int64) *int64

+ func Int64Value(v *int64) int64

+ func IntValue(v *int) int

+ func NewRateLimiter(bandwidth, ops models.TokenBucket, opts ...RateLimiterOpt) *models.RateLimiter

+ func NewUnixSocketTransport(socketPath string, logger *logrus.Entry, debug bool) runtime.ClientTransport

+ func String(str string) *string

+ func StringValue(str *string) string

+ type Client struct

+ func NewClient(socketPath string, logger *logrus.Entry, debug bool, opts ...ClientOpt) *Client

+ func (f *Client) CreateSyncAction(ctx context.Context, info *models.InstanceActionInfo, ...) (*ops.CreateSyncActionNoContent, error)

+ func (f *Client) GetMachineConfig(opts ...GetMachineConfigOpt) (*ops.GetMachineConfigOK, error)

+ func (f *Client) PatchGuestDriveByID(ctx context.Context, driveID, pathOnHost string, ...) (*ops.PatchGuestDriveByIDNoContent, error)

+ func (f *Client) PutGuestBootSource(ctx context.Context, source *models.BootSource, opts ...PutGuestBootSourceOpt) (*ops.PutGuestBootSourceNoContent, error)

+ func (f *Client) PutGuestDriveByID(ctx context.Context, driveID string, drive *models.Drive, ...) (*ops.PutGuestDriveByIDNoContent, error)

+ func (f *Client) PutGuestNetworkInterfaceByID(ctx context.Context, ifaceID string, ifaceCfg *models.NetworkInterface, ...) (*ops.PutGuestNetworkInterfaceByIDNoContent, error)

+ func (f *Client) PutGuestVsockByID(ctx context.Context, vsockID string, vsock *models.Vsock, ...) (*ops.PutGuestVsockByIDCreated, *ops.PutGuestVsockByIDNoContent, error)

+ func (f *Client) PutLogger(ctx context.Context, logger *models.Logger, opts ...PutLoggerOpt) (*ops.PutLoggerNoContent, error)

+ func (f *Client) PutMachineConfiguration(ctx context.Context, cfg *models.MachineConfiguration, ...) (*ops.PutMachineConfigurationNoContent, error)

+ func (f *Client) PutMmds(ctx context.Context, metadata interface{}, opts ...PutMmdsOpt) (*ops.PutMmdsNoContent, error)

+ type ClientOpt func(*Client)

+ func WithOpsClient(opsClient ops.ClientIface) ClientOpt

+ type Config struct

+ Debug bool

+ DisableValidation bool

+ Drives []models.Drive

+ EnableJailer bool

+ FifoLogWriter io.Writer

+ JailerCfg JailerConfig

+ KernelArgs string

+ KernelImagePath string

+ LogFifo string

+ LogLevel string

+ MachineCfg models.MachineConfiguration

+ MetricsFifo string

+ NetworkInterfaces []NetworkInterface

+ SocketPath string

+ VsockDevices []VsockDevice

+ func (cfg *Config) Validate() error

+ type CreateSyncActionOpt func(*ops.CreateSyncActionParams)

+ type DriveOpt func(*models.Drive)

+ type DrivesBuilder struct

+ func NewDrivesBuilder(rootDrivePath string) DrivesBuilder

+ func (b DrivesBuilder) AddDrive(path string, readOnly bool, opts ...DriveOpt) DrivesBuilder

+ func (b DrivesBuilder) Build() []models.Drive

+ func (b DrivesBuilder) WithRootDrive(rootDrivePath string, opts ...DriveOpt) DrivesBuilder

+ type GetMachineConfigOpt func(*ops.GetMachineConfigParams)

+ type Handler struct

+ Fn func(context.Context, *Machine) error

+ Name string

+ func LinkFilesHandler(rootfs, kernelImageFileName string) Handler

+ func NewSetMetadataHandler(metadata interface{}) Handler

+ type HandlerList struct

+ func (l HandlerList) Append(handlers ...Handler) HandlerList

+ func (l HandlerList) AppendAfter(name string, handler Handler) HandlerList

+ func (l HandlerList) Clear() HandlerList

+ func (l HandlerList) Has(name string) bool

+ func (l HandlerList) Len() int

+ func (l HandlerList) Remove(name string) HandlerList

+ func (l HandlerList) Run(ctx context.Context, m *Machine) error

+ func (l HandlerList) Swap(handler Handler) HandlerList

+ func (l HandlerList) Swappend(handler Handler) HandlerList

+ type Handlers struct

+ FcInit HandlerList

+ Validation HandlerList

+ func (h Handlers) Run(ctx context.Context, m *Machine) error

+ type HandlersAdapter interface

+ AdaptHandlers func(*Handlers) error

+ type JailerCommandBuilder struct

+ func NewJailerCommandBuilder() JailerCommandBuilder

+ func (b JailerCommandBuilder) Args() []string

+ func (b JailerCommandBuilder) Bin() string

+ func (b JailerCommandBuilder) Build(ctx context.Context) *exec.Cmd

+ func (b JailerCommandBuilder) Stderr() io.Writer

+ func (b JailerCommandBuilder) Stdin() io.Reader

+ func (b JailerCommandBuilder) Stdout() io.Writer

+ func (b JailerCommandBuilder) WithBin(bin string) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithChrootBaseDir(path string) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithDaemonize(daemonize bool) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithExecFile(path string) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithGID(gid int) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithID(id string) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithNetNS(path string) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithNumaNode(node int) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithSeccompLevel(level SeccompLevelValue) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithStderr(stderr io.Writer) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithStdin(stdin io.Reader) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithStdout(stdout io.Writer) JailerCommandBuilder

+ func (b JailerCommandBuilder) WithUID(uid int) JailerCommandBuilder

+ type JailerConfig struct

+ ChrootBaseDir string

+ ChrootStrategy HandlersAdapter

+ Daemonize bool

+ ExecFile string

+ GID *int

+ ID string

+ NetNS string

+ NumaNode *int

+ SeccompLevel SeccompLevelValue

+ UID *int

+ type Machine struct

+ Handlers Handlers

+ Metadata interface{}

+ func NewMachine(ctx context.Context, cfg Config, opts ...Opt) (*Machine, error)

+ func (m *Machine) EnableMetadata(metadata interface{})

+ func (m *Machine) LogFile() string

+ func (m *Machine) LogLevel() string

+ func (m *Machine) Logger() *log.Entry

+ func (m *Machine) SetMetadata(ctx context.Context, metadata interface{}) error

+ func (m *Machine) Start(ctx context.Context) error

+ func (m *Machine) StopVMM() error

+ func (m *Machine) UpdateGuestDrive(ctx context.Context, driveID, pathOnHost string, ...) error

+ func (m *Machine) Wait(ctx context.Context) error

+ type NaiveChrootStrategy struct

+ KernelImagePath string

+ Rootfs string

+ func NewNaiveChrootStrategy(rootfs, kernelImagePath string) NaiveChrootStrategy

+ func (s NaiveChrootStrategy) AdaptHandlers(handlers *Handlers) error

+ type NetworkInterface struct

+ AllowMMDS bool

+ HostDevName string

+ InRateLimiter *models.RateLimiter

+ MacAddress string

+ OutRateLimiter *models.RateLimiter

+ type Opt func(*Machine)

+ func WithClient(client *Client) Opt

+ func WithLogger(logger *logrus.Entry) Opt

+ func WithProcessRunner(cmd *exec.Cmd) Opt

+ type PatchGuestDriveByIDOpt func(*ops.PatchGuestDriveByIDParams)

+ type PutGuestBootSourceOpt func(*ops.PutGuestBootSourceParams)

+ type PutGuestDriveByIDOpt func(*ops.PutGuestDriveByIDParams)

+ type PutGuestNetworkInterfaceByIDOpt func(*ops.PutGuestNetworkInterfaceByIDParams)

+ type PutGuestVsockByIDOpt func(*ops.PutGuestVsockByIDParams)

+ type PutLoggerOpt func(*ops.PutLoggerParams)

+ type PutMachineConfigurationOpt func(*ops.PutMachineConfigurationParams)

+ type PutMmdsOpt func(*ops.PutMmdsParams)

+ type RateLimiterOpt func(*models.RateLimiter)

+ type SeccompLevelValue int

+ const SeccompLevelAdvanced

+ const SeccompLevelBasic

+ const SeccompLevelDisable

+ type TokenBucketBuilder struct

+ func (b TokenBucketBuilder) Build() models.TokenBucket

+ func (b TokenBucketBuilder) WithBucketSize(size int64) TokenBucketBuilder

+ func (b TokenBucketBuilder) WithInitialSize(size int64) TokenBucketBuilder

+ func (b TokenBucketBuilder) WithRefillDuration(dur time.Duration) TokenBucketBuilder

+ type VMCommandBuilder struct

+ func (b VMCommandBuilder) AddArgs(args ...string) VMCommandBuilder

+ func (b VMCommandBuilder) Args() []string

+ func (b VMCommandBuilder) Bin() string

+ func (b VMCommandBuilder) Build(ctx context.Context) *exec.Cmd

+ func (b VMCommandBuilder) SocketPath() []string

+ func (b VMCommandBuilder) Stderr() io.Writer

+ func (b VMCommandBuilder) Stdin() io.Reader

+ func (b VMCommandBuilder) Stdout() io.Writer

+ func (b VMCommandBuilder) WithArgs(args []string) VMCommandBuilder

+ func (b VMCommandBuilder) WithBin(bin string) VMCommandBuilder

+ func (b VMCommandBuilder) WithSocketPath(path string) VMCommandBuilder

+ func (b VMCommandBuilder) WithStderr(stderr io.Writer) VMCommandBuilder

+ func (b VMCommandBuilder) WithStdin(stdin io.Reader) VMCommandBuilder

+ func (b VMCommandBuilder) WithStdout(stdout io.Writer) VMCommandBuilder

+ type VsockDevice struct

+ CID uint32

+ Path string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL