kvm

Documentation

Index

• func GetGitCommitID() string
• func GetVersion() string
• type Driver
  • func NewDriver(hostName, storePath string) *Driver
  • func (d *Driver) Create() (err error)
  • func (d *Driver) DriverName() string
  • func (d *Driver) GetIP() (string, error)
  • func (d *Driver) GetSSHHostname() (string, error)
  • func (d *Driver) GetState() (st state.State, err error)
  • func (d *Driver) GetURL() (string, error)
  • func (d *Driver) Kill() (err error)
  • func (d *Driver) PreCommandCheck() error
  • func (d *Driver) Remove() error
  • func (d *Driver) Restart() error
  • func (d *Driver) Start() (err error)
  • func (d *Driver) Stop() (err error)
• type ExtraDisks
• type NUMA
• type PCIDevice

Functions

func GetGitCommitID

func GetGitCommitID() string

GetGitCommitID returns the git commit id from which it is being built

func GetVersion

func GetVersion() string

GetVersion returns the current docker-machine-driver-kvm2 version

Types

type Driver

type Driver struct {
	*drivers.BaseDriver
	*pkgdrivers.CommonDriver

	// How much memory, in MB, to allocate to the VM
	Memory int

	// How many cpus to allocate to the VM
	CPU int

	// The name of the default network
	Network string

	// The name of the private network
	PrivateNetwork string

	// The size of the disk to be created for the VM, in MB
	DiskSize int

	// The path of the disk .img
	DiskPath string

	// A file or network URI to fetch the minikube ISO
	Boot2DockerURL string

	// The location of the iso to boot from
	ISO string

	// The randomly generated MAC Address
	// If empty, a random MAC will be generated.
	MAC string

	// The randomly generated MAC Address for the NIC attached to the private network
	// If empty, a random MAC will be generated.
	PrivateMAC string

	// Whether to passthrough GPU devices from the host to the VM.
	GPU bool

	// Whether to hide the KVM hypervisor signature from the guest
	Hidden bool

	// XML that needs to be added to passthrough GPU devices.
	DevicesXML string

	// QEMU Connection URI
	ConnectionURI string

	// NUMA node count default value is 1
	NUMANodeCount int

	// NUMA XML
	NUMANodeXML string

	// Extra Disks
	ExtraDisks int

	// Extra Disks XML
	ExtraDisksXML []string
}

Driver is the machine driver for KVM

func NewDriver

func NewDriver(hostName, storePath string) *Driver

NewDriver creates a new driver for a host

func (*Driver) Create

func (d *Driver) Create() (err error)

Create a host using the driver's config

func (*Driver) DriverName

func (d *Driver) DriverName() string

DriverName returns the name of the driver

func (*Driver) GetIP

func (d *Driver) GetIP() (string, error)

GetIP returns an IP or hostname that this host is available at

func (*Driver) GetSSHHostname

func (d *Driver) GetSSHHostname() (string, error)

GetSSHHostname returns hostname for use with ssh

func (*Driver) GetState

func (d *Driver) GetState() (st state.State, err error)

GetState returns the state that the host is in (running, stopped, etc)

func (*Driver) GetURL

func (d *Driver) GetURL() (string, error)

GetURL returns a Docker URL inside this host e.g. tcp://1.2.3.4:2376 more info https://github.com/docker/machine/blob/b170508bf44c3405e079e26d5fdffe35a64c6972/libmachine/provision/utils.go#L159_L175

func (*Driver) Kill

func (d *Driver) Kill() (err error)

Kill stops a host forcefully, including any containers that we are managing.

func (*Driver) PreCommandCheck

func (d *Driver) PreCommandCheck() error

PreCommandCheck checks the connection before issuing a command

func (*Driver) Remove

func (d *Driver) Remove() error

Remove a host

func (*Driver) Restart

func (d *Driver) Restart() error

Restart a host

func (*Driver) Start

func (d *Driver) Start() (err error)

Start a host

func (*Driver) Stop

func (d *Driver) Stop() (err error)

Stop a host gracefully

type ExtraDisks

type ExtraDisks struct {
	DiskPath        string
	DiskLogicalName string
}

ExtraDisks holds the extra disks configuration

type NUMA

type NUMA struct {
	// cpu count on numa node
	CPUCount int
	// memory on numa node
	Memory int
	// cpu sequence on numa node eg: 0,1,2,3
	CPUTopology string
}

NUMA this struct use for numaTmpl

type PCIDevice

type PCIDevice struct {
	Domain   string
	Bus      string
	Slot     string
	Function string
}

PCIDevice holds a parsed PCI device