kubevirt.io/api@v1.2.0/instancetype/v1beta1/types_swagger_generated.go (about) 1 // Code generated by swagger-doc. DO NOT EDIT. 2 3 package v1beta1 4 5 func (VirtualMachineInstancetype) SwaggerDoc() map[string]string { 6 return map[string]string{ 7 "": "VirtualMachineInstancetype resource contains quantitative and resource related VirtualMachine configuration\nthat can be used by multiple VirtualMachine resources.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object\n+genclient", 8 "spec": "Required spec describing the instancetype", 9 } 10 } 11 12 func (VirtualMachineInstancetypeList) SwaggerDoc() map[string]string { 13 return map[string]string{ 14 "": "VirtualMachineInstancetypeList is a list of VirtualMachineInstancetype resources.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", 15 } 16 } 17 18 func (VirtualMachineClusterInstancetype) SwaggerDoc() map[string]string { 19 return map[string]string{ 20 "": "VirtualMachineClusterInstancetype is a cluster scoped version of VirtualMachineInstancetype resource.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object\n+genclient\n+genclient:nonNamespaced", 21 "spec": "Required spec describing the instancetype", 22 } 23 } 24 25 func (VirtualMachineClusterInstancetypeList) SwaggerDoc() map[string]string { 26 return map[string]string{ 27 "": "VirtualMachineClusterInstancetypeList is a list of VirtualMachineClusterInstancetype resources.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", 28 } 29 } 30 31 func (VirtualMachineInstancetypeSpec) SwaggerDoc() map[string]string { 32 return map[string]string{ 33 "": "VirtualMachineInstancetypeSpec is a description of the VirtualMachineInstancetype or VirtualMachineClusterInstancetype.\n\nCPU and Memory are required attributes with both requiring that their Guest attribute is defined, ensuring a number of vCPUs and amount of RAM is always provided by each instancetype.", 34 "nodeSelector": "NodeSelector is a selector which must be true for the vmi to fit on a node.\nSelector which must match a node's labels for the vmi to be scheduled on that node.\nMore info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n\nNodeSelector is the name of the custom node selector for the instancetype.\n+optional", 35 "schedulerName": "If specified, the VMI will be dispatched by specified scheduler.\nIf not specified, the VMI will be dispatched by default scheduler.\n\nSchedulerName is the name of the custom K8s scheduler for the instancetype.\n+optional", 36 "cpu": "Required CPU related attributes of the instancetype.", 37 "memory": "Required Memory related attributes of the instancetype.", 38 "gpus": "Optionally defines any GPU devices associated with the instancetype.\n\n+optional\n+listType=atomic", 39 "hostDevices": "Optionally defines any HostDevices associated with the instancetype.\n\n+optional\n+listType=atomic", 40 "ioThreadsPolicy": "Optionally defines the IOThreadsPolicy to be used by the instancetype.\n\n+optional", 41 "launchSecurity": "Optionally defines the LaunchSecurity to be used by the instancetype.\n\n+optional", 42 "annotations": "Optionally defines the required Annotations to be used by the instance type and applied to the VirtualMachineInstance\n\n+optional", 43 } 44 } 45 46 func (CPUInstancetype) SwaggerDoc() map[string]string { 47 return map[string]string{ 48 "": "CPUInstancetype contains the CPU related configuration of a given VirtualMachineInstancetypeSpec.\n\nGuest is a required attribute and defines the number of vCPUs to be exposed to the guest by the instancetype.", 49 "guest": "Required number of vCPUs to expose to the guest.\n\nThe resulting CPU topology being derived from the optional PreferredCPUTopology attribute of CPUPreferences that itself defaults to PreferSockets.", 50 "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", 51 "dedicatedCPUPlacement": "DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node\nwith enough dedicated pCPUs and pin the vCPUs to it.\n+optional", 52 "numa": "NUMA allows specifying settings for the guest NUMA topology\n+optional", 53 "isolateEmulatorThread": "IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place\nthe emulator thread on it.\n+optional", 54 "realtime": "Realtime instructs the virt-launcher to tune the VMI for lower latency, optional for real time workloads\n+optional", 55 } 56 } 57 58 func (MemoryInstancetype) SwaggerDoc() map[string]string { 59 return map[string]string{ 60 "": "MemoryInstancetype contains the Memory related configuration of a given VirtualMachineInstancetypeSpec.\n\nGuest is a required attribute and defines the amount of RAM to be exposed to the guest by the instancetype.", 61 "guest": "Required amount of memory which is visible inside the guest OS.", 62 "hugepages": "Optionally enables the use of hugepages for the VirtualMachineInstance instead of regular memory.\n+optional", 63 "overcommitPercent": "OvercommitPercent is the percentage of the guest memory which will be overcommitted.\nThis means that the VMIs parent pod (virt-launcher) will request less\nphysical memory by a factor specified by the OvercommitPercent.\nOvercommits can lead to memory exhaustion, which in turn can lead to crashes. Use carefully.\nDefaults to 0\n+optional\n+kubebuilder:validation:Maximum=100\n+kubebuilder:validation:Minimum=0", 64 } 65 } 66 67 func (VirtualMachinePreference) SwaggerDoc() map[string]string { 68 return map[string]string{ 69 "": "VirtualMachinePreference resource contains optional preferences related to the VirtualMachine.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object\n+genclient", 70 "spec": "Required spec describing the preferences", 71 } 72 } 73 74 func (VirtualMachinePreferenceList) SwaggerDoc() map[string]string { 75 return map[string]string{ 76 "": "VirtualMachinePreferenceList is a list of VirtualMachinePreference resources.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", 77 "items": "+listType=set", 78 } 79 } 80 81 func (VirtualMachineClusterPreference) SwaggerDoc() map[string]string { 82 return map[string]string{ 83 "": "VirtualMachineClusterPreference is a cluster scoped version of the VirtualMachinePreference resource.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object\n+genclient\n+genclient:nonNamespaced", 84 "spec": "Required spec describing the preferences", 85 } 86 } 87 88 func (VirtualMachineClusterPreferenceList) SwaggerDoc() map[string]string { 89 return map[string]string{ 90 "": "VirtualMachineClusterPreferenceList is a list of VirtualMachineClusterPreference resources.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", 91 "items": "+listType=set", 92 } 93 } 94 95 func (VirtualMachinePreferenceSpec) SwaggerDoc() map[string]string { 96 return map[string]string{ 97 "": "VirtualMachinePreferenceSpec is a description of the VirtualMachinePreference or VirtualMachineClusterPreference.", 98 "clock": "Clock optionally defines preferences associated with the Clock attribute of a VirtualMachineInstance DomainSpec\n\n+optional", 99 "cpu": "CPU optionally defines preferences associated with the CPU attribute of a VirtualMachineInstance DomainSpec\n\n+optional", 100 "devices": "Devices optionally defines preferences associated with the Devices attribute of a VirtualMachineInstance DomainSpec\n\n+optional", 101 "features": "Features optionally defines preferences associated with the Features attribute of a VirtualMachineInstance DomainSpec\n\n+optional", 102 "firmware": "Firmware optionally defines preferences associated with the Firmware attribute of a VirtualMachineInstance DomainSpec\n\n+optional", 103 "machine": "Machine optionally defines preferences associated with the Machine attribute of a VirtualMachineInstance DomainSpec\n\n+optional", 104 "volumes": "Volumes optionally defines preferences associated with the Volumes attribute of a VirtualMachineInstace DomainSpec\n\n+optional", 105 "preferredSubdomain": "Subdomain of the VirtualMachineInstance\n\n+optional", 106 "preferredTerminationGracePeriodSeconds": "Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.\n\n+optional", 107 "requirements": "Requirements defines the minium amount of instance type defined resources required by a set of preferences\n\n+optional", 108 "annotations": "Optionally defines preferred Annotations to be applied to the VirtualMachineInstance\n\n+optional", 109 "preferSpreadSocketToCoreRatio": "PreferSpreadSocketToCoreRatio defines the ratio to spread vCPUs between cores and sockets, it defaults to 2.\n\n+optional", 110 } 111 } 112 113 func (VolumePreferences) SwaggerDoc() map[string]string { 114 return map[string]string{ 115 "preferredStorageClassName": "PreffereedStorageClassName optionally defines the preferred storageClass\n\n+optional", 116 } 117 } 118 119 func (CPUPreferences) SwaggerDoc() map[string]string { 120 return map[string]string{ 121 "": "CPUPreferences contains various optional CPU preferences.", 122 "preferredCPUTopology": "PreferredCPUTopology optionally defines the preferred guest visible CPU topology, defaults to PreferSockets.\n\n+optional", 123 "preferredCPUFeatures": "PreferredCPUFeatures optionally defines a slice of preferred CPU features.\n\n+optional", 124 } 125 } 126 127 func (DevicePreferences) SwaggerDoc() map[string]string { 128 return map[string]string{ 129 "": "DevicePreferences contains various optional Device preferences.", 130 "preferredAutoattachGraphicsDevice": "PreferredAutoattachGraphicsDevice optionally defines the preferred value of AutoattachGraphicsDevice\n\n+optional", 131 "preferredAutoattachMemBalloon": "PreferredAutoattachMemBalloon optionally defines the preferred value of AutoattachMemBalloon\n\n+optional", 132 "preferredAutoattachPodInterface": "PreferredAutoattachPodInterface optionally defines the preferred value of AutoattachPodInterface\n\n+optional", 133 "preferredAutoattachSerialConsole": "PreferredAutoattachSerialConsole optionally defines the preferred value of AutoattachSerialConsole\n\n+optional", 134 "preferredAutoattachInputDevice": "PreferredAutoattachInputDevice optionally defines the preferred value of AutoattachInputDevice\n\n+optional", 135 "preferredDisableHotplug": "PreferredDisableHotplug optionally defines the preferred value of DisableHotplug\n\n+optional", 136 "preferredVirtualGPUOptions": "PreferredVirtualGPUOptions optionally defines the preferred value of VirtualGPUOptions\n\n+optional", 137 "preferredSoundModel": "PreferredSoundModel optionally defines the preferred model for Sound devices.\n\n+optional", 138 "preferredUseVirtioTransitional": "PreferredUseVirtioTransitional optionally defines the preferred value of UseVirtioTransitional\n\n+optional", 139 "preferredInputBus": "PreferredInputBus optionally defines the preferred bus for Input devices.\n\n+optional", 140 "preferredInputType": "PreferredInputType optionally defines the preferred type for Input devices.\n\n+optional", 141 "preferredDiskBus": "PreferredDiskBus optionally defines the preferred bus for Disk Disk devices.\n\n+optional", 142 "preferredLunBus": "PreferredLunBus optionally defines the preferred bus for Lun Disk devices.\n\n+optional", 143 "preferredCdromBus": "PreferredCdromBus optionally defines the preferred bus for Cdrom Disk devices.\n\n+optional", 144 "preferredDiskDedicatedIoThread": "PreferredDedicatedIoThread optionally enables dedicated IO threads for Disk devices.\n\n+optional", 145 "preferredDiskCache": "PreferredCache optionally defines the DriverCache to be used by Disk devices.\n\n+optional", 146 "preferredDiskIO": "PreferredIo optionally defines the QEMU disk IO mode to be used by Disk devices.\n\n+optional", 147 "preferredDiskBlockSize": "PreferredBlockSize optionally defines the block size of Disk devices.\n\n+optional", 148 "preferredInterfaceModel": "PreferredInterfaceModel optionally defines the preferred model to be used by Interface devices.\n\n+optional", 149 "preferredRng": "PreferredRng optionally defines the preferred rng device to be used.\n\n+optional", 150 "preferredBlockMultiQueue": "PreferredBlockMultiQueue optionally enables the vhost multiqueue feature for virtio disks.\n\n+optional", 151 "preferredNetworkInterfaceMultiQueue": "PreferredNetworkInterfaceMultiQueue optionally enables the vhost multiqueue feature for virtio interfaces.\n\n+optional", 152 "preferredTPM": "PreferredTPM optionally defines the preferred TPM device to be used.\n\n+optional", 153 "preferredInterfaceMasquerade": "PreferredInterfaceMasquerade optionally defines the preferred masquerade configuration to use with each network interface.\n\n+optional", 154 } 155 } 156 157 func (FeaturePreferences) SwaggerDoc() map[string]string { 158 return map[string]string{ 159 "": "FeaturePreferences contains various optional defaults for Features.", 160 "preferredAcpi": "PreferredAcpi optionally enables the ACPI feature\n\n+optional", 161 "preferredApic": "PreferredApic optionally enables and configures the APIC feature\n\n+optional", 162 "preferredHyperv": "PreferredHyperv optionally enables and configures HyperV features\n\n+optional", 163 "preferredKvm": "PreferredKvm optionally enables and configures KVM features\n\n+optional", 164 "preferredPvspinlock": "PreferredPvspinlock optionally enables the Pvspinlock feature\n\n+optional", 165 "preferredSmm": "PreferredSmm optionally enables the SMM feature\n\n+optional", 166 } 167 } 168 169 func (FirmwarePreferences) SwaggerDoc() map[string]string { 170 return map[string]string{ 171 "": "FirmwarePreferences contains various optional defaults for Firmware.", 172 "preferredUseBios": "PreferredUseBios optionally enables BIOS\n\n+optional", 173 "preferredUseBiosSerial": "PreferredUseBiosSerial optionally transmitts BIOS output over the serial.\n\nRequires PreferredUseBios to be enabled.\n\n+optional", 174 "preferredUseEfi": "PreferredUseEfi optionally enables EFI\n\n+optional", 175 "preferredUseSecureBoot": "PreferredUseSecureBoot optionally enables SecureBoot and the OVMF roms will be swapped for SecureBoot-enabled ones.\n\nRequires PreferredUseEfi and PreferredSmm to be enabled.\n\n+optional", 176 } 177 } 178 179 func (MachinePreferences) SwaggerDoc() map[string]string { 180 return map[string]string{ 181 "": "MachinePreferences contains various optional defaults for Machine.", 182 "preferredMachineType": "PreferredMachineType optionally defines the preferred machine type to use.\n\n+optional", 183 } 184 } 185 186 func (ClockPreferences) SwaggerDoc() map[string]string { 187 return map[string]string{ 188 "": "ClockPreferences contains various optional defaults for Clock.", 189 "preferredClockOffset": "ClockOffset allows specifying the UTC offset or the timezone of the guest clock.\n\n+optional", 190 "preferredTimer": "Timer specifies whih timers are attached to the vmi.\n\n+optional", 191 } 192 } 193 194 func (PreferenceRequirements) SwaggerDoc() map[string]string { 195 return map[string]string{ 196 "cpu": "Required CPU related attributes of the instancetype.\n\n+optional", 197 "memory": "Required Memory related attributes of the instancetype.\n\n+optional", 198 } 199 } 200 201 func (CPUPreferenceRequirement) SwaggerDoc() map[string]string { 202 return map[string]string{ 203 "guest": "Minimal number of vCPUs required by the preference.", 204 } 205 } 206 207 func (MemoryPreferenceRequirement) SwaggerDoc() map[string]string { 208 return map[string]string{ 209 "guest": "Minimal amount of memory required by the preference.", 210 } 211 }