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 GenerateSecureRandomString(n int) (string, error)
• func HasHugePages(vmi *v1.VirtualMachineInstance) bool
• func HasKernelBootContainerImage(vmi *v1.VirtualMachineInstance) bool
• func IsGPUVMI(vmi *v1.VirtualMachineInstance) bool
• func IsHostDevVMI(vmi *v1.VirtualMachineInstance) bool
• func IsNonRootVMI(vmi *v1.VirtualMachineInstance) bool
• func IsReadOnlyDisk(disk *v1.Disk) bool
• func IsSEVVMI(vmi *v1.VirtualMachineInstance) bool
• func IsSRIOVVmi(vmi *v1.VirtualMachineInstance) bool
• func IsVFIOVMI(vmi *v1.VirtualMachineInstance) bool
• func IsVMIVirtiofsEnabled(vmi *v1.VirtualMachineInstance) bool
• func IsVmiUsingHyperVReenlightenment(vmi *v1.VirtualMachineInstance) bool
• func MarkAsNonroot(vmi *v1.VirtualMachineInstance)
• func MkdirAllWithNosec(pathName string) error
• func NeedTunDevice(vmi *v1.VirtualMachineInstance) bool
• func NeedVirtioNetDevice(vmi *v1.VirtualMachineInstance, allowEmulation bool) bool
• func OpenFileWithNosec(pathName string, flag int) (*os.File, error)
• func ResourceNameToEnvVar(prefix string, resourceName string) string
• func SetDefaultVolumeDisk(obj *v1.VirtualMachineInstance)
• func UseSoftwareEmulationForDevice(devicePath string, allowEmulation bool) (bool, error)
• 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"
	VirtLibDir                                = "/var/lib/kubevirt"
	KubeletPodsDir                            = "/var/lib/kubelet/pods"
	HostRootMount                             = "/proc/1/root/"
	CPUManagerOS3Path                         = HostRootMount + "var/lib/origin/openshift.local.volumes/cpu_manager_state"
	CPUManagerPath                            = HostRootMount + "var/lib/kubelet/cpu_manager_state"
)

const Alphanums = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"

Alphanums is the list of alphanumeric characters used to create a securely generated random string

const NonRootUID = 107

const NonRootUserString = "qemu"

const 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 GenerateSecureRandomString

func GenerateSecureRandomString(n int) (string, error)

GenerateRandomString creates a securely generated random string using crypto/rand

func HasHugePages

func HasHugePages(vmi *v1.VirtualMachineInstance) bool

func HasKernelBootContainerImage

func HasKernelBootContainerImage(vmi *v1.VirtualMachineInstance) bool

Checks if kernel boot is defined in a valid way

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 IsReadOnlyDisk

func IsReadOnlyDisk(disk *v1.Disk) bool

func IsSEVVMI

func IsSEVVMI(vmi *v1.VirtualMachineInstance) bool

Check if a VMI spec requests AMD SEV

func IsSRIOVVmi

func IsSRIOVVmi(vmi *v1.VirtualMachineInstance) bool

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 IsVmiUsingHyperVReenlightenment

func IsVmiUsingHyperVReenlightenment(vmi *v1.VirtualMachineInstance) bool

func MarkAsNonroot

func MarkAsNonroot(vmi *v1.VirtualMachineInstance)

func MkdirAllWithNosec

func MkdirAllWithNosec(pathName string) error

func NeedTunDevice

func NeedTunDevice(vmi *v1.VirtualMachineInstance) bool

func NeedVirtioNetDevice

func NeedVirtioNetDevice(vmi *v1.VirtualMachineInstance, allowEmulation bool) bool

NeedVirtioNetDevice checks whether a VMI requires the presence of the "virtio" net device. This happens when the VMI wants to use a "virtio" network interface, and software emulation is disallowed.

func OpenFileWithNosec

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

func ResourceNameToEnvVar

func ResourceNameToEnvVar(prefix string, resourceName string) string

func SetDefaultVolumeDisk

func SetDefaultVolumeDisk(obj *v1.VirtualMachineInstance)

func UseSoftwareEmulationForDevice

func UseSoftwareEmulationForDevice(devicePath string, allowEmulation bool) (bool, error)

UseSoftwareEmulationForDevice determines whether to fallback to software emulation for the given device. This happens when the given device doesn't exist, and software emulation is enabled.

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