// Code generated by swagger-doc. DO NOT EDIT. package v1 func (HostDisk) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents a disk created on the cluster level", "path": "The path to HostDisk image located on the cluster", "type": "Contains information if disk.img exists or should be created\nallowed options are 'Disk' and 'DiskOrCreate'", "capacity": "Capacity of the sparse disk\n+optional", "shared": "Shared indicate whether the path is shared between nodes", } } func (ConfigMapVolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "": "ConfigMapVolumeSource adapts a ConfigMap into a volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#configmap", "optional": "Specify whether the ConfigMap or it's keys must be defined\n+optional", "volumeLabel": "The volume label of the resulting disk inside the VMI.\nDifferent bootstrapping mechanisms require different values.\nTypical values are \"cidata\" (cloud-init), \"config-2\" (cloud-init) or \"OEMDRV\" (kickstart).\n+optional", } } func (SecretVolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "": "SecretVolumeSource adapts a Secret into a volume.", "secretName": "Name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret", "optional": "Specify whether the Secret or it's keys must be defined\n+optional", "volumeLabel": "The volume label of the resulting disk inside the VMI.\nDifferent bootstrapping mechanisms require different values.\nTypical values are \"cidata\" (cloud-init), \"config-2\" (cloud-init) or \"OEMDRV\" (kickstart).\n+optional", } } func (DownwardAPIVolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "": "DownwardAPIVolumeSource represents a volume containing downward API info.", "fields": "Fields is a list of downward API volume file\n+optional", "volumeLabel": "The volume label of the resulting disk inside the VMI.\nDifferent bootstrapping mechanisms require different values.\nTypical values are \"cidata\" (cloud-init), \"config-2\" (cloud-init) or \"OEMDRV\" (kickstart).\n+optional", } } func (ServiceAccountVolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "": "ServiceAccountVolumeSource adapts a ServiceAccount into a volume.", "serviceAccountName": "Name of the service account in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/", } } func (DownwardMetricsVolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "": "DownwardMetricsVolumeSource adds a very small disk to VMIs which contains a limited view of host and guest\nmetrics. The disk content is compatible with vhostmd (https://github.com/vhostmd/vhostmd) and vm-dump-metrics.", } } func (SysprepSource) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents a Sysprep volume source.", "secret": "Secret references a k8s Secret that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.\n+ optional", "configMap": "ConfigMap references a ConfigMap that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.\n+ optional", } } func (CloudInitNoCloudSource) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents a cloud-init nocloud user data source.\nMore info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html", "secretRef": "UserDataSecretRef references a k8s secret that contains NoCloud userdata.\n+ optional", "userDataBase64": "UserDataBase64 contains NoCloud cloud-init userdata as a base64 encoded string.\n+ optional", "userData": "UserData contains NoCloud inline cloud-init userdata.\n+ optional", "networkDataSecretRef": "NetworkDataSecretRef references a k8s secret that contains NoCloud networkdata.\n+ optional", "networkDataBase64": "NetworkDataBase64 contains NoCloud cloud-init networkdata as a base64 encoded string.\n+ optional", "networkData": "NetworkData contains NoCloud inline cloud-init networkdata.\n+ optional", } } func (CloudInitConfigDriveSource) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents a cloud-init config drive user data source.\nMore info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html", "secretRef": "UserDataSecretRef references a k8s secret that contains config drive userdata.\n+ optional", "userDataBase64": "UserDataBase64 contains config drive cloud-init userdata as a base64 encoded string.\n+ optional", "userData": "UserData contains config drive inline cloud-init userdata.\n+ optional", "networkDataSecretRef": "NetworkDataSecretRef references a k8s secret that contains config drive networkdata.\n+ optional", "networkDataBase64": "NetworkDataBase64 contains config drive cloud-init networkdata as a base64 encoded string.\n+ optional", "networkData": "NetworkData contains config drive inline cloud-init networkdata.\n+ optional", } } func (DomainSpec) SwaggerDoc() map[string]string { return map[string]string{ "resources": "Resources describes the Compute Resources required by this vmi.", "cpu": "CPU allow specified the detailed CPU topology inside the vmi.\n+optional", "memory": "Memory allow specifying the VMI memory features.\n+optional", "machine": "Machine type.\n+optional", "firmware": "Firmware.\n+optional", "clock": "Clock sets the clock and timers of the vmi.\n+optional", "features": "Features like acpi, apic, hyperv, smm.\n+optional", "devices": "Devices allows adding disks, network interfaces, and others", "ioThreadsPolicy": "Controls whether or not disks will share IOThreads.\nOmitting IOThreadsPolicy disables use of IOThreads.\nOne of: shared, auto\n+optional", "chassis": "Chassis specifies the chassis info passed to the domain.\n+optional", "launchSecurity": "Launch Security setting of the vmi.\n+optional", } } func (Chassis) SwaggerDoc() map[string]string { return map[string]string{ "": "Chassis specifies the chassis info passed to the domain.", } } func (Bootloader) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the firmware blob used to assist in the domain creation process.\nUsed for setting the QEMU BIOS file path for the libvirt domain.", "bios": "If set (default), BIOS will be used.\n+optional", "efi": "If set, EFI will be used instead of BIOS.\n+optional", } } func (BIOS) SwaggerDoc() map[string]string { return map[string]string{ "": "If set (default), BIOS will be used.", "useSerial": "If set, the BIOS output will be transmitted over serial\n+optional", } } func (EFI) SwaggerDoc() map[string]string { return map[string]string{ "": "If set, EFI will be used instead of BIOS.", "secureBoot": "If set, SecureBoot will be enabled and the OVMF roms will be swapped for\nSecureBoot-enabled ones.\nRequires SMM to be enabled.\nDefaults to true\n+optional", "persistent": "If set to true, Persistent will persist the EFI NVRAM across reboots.\nDefaults to false\n+optional", } } func (KernelBootContainer) SwaggerDoc() map[string]string { return map[string]string{ "": "If set, the VM will be booted from the defined kernel / initrd.", "image": "Image that contains initrd / kernel files.", "imagePullSecret": "ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.\n+optional", "imagePullPolicy": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional", "kernelPath": "The fully-qualified path to the kernel image in the host OS\n+optional", "initrdPath": "the fully-qualified path to the ramdisk image in the host OS\n+optional", } } func (KernelBoot) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the firmware blob used to assist in the kernel boot process.\nUsed for setting the kernel, initrd and command line arguments", "kernelArgs": "Arguments to be passed to the kernel at boot time", "container": "Container defines the container that containes kernel artifacts", } } func (ResourceRequirements) SwaggerDoc() map[string]string { return map[string]string{ "requests": "Requests is a description of the initial vmi resources.\nValid resource keys are \"memory\" and \"cpu\".\n+optional", "limits": "Limits describes the maximum amount of compute resources allowed.\nValid resource keys are \"memory\" and \"cpu\".\n+optional", "overcommitGuestOverhead": "Don't ask the scheduler to take the guest-management overhead into account. Instead\nput the overhead only into the container's memory limit. This can lead to crashes if\nall memory is in use on a node. Defaults to false.", } } func (CPU) SwaggerDoc() map[string]string { return map[string]string{ "": "CPU allows specifying the CPU topology.", "cores": "Cores specifies the number of cores inside the vmi.\nMust be a value greater or equal 1.", "sockets": "Sockets specifies the number of sockets inside the vmi.\nMust be a value greater or equal 1.", "maxSockets": "MaxSockets specifies the maximum amount of sockets that can\nbe hotplugged", "threads": "Threads specifies the number of threads inside the vmi.\nMust be a value greater or equal 1.", "model": "Model specifies the CPU model inside the VMI.\nList of available models https://github.com/libvirt/libvirt/tree/master/src/cpu_map.\nIt is possible to specify special cases like \"host-passthrough\" to get the same CPU as the node\nand \"host-model\" to get CPU closest to the node one.\nDefaults to host-model.\n+optional", "features": "Features specifies the CPU features list inside the VMI.\n+optional", "dedicatedCpuPlacement": "DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node\nwith enough dedicated pCPUs and pin the vCPUs to it.\n+optional", "numa": "NUMA allows specifying settings for the guest NUMA topology\n+optional", "isolateEmulatorThread": "IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place\nthe emulator thread on it.\n+optional", "realtime": "Realtime instructs the virt-launcher to tune the VMI for lower latency, optional for real time workloads\n+optional", } } func (Realtime) SwaggerDoc() map[string]string { return map[string]string{ "": "Realtime holds the tuning knobs specific for realtime workloads.", "mask": "Mask defines the vcpu mask expression that defines which vcpus are used for realtime. Format matches libvirt's expressions.\nExample: \"0-3,^1\",\"0,2,3\",\"2-3\"\n+optional", } } func (NUMAGuestMappingPassthrough) SwaggerDoc() map[string]string { return map[string]string{ "": "NUMAGuestMappingPassthrough instructs kubevirt to model numa topology which is compatible with the CPU pinning on the guest.\nThis will result in a subset of the node numa topology being passed through, ensuring that virtual numa nodes and their memory\nnever cross boundaries coming from the node numa mapping.", } } func (NUMA) SwaggerDoc() map[string]string { return map[string]string{ "guestMappingPassthrough": "GuestMappingPassthrough will create an efficient guest topology based on host CPUs exclusively assigned to a pod.\nThe created topology ensures that memory and CPUs on the virtual numa nodes never cross boundaries of host numa nodes.\n+opitonal", } } func (CPUFeature) SwaggerDoc() map[string]string { return map[string]string{ "": "CPUFeature allows specifying a CPU feature.", "name": "Name of the CPU feature", "policy": "Policy is the CPU feature attribute which can have the following attributes:\nforce - The virtual CPU will claim the feature is supported regardless of it being supported by host CPU.\nrequire - Guest creation will fail unless the feature is supported by the host CPU or the hypervisor is able to emulate it.\noptional - The feature will be supported by virtual CPU if and only if it is supported by host CPU.\ndisable - The feature will not be supported by virtual CPU.\nforbid - Guest creation will fail if the feature is supported by host CPU.\nDefaults to require\n+optional", } } func (Memory) SwaggerDoc() map[string]string { return map[string]string{ "": "Memory allows specifying the VirtualMachineInstance memory features.", "hugepages": "Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.\n+optional", "guest": "Guest allows to specifying the amount of memory which is visible inside the Guest OS.\nThe Guest must lie between Requests and Limits from the resources section.\nDefaults to the requested memory in the resources section if not specified.\n+ optional", "maxGuest": "MaxGuest allows to specify the maximum amount of memory which is visible inside the Guest OS.\nThe delta between MaxGuest and Guest is the amount of memory that can be hot(un)plugged.", } } func (MemoryStatus) SwaggerDoc() map[string]string { return map[string]string{ "guestAtBoot": "GuestAtBoot specifies with how much memory the VirtualMachine intiallly booted with.\n+optional", "guestCurrent": "GuestCurrent specifies how much memory is currently available for the VirtualMachine.\n+optional", "guestRequested": "GuestRequested specifies how much memory was requested (hotplug) for the VirtualMachine.\n+optional", } } func (Hugepages) SwaggerDoc() map[string]string { return map[string]string{ "": "Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.", "pageSize": "PageSize specifies the hugepage size, for x86_64 architecture valid values are 1Gi and 2Mi.", } } func (Machine) SwaggerDoc() map[string]string { return map[string]string{ "type": "QEMU machine type is the actual chipset of the VirtualMachineInstance.\n+optional", } } func (Firmware) SwaggerDoc() map[string]string { return map[string]string{ "uuid": "UUID reported by the vmi bios.\nDefaults to a random generated uid.", "bootloader": "Settings to control the bootloader that is used.\n+optional", "serial": "The system-serial-number in SMBIOS", "kernelBoot": "Settings to set the kernel for booting.\n+optional", "acpi": "Information that can be set in the ACPI table", } } func (ACPI) SwaggerDoc() map[string]string { return map[string]string{ "slicNameRef": "SlicNameRef should match the volume name of a secret object. The data in the secret should\nbe a binary blob that follows the ACPI SLIC standard, see:\nhttps://learn.microsoft.com/en-us/previous-versions/windows/hardware/design/dn653305(v=vs.85)", } } func (Devices) SwaggerDoc() map[string]string { return map[string]string{ "useVirtioTransitional": "Fall back to legacy virtio 0.9 support if virtio bus is selected on devices.\nThis is helpful for old machines like CentOS6 or RHEL6 which\ndo not understand virtio_non_transitional (virtio 1.0).", "disableHotplug": "DisableHotplug disabled the ability to hotplug disks.", "disks": "Disks describes disks, cdroms and luns which are connected to the vmi.\n+kubebuilder:validation:MaxItems:=256", "watchdog": "Watchdog describes a watchdog device which can be added to the vmi.", "interfaces": "Interfaces describe network interfaces which are added to the vmi.\n+kubebuilder:validation:MaxItems:=256", "inputs": "Inputs describe input devices", "autoattachPodInterface": "Whether to attach a pod network interface. Defaults to true.", "autoattachGraphicsDevice": "Whether to attach the default graphics device or not.\nVNC will not be available if set to false. Defaults to true.", "autoattachSerialConsole": "Whether to attach the default virtio-serial console or not.\nSerial console access will not be available if set to false. Defaults to true.", "logSerialConsole": "Whether to log the auto-attached default serial console or not.\nSerial console logs will be collect to a file and then streamed from a named `guest-console-log`.\nNot relevant if autoattachSerialConsole is disabled.\nDefaults to cluster wide setting on VirtualMachineOptions.", "autoattachMemBalloon": "Whether to attach the Memory balloon device with default period.\nPeriod can be adjusted in virt-config.\nDefaults to true.\n+optional", "autoattachInputDevice": "Whether to attach an Input Device.\nDefaults to false.\n+optional", "autoattachVSOCK": "Whether to attach the VSOCK CID to the VM or not.\nVSOCK access will be available if set to true. Defaults to false.", "rng": "Whether to have random number generator from host\n+optional", "blockMultiQueue": "Whether or not to enable virtio multi-queue for block devices.\nDefaults to false.\n+optional", "networkInterfaceMultiqueue": "If specified, virtual network interfaces configured with a virtio bus will also enable the vhost multiqueue feature for network devices. The number of queues created depends on additional factors of the VirtualMachineInstance, like the number of guest CPUs.\n+optional", "gpus": "Whether to attach a GPU device to the vmi.\n+optional\n+listType=atomic", "downwardMetrics": "DownwardMetrics creates a virtio serials for exposing the downward metrics to the vmi.\n+optional", "filesystems": "Filesystems describes filesystem which is connected to the vmi.\n+optional\n+listType=atomic", "hostDevices": "Whether to attach a host device to the vmi.\n+optional\n+listType=atomic", "clientPassthrough": "To configure and access client devices such as redirecting USB\n+optional", "sound": "Whether to emulate a sound device.\n+optional", "tpm": "Whether to emulate a TPM device.\n+optional", } } func (ClientPassthroughDevices) SwaggerDoc() map[string]string { return map[string]string{ "": "Represent a subset of client devices that can be accessed by VMI. At the\nmoment only, USB devices using Usbredir's library and tooling. Another fit\nwould be a smartcard with libcacard.\n\nThe struct is currently empty as there is no immediate request for\nuser-facing APIs. This structure simply turns on USB redirection of\nUsbClientPassthroughMaxNumberOf devices.", } } func (SoundDevice) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the user's configuration to emulate sound cards in the VMI.", "name": "User's defined name for this sound device", "model": "We only support ich9 or ac97.\nIf SoundDevice is not set: No sound card is emulated.\nIf SoundDevice is set but Model is not: ich9\n+optional", } } func (TPMDevice) SwaggerDoc() map[string]string { return map[string]string{ "persistent": "Persistent indicates the state of the TPM device should be kept accross reboots\nDefaults to false", } } func (Input) SwaggerDoc() map[string]string { return map[string]string{ "bus": "Bus indicates the bus of input device to emulate.\nSupported values: virtio, usb.", "type": "Type indicated the type of input device.\nSupported values: tablet.", "name": "Name is the device name", } } func (Filesystem) SwaggerDoc() map[string]string { return map[string]string{ "name": "Name is the device name", "virtiofs": "Virtiofs is supported", } } func (FilesystemVirtiofs) SwaggerDoc() map[string]string { return map[string]string{} } func (DownwardMetrics) SwaggerDoc() map[string]string { return map[string]string{} } func (GPU) SwaggerDoc() map[string]string { return map[string]string{ "name": "Name of the GPU device as exposed by a device plugin", "tag": "If specified, the virtual network interface address and its tag will be provided to the guest via config drive\n+optional", } } func (VGPUOptions) SwaggerDoc() map[string]string { return map[string]string{} } func (VGPUDisplayOptions) SwaggerDoc() map[string]string { return map[string]string{ "enabled": "Enabled determines if a display addapter backed by a vGPU should be enabled or disabled on the guest.\nDefaults to true.\n+optional", "ramFB": "Enables a boot framebuffer, until the guest OS loads a real GPU driver\nDefaults to true.\n+optional", } } func (HostDevice) SwaggerDoc() map[string]string { return map[string]string{ "deviceName": "DeviceName is the resource name of the host device exposed by a device plugin", "tag": "If specified, the virtual network interface address and its tag will be provided to the guest via config drive\n+optional", } } func (Disk) SwaggerDoc() map[string]string { return map[string]string{ "name": "Name is the device name", "bootOrder": "BootOrder is an integer value > 0, used to determine ordering of boot devices.\nLower values take precedence.\nEach disk or interface that has a boot order must have a unique value.\nDisks without a boot order are not tried if a disk with a boot order exists.\n+optional", "serial": "Serial provides the ability to specify a serial number for the disk device.\n+optional", "dedicatedIOThread": "dedicatedIOThread indicates this disk should have an exclusive IO Thread.\nEnabling this implies useIOThreads = true.\nDefaults to false.\n+optional", "cache": "Cache specifies which kvm disk cache mode should be used.\nSupported values are: CacheNone, CacheWriteThrough.\n+optional", "io": "IO specifies which QEMU disk IO mode should be used.\nSupported values are: native, default, threads.\n+optional", "tag": "If specified, disk address and its tag will be provided to the guest via config drive metadata\n+optional", "blockSize": "If specified, the virtual disk will be presented with the given block sizes.\n+optional", "shareable": "If specified the disk is made sharable and multiple write from different VMs are permitted\n+optional", "errorPolicy": "If specified, it can change the default error policy (stop) for the disk\n+optional", } } func (CustomBlockSize) SwaggerDoc() map[string]string { return map[string]string{ "": "CustomBlockSize represents the desired logical and physical block size for a VM disk.", } } func (BlockSize) SwaggerDoc() map[string]string { return map[string]string{ "": "BlockSize provides the option to change the block size presented to the VM for a disk.\nOnly one of its members may be specified.", } } func (DiskDevice) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the target of a volume to mount.\nOnly one of its members may be specified.", "disk": "Attach a volume as a disk to the vmi.", "lun": "Attach a volume as a LUN to the vmi.", "cdrom": "Attach a volume as a cdrom to the vmi.", } } func (DiskTarget) SwaggerDoc() map[string]string { return map[string]string{ "bus": "Bus indicates the type of disk device to emulate.\nsupported values: virtio, sata, scsi, usb.", "readonly": "ReadOnly.\nDefaults to false.", "pciAddress": "If specified, the virtual disk will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10\n+optional", } } func (LaunchSecurity) SwaggerDoc() map[string]string { return map[string]string{ "sev": "AMD Secure Encrypted Virtualization (SEV).", } } func (SEV) SwaggerDoc() map[string]string { return map[string]string{ "policy": "Guest policy flags as defined in AMD SEV API specification.\nNote: due to security reasons it is not allowed to enable guest debugging. Therefore NoDebug flag is not exposed to users and is always true.", "attestation": "If specified, run the attestation process for a vmi.\n+opitonal", "session": "Base64 encoded session blob.", "dhCert": "Base64 encoded guest owner's Diffie-Hellman key.", } } func (SEVPolicy) SwaggerDoc() map[string]string { return map[string]string{ "encryptedState": "SEV-ES is required.\nDefaults to false.\n+optional", } } func (SEVAttestation) SwaggerDoc() map[string]string { return map[string]string{} } func (LunTarget) SwaggerDoc() map[string]string { return map[string]string{ "bus": "Bus indicates the type of disk device to emulate.\nsupported values: virtio, sata, scsi.", "readonly": "ReadOnly.\nDefaults to false.", "reservation": "Reservation indicates if the disk needs to support the persistent reservation for the SCSI disk", } } func (CDRomTarget) SwaggerDoc() map[string]string { return map[string]string{ "bus": "Bus indicates the type of disk device to emulate.\nsupported values: virtio, sata, scsi.", "readonly": "ReadOnly.\nDefaults to true.", "tray": "Tray indicates if the tray of the device is open or closed.\nAllowed values are \"open\" and \"closed\".\nDefaults to closed.\n+optional", } } func (Volume) SwaggerDoc() map[string]string { return map[string]string{ "": "Volume represents a named volume in a vmi.", "name": "Volume's name.\nMust be a DNS_LABEL and unique within the vmi.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", } } func (VolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the source of a volume to mount.\nOnly one of its members may be specified.", "hostDisk": "HostDisk represents a disk created on the cluster level\n+optional", "persistentVolumeClaim": "PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace.\nDirectly attached to the vmi via qemu.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims\n+optional", "cloudInitNoCloud": "CloudInitNoCloud represents a cloud-init NoCloud user-data source.\nThe NoCloud data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest.\nMore info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html\n+optional", "cloudInitConfigDrive": "CloudInitConfigDrive represents a cloud-init Config Drive user-data source.\nThe Config Drive data will be added as a disk to the vmi. A proper cloud-init installation is required inside the guest.\nMore info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html\n+optional", "sysprep": "Represents a Sysprep volume source.\n+optional", "containerDisk": "ContainerDisk references a docker image, embedding a qcow or raw disk.\nMore info: https://kubevirt.gitbooks.io/user-guide/registry-disk.html\n+optional", "ephemeral": "Ephemeral is a special volume source that \"wraps\" specified source and provides copy-on-write image on top of it.\n+optional", "emptyDisk": "EmptyDisk represents a temporary disk which shares the vmis lifecycle.\nMore info: https://kubevirt.gitbooks.io/user-guide/disks-and-volumes.html\n+optional", "dataVolume": "DataVolume represents the dynamic creation a PVC for this volume as well as\nthe process of populating that PVC with a disk image.\n+optional", "configMap": "ConfigMapSource represents a reference to a ConfigMap in the same namespace.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/\n+optional", "secret": "SecretVolumeSource represents a reference to a secret data in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/configuration/secret/\n+optional", "downwardAPI": "DownwardAPI represents downward API about the pod that should populate this volume\n+optional", "serviceAccount": "ServiceAccountVolumeSource represents a reference to a service account.\nThere can only be one volume of this type!\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/\n+optional", "downwardMetrics": "DownwardMetrics adds a very small disk to VMIs which contains a limited view of host and guest\nmetrics. The disk content is compatible with vhostmd (https://github.com/vhostmd/vhostmd) and vm-dump-metrics.", "memoryDump": "MemoryDump is attached to the virt launcher and is populated with a memory dump of the vmi", } } func (HotplugVolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "": "HotplugVolumeSource Represents the source of a volume to mount which are capable\nof being hotplugged on a live running VMI.\nOnly one of its members may be specified.", "persistentVolumeClaim": "PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace.\nDirectly attached to the vmi via qemu.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims\n+optional", "dataVolume": "DataVolume represents the dynamic creation a PVC for this volume as well as\nthe process of populating that PVC with a disk image.\n+optional", } } func (DataVolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "name": "Name of both the DataVolume and the PVC in the same namespace.\nAfter PVC population the DataVolume is garbage collected by default.", "hotpluggable": "Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.\n+optional", } } func (PersistentVolumeClaimVolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "": "PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace.\nDirectly attached to the vmi via qemu.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "hotpluggable": "Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.\n+optional", } } func (MemoryDumpVolumeSource) SwaggerDoc() map[string]string { return map[string]string{} } func (EphemeralVolumeSource) SwaggerDoc() map[string]string { return map[string]string{ "persistentVolumeClaim": "PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace.\nDirectly attached to the vmi via qemu.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims\n+optional", } } func (EmptyDiskSource) SwaggerDoc() map[string]string { return map[string]string{ "": "EmptyDisk represents a temporary disk which shares the vmis lifecycle.", "capacity": "Capacity of the sparse disk.", } } func (ContainerDiskSource) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents a docker image with an embedded disk.", "image": "Image is the name of the image with the embedded disk.", "imagePullSecret": "ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.", "path": "Path defines the path to disk file in the container", "imagePullPolicy": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images\n+optional", } } func (ClockOffset) SwaggerDoc() map[string]string { return map[string]string{ "": "Exactly one of its members must be set.", "utc": "UTC sets the guest clock to UTC on each boot. If an offset is specified,\nguest changes to the clock will be kept during reboots and are not reset.", "timezone": "Timezone sets the guest clock to the specified timezone.\nZone name follows the TZ environment variable format (e.g. 'America/New_York').", } } func (ClockOffsetUTC) SwaggerDoc() map[string]string { return map[string]string{ "": "UTC sets the guest clock to UTC on each boot.", "offsetSeconds": "OffsetSeconds specifies an offset in seconds, relative to UTC. If set,\nguest changes to the clock will be kept during reboots and not reset.", } } func (Clock) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the clock and timers of a vmi.\n+kubebuilder:pruning:PreserveUnknownFields", "timer": "Timer specifies whih timers are attached to the vmi.\n+optional", } } func (Timer) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents all available timers in a vmi.", "hpet": "HPET (High Precision Event Timer) - multiple timers with periodic interrupts.", "kvm": "KVM \t(KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests.", "pit": "PIT (Programmable Interval Timer) - a timer with periodic interrupts.", "rtc": "RTC (Real Time Clock) - a continuously running timer with periodic interrupts.", "hyperv": "Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.", } } func (RTCTimer) SwaggerDoc() map[string]string { return map[string]string{ "tickPolicy": "TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest.\nOne of \"delay\", \"catchup\".", "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional", "track": "Track the guest or the wall clock.", } } func (HPETTimer) SwaggerDoc() map[string]string { return map[string]string{ "tickPolicy": "TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest.\nOne of \"delay\", \"catchup\", \"merge\", \"discard\".", "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional", } } func (PITTimer) SwaggerDoc() map[string]string { return map[string]string{ "tickPolicy": "TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest.\nOne of \"delay\", \"catchup\", \"discard\".", "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional", } } func (KVMTimer) SwaggerDoc() map[string]string { return map[string]string{ "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional", } } func (HypervTimer) SwaggerDoc() map[string]string { return map[string]string{ "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional", } } func (HyperVPassthrough) SwaggerDoc() map[string]string { return map[string]string{ "enabled": "+optional", } } func (Features) SwaggerDoc() map[string]string { return map[string]string{ "acpi": "ACPI enables/disables ACPI inside the guest.\nDefaults to enabled.\n+optional", "apic": "Defaults to the machine type setting.\n+optional", "hypervPassthrough": "This enables all supported hyperv flags automatically.\nBear in mind that if this enabled hyperV features cannot\nbe enabled explicitly. In addition, a Virtual Machine\nusing it will be non-migratable.\n+optional", "hyperv": "Defaults to the machine type setting.\n+optional", "smm": "SMM enables/disables System Management Mode.\nTSEG not yet implemented.\n+optional", "kvm": "Configure how KVM presence is exposed to the guest.\n+optional", "pvspinlock": "Notify the guest that the host supports paravirtual spinlocks.\nFor older kernels this feature should be explicitly disabled.\n+optional", } } func (SyNICTimer) SwaggerDoc() map[string]string { return map[string]string{} } func (FeatureState) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents if a feature is enabled or disabled.", "enabled": "Enabled determines if the feature should be enabled or disabled on the guest.\nDefaults to true.\n+optional", } } func (FeatureAPIC) SwaggerDoc() map[string]string { return map[string]string{ "enabled": "Enabled determines if the feature should be enabled or disabled on the guest.\nDefaults to true.\n+optional", "endOfInterrupt": "EndOfInterrupt enables the end of interrupt notification in the guest.\nDefaults to false.\n+optional", } } func (FeatureSpinlocks) SwaggerDoc() map[string]string { return map[string]string{ "enabled": "Enabled determines if the feature should be enabled or disabled on the guest.\nDefaults to true.\n+optional", "spinlocks": "Retries indicates the number of retries.\nMust be a value greater or equal 4096.\nDefaults to 4096.\n+optional", } } func (FeatureVendorID) SwaggerDoc() map[string]string { return map[string]string{ "enabled": "Enabled determines if the feature should be enabled or disabled on the guest.\nDefaults to true.\n+optional", "vendorid": "VendorID sets the hypervisor vendor id, visible to the vmi.\nString up to twelve characters.", } } func (FeatureHyperv) SwaggerDoc() map[string]string { return map[string]string{ "": "Hyperv specific features.", "relaxed": "Relaxed instructs the guest OS to disable watchdog timeouts.\nDefaults to the machine type setting.\n+optional", "vapic": "VAPIC improves the paravirtualized handling of interrupts.\nDefaults to the machine type setting.\n+optional", "spinlocks": "Spinlocks allows to configure the spinlock retry attempts.\n+optional", "vpindex": "VPIndex enables the Virtual Processor Index to help windows identifying virtual processors.\nDefaults to the machine type setting.\n+optional", "runtime": "Runtime improves the time accounting to improve scheduling in the guest.\nDefaults to the machine type setting.\n+optional", "synic": "SyNIC enables the Synthetic Interrupt Controller.\nDefaults to the machine type setting.\n+optional", "synictimer": "SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load.\nDefaults to the machine type setting.\n+optional", "reset": "Reset enables Hyperv reboot/reset for the vmi. Requires synic.\nDefaults to the machine type setting.\n+optional", "vendorid": "VendorID allows setting the hypervisor vendor id.\nDefaults to the machine type setting.\n+optional", "frequencies": "Frequencies improves the TSC clock source handling for Hyper-V on KVM.\nDefaults to the machine type setting.\n+optional", "reenlightenment": "Reenlightenment enables the notifications on TSC frequency changes.\nDefaults to the machine type setting.\n+optional", "tlbflush": "TLBFlush improves performances in overcommited environments. Requires vpindex.\nDefaults to the machine type setting.\n+optional", "ipi": "IPI improves performances in overcommited environments. Requires vpindex.\nDefaults to the machine type setting.\n+optional", "evmcs": "EVMCS Speeds up L2 vmexits, but disables other virtualization features. Requires vapic.\nDefaults to the machine type setting.\n+optional", } } func (FeatureKVM) SwaggerDoc() map[string]string { return map[string]string{ "hidden": "Hide the KVM hypervisor from standard MSR based discovery.\nDefaults to false", } } func (Watchdog) SwaggerDoc() map[string]string { return map[string]string{ "": "Named watchdog device.", "name": "Name of the watchdog.", } } func (WatchdogDevice) SwaggerDoc() map[string]string { return map[string]string{ "": "Hardware watchdog device.\nExactly one of its members must be set.", "i6300esb": "i6300esb watchdog device.\n+optional", } } func (I6300ESBWatchdog) SwaggerDoc() map[string]string { return map[string]string{ "": "i6300esb watchdog device.", "action": "The action to take. Valid values are poweroff, reset, shutdown.\nDefaults to reset.", } } func (Interface) SwaggerDoc() map[string]string { return map[string]string{ "name": "Logical name of the interface as well as a reference to the associated networks.\nMust match the Name of a Network.", "model": "Interface model.\nOne of: e1000, e1000e, igb, ne2k_pci, pcnet, rtl8139, virtio.\nDefaults to virtio.", "binding": "Binding specifies the binding plugin that will be used to connect the interface to the guest.\nIt provides an alternative to InterfaceBindingMethod.\nversion: 1alphav1", "ports": "List of ports to be forwarded to the virtual machine.", "macAddress": "Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF.", "bootOrder": "BootOrder is an integer value > 0, used to determine ordering of boot devices.\nLower values take precedence.\nEach interface or disk that has a boot order must have a unique value.\nInterfaces without a boot order are not tried.\n+optional", "pciAddress": "If specified, the virtual network interface will be placed on the guests pci address with the specified PCI address. For example: 0000:81:01.10\n+optional", "dhcpOptions": "If specified the network interface will pass additional DHCP options to the VMI\n+optional", "tag": "If specified, the virtual network interface address and its tag will be provided to the guest via config drive\n+optional", "acpiIndex": "If specified, the ACPI index is used to provide network interface device naming, that is stable across changes\nin PCI addresses assigned to the device.\nThis value is required to be unique across all devices and be between 1 and (16*1024-1).\n+optional", "state": "State represents the requested operational state of the interface.\nThe (only) value supported is `absent`, expressing a request to remove the interface.\n+optional", } } func (DHCPOptions) SwaggerDoc() map[string]string { return map[string]string{ "": "Extra DHCP options to use in the interface.", "bootFileName": "If specified will pass option 67 to interface's DHCP server\n+optional", "tftpServerName": "If specified will pass option 66 to interface's DHCP server\n+optional", "ntpServers": "If specified will pass the configured NTP server to the VM via DHCP option 042.\n+optional", "privateOptions": "If specified will pass extra DHCP options for private use, range: 224-254\n+optional", } } func (DHCPPrivateOptions) SwaggerDoc() map[string]string { return map[string]string{ "": "DHCPExtraOptions defines Extra DHCP options for a VM.", "option": "Option is an Integer value from 224-254\nRequired.", "value": "Value is a String value for the Option provided\nRequired.", } } func (InterfaceBindingMethod) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the method which will be used to connect the interface to the guest.\nOnly one of its members may be specified.", "slirp": "DeprecatedSlirp is an alias to the deprecated Slirp interface\nDeprecated: Removed in v1.3", "macvtap": "DeprecatedMacvtap is an alias to the deprecated Macvtap interface,\nplease refer to Kubevirt user guide for alternatives.\nDeprecated: Removed in v1.3\n+optional", "passt": "DeprecatedPasst is an alias to the deprecated Passt interface,\nplease refer to Kubevirt user guide for alternatives.\nDeprecated: Removed in v1.3\n+optional", } } func (InterfaceBridge) SwaggerDoc() map[string]string { return map[string]string{ "": "InterfaceBridge connects to a given network via a linux bridge.", } } func (DeprecatedInterfaceSlirp) SwaggerDoc() map[string]string { return map[string]string{ "": "DeprecatedInterfaceSlirp is an alias to the deprecated InterfaceSlirp\nthat connects to a given network using QEMU user networking mode.\nDeprecated: Removed in v1.3", } } func (InterfaceMasquerade) SwaggerDoc() map[string]string { return map[string]string{ "": "InterfaceMasquerade connects to a given network using netfilter rules to nat the traffic.", } } func (InterfaceSRIOV) SwaggerDoc() map[string]string { return map[string]string{ "": "InterfaceSRIOV connects to a given network by passing-through an SR-IOV PCI device via vfio.", } } func (DeprecatedInterfaceMacvtap) SwaggerDoc() map[string]string { return map[string]string{ "": "DeprecatedInterfaceMacvtap is an alias to the deprecated InterfaceMacvtap\nthat connects to a given network by extending the Kubernetes node's L2 networks via a macvtap interface.\nDeprecated: Removed in v1.3", } } func (DeprecatedInterfacePasst) SwaggerDoc() map[string]string { return map[string]string{ "": "DeprecatedInterfacePasst is an alias to the deprecated InterfacePasst\nDeprecated: Removed in v1.3", } } func (PluginBinding) SwaggerDoc() map[string]string { return map[string]string{ "": "PluginBinding represents a binding implemented in a plugin.", "name": "Name references to the binding name as denined in the kubevirt CR.\nversion: 1alphav1", } } func (Port) SwaggerDoc() map[string]string { return map[string]string{ "": "Port represents a port to expose from the virtual machine.\nDefault protocol TCP.\nThe port field is mandatory", "name": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.\n+optional", "protocol": "Protocol for port. Must be UDP or TCP.\nDefaults to \"TCP\".\n+optional", "port": "Number of port to expose for the virtual machine.\nThis must be a valid port number, 0 < x < 65536.", } } func (AccessCredentialSecretSource) SwaggerDoc() map[string]string { return map[string]string{ "secretName": "SecretName represents the name of the secret in the VMI's namespace", } } func (ConfigDriveSSHPublicKeyAccessCredentialPropagation) SwaggerDoc() map[string]string { return map[string]string{} } func (NoCloudSSHPublicKeyAccessCredentialPropagation) SwaggerDoc() map[string]string { return map[string]string{} } func (AuthorizedKeysFile) SwaggerDoc() map[string]string { return map[string]string{ "": "AuthorizedKeysFile represents a path within the guest\nthat ssh public keys should be propagated to", "filePath": "FilePath represents the place on the guest that the authorized_keys\nfile should be writen to. This is expected to be a full path including\nboth the base directory and file name.", } } func (QemuGuestAgentUserPasswordAccessCredentialPropagation) SwaggerDoc() map[string]string { return map[string]string{} } func (QemuGuestAgentSSHPublicKeyAccessCredentialPropagation) SwaggerDoc() map[string]string { return map[string]string{ "users": "Users represents a list of guest users that should have the ssh public keys\nadded to their authorized_keys file.\n+listType=set", } } func (SSHPublicKeyAccessCredentialSource) SwaggerDoc() map[string]string { return map[string]string{ "": "SSHPublicKeyAccessCredentialSource represents where to retrieve the ssh key\ncredentials\nOnly one of its members may be specified.", "secret": "Secret means that the access credential is pulled from a kubernetes secret\n+optional", } } func (SSHPublicKeyAccessCredentialPropagationMethod) SwaggerDoc() map[string]string { return map[string]string{ "": "SSHPublicKeyAccessCredentialPropagationMethod represents the method used to\ninject a ssh public key into the vm guest.\nOnly one of its members may be specified.", "configDrive": "ConfigDrivePropagation means that the ssh public keys are injected\ninto the VM using metadata using the configDrive cloud-init provider\n+optional", "noCloud": "NoCloudPropagation means that the ssh public keys are injected\ninto the VM using metadata using the noCloud cloud-init provider\n+optional", "qemuGuestAgent": "QemuGuestAgentAccessCredentailPropagation means ssh public keys are\ndynamically injected into the vm at runtime via the qemu guest agent.\nThis feature requires the qemu guest agent to be running within the guest.\n+optional", } } func (SSHPublicKeyAccessCredential) SwaggerDoc() map[string]string { return map[string]string{ "": "SSHPublicKeyAccessCredential represents a source and propagation method for\ninjecting ssh public keys into a vm guest", "source": "Source represents where the public keys are pulled from", "propagationMethod": "PropagationMethod represents how the public key is injected into the vm guest.", } } func (UserPasswordAccessCredentialSource) SwaggerDoc() map[string]string { return map[string]string{ "": "UserPasswordAccessCredentialSource represents where to retrieve the user password\ncredentials\nOnly one of its members may be specified.", "secret": "Secret means that the access credential is pulled from a kubernetes secret\n+optional", } } func (UserPasswordAccessCredentialPropagationMethod) SwaggerDoc() map[string]string { return map[string]string{ "": "UserPasswordAccessCredentialPropagationMethod represents the method used to\ninject a user passwords into the vm guest.\nOnly one of its members may be specified.", "qemuGuestAgent": "QemuGuestAgentAccessCredentailPropagation means passwords are\ndynamically injected into the vm at runtime via the qemu guest agent.\nThis feature requires the qemu guest agent to be running within the guest.\n+optional", } } func (UserPasswordAccessCredential) SwaggerDoc() map[string]string { return map[string]string{ "": "UserPasswordAccessCredential represents a source and propagation method for\ninjecting user passwords into a vm guest\nOnly one of its members may be specified.", "source": "Source represents where the user passwords are pulled from", "propagationMethod": "propagationMethod represents how the user passwords are injected into the vm guest.", } } func (AccessCredential) SwaggerDoc() map[string]string { return map[string]string{ "": "AccessCredential represents a credential source that can be used to\nauthorize remote access to the vm guest\nOnly one of its members may be specified.", "sshPublicKey": "SSHPublicKey represents the source and method of applying a ssh public\nkey into a guest virtual machine.\n+optional", "userPassword": "UserPassword represents the source and method for applying a guest user's\npassword\n+optional", } } func (Network) SwaggerDoc() map[string]string { return map[string]string{ "": "Network represents a network type and a resource that should be connected to the vm.", "name": "Network name.\nMust be a DNS_LABEL and unique within the vm.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", } } func (NetworkSource) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the source resource that will be connected to the vm.\nOnly one of its members may be specified.", } } func (PodNetwork) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the stock pod network interface.", "vmNetworkCIDR": "CIDR for vm network.\nDefault 10.0.2.0/24 if not specified.", "vmIPv6NetworkCIDR": "IPv6 CIDR for the vm network.\nDefaults to fd10:0:2::/120 if not specified.", } } func (Rng) SwaggerDoc() map[string]string { return map[string]string{ "": "Rng represents the random device passed from host", } } func (MultusNetwork) SwaggerDoc() map[string]string { return map[string]string{ "": "Represents the multus cni network.", "networkName": "References to a NetworkAttachmentDefinition CRD object. Format:\n, /. If namespace is not\nspecified, VMI namespace is assumed.", "default": "Select the default network and add it to the\nmultus-cni.io/default-network annotation.", } } func (CPUTopology) SwaggerDoc() map[string]string { return map[string]string{ "": "CPUTopology allows specifying the amount of cores, sockets\nand threads.", "cores": "Cores specifies the number of cores inside the vmi.\nMust be a value greater or equal 1.", "sockets": "Sockets specifies the number of sockets inside the vmi.\nMust be a value greater or equal 1.", "threads": "Threads specifies the number of threads inside the vmi.\nMust be a value greater or equal 1.", } }