Documentation
¶
Index ¶
- Constants
- func GetPodByVirtualMachineInstance(vmi *v1.VirtualMachineInstance, namespace string) (*k8sv1.Pod, error)
- 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 InterfaceWithBindingPlugin(name string, binding kvirtv1.PluginBinding, ports ...kvirtv1.Port) kvirtv1.Interface
- func InterfaceWithMac(iface *kvirtv1.Interface, macAddress string) *kvirtv1.Interface
- func InterfaceWithPasstBindingPlugin(ports ...kvirtv1.Port) kvirtv1.Interface
- func MultusNetwork(name, nadName string) *kvirtv1.Network
- func New(opts ...Option) *v1.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 NewVirtualMachine(vmi *v1.VirtualMachineInstance, opts ...VMOption) *v1.VirtualMachine
- func NewWindows(opts ...Option) *kvirtv1.VirtualMachineInstance
- type Option
- func WithAnnotation(key, value string) Option
- func WithCDRom(cdRomName string, bus v1.DiskBus, claimName string) Option
- func WithCPUCount(cores, threads, sockets uint32) Option
- func WithCPUFeature(featureName, policy string) Option
- func WithCPUModel(model string) Option
- func WithCloudInitConfigDriveData(data string) Option
- func WithCloudInitNoCloudEncodedUserData(data string) Option
- func WithCloudInitNoCloudNetworkData(data string) Option
- func WithCloudInitNoCloudUserData(data string) Option
- func WithConfigMapDisk(configMapName, volumeName string) Option
- func WithConfigMapFs(configMapName, volumeName string) Option
- func WithContainerDisk(diskName, imageName string) Option
- func WithDataVolume(diskName, pvcName string) Option
- func WithDedicatedCPUPlacement() Option
- func WithDownwardAPIDisk(name string) Option
- func WithDownwardAPIFs(name string) Option
- func WithDownwardMetricsChannel() Option
- func WithDownwardMetricsVolume(volumeName string) Option
- func WithEmptyDisk(diskName string, bus v1.DiskBus, capacity resource.Quantity) Option
- func WithEphemeralCDRom(cdRomName string, bus v1.DiskBus, claimName string) Option
- func WithEphemeralPersistentVolumeClaim(diskName, pvcName string) Option
- func WithEvictionStrategy(evictionStrategy v1.EvictionStrategy) Option
- func WithFilesystemDV(dataVolumeName string) Option
- func WithFilesystemPVC(claimName string) Option
- func WithGuestMemory(memory string) Option
- func WithHostDisk(diskName, path string, diskType v1.HostDiskType) Option
- func WithHugepages(pageSize string) Option
- func WithInterface(iface kvirtv1.Interface) Option
- func WithLabel(key, value string) Option
- func WithLabelledConfigMapDisk(configMapName, volumeName, label string) Option
- func WithLabelledSecretDisk(secretName, volumeName, label string) Option
- func WithLimitCPU(value string) Option
- func WithLimitMemory(value string) Option
- func WithMasqueradeNetworking(ports ...kvirtv1.Port) []Option
- func WithNUMAGuestMappingPassthrough() Option
- func WithNamespace(namespace string) Option
- func WithNetwork(network *kvirtv1.Network) Option
- func WithNodeAffinityFor(nodeName string) Option
- func WithNodeAffinityForLabel(nodeLabelKey, nodeLabelValue string) Option
- func WithNodeSelectorFor(node *k8sv1.Node) Option
- func WithPasstInterfaceWithPort() Option
- func WithPersistentVolumeClaim(diskName, pvcName string) Option
- func WithPersistentVolumeClaimLun(diskName, pvcName string, reservation bool) Option
- func WithRealtimeMask(realtimeMask string) Option
- func WithResourceCPU(value string) Option
- func WithResourceMemory(value string) Option
- func WithRng() Option
- func WithSEV(isESEnabled bool) Option
- func WithSEVAttestation() Option
- func WithSecretDisk(secretName, volumeName string) Option
- func WithSecretFs(secretName, volumeName string) Option
- func WithServiceAccountDisk(name string) Option
- func WithServiceAccountFs(serviceAccountName, volumeName string) Option
- func WithStartStrategy(startStrategy v1.StartStrategy) Option
- func WithTerminationGracePeriod(seconds int64) Option
- func WithUefi(secureBoot bool) Option
- func WithWatchdog(action v1.WatchdogAction) Option
- func WithoutSerialConsole() Option
- type VMOption
Constants ¶
const ( WindowsFirmware = "5d307ca9-b3ef-428c-8861-06e72d69f223" WindowsPVCName = "disk-windows" )
Variables ¶
This section is empty.
Functions ¶
func GetPodByVirtualMachineInstance ¶ added in v0.36.0
func IndexInterfaceStatusByName ¶ added in v0.36.0
func IndexInterfaceStatusByName(vmi *v1.VirtualMachineInstance) map[string]v1.VirtualMachineInstanceNetworkInterface
func InterfaceDeviceWithBridgeBinding ¶ added in v0.34.0
InterfaceDeviceWithBridgeBinding returns an Interface with bridge binding.
func InterfaceDeviceWithMasqueradeBinding ¶
InterfaceDeviceWithMasqueradeBinding returns an Interface named "default" with masquerade binding.
func InterfaceDeviceWithSRIOVBinding ¶ added in v0.36.0
InterfaceDeviceWithSRIOVBinding returns an Interface with SRIOV binding.
func InterfaceDeviceWithSlirpBinding ¶ added in v0.50.0
InterfaceDeviceWithSlirpBinding returns an Interface with SLIRP binding.
func InterfaceWithBindingPlugin ¶ added in v1.2.0
func InterfaceWithMac ¶ added in v0.36.0
InterfaceWithMac decorates an existing Interface with a MAC address.
func InterfaceWithPasstBindingPlugin ¶ added in v1.2.0
InterfaceWithPasstBinding returns an Interface named "default" with passt binding plugin.
func MultusNetwork ¶ added in v0.35.0
MultusNetwork returns a Network with the given name, associated to the given nad
func New ¶
func New(opts ...Option) *v1.VirtualMachineInstance
New instantiates a new VMI configuration, building its properties based on the specified With* options.
func NewAlpine ¶ added in v0.50.0
func NewAlpine(opts ...Option) *kvirtv1.VirtualMachineInstance
NewAlpine instantiates a new Alpine based VMI configuration
func NewAlpineWithTestTooling ¶ added in v0.53.0
func NewAlpineWithTestTooling(opts ...Option) *kvirtv1.VirtualMachineInstance
func NewCirros ¶ added in v0.34.0
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 NewVirtualMachine ¶ added in v1.2.0
func NewVirtualMachine(vmi *v1.VirtualMachineInstance, opts ...VMOption) *v1.VirtualMachine
func NewWindows ¶ added in v1.1.0
func NewWindows(opts ...Option) *kvirtv1.VirtualMachineInstance
Types ¶
type Option ¶
type Option func(vmi *v1.VirtualMachineInstance)
Option represents an action that enables an option.
func WithAnnotation ¶ added in v0.42.0
WithAnnotation adds an annotation with specified value
func WithCPUCount ¶ added in v1.0.0
func WithCPUFeature ¶ added in v0.56.0
func WithCPUModel ¶ added in v0.56.0
func WithCloudInitConfigDriveData ¶ added in v0.55.0
WithCloudInitConfigDriveData adds cloud-init config-drive user data.
func WithCloudInitNoCloudEncodedUserData ¶ added in v1.2.0
WithCloudInitNoCloudEncodedUserData adds cloud-init no-cloud base64-encoded user data
func WithCloudInitNoCloudNetworkData ¶ added in v0.35.0
WithCloudInitNoCloudNetworkData adds cloud-init no-cloud network data.
func WithCloudInitNoCloudUserData ¶
WithCloudInitNoCloudUserData adds cloud-init no-cloud user data.
func WithConfigMapDisk ¶ added in v1.0.0
func WithConfigMapFs ¶ added in v1.0.0
func WithContainerDisk ¶ added in v1.2.0
WithContainerDisk specifies the disk name and the name of the container image to be used.
func WithDataVolume ¶ added in v0.56.0
WithDataVolume specifies the name of the DataVolume to be used.
func WithDedicatedCPUPlacement ¶ added in v0.56.0
func WithDedicatedCPUPlacement() Option
func WithDownwardAPIDisk ¶ added in v1.0.0
func WithDownwardAPIFs ¶ added in v1.0.0
func WithDownwardMetricsChannel ¶ added in v1.1.0
func WithDownwardMetricsChannel() Option
func WithDownwardMetricsVolume ¶ added in v1.1.0
func WithEmptyDisk ¶ added in v0.57.0
WithEmptyDisk specifies the name of the EmptyDisk to be used.
func WithEphemeralCDRom ¶ added in v1.2.0
WithEphemeralCDRom specifies a CDRom drive to be used.
func WithEphemeralPersistentVolumeClaim ¶ added in v1.1.0
WithEphemeralPersistentVolumeClaim specifies the name of the Ephemeral.PersistentVolumeClaim to be used.
func WithEvictionStrategy ¶ added in v1.1.0
func WithEvictionStrategy(evictionStrategy v1.EvictionStrategy) Option
func WithFilesystemDV ¶ added in v0.58.0
WithFilesystemDV specifies a filesystem backed by a DV to be used.
func WithFilesystemPVC ¶ added in v0.58.0
WithFilesystemPVC specifies a filesystem backed by a PVC to be used.
func WithGuestMemory ¶ added in v0.56.0
func WithHostDisk ¶ added in v1.2.0
func WithHostDisk(diskName, path string, diskType v1.HostDiskType) Option
func WithHugepages ¶ added in v0.56.0
func WithInterface ¶
WithInterface adds a Domain Device Interface.
func WithLabelledConfigMapDisk ¶ added in v1.0.0
func WithLabelledSecretDisk ¶ added in v1.0.0
func WithLimitCPU ¶ added in v0.56.0
WithLimitCPU specifies the VMI CPU limit.
func WithLimitMemory ¶ added in v0.56.0
WithLimitMemory specifies the VMI memory limit.
func WithMasqueradeNetworking ¶ added in v0.53.0
func WithNUMAGuestMappingPassthrough ¶ added in v0.56.0
func WithNUMAGuestMappingPassthrough() Option
func WithNamespace ¶ added in v0.59.0
func WithNetwork ¶
WithNetwork adds a network object.
func WithNodeAffinityFor ¶ added in v0.58.1
func WithNodeAffinityForLabel ¶ added in v1.2.0
func WithNodeSelectorFor ¶ added in v0.44.2
WithNodeSelectorFor ensures that the VMI gets scheduled on the specified node
func WithPasstInterfaceWithPort ¶ added in v0.58.1
func WithPasstInterfaceWithPort() Option
func WithPersistentVolumeClaim ¶ added in v0.56.0
WithPersistentVolumeClaim specifies the name of the PersistentVolumeClaim to be used.
func WithPersistentVolumeClaimLun ¶ added in v1.0.0
func WithRealtimeMask ¶ added in v0.56.0
func WithResourceCPU ¶ added in v0.56.0
WithResourceCPU specifies the vmi CPU resource.
func WithResourceMemory ¶
WithResourceMemory specifies the vmi memory resource.
func WithSEVAttestation ¶ added in v1.1.0
func WithSEVAttestation() Option
func WithSecretDisk ¶ added in v1.0.0
func WithSecretFs ¶ added in v1.0.0
func WithServiceAccountDisk ¶ added in v1.0.0
func WithServiceAccountFs ¶ added in v1.0.0
func WithStartStrategy ¶ added in v1.2.0
func WithStartStrategy(startStrategy v1.StartStrategy) Option
func WithTerminationGracePeriod ¶
WithTerminationGracePeriod specifies the termination grace period in seconds.
func WithWatchdog ¶ added in v1.1.0
func WithWatchdog(action v1.WatchdogAction) Option
WithWatchdog adds a watchdog to the vmi devices.
func WithoutSerialConsole ¶ added in v1.2.0
func WithoutSerialConsole() Option
type VMOption ¶ added in v1.2.0
type VMOption func(vm *v1.VirtualMachine)
func WithDataVolumeTemplate ¶ added in v1.2.0
func WithDataVolumeTemplate(datavolume *v1beta1.DataVolume) VMOption
func WithRunning ¶ added in v1.2.0
func WithRunning() VMOption