kubevirt

Documentation

Index

• type CommandExecutor
• type DefaultMachineFactory
  • func (defaultMachineFactory DefaultMachineFactory) NewMachine(ctx *context.MachineContext, client client.Client, namespace string, ...) (MachineInterface, error)
• type Machine
  • func NewMachine(ctx *context.MachineContext, client client.Client, namespace string, ...) (*Machine, error)
  • func (m *Machine) Address() string
  • func (m *Machine) Create(ctx gocontext.Context) error
  • func (m *Machine) Delete() error
  • func (m *Machine) DrainNodeIfNeeded(wrkldClstr workloadcluster.WorkloadCluster) (time.Duration, error)
  • func (m *Machine) Exists() bool
  • func (m *Machine) GenerateProviderID() (string, error)
  • func (m *Machine) GetVMNotReadyReason() (reason string, message string)
  • func (m *Machine) IsBootstrapped() bool
  • func (m *Machine) IsBootstrappedWithSSH() bool
  • func (m *Machine) IsLiveMigratable() (bool, string, string, error)
  • func (m *Machine) IsReady() bool
  • func (m *Machine) IsTerminal() (bool, string, error)
  • func (m *Machine) SupportsCheckingIsBootstrapped() bool
• type MachineFactory
• type MachineInterface

Types

type CommandExecutor

type CommandExecutor interface {
	ExecuteCommand(command string) (string, error)
}

type DefaultMachineFactory

type DefaultMachineFactory struct {
}

DefaultMachineFactory is the default implementation of MachineFactory

func (DefaultMachineFactory) NewMachine

func (defaultMachineFactory DefaultMachineFactory) NewMachine(ctx *context.MachineContext, client client.Client, namespace string, sshKeys *ssh.ClusterNodeSshKeys) (MachineInterface, error)

NewMachine creates a new kubevirt.machine

type Machine

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

Machine implement a service for managing the KubeVirt VM hosting a kubernetes node.

func NewMachine

func NewMachine(ctx *context.MachineContext, client client.Client, namespace string, sshKeys *ssh.ClusterNodeSshKeys) (*Machine, error)

NewMachine returns a new Machine service for the given context.

func (*Machine) Address

func (m *Machine) Address() string

Address returns the IP address of the VM.

func (*Machine) Create

func (m *Machine) Create(ctx gocontext.Context) error

Create creates a new VM for this machine.

func (*Machine) Delete

func (m *Machine) Delete() error

Delete deletes VM for this machine.

func (*Machine) DrainNodeIfNeeded

func (m *Machine) DrainNodeIfNeeded(wrkldClstr workloadcluster.WorkloadCluster) (time.Duration, error)

func (*Machine) Exists

func (m *Machine) Exists() bool

Exists checks if the VM has been provisioned already.

func (*Machine) GenerateProviderID

func (m *Machine) GenerateProviderID() (string, error)

GenerateProviderID generates the KubeVirt provider ID to be used for the NodeRef

func (*Machine) GetVMNotReadyReason

func (m *Machine) GetVMNotReadyReason() (reason string, message string)

func (*Machine) IsBootstrapped

func (m *Machine) IsBootstrapped() bool

IsBootstrapped checks if the VM is bootstrapped with Kubernetes.

func (*Machine) IsBootstrappedWithSSH

func (m *Machine) IsBootstrappedWithSSH() bool

IsBootstrappedWithSSH checks if the VM is bootstrapped with Kubernetes using SSH strategy.

func (*Machine) IsLiveMigratable

func (m *Machine) IsLiveMigratable() (bool, string, string, error)

IsLiveMigratable reports back the live-migratability state of the VM: Status, Reason and Message

func (*Machine) IsReady

func (m *Machine) IsReady() bool

IsReady checks if the VM is ready

func (*Machine) IsTerminal

func (m *Machine) IsTerminal() (bool, string, error)

IsTerminal Reports back if the VM is either being requested to terminate or is terminated in a way that it will never recover from.

func (*Machine) SupportsCheckingIsBootstrapped

func (m *Machine) SupportsCheckingIsBootstrapped() bool

SupportsCheckingIsBootstrapped checks if we have a method of checking that this bootstrapper has completed.

type MachineFactory

type MachineFactory interface {
	// NewMachine returns a new Machine service for the given context.
	NewMachine(ctx *context.MachineContext, client client.Client, namespace string, sshKeys *ssh.ClusterNodeSshKeys) (MachineInterface, error)
}

type MachineInterface

type MachineInterface interface {
	// Create creates a new VM for this machine.
	Create(ctx gocontext.Context) error
	// Delete deletes VM for this machine.
	Delete() error
	// Exists checks if the VM has been provisioned already.
	Exists() bool
	// IsReady checks if the VM is ready
	IsReady() bool
	// IsLiveMigratable reports back the live-migratability state of the VM: Status, Reason and Message
	IsLiveMigratable() (bool, string, string, error)
	// Address returns the IP address of the VM.
	Address() string
	// SupportsCheckingIsBootstrapped checks if we have a method of checking
	// that this bootstrapper has completed.
	SupportsCheckingIsBootstrapped() bool
	// IsBootstrapped checks if the VM is bootstrapped with Kubernetes.
	IsBootstrapped() bool
	// GenerateProviderID generates the KubeVirt provider ID to be used for the NodeRef
	GenerateProviderID() (string, error)
	// IsTerminal reports back if a VM is in a permanent terminal state
	IsTerminal() (bool, string, error)

	DrainNodeIfNeeded(workloadcluster.WorkloadCluster) (time.Duration, error)

	// GetVMUnscheduledReason returns the reason and message for the condition, if the VM is not ready
	GetVMNotReadyReason() (string, string)
}