types

Documentation

Index

• Variables
• type Environment
• type Machine
  • func (m Machine) Environment() Environment
  • func (m Machine) ExecSSH() error
  • func (m Machine) ID() string
  • func (m Machine) IPAddress() string
  • func (m Machine) Name() string
  • func (m Machine) Restart() error
  • func (m Machine) Start() error
  • func (m Machine) State() string
  • func (m Machine) Stop() error
• type MachineState
• type Platform
• type Provider
• type VM

Variables

var StateOff = MachineState{"Off"}

var StateRunning = MachineState{"Running"}

var StateSleeping = MachineState{"Sleeping"}

var StateStarting = MachineState{"Starting"}

var StateStopping = MachineState{"Stopping"}

var StateTerminating = MachineState{"Terminating"}

var StateUnknown = MachineState{"Unknown"}

Types

type Environment

type Environment interface {
	Name() string
	VMs() []VM
	Platform() Platform
	StartVM(string) error
	StopVM(string) error
	RestartVM(string) error
}

type Machine

type Machine struct {
	InstanceName       string
	InstanceID         string
	CurrentUpTime      time.Duration
	PublicIPAddresses  []string
	PrivateIPAddresses []string
	CurrentState       MachineState
	Env                Environment
}

func (Machine) Environment

func (m Machine) Environment() Environment

func (Machine) ExecSSH

func (m Machine) ExecSSH() error

func (Machine) ID

func (m Machine) ID() string

func (Machine) IPAddress

func (m Machine) IPAddress() string

func (Machine) Name

func (m Machine) Name() string

func (Machine) Restart

func (m Machine) Restart() error

func (Machine) Start

func (m Machine) Start() error

func (Machine) State

func (m Machine) State() string

func (Machine) Stop

func (m Machine) Stop() error

type MachineState

type MachineState struct{ Name string }

type Platform

type Platform interface {
	Environments(validNames ...string) []Environment
	Name() string
	Provider() Provider
}

type Provider

type Provider interface {
	Platforms(validNames ...string) []Platform
	Name() string
	IsAvailable() bool
}

type VM

type VM interface {
	Name() string
	ID() string
	IPAddress() string
	State() string
	Start() error
	Stop() error
	Restart() error
	Environment() Environment
	ExecSSH() error
}