1
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 "maxSockets": "MaxSockets specifies the maximum amount of sockets that can be hotplugged\n+optional",
56 }
57 }
58
59 func (MemoryInstancetype) SwaggerDoc() map[string]string {
60 return map[string]string{
61 "": "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.",
62 "guest": "Required amount of memory which is visible inside the guest OS.",
63 "hugepages": "Optionally enables the use of hugepages for the VirtualMachineInstance instead of regular memory.\n+optional",
64 "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",
65 "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.\n+optional",
66 }
67 }
68
69 func (VirtualMachinePreference) SwaggerDoc() map[string]string {
70 return map[string]string{
71 "": "VirtualMachinePreference resource contains optional preferences related to the VirtualMachine.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object\n+genclient",
72 "spec": "Required spec describing the preferences",
73 }
74 }
75
76 func (VirtualMachinePreferenceList) SwaggerDoc() map[string]string {
77 return map[string]string{
78 "": "VirtualMachinePreferenceList is a list of VirtualMachinePreference resources.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object",
79 "items": "+listType=set",
80 }
81 }
82
83 func (VirtualMachineClusterPreference) SwaggerDoc() map[string]string {
84 return map[string]string{
85 "": "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",
86 "spec": "Required spec describing the preferences",
87 }
88 }
89
90 func (VirtualMachineClusterPreferenceList) SwaggerDoc() map[string]string {
91 return map[string]string{
92 "": "VirtualMachineClusterPreferenceList is a list of VirtualMachineClusterPreference resources.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object",
93 "items": "+listType=set",
94 }
95 }
96
97 func (VirtualMachinePreferenceSpec) SwaggerDoc() map[string]string {
98 return map[string]string{
99 "": "VirtualMachinePreferenceSpec is a description of the VirtualMachinePreference or VirtualMachineClusterPreference.",
100 "clock": "Clock optionally defines preferences associated with the Clock attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
101 "cpu": "CPU optionally defines preferences associated with the CPU attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
102 "devices": "Devices optionally defines preferences associated with the Devices attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
103 "features": "Features optionally defines preferences associated with the Features attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
104 "firmware": "Firmware optionally defines preferences associated with the Firmware attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
105 "machine": "Machine optionally defines preferences associated with the Machine attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
106 "volumes": "Volumes optionally defines preferences associated with the Volumes attribute of a VirtualMachineInstace DomainSpec\n\n+optional",
107 "preferredSubdomain": "Subdomain of the VirtualMachineInstance\n\n+optional",
108 "preferredTerminationGracePeriodSeconds": "Grace period observed after signalling a VirtualMachineInstance to stop after which the VirtualMachineInstance is force terminated.\n\n+optional",
109 "requirements": "Requirements defines the minium amount of instance type defined resources required by a set of preferences\n\n+optional",
110 "annotations": "Optionally defines preferred Annotations to be applied to the VirtualMachineInstance\n\n+optional",
111 "preferSpreadSocketToCoreRatio": "PreferSpreadSocketToCoreRatio defines the ratio to spread vCPUs between cores and sockets, it defaults to 2.\n\n+optional",
112 }
113 }
114
115 func (VolumePreferences) SwaggerDoc() map[string]string {
116 return map[string]string{
117 "preferredStorageClassName": "PreffereedStorageClassName optionally defines the preferred storageClass\n\n+optional",
118 }
119 }
120
121 func (CPUPreferences) SwaggerDoc() map[string]string {
122 return map[string]string{
123 "": "CPUPreferences contains various optional CPU preferences.",
124 "preferredCPUTopology": "PreferredCPUTopology optionally defines the preferred guest visible CPU topology, defaults to PreferSockets.\n\n+optional",
125 "spreadOptions": "+optional",
126 "preferredCPUFeatures": "PreferredCPUFeatures optionally defines a slice of preferred CPU features.\n\n+optional",
127 }
128 }
129
130 func (SpreadOptions) SwaggerDoc() map[string]string {
131 return map[string]string{
132 "across": "Across optionally defines how to spread vCPUs across the guest visible topology.\nDefault: SocketsCores\n\n+optional",
133 "ratio": "Ratio optionally defines the ratio to spread vCPUs across the guest visible topology:\n\nCoresThreads - 1:2 - Controls the ratio of cores to threads. Only a ratio of 2 is currently accepted.\nSocketsCores - 1:N - Controls the ratio of socket to cores.\nSocketsCoresThreads - 1:N:2 - Controls the ratio of socket to cores. Each core providing 2 threads.\n\nDefault: 2\n\n+optional",
134 }
135 }
136
137 func (DevicePreferences) SwaggerDoc() map[string]string {
138 return map[string]string{
139 "": "DevicePreferences contains various optional Device preferences.",
140 "preferredAutoattachGraphicsDevice": "PreferredAutoattachGraphicsDevice optionally defines the preferred value of AutoattachGraphicsDevice\n\n+optional",
141 "preferredAutoattachMemBalloon": "PreferredAutoattachMemBalloon optionally defines the preferred value of AutoattachMemBalloon\n\n+optional",
142 "preferredAutoattachPodInterface": "PreferredAutoattachPodInterface optionally defines the preferred value of AutoattachPodInterface\n\n+optional",
143 "preferredAutoattachSerialConsole": "PreferredAutoattachSerialConsole optionally defines the preferred value of AutoattachSerialConsole\n\n+optional",
144 "preferredAutoattachInputDevice": "PreferredAutoattachInputDevice optionally defines the preferred value of AutoattachInputDevice\n\n+optional",
145 "preferredDisableHotplug": "PreferredDisableHotplug optionally defines the preferred value of DisableHotplug\n\n+optional",
146 "preferredVirtualGPUOptions": "PreferredVirtualGPUOptions optionally defines the preferred value of VirtualGPUOptions\n\n+optional",
147 "preferredSoundModel": "PreferredSoundModel optionally defines the preferred model for Sound devices.\n\n+optional",
148 "preferredUseVirtioTransitional": "PreferredUseVirtioTransitional optionally defines the preferred value of UseVirtioTransitional\n\n+optional",
149 "preferredInputBus": "PreferredInputBus optionally defines the preferred bus for Input devices.\n\n+optional",
150 "preferredInputType": "PreferredInputType optionally defines the preferred type for Input devices.\n\n+optional",
151 "preferredDiskBus": "PreferredDiskBus optionally defines the preferred bus for Disk Disk devices.\n\n+optional",
152 "preferredLunBus": "PreferredLunBus optionally defines the preferred bus for Lun Disk devices.\n\n+optional",
153 "preferredCdromBus": "PreferredCdromBus optionally defines the preferred bus for Cdrom Disk devices.\n\n+optional",
154 "preferredDiskDedicatedIoThread": "PreferredDedicatedIoThread optionally enables dedicated IO threads for Disk devices using the virtio bus.\n\n+optional",
155 "preferredDiskCache": "PreferredCache optionally defines the DriverCache to be used by Disk devices.\n\n+optional",
156 "preferredDiskIO": "PreferredIo optionally defines the QEMU disk IO mode to be used by Disk devices.\n\n+optional",
157 "preferredDiskBlockSize": "PreferredBlockSize optionally defines the block size of Disk devices.\n\n+optional",
158 "preferredInterfaceModel": "PreferredInterfaceModel optionally defines the preferred model to be used by Interface devices.\n\n+optional",
159 "preferredRng": "PreferredRng optionally defines the preferred rng device to be used.\n\n+optional",
160 "preferredBlockMultiQueue": "PreferredBlockMultiQueue optionally enables the vhost multiqueue feature for virtio disks.\n\n+optional",
161 "preferredNetworkInterfaceMultiQueue": "PreferredNetworkInterfaceMultiQueue optionally enables the vhost multiqueue feature for virtio interfaces.\n\n+optional",
162 "preferredTPM": "PreferredTPM optionally defines the preferred TPM device to be used.\n\n+optional",
163 "preferredInterfaceMasquerade": "PreferredInterfaceMasquerade optionally defines the preferred masquerade configuration to use with each network interface.\n\n+optional",
164 }
165 }
166
167 func (FeaturePreferences) SwaggerDoc() map[string]string {
168 return map[string]string{
169 "": "FeaturePreferences contains various optional defaults for Features.",
170 "preferredAcpi": "PreferredAcpi optionally enables the ACPI feature\n\n+optional",
171 "preferredApic": "PreferredApic optionally enables and configures the APIC feature\n\n+optional",
172 "preferredHyperv": "PreferredHyperv optionally enables and configures HyperV features\n\n+optional",
173 "preferredKvm": "PreferredKvm optionally enables and configures KVM features\n\n+optional",
174 "preferredPvspinlock": "PreferredPvspinlock optionally enables the Pvspinlock feature\n\n+optional",
175 "preferredSmm": "PreferredSmm optionally enables the SMM feature\n\n+optional",
176 }
177 }
178
179 func (FirmwarePreferences) SwaggerDoc() map[string]string {
180 return map[string]string{
181 "": "FirmwarePreferences contains various optional defaults for Firmware.",
182 "preferredUseBios": "PreferredUseBios optionally enables BIOS\n\n+optional",
183 "preferredUseBiosSerial": "PreferredUseBiosSerial optionally transmitts BIOS output over the serial.\n\nRequires PreferredUseBios to be enabled.\n\n+optional",
184 "preferredUseEfi": "PreferredUseEfi optionally enables EFI\n\n+optional",
185 "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",
186 "preferredEfi": "PreferredEfi optionally enables EFI\n\n+optional",
187 }
188 }
189
190 func (MachinePreferences) SwaggerDoc() map[string]string {
191 return map[string]string{
192 "": "MachinePreferences contains various optional defaults for Machine.",
193 "preferredMachineType": "PreferredMachineType optionally defines the preferred machine type to use.\n\n+optional",
194 }
195 }
196
197 func (ClockPreferences) SwaggerDoc() map[string]string {
198 return map[string]string{
199 "": "ClockPreferences contains various optional defaults for Clock.",
200 "preferredClockOffset": "ClockOffset allows specifying the UTC offset or the timezone of the guest clock.\n\n+optional",
201 "preferredTimer": "Timer specifies whih timers are attached to the vmi.\n\n+optional",
202 }
203 }
204
205 func (PreferenceRequirements) SwaggerDoc() map[string]string {
206 return map[string]string{
207 "cpu": "Required CPU related attributes of the instancetype.\n\n+optional",
208 "memory": "Required Memory related attributes of the instancetype.\n\n+optional",
209 }
210 }
211
212 func (CPUPreferenceRequirement) SwaggerDoc() map[string]string {
213 return map[string]string{
214 "guest": "Minimal number of vCPUs required by the preference.",
215 }
216 }
217
218 func (MemoryPreferenceRequirement) SwaggerDoc() map[string]string {
219 return map[string]string{
220 "guest": "Minimal amount of memory required by the preference.",
221 }
222 }
223
View as plain text