firevm

Documentation

Index

• func NewFirecrackerDriver(logger hclog.Logger) drivers.DriverPlugin
• func RandomVethName() (string, error)
• type Config
• type Driver
  • func (d *Driver) Capabilities() (*drivers.Capabilities, error)
  • func (d *Driver) ConfigSchema() (*hclspec.Spec, error)
  • func (d *Driver) DestroyTask(taskID string, force bool) error
  • func (d *Driver) ExecTask(taskID string, cmd []string, timeout time.Duration) (*drivers.ExecTaskResult, error)
  • func (d *Driver) Fingerprint(ctx context.Context) (<-chan *drivers.Fingerprint, error)
  • func (d *Driver) InspectTask(taskID string) (*drivers.TaskStatus, error)
  • func (d *Driver) PluginInfo() (*base.PluginInfoResponse, error)
  • func (d *Driver) RecoverTask(handle *drivers.TaskHandle) error
  • func (d *Driver) SetConfig(cfg *base.Config) error
  • func (d *Driver) Shutdown(ctx context.Context) error
  • func (d *Driver) SignalTask(taskID string, signal string) error
  • func (d *Driver) StartTask(cfg *drivers.TaskConfig) (*drivers.TaskHandle, *drivers.DriverNetwork, error)
  • func (d *Driver) StopTask(taskID string, timeout time.Duration, signal string) error
  • func (d *Driver) TaskConfigSchema() (*hclspec.Spec, error)
  • func (d *Driver) TaskEvents(ctx context.Context) (<-chan *drivers.TaskEvent, error)
  • func (d *Driver) TaskStats(ctx context.Context, taskID string, interval time.Duration) (<-chan *drivers.TaskResourceUsage, error)
  • func (d *Driver) WaitTask(ctx context.Context, taskID string) (<-chan *drivers.ExitResult, error)
• type Instance_info
• type Nic
• type TaskConfig
• type TaskState

Functions

func NewFirecrackerDriver

func NewFirecrackerDriver(logger hclog.Logger) drivers.DriverPlugin

func RandomVethName

func RandomVethName() (string, error)

Types

type Config

type Config struct {
}

Config is the driver configuration set by the SetConfig RPC call

type Driver

type Driver struct {
	// contains filtered or unexported fields
}

func (*Driver) Capabilities

func (d *Driver) Capabilities() (*drivers.Capabilities, error)

func (*Driver) ConfigSchema

func (d *Driver) ConfigSchema() (*hclspec.Spec, error)

func (*Driver) DestroyTask

func (d *Driver) DestroyTask(taskID string, force bool) error

func (*Driver) ExecTask

func (d *Driver) ExecTask(taskID string, cmd []string, timeout time.Duration) (*drivers.ExecTaskResult, error)

func (*Driver) Fingerprint

func (d *Driver) Fingerprint(ctx context.Context) (<-chan *drivers.Fingerprint, error)

func (*Driver) InspectTask

func (d *Driver) InspectTask(taskID string) (*drivers.TaskStatus, error)

func (*Driver) PluginInfo

func (d *Driver) PluginInfo() (*base.PluginInfoResponse, error)

func (*Driver) RecoverTask

func (d *Driver) RecoverTask(handle *drivers.TaskHandle) error

func (*Driver) SetConfig

func (d *Driver) SetConfig(cfg *base.Config) error

func (*Driver) Shutdown

func (d *Driver) Shutdown(ctx context.Context) error

func (*Driver) SignalTask

func (d *Driver) SignalTask(taskID string, signal string) error

func (*Driver) StartTask

func (d *Driver) StartTask(cfg *drivers.TaskConfig) (*drivers.TaskHandle, *drivers.DriverNetwork, error)

func (*Driver) StopTask

func (d *Driver) StopTask(taskID string, timeout time.Duration, signal string) error

func (*Driver) TaskConfigSchema

func (d *Driver) TaskConfigSchema() (*hclspec.Spec, error)

func (*Driver) TaskEvents

func (d *Driver) TaskEvents(ctx context.Context) (<-chan *drivers.TaskEvent, error)

func (*Driver) TaskStats

func (d *Driver) TaskStats(ctx context.Context, taskID string, interval time.Duration) (<-chan *drivers.TaskResourceUsage, error)

TaskStats will query the driver and return the current usage for the vm

func (*Driver) WaitTask

func (d *Driver) WaitTask(ctx context.Context, taskID string) (<-chan *drivers.ExitResult, error)

type Instance_info

type Instance_info struct {
	AllocId string
	Ip      string
	Serial  string
	Pid     string
	Vnic    string
}

type Nic

type Nic struct {
	Ip          string // CIDR
	Gateway     string
	Interface   string
	Nameservers []string
}

type TaskConfig

type TaskConfig struct {
	KernelImage string   `codec:"KernelImage"`
	BootOptions string   `codec:"BootOptions"`
	BootDisk    string   `codec:"BootDisk"`
	Disks       []string `codec:"Disks"`
	Network     string   `codec:"Network"`
	Nic         Nic      `codec:"Nic"`
	Vcpus       uint64   `codec:"Vcpus"`
	Cputype     string   `codec:"Cputype"`
	Mem         uint64   `codec:"Mem"`
	Firecracker string   `codec:"Firecracker"`
	Log         string   `code:"Log"`
	DisableHt   bool     `code:"DisableHt"`
}

TaskConfig is the driver configuration of a task within a job

type TaskState

type TaskState struct {
	TaskConfig    *drivers.TaskConfig
	ContainerName string
	StartedAt     time.Time
}

TaskState is the state which is encoded in the handle returned in StartTask. This information is needed to rebuild the task state and handler during recovery.