util

Documentation

Index

• Constants
• func AlignImageSizeTo1MiB(size int64, logger *log.FilteredLogger) int64
• func CalcExpectedMemoryDumpSize(vmi *v1.VirtualMachineInstance) *resource.Quantity
• func CloseIOAndCheckErr(c io.Closer, err *error)
• func GenerateKubeVirtGroupVersionKind(obj runtime.Object) (runtime.Object, error)
• func GenerateVMExportToken() (string, error)
• func HasKernelBootContainerImage(vmi *v1.VirtualMachineInstance) bool
• func IsAutoAttachVSOCK(vmi *v1.VirtualMachineInstance) bool
• func IsGPUVMI(vmi *v1.VirtualMachineInstance) bool
• func IsHostDevVMI(vmi *v1.VirtualMachineInstance) bool
• func IsNonRootVMI(vmi *v1.VirtualMachineInstance) bool
• func IsSEVAttestationRequested(vmi *v1.VirtualMachineInstance) bool
• func IsSEVVMI(vmi *v1.VirtualMachineInstance) bool
• func IsVFIOVMI(vmi *v1.VirtualMachineInstance) bool
• func IsVMIVirtiofsEnabled(vmi *v1.VirtualMachineInstance) bool
• func MkdirAllWithNosec(pathName string) error
• func NeedTunDevice(vmi *v1.VirtualMachineInstance) bool
• func OpenFileWithNosec(pathName string, flag int) (*os.File, error)
• func ResourceNameToEnvVar(prefix string, resourceName string) string
• func SetDefaultVolumeDisk(spec *v1.VirtualMachineInstanceSpec)
• func WantVirtioNetDevice(vmi *v1.VirtualMachineInstance) bool
• func WriteBytes(f *os.File, c byte, n int64) error
• func WriteFileWithNosec(pathName string, data []byte) error

Constants

const (
	ExtensionAPIServerAuthenticationConfigMap = "extension-apiserver-authentication"
	RequestHeaderClientCAFileKey              = "requestheader-client-ca-file"
	VirtShareDir                              = "/var/run/kubevirt"
	VirtPrivateDir                            = "/var/run/kubevirt-private"
	KubeletRoot                               = "/var/lib/kubelet"
	KubeletPodsDir                            = KubeletRoot + "/pods"
	HostRootMount                             = "/proc/1/root/"

	NonRootUID        = 107
	NonRootUserString = "qemu"
	RootUser          = 0
)

Functions

func AlignImageSizeTo1MiB

func AlignImageSizeTo1MiB(size int64, logger *log.FilteredLogger) int64

AlignImageSizeTo1MiB rounds down the size to the nearest multiple of 1MiB A warning or an error may get logged The caller is responsible for ensuring the rounded-down size is not 0

func CalcExpectedMemoryDumpSize

func CalcExpectedMemoryDumpSize(vmi *v1.VirtualMachineInstance) *resource.Quantity

func CloseIOAndCheckErr

func CloseIOAndCheckErr(c io.Closer, err *error)

CloseIOAndCheckErr closes the file and check the returned error. If there was an error a log messages will be printed. If a valid address (not nil) is passed in err the function will also update the error Note: to update the error the calling funtion need to use named returned variable (If called as defer function)

func GenerateKubeVirtGroupVersionKind

func GenerateKubeVirtGroupVersionKind(obj runtime.Object) (runtime.Object, error)

GenerateKubeVirtGroupVersionKind ensures a provided object registered with KubeVirts generated schema has GVK set correctly. This is required as client-go continues to return objects without TypeMeta set as set out in the following issue: https://github.com/kubernetes/client-go/issues/413

func GenerateVMExportToken

func GenerateVMExportToken() (string, error)

GenerateVMExportToken creates a cryptographically secure token for VM export

func HasKernelBootContainerImage

func HasKernelBootContainerImage(vmi *v1.VirtualMachineInstance) bool

Checks if kernel boot is defined in a valid way

func IsAutoAttachVSOCK

func IsAutoAttachVSOCK(vmi *v1.VirtualMachineInstance) bool

func IsGPUVMI

func IsGPUVMI(vmi *v1.VirtualMachineInstance) bool

Check if a VMI spec requests GPU

func IsHostDevVMI

func IsHostDevVMI(vmi *v1.VirtualMachineInstance) bool

Check if a VMI spec requests a HostDevice

func IsNonRootVMI

func IsNonRootVMI(vmi *v1.VirtualMachineInstance) bool

func IsSEVAttestationRequested

func IsSEVAttestationRequested(vmi *v1.VirtualMachineInstance) bool

Check if a VMI spec requests SEV with attestation

func IsSEVVMI

func IsSEVVMI(vmi *v1.VirtualMachineInstance) bool

Check if a VMI spec requests AMD SEV

func IsVFIOVMI

func IsVFIOVMI(vmi *v1.VirtualMachineInstance) bool

Check if a VMI spec requests a VFIO device

func IsVMIVirtiofsEnabled

func IsVMIVirtiofsEnabled(vmi *v1.VirtualMachineInstance) bool

Check if a VMI spec requests VirtIO-FS

func MkdirAllWithNosec

func MkdirAllWithNosec(pathName string) error

func NeedTunDevice

func NeedTunDevice(vmi *v1.VirtualMachineInstance) bool

func OpenFileWithNosec

func OpenFileWithNosec(pathName string, flag int) (*os.File, error)

func ResourceNameToEnvVar

func ResourceNameToEnvVar(prefix string, resourceName string) string

func SetDefaultVolumeDisk

func SetDefaultVolumeDisk(spec *v1.VirtualMachineInstanceSpec)

func WantVirtioNetDevice

func WantVirtioNetDevice(vmi *v1.VirtualMachineInstance) bool

WantVirtioNetDevice checks whether a VMI references at least one "virtio" network interface. Note that the reference can be explicit or implicit (unspecified nic models defaults to "virtio").

func WriteBytes

func WriteBytes(f *os.File, c byte, n int64) error

func WriteFileWithNosec

func WriteFileWithNosec(pathName string, data []byte) error