uml

Documentation

Index

• type Config
• type Machine
  • func (m *Machine) Attach(opts *driver.AttachOptions) (err error)
  • func (m *Machine) Exec(command string, opts *driver.ExecOptions) (err error)
  • func (m *Machine) Exists() (bool, error)
  • func (m *Machine) Id() string
  • func (m *Machine) Info() (info driver.MachineInfo, err error)
  • func (m *Machine) Logs(opts *driver.LogOptions) (err error)
  • func (m *Machine) Name() string
  • func (m *Machine) Networks() ([]driver.Network, error)
  • func (m *Machine) Remove() error
  • func (m *Machine) Running() bool
  • func (m *Machine) Shell(opts *driver.ShellOptions) (err error)
  • func (m *Machine) Start(opts *driver.MachineConfig) (err error)
  • func (m *Machine) State() (state driver.MachineState, err error)
  • func (m *Machine) Stop(force bool) error
  • func (m *Machine) WaitUntil(timeout time.Duration, target, failOn *driver.MachineState) error
• type Network
  • func (n *Network) Create(opts *driver.NetConfig) (err error)
  • func (n *Network) Exists() (bool, error)
  • func (n *Network) Id() string
  • func (n *Network) Info() (nInfo driver.NetInfo, err error)
  • func (n *Network) Name() string
  • func (n *Network) Remove() (err error)
  • func (n *Network) Running() (running bool, err error)
  • func (n *Network) Start() error
  • func (n *Network) Stop() (err error)
• type UMLDriver
  • func (ud *UMLDriver) GetCLICommand() (command *cobra.Command, err error)
  • func (ud *UMLDriver) ListAllNamespaces() ([]string, error)
  • func (ud *UMLDriver) ListMachines(namespace string, all bool) ([]driver.MachineInfo, error)
  • func (ud *UMLDriver) ListNetworks(namespace string, all bool) (networks []driver.NetInfo, err error)
  • func (ud *UMLDriver) Machine(name, namespace string) (m driver.Machine, err error)
  • func (ud *UMLDriver) Network(name, namespace string) (n driver.Network, err error)
  • func (ud *UMLDriver) SetupDriver(conf map[string]interface{}) (err error)

Types

type Config

type Config struct {
	DefaultImage string `koanf:"default_image" validate:"required"`
	Kernel       string `koanf:"kernel" validate:"required"`
	StorageDir   string `koanf:"storage_dir" validate:"required"`
	Testing      bool   `koanf:"testing"`
}

type Machine

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

func (*Machine) Attach

func (m *Machine) Attach(opts *driver.AttachOptions) (err error)

func (*Machine) Exec

func (m *Machine) Exec(command string,
	opts *driver.ExecOptions) (err error)

func (*Machine) Exists

func (m *Machine) Exists() (bool, error)

func (*Machine) Id

func (m *Machine) Id() string

func (*Machine) Info

func (m *Machine) Info() (info driver.MachineInfo, err error)

func (*Machine) Logs

func (m *Machine) Logs(opts *driver.LogOptions) (err error)

func (*Machine) Name

func (m *Machine) Name() string

func (*Machine) Networks

func (m *Machine) Networks() ([]driver.Network, error)

func (*Machine) Remove

func (m *Machine) Remove() error

func (*Machine) Running

func (m *Machine) Running() bool

func (*Machine) Shell

func (m *Machine) Shell(opts *driver.ShellOptions) (err error)

func (*Machine) Start

func (m *Machine) Start(opts *driver.MachineConfig) (err error)

func (*Machine) State

func (m *Machine) State() (state driver.MachineState, err error)

func (*Machine) Stop

func (m *Machine) Stop(force bool) error

func (*Machine) WaitUntil

func (m *Machine) WaitUntil(timeout time.Duration,
	target, failOn *driver.MachineState) error

type Network

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

func (*Network) Create

func (n *Network) Create(opts *driver.NetConfig) (err error)

func (*Network) Exists

func (n *Network) Exists() (bool, error)

func (*Network) Id

func (n *Network) Id() string

func (*Network) Info

func (n *Network) Info() (nInfo driver.NetInfo, err error)

func (*Network) Name

func (n *Network) Name() string

func (*Network) Remove

func (n *Network) Remove() (err error)

func (*Network) Running

func (n *Network) Running() (running bool, err error)

func (*Network) Start

func (n *Network) Start() error

func (*Network) Stop

func (n *Network) Stop() (err error)

type UMLDriver

type UMLDriver struct {
	Name   string
	Config Config
	Podman podman.PodmanDriver
}

func (*UMLDriver) GetCLICommand

func (ud *UMLDriver) GetCLICommand() (command *cobra.Command, err error)

func (*UMLDriver) ListAllNamespaces

func (ud *UMLDriver) ListAllNamespaces() ([]string, error)

func (*UMLDriver) ListMachines

func (ud *UMLDriver) ListMachines(namespace string, all bool) ([]driver.MachineInfo, error)

func (*UMLDriver) ListNetworks

func (ud *UMLDriver) ListNetworks(namespace string, all bool) (networks []driver.NetInfo, err error)

func (*UMLDriver) Machine

func (ud *UMLDriver) Machine(name, namespace string) (m driver.Machine,
	err error)

func (*UMLDriver) Network

func (ud *UMLDriver) Network(name, namespace string) (n driver.Network,
	err error)

func (*UMLDriver) SetupDriver

func (ud *UMLDriver) SetupDriver(conf map[string]interface{}) (err error)