1
2
3 package v1alpha1
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 (VirtualMachineInstancetypeSpecRevision) SwaggerDoc() map[string]string {
32 return map[string]string{
33 "": "VirtualMachineInstancetypeSpecRevision is used to capture a versioned copy of VirtualMachineInstancetypeSpec within a ControllerRevision\n\n**WARNING** This struct should never change ensuring it can always be unmarshaled from a ControllerRevision",
34 "apiVersion": "The specific version of VirtualMachineInstancetypeSpec that is contained below",
35 "spec": "This is a marshaled version of the VirtualMachineInstancetypeSpec\n+listType=atomic",
36 }
37 }
38
39 func (VirtualMachineInstancetypeSpec) SwaggerDoc() map[string]string {
40 return map[string]string{
41 "": "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.",
42 "cpu": "Required CPU related attributes of the instancetype.",
43 "memory": "Required Memory related attributes of the instancetype.",
44 "gpus": "Optionally defines any GPU devices associated with the instancetype.\n\n+optional\n+listType=atomic",
45 "hostDevices": "Optionally defines any HostDevices associated with the instancetype.\n\n+optional\n+listType=atomic",
46 "ioThreadsPolicy": "Optionally defines the IOThreadsPolicy to be used by the instancetype.\n\n+optional",
47 "launchSecurity": "Optionally defines the LaunchSecurity to be used by the instancetype.\n\n+optional",
48 }
49 }
50
51 func (CPUInstancetype) SwaggerDoc() map[string]string {
52 return map[string]string{
53 "": "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.",
54 "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.",
55 "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",
56 "dedicatedCPUPlacement": "DedicatedCPUPlacement requests the scheduler to place the VirtualMachineInstance on a node\nwith enough dedicated pCPUs and pin the vCPUs to it.\n+optional",
57 "numa": "NUMA allows specifying settings for the guest NUMA topology\n+optional",
58 "isolateEmulatorThread": "IsolateEmulatorThread requests one more dedicated pCPU to be allocated for the VMI to place\nthe emulator thread on it.\n+optional",
59 "realtime": "Realtime instructs the virt-launcher to tune the VMI for lower latency, optional for real time workloads\n+optional",
60 }
61 }
62
63 func (MemoryInstancetype) SwaggerDoc() map[string]string {
64 return map[string]string{
65 "": "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.",
66 "guest": "Required amount of memory which is visible inside the guest OS.",
67 "hugepages": "Optionally enables the use of hugepages for the VirtualMachineInstance instead of regular memory.\n+optional",
68 }
69 }
70
71 func (VirtualMachinePreference) SwaggerDoc() map[string]string {
72 return map[string]string{
73 "": "VirtualMachinePreference resource contains optional preferences related to the VirtualMachine.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object\n+genclient",
74 "spec": "Required spec describing the preferences",
75 }
76 }
77
78 func (VirtualMachinePreferenceList) SwaggerDoc() map[string]string {
79 return map[string]string{
80 "": "VirtualMachinePreferenceList is a list of VirtualMachinePreference resources.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object",
81 "items": "+listType=set",
82 }
83 }
84
85 func (VirtualMachineClusterPreference) SwaggerDoc() map[string]string {
86 return map[string]string{
87 "": "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",
88 "spec": "Required spec describing the preferences",
89 }
90 }
91
92 func (VirtualMachineClusterPreferenceList) SwaggerDoc() map[string]string {
93 return map[string]string{
94 "": "VirtualMachineClusterPreferenceList is a list of VirtualMachineClusterPreference resources.\n\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object",
95 "items": "+listType=set",
96 }
97 }
98
99 func (VirtualMachinePreferenceSpecRevision) SwaggerDoc() map[string]string {
100 return map[string]string{
101 "": "VirtualMachinePreferenceSpecRevision is used to capture a versioned copy of VirtualMachinePreferenceSpec within a ControllerRevision\n\n**WARNING** This struct should never change ensuring it can always be unmarshaled from a ControllerRevision",
102 "apiVersion": "The specific version of VirtualMachinePreferenceSpec that is contained below",
103 "spec": "This is a marshaled version of the VirtualMachinePreferenceSpec\n+listType=atomic",
104 }
105 }
106
107 func (VirtualMachinePreferenceSpec) SwaggerDoc() map[string]string {
108 return map[string]string{
109 "": "VirtualMachinePreferenceSpec is a description of the VirtualMachinePreference or VirtualMachineClusterPreference.",
110 "clock": "Clock optionally defines preferences associated with the Clock attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
111 "cpu": "CPU optionally defines preferences associated with the CPU attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
112 "devices": "Devices optionally defines preferences associated with the Devices attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
113 "features": "Features optionally defines preferences associated with the Features attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
114 "firmware": "Firmware optionally defines preferences associated with the Firmware attribute of a VirtualMachineInstance DomainSpec\n\n+optional",
115 "machine": "Machine optionally defines preferences associated with the Machine attribute of a VirtualMachineInstance DomainSpec\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 }
124 }
125
126 func (DevicePreferences) SwaggerDoc() map[string]string {
127 return map[string]string{
128 "": "DevicePreferences contains various optional Device preferences.",
129 "preferredAutoattachGraphicsDevice": "PreferredAutoattachGraphicsDevice optionally defines the preferred value of AutoattachGraphicsDevice\n\n+optional",
130 "preferredAutoattachMemBalloon": "PreferredAutoattachMemBalloon optionally defines the preferred value of AutoattachMemBalloon\n\n+optional",
131 "preferredAutoattachPodInterface": "PreferredAutoattachPodInterface optionally defines the preferred value of AutoattachPodInterface\n\n+optional",
132 "preferredAutoattachSerialConsole": "PreferredAutoattachSerialConsole optionally defines the preferred value of AutoattachSerialConsole\n\n+optional",
133 "preferredAutoattachInputDevice": "PreferredAutoattachInputDevice optionally defines the preferred value of AutoattachInputDevice\n\n+optional",
134 "preferredDisableHotplug": "PreferredDisableHotplug optionally defines the preferred value of DisableHotplug\n\n+optional",
135 "preferredVirtualGPUOptions": "PreferredVirtualGPUOptions optionally defines the preferred value of VirtualGPUOptions\n\n+optional",
136 "preferredSoundModel": "PreferredSoundModel optionally defines the preferred model for Sound devices.\n\n+optional",
137 "preferredUseVirtioTransitional": "PreferredUseVirtioTransitional optionally defines the preferred value of UseVirtioTransitional\n\n+optional",
138 "preferredInputBus": "PreferredInputBus optionally defines the preferred bus for Input devices.\n\n+optional",
139 "preferredInputType": "PreferredInputType optionally defines the preferred type for Input devices.\n\n+optional",
140 "preferredDiskBus": "PreferredDiskBus optionally defines the preferred bus for Disk Disk devices.\n\n+optional",
141 "preferredLunBus": "PreferredLunBus optionally defines the preferred bus for Lun Disk devices.\n\n+optional",
142 "preferredCdromBus": "PreferredCdromBus optionally defines the preferred bus for Cdrom Disk devices.\n\n+optional",
143 "preferredDiskDedicatedIoThread": "PreferredDedicatedIoThread optionally enables dedicated IO threads for Disk devices.\n\n+optional",
144 "preferredDiskCache": "PreferredCache optionally defines the DriverCache to be used by Disk devices.\n\n+optional",
145 "preferredDiskIO": "PreferredIo optionally defines the QEMU disk IO mode to be used by Disk devices.\n\n+optional",
146 "preferredDiskBlockSize": "PreferredBlockSize optionally defines the block size of Disk devices.\n\n+optional",
147 "preferredInterfaceModel": "PreferredInterfaceModel optionally defines the preferred model to be used by Interface devices.\n\n+optional",
148 "preferredRng": "PreferredRng optionally defines the preferred rng device to be used.\n\n+optional",
149 "preferredBlockMultiQueue": "PreferredBlockMultiQueue optionally enables the vhost multiqueue feature for virtio disks.\n\n+optional",
150 "preferredNetworkInterfaceMultiQueue": "PreferredNetworkInterfaceMultiQueue optionally enables the vhost multiqueue feature for virtio interfaces.\n\n+optional",
151 "preferredTPM": "PreferredTPM optionally defines the preferred TPM device to be used.\n\n+optional",
152 }
153 }
154
155 func (FeaturePreferences) SwaggerDoc() map[string]string {
156 return map[string]string{
157 "": "FeaturePreferences contains various optional defaults for Features.",
158 "preferredAcpi": "PreferredAcpi optionally enables the ACPI feature\n\n+optional",
159 "preferredApic": "PreferredApic optionally enables and configures the APIC feature\n\n+optional",
160 "preferredHyperv": "PreferredHyperv optionally enables and configures HyperV features\n\n+optional",
161 "preferredKvm": "PreferredKvm optionally enables and configures KVM features\n\n+optional",
162 "preferredPvspinlock": "PreferredPvspinlock optionally enables the Pvspinlock feature\n\n+optional",
163 "preferredSmm": "PreferredSmm optionally enables the SMM feature\n\n+optional",
164 }
165 }
166
167 func (FirmwarePreferences) SwaggerDoc() map[string]string {
168 return map[string]string{
169 "": "FirmwarePreferences contains various optional defaults for Firmware.",
170 "preferredUseBios": "PreferredUseBios optionally enables BIOS\n\n+optional",
171 "preferredUseBiosSerial": "PreferredUseBiosSerial optionally transmitts BIOS output over the serial.\n\nRequires PreferredUseBios to be enabled.\n\n+optional",
172 "preferredUseEfi": "PreferredUseEfi optionally enables EFI\n\n+optional",
173 "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",
174 }
175 }
176
177 func (MachinePreferences) SwaggerDoc() map[string]string {
178 return map[string]string{
179 "": "MachinePreferences contains various optional defaults for Machine.",
180 "preferredMachineType": "PreferredMachineType optionally defines the preferred machine type to use.\n\n+optional",
181 }
182 }
183
184 func (ClockPreferences) SwaggerDoc() map[string]string {
185 return map[string]string{
186 "": "ClockPreferences contains various optional defaults for Clock.",
187 "preferredClockOffset": "ClockOffset allows specifying the UTC offset or the timezone of the guest clock.\n\n+optional",
188 "preferredTimer": "Timer specifies whih timers are attached to the vmi.\n\n+optional",
189 }
190 }
191
View as plain text