multipass

README

---

title: Multipass description: Multpass provider weight: 20

The Multipass provider is a simple wrapper around the Multipass executable. If Multipass is installed this provider will allow Carbon to interact with them. Since Multipass is on the local machine there is only one Profile returned (local) and one Environment returned (local).

Documentation

Index

• func New() types.Provider
• type Environment
  • func (e *Environment) CreateVM(options types.MachineLaunchOptions) error
  • func (e *Environment) DestroyImage(imageID string) error
  • func (e *Environment) DestroyVM(id string) error
  • func (e *Environment) ImageBuilds() ([]types.ImageBuild, error)
  • func (e *Environment) Images() ([]types.Image, error)
  • func (e *Environment) Name() string
  • func (e *Environment) Profile() types.Profile
  • func (e *Environment) RestartVM(id string) error
  • func (e *Environment) StartVM(id string) error
  • func (e *Environment) StopVM(id string) error
  • func (e *Environment) VMs() []types.VM
• type Profile
  • func NewProfile(name string, providerInstance *Provider, config common.ProfileConfig) *Profile
  • func (p *Profile) Environments() []types.Environment
• type Provider
  • func (p *Provider) IsAvailable() bool
  • func (p *Provider) Profiles() []types.Profile

Functions

func New

func New() types.Provider

Types

type Environment

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

func (*Environment) CreateVM

func (e *Environment) CreateVM(options types.MachineLaunchOptions) error

func (*Environment) DestroyImage

func (e *Environment) DestroyImage(imageID string) error

func (*Environment) DestroyVM

func (e *Environment) DestroyVM(id string) error

func (*Environment) ImageBuilds

func (e *Environment) ImageBuilds() ([]types.ImageBuild, error)

func (*Environment) Images

func (e *Environment) Images() ([]types.Image, error)

func (*Environment) Name

func (e *Environment) Name() string

func (*Environment) Profile

func (e *Environment) Profile() types.Profile

func (*Environment) RestartVM

func (e *Environment) RestartVM(id string) error

func (*Environment) StartVM

func (e *Environment) StartVM(id string) error

func (*Environment) StopVM

func (e *Environment) StopVM(id string) error

func (*Environment) VMs

func (e *Environment) VMs() []types.VM

type Profile

type Profile struct {
	types.Profile
}

func NewProfile

func NewProfile(name string, providerInstance *Provider, config common.ProfileConfig) *Profile

func (*Profile) Environments

func (p *Profile) Environments() []types.Environment

type Provider

type Provider struct {
	types.Provider
	// contains filtered or unexported fields
}

func (*Provider) IsAvailable

func (p *Provider) IsAvailable() bool

func (*Provider) Profiles

func (p *Provider) Profiles() []types.Profile