1
2
3 package v1
4
5 func (HostDisk) SwaggerDoc() map[string]string {
6 return map[string]string{
7 "": "Represents a disk created on the cluster level",
8 "path": "The path to HostDisk image located on the cluster",
9 "type": "Contains information if disk.img exists or should be created\nallowed options are 'Disk' and 'DiskOrCreate'",
10 "capacity": "Capacity of the sparse disk\n+optional",
11 "shared": "Shared indicate whether the path is shared between nodes",
12 }
13 }
14
15 func (ConfigMapVolumeSource) SwaggerDoc() map[string]string {
16 return map[string]string{
17 "": "ConfigMapVolumeSource adapts a ConfigMap into a volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#configmap",
18 "optional": "Specify whether the ConfigMap or it's keys must be defined\n+optional",
19 "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",
20 }
21 }
22
23 func (SecretVolumeSource) SwaggerDoc() map[string]string {
24 return map[string]string{
25 "": "SecretVolumeSource adapts a Secret into a volume.",
26 "secretName": "Name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret",
27 "optional": "Specify whether the Secret or it's keys must be defined\n+optional",
28 "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",
29 }
30 }
31
32 func (DownwardAPIVolumeSource) SwaggerDoc() map[string]string {
33 return map[string]string{
34 "": "DownwardAPIVolumeSource represents a volume containing downward API info.",
35 "fields": "Fields is a list of downward API volume file\n+optional",
36 "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",
37 }
38 }
39
40 func (ServiceAccountVolumeSource) SwaggerDoc() map[string]string {
41 return map[string]string{
42 "": "ServiceAccountVolumeSource adapts a ServiceAccount into a volume.",
43 "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/",
44 }
45 }
46
47 func (DownwardMetricsVolumeSource) SwaggerDoc() map[string]string {
48 return map[string]string{
49 "": "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.",
50 }
51 }
52
53 func (SysprepSource) SwaggerDoc() map[string]string {
54 return map[string]string{
55 "": "Represents a Sysprep volume source.",
56 "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",
57 "configMap": "ConfigMap references a ConfigMap that contains Sysprep answer file named autounattend.xml that should be attached as disk of CDROM type.\n+ optional",
58 }
59 }
60
61 func (CloudInitNoCloudSource) SwaggerDoc() map[string]string {
62 return map[string]string{
63 "": "Represents a cloud-init nocloud user data source.\nMore info: http://cloudinit.readthedocs.io/en/latest/topics/datasources/nocloud.html",
64 "secretRef": "UserDataSecretRef references a k8s secret that contains NoCloud userdata.\n+ optional",
65 "userDataBase64": "UserDataBase64 contains NoCloud cloud-init userdata as a base64 encoded string.\n+ optional",
66 "userData": "UserData contains NoCloud inline cloud-init userdata.\n+ optional",
67 "networkDataSecretRef": "NetworkDataSecretRef references a k8s secret that contains NoCloud networkdata.\n+ optional",
68 "networkDataBase64": "NetworkDataBase64 contains NoCloud cloud-init networkdata as a base64 encoded string.\n+ optional",
69 "networkData": "NetworkData contains NoCloud inline cloud-init networkdata.\n+ optional",
70 }
71 }
72
73 func (CloudInitConfigDriveSource) SwaggerDoc() map[string]string {
74 return map[string]string{
75 "": "Represents a cloud-init config drive user data source.\nMore info: https://cloudinit.readthedocs.io/en/latest/topics/datasources/configdrive.html",
76 "secretRef": "UserDataSecretRef references a k8s secret that contains config drive userdata.\n+ optional",
77 "userDataBase64": "UserDataBase64 contains config drive cloud-init userdata as a base64 encoded string.\n+ optional",
78 "userData": "UserData contains config drive inline cloud-init userdata.\n+ optional",
79 "networkDataSecretRef": "NetworkDataSecretRef references a k8s secret that contains config drive networkdata.\n+ optional",
80 "networkDataBase64": "NetworkDataBase64 contains config drive cloud-init networkdata as a base64 encoded string.\n+ optional",
81 "networkData": "NetworkData contains config drive inline cloud-init networkdata.\n+ optional",
82 }
83 }
84
85 func (DomainSpec) SwaggerDoc() map[string]string {
86 return map[string]string{
87 "resources": "Resources describes the Compute Resources required by this vmi.",
88 "cpu": "CPU allow specified the detailed CPU topology inside the vmi.\n+optional",
89 "memory": "Memory allow specifying the VMI memory features.\n+optional",
90 "machine": "Machine type.\n+optional",
91 "firmware": "Firmware.\n+optional",
92 "clock": "Clock sets the clock and timers of the vmi.\n+optional",
93 "features": "Features like acpi, apic, hyperv, smm.\n+optional",
94 "devices": "Devices allows adding disks, network interfaces, and others",
95 "ioThreadsPolicy": "Controls whether or not disks will share IOThreads.\nOmitting IOThreadsPolicy disables use of IOThreads.\nOne of: shared, auto\n+optional",
96 "chassis": "Chassis specifies the chassis info passed to the domain.\n+optional",
97 "launchSecurity": "Launch Security setting of the vmi.\n+optional",
98 }
99 }
100
101 func (Chassis) SwaggerDoc() map[string]string {
102 return map[string]string{
103 "": "Chassis specifies the chassis info passed to the domain.",
104 }
105 }
106
107 func (Bootloader) SwaggerDoc() map[string]string {
108 return map[string]string{
109 "": "Represents the firmware blob used to assist in the domain creation process.\nUsed for setting the QEMU BIOS file path for the libvirt domain.",
110 "bios": "If set (default), BIOS will be used.\n+optional",
111 "efi": "If set, EFI will be used instead of BIOS.\n+optional",
112 }
113 }
114
115 func (BIOS) SwaggerDoc() map[string]string {
116 return map[string]string{
117 "": "If set (default), BIOS will be used.",
118 "useSerial": "If set, the BIOS output will be transmitted over serial\n+optional",
119 }
120 }
121
122 func (EFI) SwaggerDoc() map[string]string {
123 return map[string]string{
124 "": "If set, EFI will be used instead of BIOS.",
125 "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",
126 "persistent": "If set to true, Persistent will persist the EFI NVRAM across reboots.\nDefaults to false\n+optional",
127 }
128 }
129
130 func (KernelBootContainer) SwaggerDoc() map[string]string {
131 return map[string]string{
132 "": "If set, the VM will be booted from the defined kernel / initrd.",
133 "image": "Image that contains initrd / kernel files.",
134 "imagePullSecret": "ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.\n+optional",
135 "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",
136 "kernelPath": "The fully-qualified path to the kernel image in the host OS\n+optional",
137 "initrdPath": "the fully-qualified path to the ramdisk image in the host OS\n+optional",
138 }
139 }
140
141 func (KernelBoot) SwaggerDoc() map[string]string {
142 return map[string]string{
143 "": "Represents the firmware blob used to assist in the kernel boot process.\nUsed for setting the kernel, initrd and command line arguments",
144 "kernelArgs": "Arguments to be passed to the kernel at boot time",
145 "container": "Container defines the container that containes kernel artifacts",
146 }
147 }
148
149 func (ResourceRequirements) SwaggerDoc() map[string]string {
150 return map[string]string{
151 "requests": "Requests is a description of the initial vmi resources.\nValid resource keys are \"memory\" and \"cpu\".\n+optional",
152 "limits": "Limits describes the maximum amount of compute resources allowed.\nValid resource keys are \"memory\" and \"cpu\".\n+optional",
153 "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.",
154 }
155 }
156
157 func (CPU) SwaggerDoc() map[string]string {
158 return map[string]string{
159 "": "CPU allows specifying the CPU topology.",
160 "cores": "Cores specifies the number of cores inside the vmi.\nMust be a value greater or equal 1.",
161 "sockets": "Sockets specifies the number of sockets inside the vmi.\nMust be a value greater or equal 1.",
162 "maxSockets": "MaxSockets specifies the maximum amount of sockets that can\nbe hotplugged",
163 "threads": "Threads specifies the number of threads inside the vmi.\nMust be a value greater or equal 1.",
164 "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",
165 "features": "Features specifies the CPU features list inside the VMI.\n+optional",
166 "dedicatedCpuPlacement": "DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node\nwith enough dedicated pCPUs and pin the vCPUs to it.\n+optional",
167 "numa": "NUMA allows specifying settings for the guest NUMA topology\n+optional",
168 "isolateEmulatorThread": "IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place\nthe emulator thread on it.\n+optional",
169 "realtime": "Realtime instructs the virt-launcher to tune the VMI for lower latency, optional for real time workloads\n+optional",
170 }
171 }
172
173 func (Realtime) SwaggerDoc() map[string]string {
174 return map[string]string{
175 "": "Realtime holds the tuning knobs specific for realtime workloads.",
176 "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",
177 }
178 }
179
180 func (NUMAGuestMappingPassthrough) SwaggerDoc() map[string]string {
181 return map[string]string{
182 "": "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.",
183 }
184 }
185
186 func (NUMA) SwaggerDoc() map[string]string {
187 return map[string]string{
188 "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",
189 }
190 }
191
192 func (CPUFeature) SwaggerDoc() map[string]string {
193 return map[string]string{
194 "": "CPUFeature allows specifying a CPU feature.",
195 "name": "Name of the CPU feature",
196 "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",
197 }
198 }
199
200 func (Memory) SwaggerDoc() map[string]string {
201 return map[string]string{
202 "": "Memory allows specifying the VirtualMachineInstance memory features.",
203 "hugepages": "Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.\n+optional",
204 "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",
205 "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.",
206 }
207 }
208
209 func (MemoryStatus) SwaggerDoc() map[string]string {
210 return map[string]string{
211 "guestAtBoot": "GuestAtBoot specifies with how much memory the VirtualMachine intiallly booted with.\n+optional",
212 "guestCurrent": "GuestCurrent specifies how much memory is currently available for the VirtualMachine.\n+optional",
213 "guestRequested": "GuestRequested specifies how much memory was requested (hotplug) for the VirtualMachine.\n+optional",
214 }
215 }
216
217 func (Hugepages) SwaggerDoc() map[string]string {
218 return map[string]string{
219 "": "Hugepages allow to use hugepages for the VirtualMachineInstance instead of regular memory.",
220 "pageSize": "PageSize specifies the hugepage size, for x86_64 architecture valid values are 1Gi and 2Mi.",
221 }
222 }
223
224 func (Machine) SwaggerDoc() map[string]string {
225 return map[string]string{
226 "type": "QEMU machine type is the actual chipset of the VirtualMachineInstance.\n+optional",
227 }
228 }
229
230 func (Firmware) SwaggerDoc() map[string]string {
231 return map[string]string{
232 "uuid": "UUID reported by the vmi bios.\nDefaults to a random generated uid.",
233 "bootloader": "Settings to control the bootloader that is used.\n+optional",
234 "serial": "The system-serial-number in SMBIOS",
235 "kernelBoot": "Settings to set the kernel for booting.\n+optional",
236 "acpi": "Information that can be set in the ACPI table",
237 }
238 }
239
240 func (ACPI) SwaggerDoc() map[string]string {
241 return map[string]string{
242 "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)",
243 }
244 }
245
246 func (Devices) SwaggerDoc() map[string]string {
247 return map[string]string{
248 "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).",
249 "disableHotplug": "DisableHotplug disabled the ability to hotplug disks.",
250 "disks": "Disks describes disks, cdroms and luns which are connected to the vmi.\n+kubebuilder:validation:MaxItems:=256",
251 "watchdog": "Watchdog describes a watchdog device which can be added to the vmi.",
252 "interfaces": "Interfaces describe network interfaces which are added to the vmi.\n+kubebuilder:validation:MaxItems:=256",
253 "inputs": "Inputs describe input devices",
254 "autoattachPodInterface": "Whether to attach a pod network interface. Defaults to true.",
255 "autoattachGraphicsDevice": "Whether to attach the default graphics device or not.\nVNC will not be available if set to false. Defaults to true.",
256 "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.",
257 "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.",
258 "autoattachMemBalloon": "Whether to attach the Memory balloon device with default period.\nPeriod can be adjusted in virt-config.\nDefaults to true.\n+optional",
259 "autoattachInputDevice": "Whether to attach an Input Device.\nDefaults to false.\n+optional",
260 "autoattachVSOCK": "Whether to attach the VSOCK CID to the VM or not.\nVSOCK access will be available if set to true. Defaults to false.",
261 "rng": "Whether to have random number generator from host\n+optional",
262 "blockMultiQueue": "Whether or not to enable virtio multi-queue for block devices.\nDefaults to false.\n+optional",
263 "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",
264 "gpus": "Whether to attach a GPU device to the vmi.\n+optional\n+listType=atomic",
265 "downwardMetrics": "DownwardMetrics creates a virtio serials for exposing the downward metrics to the vmi.\n+optional",
266 "filesystems": "Filesystems describes filesystem which is connected to the vmi.\n+optional\n+listType=atomic",
267 "hostDevices": "Whether to attach a host device to the vmi.\n+optional\n+listType=atomic",
268 "clientPassthrough": "To configure and access client devices such as redirecting USB\n+optional",
269 "sound": "Whether to emulate a sound device.\n+optional",
270 "tpm": "Whether to emulate a TPM device.\n+optional",
271 }
272 }
273
274 func (ClientPassthroughDevices) SwaggerDoc() map[string]string {
275 return map[string]string{
276 "": "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.",
277 }
278 }
279
280 func (SoundDevice) SwaggerDoc() map[string]string {
281 return map[string]string{
282 "": "Represents the user's configuration to emulate sound cards in the VMI.",
283 "name": "User's defined name for this sound device",
284 "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",
285 }
286 }
287
288 func (TPMDevice) SwaggerDoc() map[string]string {
289 return map[string]string{
290 "persistent": "Persistent indicates the state of the TPM device should be kept accross reboots\nDefaults to false",
291 }
292 }
293
294 func (Input) SwaggerDoc() map[string]string {
295 return map[string]string{
296 "bus": "Bus indicates the bus of input device to emulate.\nSupported values: virtio, usb.",
297 "type": "Type indicated the type of input device.\nSupported values: tablet.",
298 "name": "Name is the device name",
299 }
300 }
301
302 func (Filesystem) SwaggerDoc() map[string]string {
303 return map[string]string{
304 "name": "Name is the device name",
305 "virtiofs": "Virtiofs is supported",
306 }
307 }
308
309 func (FilesystemVirtiofs) SwaggerDoc() map[string]string {
310 return map[string]string{}
311 }
312
313 func (DownwardMetrics) SwaggerDoc() map[string]string {
314 return map[string]string{}
315 }
316
317 func (GPU) SwaggerDoc() map[string]string {
318 return map[string]string{
319 "name": "Name of the GPU device as exposed by a device plugin",
320 "tag": "If specified, the virtual network interface address and its tag will be provided to the guest via config drive\n+optional",
321 }
322 }
323
324 func (VGPUOptions) SwaggerDoc() map[string]string {
325 return map[string]string{}
326 }
327
328 func (VGPUDisplayOptions) SwaggerDoc() map[string]string {
329 return map[string]string{
330 "enabled": "Enabled determines if a display addapter backed by a vGPU should be enabled or disabled on the guest.\nDefaults to true.\n+optional",
331 "ramFB": "Enables a boot framebuffer, until the guest OS loads a real GPU driver\nDefaults to true.\n+optional",
332 }
333 }
334
335 func (HostDevice) SwaggerDoc() map[string]string {
336 return map[string]string{
337 "deviceName": "DeviceName is the resource name of the host device exposed by a device plugin",
338 "tag": "If specified, the virtual network interface address and its tag will be provided to the guest via config drive\n+optional",
339 }
340 }
341
342 func (Disk) SwaggerDoc() map[string]string {
343 return map[string]string{
344 "name": "Name is the device name",
345 "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",
346 "serial": "Serial provides the ability to specify a serial number for the disk device.\n+optional",
347 "dedicatedIOThread": "dedicatedIOThread indicates this disk should have an exclusive IO Thread.\nEnabling this implies useIOThreads = true.\nDefaults to false.\n+optional",
348 "cache": "Cache specifies which kvm disk cache mode should be used.\nSupported values are: CacheNone, CacheWriteThrough.\n+optional",
349 "io": "IO specifies which QEMU disk IO mode should be used.\nSupported values are: native, default, threads.\n+optional",
350 "tag": "If specified, disk address and its tag will be provided to the guest via config drive metadata\n+optional",
351 "blockSize": "If specified, the virtual disk will be presented with the given block sizes.\n+optional",
352 "shareable": "If specified the disk is made sharable and multiple write from different VMs are permitted\n+optional",
353 "errorPolicy": "If specified, it can change the default error policy (stop) for the disk\n+optional",
354 }
355 }
356
357 func (CustomBlockSize) SwaggerDoc() map[string]string {
358 return map[string]string{
359 "": "CustomBlockSize represents the desired logical and physical block size for a VM disk.",
360 }
361 }
362
363 func (BlockSize) SwaggerDoc() map[string]string {
364 return map[string]string{
365 "": "BlockSize provides the option to change the block size presented to the VM for a disk.\nOnly one of its members may be specified.",
366 }
367 }
368
369 func (DiskDevice) SwaggerDoc() map[string]string {
370 return map[string]string{
371 "": "Represents the target of a volume to mount.\nOnly one of its members may be specified.",
372 "disk": "Attach a volume as a disk to the vmi.",
373 "lun": "Attach a volume as a LUN to the vmi.",
374 "cdrom": "Attach a volume as a cdrom to the vmi.",
375 }
376 }
377
378 func (DiskTarget) SwaggerDoc() map[string]string {
379 return map[string]string{
380 "bus": "Bus indicates the type of disk device to emulate.\nsupported values: virtio, sata, scsi, usb.",
381 "readonly": "ReadOnly.\nDefaults to false.",
382 "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",
383 }
384 }
385
386 func (LaunchSecurity) SwaggerDoc() map[string]string {
387 return map[string]string{
388 "sev": "AMD Secure Encrypted Virtualization (SEV).",
389 }
390 }
391
392 func (SEV) SwaggerDoc() map[string]string {
393 return map[string]string{
394 "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.",
395 "attestation": "If specified, run the attestation process for a vmi.\n+opitonal",
396 "session": "Base64 encoded session blob.",
397 "dhCert": "Base64 encoded guest owner's Diffie-Hellman key.",
398 }
399 }
400
401 func (SEVPolicy) SwaggerDoc() map[string]string {
402 return map[string]string{
403 "encryptedState": "SEV-ES is required.\nDefaults to false.\n+optional",
404 }
405 }
406
407 func (SEVAttestation) SwaggerDoc() map[string]string {
408 return map[string]string{}
409 }
410
411 func (LunTarget) SwaggerDoc() map[string]string {
412 return map[string]string{
413 "bus": "Bus indicates the type of disk device to emulate.\nsupported values: virtio, sata, scsi.",
414 "readonly": "ReadOnly.\nDefaults to false.",
415 "reservation": "Reservation indicates if the disk needs to support the persistent reservation for the SCSI disk",
416 }
417 }
418
419 func (CDRomTarget) SwaggerDoc() map[string]string {
420 return map[string]string{
421 "bus": "Bus indicates the type of disk device to emulate.\nsupported values: virtio, sata, scsi.",
422 "readonly": "ReadOnly.\nDefaults to true.",
423 "tray": "Tray indicates if the tray of the device is open or closed.\nAllowed values are \"open\" and \"closed\".\nDefaults to closed.\n+optional",
424 }
425 }
426
427 func (Volume) SwaggerDoc() map[string]string {
428 return map[string]string{
429 "": "Volume represents a named volume in a vmi.",
430 "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",
431 }
432 }
433
434 func (VolumeSource) SwaggerDoc() map[string]string {
435 return map[string]string{
436 "": "Represents the source of a volume to mount.\nOnly one of its members may be specified.",
437 "hostDisk": "HostDisk represents a disk created on the cluster level\n+optional",
438 "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",
439 "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",
440 "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",
441 "sysprep": "Represents a Sysprep volume source.\n+optional",
442 "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",
443 "ephemeral": "Ephemeral is a special volume source that \"wraps\" specified source and provides copy-on-write image on top of it.\n+optional",
444 "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",
445 "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",
446 "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",
447 "secret": "SecretVolumeSource represents a reference to a secret data in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/configuration/secret/\n+optional",
448 "downwardAPI": "DownwardAPI represents downward API about the pod that should populate this volume\n+optional",
449 "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",
450 "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.",
451 "memoryDump": "MemoryDump is attached to the virt launcher and is populated with a memory dump of the vmi",
452 }
453 }
454
455 func (HotplugVolumeSource) SwaggerDoc() map[string]string {
456 return map[string]string{
457 "": "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.",
458 "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",
459 "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",
460 }
461 }
462
463 func (DataVolumeSource) SwaggerDoc() map[string]string {
464 return map[string]string{
465 "name": "Name of both the DataVolume and the PVC in the same namespace.\nAfter PVC population the DataVolume is garbage collected by default.",
466 "hotpluggable": "Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.\n+optional",
467 }
468 }
469
470 func (PersistentVolumeClaimVolumeSource) SwaggerDoc() map[string]string {
471 return map[string]string{
472 "": "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",
473 "hotpluggable": "Hotpluggable indicates whether the volume can be hotplugged and hotunplugged.\n+optional",
474 }
475 }
476
477 func (MemoryDumpVolumeSource) SwaggerDoc() map[string]string {
478 return map[string]string{}
479 }
480
481 func (EphemeralVolumeSource) SwaggerDoc() map[string]string {
482 return map[string]string{
483 "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",
484 }
485 }
486
487 func (EmptyDiskSource) SwaggerDoc() map[string]string {
488 return map[string]string{
489 "": "EmptyDisk represents a temporary disk which shares the vmis lifecycle.",
490 "capacity": "Capacity of the sparse disk.",
491 }
492 }
493
494 func (ContainerDiskSource) SwaggerDoc() map[string]string {
495 return map[string]string{
496 "": "Represents a docker image with an embedded disk.",
497 "image": "Image is the name of the image with the embedded disk.",
498 "imagePullSecret": "ImagePullSecret is the name of the Docker registry secret required to pull the image. The secret must already exist.",
499 "path": "Path defines the path to disk file in the container",
500 "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",
501 }
502 }
503
504 func (ClockOffset) SwaggerDoc() map[string]string {
505 return map[string]string{
506 "": "Exactly one of its members must be set.",
507 "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.",
508 "timezone": "Timezone sets the guest clock to the specified timezone.\nZone name follows the TZ environment variable format (e.g. 'America/New_York').",
509 }
510 }
511
512 func (ClockOffsetUTC) SwaggerDoc() map[string]string {
513 return map[string]string{
514 "": "UTC sets the guest clock to UTC on each boot.",
515 "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.",
516 }
517 }
518
519 func (Clock) SwaggerDoc() map[string]string {
520 return map[string]string{
521 "": "Represents the clock and timers of a vmi.\n+kubebuilder:pruning:PreserveUnknownFields",
522 "timer": "Timer specifies whih timers are attached to the vmi.\n+optional",
523 }
524 }
525
526 func (Timer) SwaggerDoc() map[string]string {
527 return map[string]string{
528 "": "Represents all available timers in a vmi.",
529 "hpet": "HPET (High Precision Event Timer) - multiple timers with periodic interrupts.",
530 "kvm": "KVM \t(KVM clock) - lets guests read the host’s wall clock time (paravirtualized). For linux guests.",
531 "pit": "PIT (Programmable Interval Timer) - a timer with periodic interrupts.",
532 "rtc": "RTC (Real Time Clock) - a continuously running timer with periodic interrupts.",
533 "hyperv": "Hyperv (Hypervclock) - lets guests read the host’s wall clock time (paravirtualized). For windows guests.",
534 }
535 }
536
537 func (RTCTimer) SwaggerDoc() map[string]string {
538 return map[string]string{
539 "tickPolicy": "TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest.\nOne of \"delay\", \"catchup\".",
540 "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional",
541 "track": "Track the guest or the wall clock.",
542 }
543 }
544
545 func (HPETTimer) SwaggerDoc() map[string]string {
546 return map[string]string{
547 "tickPolicy": "TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest.\nOne of \"delay\", \"catchup\", \"merge\", \"discard\".",
548 "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional",
549 }
550 }
551
552 func (PITTimer) SwaggerDoc() map[string]string {
553 return map[string]string{
554 "tickPolicy": "TickPolicy determines what happens when QEMU misses a deadline for injecting a tick to the guest.\nOne of \"delay\", \"catchup\", \"discard\".",
555 "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional",
556 }
557 }
558
559 func (KVMTimer) SwaggerDoc() map[string]string {
560 return map[string]string{
561 "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional",
562 }
563 }
564
565 func (HypervTimer) SwaggerDoc() map[string]string {
566 return map[string]string{
567 "present": "Enabled set to false makes sure that the machine type or a preset can't add the timer.\nDefaults to true.\n+optional",
568 }
569 }
570
571 func (HyperVPassthrough) SwaggerDoc() map[string]string {
572 return map[string]string{
573 "enabled": "+optional",
574 }
575 }
576
577 func (Features) SwaggerDoc() map[string]string {
578 return map[string]string{
579 "acpi": "ACPI enables/disables ACPI inside the guest.\nDefaults to enabled.\n+optional",
580 "apic": "Defaults to the machine type setting.\n+optional",
581 "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",
582 "hyperv": "Defaults to the machine type setting.\n+optional",
583 "smm": "SMM enables/disables System Management Mode.\nTSEG not yet implemented.\n+optional",
584 "kvm": "Configure how KVM presence is exposed to the guest.\n+optional",
585 "pvspinlock": "Notify the guest that the host supports paravirtual spinlocks.\nFor older kernels this feature should be explicitly disabled.\n+optional",
586 }
587 }
588
589 func (SyNICTimer) SwaggerDoc() map[string]string {
590 return map[string]string{}
591 }
592
593 func (FeatureState) SwaggerDoc() map[string]string {
594 return map[string]string{
595 "": "Represents if a feature is enabled or disabled.",
596 "enabled": "Enabled determines if the feature should be enabled or disabled on the guest.\nDefaults to true.\n+optional",
597 }
598 }
599
600 func (FeatureAPIC) SwaggerDoc() map[string]string {
601 return map[string]string{
602 "enabled": "Enabled determines if the feature should be enabled or disabled on the guest.\nDefaults to true.\n+optional",
603 "endOfInterrupt": "EndOfInterrupt enables the end of interrupt notification in the guest.\nDefaults to false.\n+optional",
604 }
605 }
606
607 func (FeatureSpinlocks) SwaggerDoc() map[string]string {
608 return map[string]string{
609 "enabled": "Enabled determines if the feature should be enabled or disabled on the guest.\nDefaults to true.\n+optional",
610 "spinlocks": "Retries indicates the number of retries.\nMust be a value greater or equal 4096.\nDefaults to 4096.\n+optional",
611 }
612 }
613
614 func (FeatureVendorID) SwaggerDoc() map[string]string {
615 return map[string]string{
616 "enabled": "Enabled determines if the feature should be enabled or disabled on the guest.\nDefaults to true.\n+optional",
617 "vendorid": "VendorID sets the hypervisor vendor id, visible to the vmi.\nString up to twelve characters.",
618 }
619 }
620
621 func (FeatureHyperv) SwaggerDoc() map[string]string {
622 return map[string]string{
623 "": "Hyperv specific features.",
624 "relaxed": "Relaxed instructs the guest OS to disable watchdog timeouts.\nDefaults to the machine type setting.\n+optional",
625 "vapic": "VAPIC improves the paravirtualized handling of interrupts.\nDefaults to the machine type setting.\n+optional",
626 "spinlocks": "Spinlocks allows to configure the spinlock retry attempts.\n+optional",
627 "vpindex": "VPIndex enables the Virtual Processor Index to help windows identifying virtual processors.\nDefaults to the machine type setting.\n+optional",
628 "runtime": "Runtime improves the time accounting to improve scheduling in the guest.\nDefaults to the machine type setting.\n+optional",
629 "synic": "SyNIC enables the Synthetic Interrupt Controller.\nDefaults to the machine type setting.\n+optional",
630 "synictimer": "SyNICTimer enables Synthetic Interrupt Controller Timers, reducing CPU load.\nDefaults to the machine type setting.\n+optional",
631 "reset": "Reset enables Hyperv reboot/reset for the vmi. Requires synic.\nDefaults to the machine type setting.\n+optional",
632 "vendorid": "VendorID allows setting the hypervisor vendor id.\nDefaults to the machine type setting.\n+optional",
633 "frequencies": "Frequencies improves the TSC clock source handling for Hyper-V on KVM.\nDefaults to the machine type setting.\n+optional",
634 "reenlightenment": "Reenlightenment enables the notifications on TSC frequency changes.\nDefaults to the machine type setting.\n+optional",
635 "tlbflush": "TLBFlush improves performances in overcommited environments. Requires vpindex.\nDefaults to the machine type setting.\n+optional",
636 "ipi": "IPI improves performances in overcommited environments. Requires vpindex.\nDefaults to the machine type setting.\n+optional",
637 "evmcs": "EVMCS Speeds up L2 vmexits, but disables other virtualization features. Requires vapic.\nDefaults to the machine type setting.\n+optional",
638 }
639 }
640
641 func (FeatureKVM) SwaggerDoc() map[string]string {
642 return map[string]string{
643 "hidden": "Hide the KVM hypervisor from standard MSR based discovery.\nDefaults to false",
644 }
645 }
646
647 func (Watchdog) SwaggerDoc() map[string]string {
648 return map[string]string{
649 "": "Named watchdog device.",
650 "name": "Name of the watchdog.",
651 }
652 }
653
654 func (WatchdogDevice) SwaggerDoc() map[string]string {
655 return map[string]string{
656 "": "Hardware watchdog device.\nExactly one of its members must be set.",
657 "i6300esb": "i6300esb watchdog device.\n+optional",
658 }
659 }
660
661 func (I6300ESBWatchdog) SwaggerDoc() map[string]string {
662 return map[string]string{
663 "": "i6300esb watchdog device.",
664 "action": "The action to take. Valid values are poweroff, reset, shutdown.\nDefaults to reset.",
665 }
666 }
667
668 func (Interface) SwaggerDoc() map[string]string {
669 return map[string]string{
670 "name": "Logical name of the interface as well as a reference to the associated networks.\nMust match the Name of a Network.",
671 "model": "Interface model.\nOne of: e1000, e1000e, igb, ne2k_pci, pcnet, rtl8139, virtio.\nDefaults to virtio.",
672 "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",
673 "ports": "List of ports to be forwarded to the virtual machine.",
674 "macAddress": "Interface MAC address. For example: de:ad:00:00:be:af or DE-AD-00-00-BE-AF.",
675 "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",
676 "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",
677 "dhcpOptions": "If specified the network interface will pass additional DHCP options to the VMI\n+optional",
678 "tag": "If specified, the virtual network interface address and its tag will be provided to the guest via config drive\n+optional",
679 "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",
680 "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",
681 }
682 }
683
684 func (DHCPOptions) SwaggerDoc() map[string]string {
685 return map[string]string{
686 "": "Extra DHCP options to use in the interface.",
687 "bootFileName": "If specified will pass option 67 to interface's DHCP server\n+optional",
688 "tftpServerName": "If specified will pass option 66 to interface's DHCP server\n+optional",
689 "ntpServers": "If specified will pass the configured NTP server to the VM via DHCP option 042.\n+optional",
690 "privateOptions": "If specified will pass extra DHCP options for private use, range: 224-254\n+optional",
691 }
692 }
693
694 func (DHCPPrivateOptions) SwaggerDoc() map[string]string {
695 return map[string]string{
696 "": "DHCPExtraOptions defines Extra DHCP options for a VM.",
697 "option": "Option is an Integer value from 224-254\nRequired.",
698 "value": "Value is a String value for the Option provided\nRequired.",
699 }
700 }
701
702 func (InterfaceBindingMethod) SwaggerDoc() map[string]string {
703 return map[string]string{
704 "": "Represents the method which will be used to connect the interface to the guest.\nOnly one of its members may be specified.",
705 "slirp": "DeprecatedSlirp is an alias to the deprecated Slirp interface\nDeprecated: Removed in v1.3",
706 "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",
707 "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",
708 }
709 }
710
711 func (InterfaceBridge) SwaggerDoc() map[string]string {
712 return map[string]string{
713 "": "InterfaceBridge connects to a given network via a linux bridge.",
714 }
715 }
716
717 func (DeprecatedInterfaceSlirp) SwaggerDoc() map[string]string {
718 return map[string]string{
719 "": "DeprecatedInterfaceSlirp is an alias to the deprecated InterfaceSlirp\nthat connects to a given network using QEMU user networking mode.\nDeprecated: Removed in v1.3",
720 }
721 }
722
723 func (InterfaceMasquerade) SwaggerDoc() map[string]string {
724 return map[string]string{
725 "": "InterfaceMasquerade connects to a given network using netfilter rules to nat the traffic.",
726 }
727 }
728
729 func (InterfaceSRIOV) SwaggerDoc() map[string]string {
730 return map[string]string{
731 "": "InterfaceSRIOV connects to a given network by passing-through an SR-IOV PCI device via vfio.",
732 }
733 }
734
735 func (DeprecatedInterfaceMacvtap) SwaggerDoc() map[string]string {
736 return map[string]string{
737 "": "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",
738 }
739 }
740
741 func (DeprecatedInterfacePasst) SwaggerDoc() map[string]string {
742 return map[string]string{
743 "": "DeprecatedInterfacePasst is an alias to the deprecated InterfacePasst\nDeprecated: Removed in v1.3",
744 }
745 }
746
747 func (PluginBinding) SwaggerDoc() map[string]string {
748 return map[string]string{
749 "": "PluginBinding represents a binding implemented in a plugin.",
750 "name": "Name references to the binding name as denined in the kubevirt CR.\nversion: 1alphav1",
751 }
752 }
753
754 func (Port) SwaggerDoc() map[string]string {
755 return map[string]string{
756 "": "Port represents a port to expose from the virtual machine.\nDefault protocol TCP.\nThe port field is mandatory",
757 "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",
758 "protocol": "Protocol for port. Must be UDP or TCP.\nDefaults to \"TCP\".\n+optional",
759 "port": "Number of port to expose for the virtual machine.\nThis must be a valid port number, 0 < x < 65536.",
760 }
761 }
762
763 func (AccessCredentialSecretSource) SwaggerDoc() map[string]string {
764 return map[string]string{
765 "secretName": "SecretName represents the name of the secret in the VMI's namespace",
766 }
767 }
768
769 func (ConfigDriveSSHPublicKeyAccessCredentialPropagation) SwaggerDoc() map[string]string {
770 return map[string]string{}
771 }
772
773 func (NoCloudSSHPublicKeyAccessCredentialPropagation) SwaggerDoc() map[string]string {
774 return map[string]string{}
775 }
776
777 func (AuthorizedKeysFile) SwaggerDoc() map[string]string {
778 return map[string]string{
779 "": "AuthorizedKeysFile represents a path within the guest\nthat ssh public keys should be propagated to",
780 "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.",
781 }
782 }
783
784 func (QemuGuestAgentUserPasswordAccessCredentialPropagation) SwaggerDoc() map[string]string {
785 return map[string]string{}
786 }
787
788 func (QemuGuestAgentSSHPublicKeyAccessCredentialPropagation) SwaggerDoc() map[string]string {
789 return map[string]string{
790 "users": "Users represents a list of guest users that should have the ssh public keys\nadded to their authorized_keys file.\n+listType=set",
791 }
792 }
793
794 func (SSHPublicKeyAccessCredentialSource) SwaggerDoc() map[string]string {
795 return map[string]string{
796 "": "SSHPublicKeyAccessCredentialSource represents where to retrieve the ssh key\ncredentials\nOnly one of its members may be specified.",
797 "secret": "Secret means that the access credential is pulled from a kubernetes secret\n+optional",
798 }
799 }
800
801 func (SSHPublicKeyAccessCredentialPropagationMethod) SwaggerDoc() map[string]string {
802 return map[string]string{
803 "": "SSHPublicKeyAccessCredentialPropagationMethod represents the method used to\ninject a ssh public key into the vm guest.\nOnly one of its members may be specified.",
804 "configDrive": "ConfigDrivePropagation means that the ssh public keys are injected\ninto the VM using metadata using the configDrive cloud-init provider\n+optional",
805 "noCloud": "NoCloudPropagation means that the ssh public keys are injected\ninto the VM using metadata using the noCloud cloud-init provider\n+optional",
806 "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",
807 }
808 }
809
810 func (SSHPublicKeyAccessCredential) SwaggerDoc() map[string]string {
811 return map[string]string{
812 "": "SSHPublicKeyAccessCredential represents a source and propagation method for\ninjecting ssh public keys into a vm guest",
813 "source": "Source represents where the public keys are pulled from",
814 "propagationMethod": "PropagationMethod represents how the public key is injected into the vm guest.",
815 }
816 }
817
818 func (UserPasswordAccessCredentialSource) SwaggerDoc() map[string]string {
819 return map[string]string{
820 "": "UserPasswordAccessCredentialSource represents where to retrieve the user password\ncredentials\nOnly one of its members may be specified.",
821 "secret": "Secret means that the access credential is pulled from a kubernetes secret\n+optional",
822 }
823 }
824
825 func (UserPasswordAccessCredentialPropagationMethod) SwaggerDoc() map[string]string {
826 return map[string]string{
827 "": "UserPasswordAccessCredentialPropagationMethod represents the method used to\ninject a user passwords into the vm guest.\nOnly one of its members may be specified.",
828 "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",
829 }
830 }
831
832 func (UserPasswordAccessCredential) SwaggerDoc() map[string]string {
833 return map[string]string{
834 "": "UserPasswordAccessCredential represents a source and propagation method for\ninjecting user passwords into a vm guest\nOnly one of its members may be specified.",
835 "source": "Source represents where the user passwords are pulled from",
836 "propagationMethod": "propagationMethod represents how the user passwords are injected into the vm guest.",
837 }
838 }
839
840 func (AccessCredential) SwaggerDoc() map[string]string {
841 return map[string]string{
842 "": "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.",
843 "sshPublicKey": "SSHPublicKey represents the source and method of applying a ssh public\nkey into a guest virtual machine.\n+optional",
844 "userPassword": "UserPassword represents the source and method for applying a guest user's\npassword\n+optional",
845 }
846 }
847
848 func (Network) SwaggerDoc() map[string]string {
849 return map[string]string{
850 "": "Network represents a network type and a resource that should be connected to the vm.",
851 "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",
852 }
853 }
854
855 func (NetworkSource) SwaggerDoc() map[string]string {
856 return map[string]string{
857 "": "Represents the source resource that will be connected to the vm.\nOnly one of its members may be specified.",
858 }
859 }
860
861 func (PodNetwork) SwaggerDoc() map[string]string {
862 return map[string]string{
863 "": "Represents the stock pod network interface.",
864 "vmNetworkCIDR": "CIDR for vm network.\nDefault 10.0.2.0/24 if not specified.",
865 "vmIPv6NetworkCIDR": "IPv6 CIDR for the vm network.\nDefaults to fd10:0:2::/120 if not specified.",
866 }
867 }
868
869 func (Rng) SwaggerDoc() map[string]string {
870 return map[string]string{
871 "": "Rng represents the random device passed from host",
872 }
873 }
874
875 func (MultusNetwork) SwaggerDoc() map[string]string {
876 return map[string]string{
877 "": "Represents the multus cni network.",
878 "networkName": "References to a NetworkAttachmentDefinition CRD object. Format:\n<networkName>, <namespace>/<networkName>. If namespace is not\nspecified, VMI namespace is assumed.",
879 "default": "Select the default network and add it to the\nmultus-cni.io/default-network annotation.",
880 }
881 }
882
883 func (CPUTopology) SwaggerDoc() map[string]string {
884 return map[string]string{
885 "": "CPUTopology allows specifying the amount of cores, sockets\nand threads.",
886 "cores": "Cores specifies the number of cores inside the vmi.\nMust be a value greater or equal 1.",
887 "sockets": "Sockets specifies the number of sockets inside the vmi.\nMust be a value greater or equal 1.",
888 "threads": "Threads specifies the number of threads inside the vmi.\nMust be a value greater or equal 1.",
889 }
890 }
891
View as plain text