vetu

Documentation

Index

• Variables
• func Cleanup() error
• func Cmd(ctx context.Context, additionalEnvironment map[string]string, name string, ...) (string, string, error)
• func CmdWithLogger(ctx context.Context, additionalEnvironment map[string]string, ...) (string, string, error)
• func Installed() bool
• type Option
  • func WithBridgedInterface(bridgedInterface string) Option
  • func WithDiskSize(diskSize uint32) Option
  • func WithHostNetworking() Option
  • func WithLogger(logger logger.Lightweight) Option
• type VM
  • func NewVMClonedFrom(ctx context.Context, from string, to string, lazyPull bool, ...) (*VM, error)
  • func (vm *VM) Close() error
  • func (vm *VM) Configure(ctx context.Context, cpu uint32, memory uint32, diskSize uint32, ...) error
  • func (vm *VM) ErrChan() chan error
  • func (vm *VM) Ident() string
  • func (vm *VM) RetrieveIP(ctx context.Context) (string, error)
  • func (vm *VM) Start(ctx context.Context, bridgedInterface string, hostNetworking bool)
• type Vetu
  • func New(vmName string, sshUser string, sshPassword string, sshPort uint16, cpu uint32, ...) (*Vetu, error)
  • func (vetu *Vetu) Attributes() []attribute.KeyValue
  • func (vetu *Vetu) Close(ctx context.Context) error
  • func (vetu *Vetu) Image() string
  • func (vetu *Vetu) Run(ctx context.Context, config *runconfig.RunConfig) error
  • func (vetu *Vetu) Warmup(ctx context.Context, ident string, env map[string]string, ...) error
  • func (vetu *Vetu) WorkingDirectory(projectDir string, dirtyMode bool) string

Variables

var (
	ErrVetuNotFound = errors.New("vetu command not found")
	ErrVetuFailed   = errors.New("vetu command returned non-zero exit code")
)

var (
	ErrFailed     = errors.New("vetu isolation failed")
	ErrSyncFailed = errors.New("failed to sync project directory")
)

Functions

func Cleanup

func Cleanup() error

func Cmd

func Cmd(
	ctx context.Context,
	additionalEnvironment map[string]string,
	name string,
	args ...string,
) (string, string, error)

func CmdWithLogger

func CmdWithLogger(
	ctx context.Context,
	additionalEnvironment map[string]string,
	logger *echelon.Logger,
	name string,
	args ...string,
) (string, string, error)

func Installed

func Installed() bool

Types

type Option

type Option func(*Vetu)

func WithBridgedInterface

func WithBridgedInterface(bridgedInterface string) Option

func WithDiskSize

func WithDiskSize(diskSize uint32) Option

func WithHostNetworking

func WithHostNetworking() Option

func WithLogger

func WithLogger(logger logger.Lightweight) Option

type VM

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

func NewVMClonedFrom

func NewVMClonedFrom(
	ctx context.Context,
	from string,
	to string,
	lazyPull bool,
	env map[string]string,
	logger *echelon.Logger,
) (*VM, error)

func (*VM) Close

func (vm *VM) Close() error

func (*VM) Configure

func (vm *VM) Configure(
	ctx context.Context,
	cpu uint32,
	memory uint32,
	diskSize uint32,
	logger *echelon.Logger,
) error

func (*VM) ErrChan

func (vm *VM) ErrChan() chan error

func (*VM) Ident

func (vm *VM) Ident() string

func (*VM) RetrieveIP

func (vm *VM) RetrieveIP(ctx context.Context) (string, error)

func (*VM) Start

func (vm *VM) Start(
	ctx context.Context,
	bridgedInterface string,
	hostNetworking bool,
)

type Vetu

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

func New

func New(
	vmName string,
	sshUser string,
	sshPassword string,
	sshPort uint16,
	cpu uint32,
	memory uint32,
	opts ...Option,
) (*Vetu, error)

func (*Vetu) Attributes

func (vetu *Vetu) Attributes() []attribute.KeyValue

func (*Vetu) Close

func (vetu *Vetu) Close(ctx context.Context) error

func (*Vetu) Image

func (vetu *Vetu) Image() string

func (*Vetu) Run

func (vetu *Vetu) Run(ctx context.Context, config *runconfig.RunConfig) error

func (*Vetu) Warmup

func (vetu *Vetu) Warmup(
	ctx context.Context,
	ident string,
	env map[string]string,
	logger *echelon.Logger,
) error

func (*Vetu) WorkingDirectory

func (vetu *Vetu) WorkingDirectory(projectDir string, dirtyMode bool) string