libvmi

Documentation

Index

• Constants
• func GetPodByVirtualMachineInstance(vmi *v1.VirtualMachineInstance, namespace string) *k8sv1.Pod
• func IndexInterfaceStatusByName(vmi *v1.VirtualMachineInstance) map[string]v1.VirtualMachineInstanceNetworkInterface
• func InterfaceDeviceWithBridgeBinding(name string) kvirtv1.Interface
• func InterfaceDeviceWithMasqueradeBinding(ports ...kvirtv1.Port) kvirtv1.Interface
• func InterfaceDeviceWithSRIOVBinding(name string) kvirtv1.Interface
• func InterfaceDeviceWithSlirpBinding(name string, ports ...kvirtv1.Port) kvirtv1.Interface
• func InterfaceWithMac(iface *kvirtv1.Interface, macAddress string) *kvirtv1.Interface
• func MultusNetwork(name, nadName string) *kvirtv1.Network
• func New(name string, opts ...Option) *kvirtv1.VirtualMachineInstance
• func NewAlpine(opts ...Option) *kvirtv1.VirtualMachineInstance
• func NewAlpineWithTestTooling(opts ...Option) *kvirtv1.VirtualMachineInstance
• func NewCirros(opts ...Option) *kvirtv1.VirtualMachineInstance
• func NewFedora(opts ...Option) *kvirtv1.VirtualMachineInstance
• func RandName(name string) string
• type Option
  • func WithAnnotation(key, value string) Option
  • func WithCloudInitNoCloudNetworkData(data string, b64Encoding bool) Option
  • func WithCloudInitNoCloudUserData(data string, b64Encoding bool) Option
  • func WithContainerImage(name string) Option
  • func WithInterface(iface kvirtv1.Interface) Option
  • func WithLabel(key, value string) Option
  • func WithMasqueradeNetworking(ports ...kvirtv1.Port) []Option
  • func WithNetwork(network *kvirtv1.Network) Option
  • func WithNodeSelectorFor(node *k8sv1.Node) Option
  • func WithResourceMemory(value string) Option
  • func WithRng() Option
  • func WithSEV() Option
  • func WithTerminationGracePeriod(seconds int64) Option
  • func WithUefi(secureBoot bool) Option

Constants

const (
	DefaultTestGracePeriod int64 = 0
	DefaultVmiName               = "testvmi"
)

Default VMI values

const DefaultInterfaceName = "default"

Functions

func GetPodByVirtualMachineInstance

func GetPodByVirtualMachineInstance(vmi *v1.VirtualMachineInstance, namespace string) *k8sv1.Pod

func IndexInterfaceStatusByName

func IndexInterfaceStatusByName(vmi *v1.VirtualMachineInstance) map[string]v1.VirtualMachineInstanceNetworkInterface

func InterfaceDeviceWithBridgeBinding

func InterfaceDeviceWithBridgeBinding(name string) kvirtv1.Interface

InterfaceDeviceWithBridgeBinding returns an Interface with bridge binding.

func InterfaceDeviceWithMasqueradeBinding

func InterfaceDeviceWithMasqueradeBinding(ports ...kvirtv1.Port) kvirtv1.Interface

InterfaceDeviceWithMasqueradeBinding returns an Interface named "default" with masquerade binding.

func InterfaceDeviceWithSRIOVBinding

func InterfaceDeviceWithSRIOVBinding(name string) kvirtv1.Interface

InterfaceDeviceWithSRIOVBinding returns an Interface with SRIOV binding.

func InterfaceDeviceWithSlirpBinding

func InterfaceDeviceWithSlirpBinding(name string, ports ...kvirtv1.Port) kvirtv1.Interface

InterfaceDeviceWithSlirpBinding returns an Interface with SLIRP binding.

func InterfaceWithMac

func InterfaceWithMac(iface *kvirtv1.Interface, macAddress string) *kvirtv1.Interface

InterfaceWithMac decorates an existing Interface with a MAC address.

func MultusNetwork

func MultusNetwork(name, nadName string) *kvirtv1.Network

MultusNetwork returns a Network with the given name, associated to the given nad

func New

func New(name string, opts ...Option) *kvirtv1.VirtualMachineInstance

New instantiates a new VMI configuration, building its properties based on the specified With* options.

func NewAlpine

func NewAlpine(opts ...Option) *kvirtv1.VirtualMachineInstance

NewAlpine instantiates a new Alpine based VMI configuration

func NewAlpineWithTestTooling

func NewAlpineWithTestTooling(opts ...Option) *kvirtv1.VirtualMachineInstance

func NewCirros

func NewCirros(opts ...Option) *kvirtv1.VirtualMachineInstance

NewCirros instantiates a new CirrOS based VMI configuration

func NewFedora

func NewFedora(opts ...Option) *kvirtv1.VirtualMachineInstance

NewFedora instantiates a new Fedora based VMI configuration, building its extra properties based on the specified With* options. This image has tooling for the guest agent, stress, SR-IOV and more.

func RandName

func RandName(name string) string

RandName returns a random name by concatenating the given name with a hyphen and a random string.

Types

type Option

type Option func(vmi *kvirtv1.VirtualMachineInstance)

Option represents an action that enables an option.

func WithAnnotation

func WithAnnotation(key, value string) Option

WithAnnotation adds an annotation with specified value

func WithCloudInitNoCloudNetworkData

func WithCloudInitNoCloudNetworkData(data string, b64Encoding bool) Option

WithCloudInitNoCloudNetworkData adds cloud-init no-cloud network data.

func WithCloudInitNoCloudUserData

func WithCloudInitNoCloudUserData(data string, b64Encoding bool) Option

WithCloudInitNoCloudUserData adds cloud-init no-cloud user data.

func WithContainerImage

func WithContainerImage(name string) Option

WithContainerImage specifies the name of the container image to be used.

func WithInterface

func WithInterface(iface kvirtv1.Interface) Option

WithInterface adds a Domain Device Interface.

func WithLabel

func WithLabel(key, value string) Option

WithLabel sets a label with specified value

func WithMasqueradeNetworking

func WithMasqueradeNetworking(ports ...kvirtv1.Port) []Option

func WithNetwork

func WithNetwork(network *kvirtv1.Network) Option

WithNetwork adds a network object.

func WithNodeSelectorFor

func WithNodeSelectorFor(node *k8sv1.Node) Option

WithNodeSelectorFor ensures that the VMI gets scheduled on the specified node

func WithResourceMemory

func WithResourceMemory(value string) Option

WithResourceMemory specifies the vmi memory resource.

func WithRng

func WithRng() Option

WithRng adds `rng` to the the vmi devices.

func WithSEV

func WithSEV() Option

WithSEV adds `launchSecurity` with `sev`.

func WithTerminationGracePeriod

func WithTerminationGracePeriod(seconds int64) Option

WithTerminationGracePeriod specifies the termination grace period in seconds.

func WithUefi

func WithUefi(secureBoot bool) Option

WithUefi configures EFI bootloader and SecureBoot.