types

Documentation

Index

• Variables
• type Environment
• type Image
• type ImageBuild
• type MachineLaunchOptions
• type MachineState
• type Profile
• type Provider
• type VM

Variables

var StateRunning = MachineState{"Running"}

var StateSleeping = MachineState{"Sleeping"}

var StateStarting = MachineState{"Starting"}

var StateStopped = MachineState{"Stopped"}

var StateStopping = MachineState{"Stopping"}

var StateTerminated = MachineState{"Terminated"}

var StateTerminating = MachineState{"Terminating"}

var StateUnknown = MachineState{"Unknown"}

Types

type Environment

type Environment interface {
	Name() string
	VMs() []VM
	Profile() Profile
	StartVM(string) error
	StopVM(string) error
	RestartVM(string) error
	ImageBuilds() ([]ImageBuild, error)
	Images() ([]Image, error)
	CreateVM(MachineLaunchOptions) error
	DestroyVM(string) error
}

type Image

type Image interface {
	Name() string
	Environment() Environment
	Launch() error
}

type ImageBuild

type ImageBuild interface {
	Name() string
	ProviderType() string
	Provisioner() string
	Build() error
}

type MachineLaunchOptions

type MachineLaunchOptions struct {
	CloudInitTpl string      `json:"cloud-init"`
	Image        types.Image `json:"image"`
}

type MachineState

type MachineState struct {
	Name string `json:"name"`
}

type Profile

type Profile interface {
	Environments() []Environment
	Name() string
	Provider() Provider
	SetConfig(config common.ProfileConfig)
	GetConfig() common.ProfileConfig
}

type Provider

type Provider interface {
	Profiles() []Profile
	Name() string
	Type() string
	IsAvailable() bool
	SetConfig(config common.ProviderConfig)
	GetConfig() common.ProviderConfig
}

type VM

type VM interface {
	Name() string
	ID() string
	IPAddress() string
	State() string
	Start() error
	Stop() error
	Restart() error
	Environment() Environment
	ExecSSH(string, ...string) error
	StartVNC(user string, killVNC bool) error
	NewSSHSession(string) (*ssh_util.Session, error)
}