kubevirt.io/api@v1.2.0/instancetype/v1alpha2/types_swagger_generated.go (about)

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