ignite

Documentation

Index

• Constants
• func CheckVersion()
• func Create(name string, spec *config.Machine, pubKeyPath string) (id string, err error)
• func IsCreated(name string) bool
• func IsStarted(name string) bool
• func Remove(name string) error
• func Start(name string) error
• func Stop(name string) error
• type Metadata
• type Network
• type Port
• type Spec
• type Status
• type VM
  • func PopulateMachineDetails(name string) (*VM, error)

Constants

const (
	BackendName = "ignite"
)

Functions

func CheckVersion

func CheckVersion()

func Create

func Create(name string, spec *config.Machine, pubKeyPath string) (id string, err error)

Create creates an Ignite VM using "ignite run", it doesn't return a container ID

func IsCreated

func IsCreated(name string) bool

IsCreated checks if the VM with the given name is created

func IsStarted

func IsStarted(name string) bool

IsStarted checks if the VM with the given name is running

func Remove

func Remove(name string) error

Remove removes an Ignite VM

func Start

func Start(name string) error

Start starts an Ignite VM

func Stop

func Stop(name string) error

Stop stops an Ignite VM

Types

type Metadata

type Metadata struct {
	Name    string
	UID     string
	Created string
}

type Network

type Network struct {
	Ports []Port
}

type Port

type Port struct {
	HostPort uint16
	VMPort   uint16
	Protocol string
}

type Spec

type Spec struct {
	Network  Network
	Cpus     uint
	Memory   string
	DiskSize string
}

type Status

type Status struct {
	Running     bool
	StartTime   string
	IpAddresses []string
}

type VM

type VM struct {
	Metadata Metadata
	Spec     Spec
	Status   Status
}

func PopulateMachineDetails

func PopulateMachineDetails(name string) (*VM, error)

PopulateMachineDetails returns the details of the VM identified by the given name