devpod

README

DevPod commands package

Implement the necessary commands that DevPod need to interact with the provider.

Used by the Cobra commands package.

Documentation

Index

• Constants
• func Command() error
• func Create() error
• func Delete() error
• func Init() error
• func Start() error
• func Status() error
• func Stop() error
• type Options
  • func OptsFromEnv() (*Options, error)

Constants

const (
	RUNNING  = "Running"
	STOPPED  = "Stopped"
	NOTFOUND = "NotFound"
	BUSY     = "Busy"
)

const (
	MULTIPASS_PATH      = "MULTIPASS_PATH"
	MULTIPASS_IMAGE     = "MULTIPASS_IMAGE"
	MULTIPASS_CPUS      = "MULTIPASS_CPUS"
	MULTIPASS_DISK_SIZE = "MULTIPASS_DISK_SIZE"
	MULTIPASS_MEMORY    = "MULTIPASS_MEMORY"
	MULTIPASS_MOUNTS    = "MULTIPASS_MOUNTS"
)

Functions

func Command

func Command() error

devpod uses this to inject itself into the environment and route all communication through the commands standard output and input.

func Create

func Create() error

devpod calls this to create the multipass instance

func Delete

func Delete() error

devpod calls this to delete the multipass instance

func Init

func Init() error

devpod calls this when the provider is being added, here we are just invoking the 'multipass version' command as a way to ensure that multipass is reachable

func Start

func Start() error

devpod calls this to start the multipass instance

func Status

func Status() error

devpod calls this to get the status of the multipass instance and expect the response to be returned via stdout

func Stop

func Stop() error

devpod calls this to stop the multipass instance

Types

type Options

type Options struct {
	Path     string // Path to multipass executable
	Image    string // --image arg passed into multipass launch command
	Cpus     int    // --cpus arg passed into multipass launch command
	DiskSize string // --disk arg passed into multipass launch command
	Memory   string // --memory arg passed into multipass launch command
	Mounts   string // host to multipass instance mounts
}

func OptsFromEnv

func OptsFromEnv() (*Options, error)