1 package v1beta1
2
3
4
5
6
7
8
9
10
11
12
13
14 var map_AWSMachineProviderConfig = map[string]string{
15 "": "AWSMachineProviderConfig is the Schema for the awsmachineproviderconfigs API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
16 "ami": "AMI is the reference to the AMI from which to create the machine instance.",
17 "instanceType": "InstanceType is the type of instance to create. Example: m4.xlarge",
18 "tags": "Tags is the set of tags to add to apply to an instance, in addition to the ones added by default by the actuator. These tags are additive. The actuator will ensure these tags are present, but will not remove any other tags that may exist on the instance.",
19 "iamInstanceProfile": "IAMInstanceProfile is a reference to an IAM role to assign to the instance",
20 "userDataSecret": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance",
21 "credentialsSecret": "CredentialsSecret is a reference to the secret with AWS credentials. Otherwise, defaults to permissions provided by attached IAM role where the actuator is running.",
22 "keyName": "KeyName is the name of the KeyPair to use for SSH",
23 "deviceIndex": "DeviceIndex is the index of the device on the instance for the network interface attachment. Defaults to 0.",
24 "publicIp": "PublicIP specifies whether the instance should get a public IP. If not present, it should use the default of its subnet.",
25 "networkInterfaceType": "NetworkInterfaceType specifies the type of network interface to be used for the primary network interface. Valid values are \"ENA\", \"EFA\", and omitted, which means no opinion and the platform chooses a good default which may change over time. The current default value is \"ENA\". Please visit https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html to learn more about the AWS Elastic Fabric Adapter interface option.",
26 "securityGroups": "SecurityGroups is an array of references to security groups that should be applied to the instance.",
27 "subnet": "Subnet is a reference to the subnet to use for this instance",
28 "placement": "Placement specifies where to create the instance in AWS",
29 "loadBalancers": "LoadBalancers is the set of load balancers to which the new instance should be added once it is created.",
30 "blockDevices": "BlockDevices is the set of block device mapping associated to this instance, block device without a name will be used as a root device and only one device without a name is allowed https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html",
31 "spotMarketOptions": "SpotMarketOptions allows users to configure instances to be run using AWS Spot instances.",
32 "metadataServiceOptions": "MetadataServiceOptions allows users to configure instance metadata service interaction options. If nothing specified, default AWS IMDS settings will be applied. https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_InstanceMetadataOptionsRequest.html",
33 }
34
35 func (AWSMachineProviderConfig) SwaggerDoc() map[string]string {
36 return map_AWSMachineProviderConfig
37 }
38
39 var map_AWSMachineProviderConfigList = map[string]string{
40 "": "AWSMachineProviderConfigList contains a list of AWSMachineProviderConfig Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
41 }
42
43 func (AWSMachineProviderConfigList) SwaggerDoc() map[string]string {
44 return map_AWSMachineProviderConfigList
45 }
46
47 var map_AWSMachineProviderStatus = map[string]string{
48 "": "AWSMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains AWS-specific status information. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
49 "instanceId": "InstanceID is the instance ID of the machine created in AWS",
50 "instanceState": "InstanceState is the state of the AWS instance for this machine",
51 "conditions": "Conditions is a set of conditions associated with the Machine to indicate errors or other status",
52 }
53
54 func (AWSMachineProviderStatus) SwaggerDoc() map[string]string {
55 return map_AWSMachineProviderStatus
56 }
57
58 var map_AWSResourceReference = map[string]string{
59 "": "AWSResourceReference is a reference to a specific AWS resource by ID, ARN, or filters. Only one of ID, ARN or Filters may be specified. Specifying more than one will result in a validation error.",
60 "id": "ID of resource",
61 "arn": "ARN of resource",
62 "filters": "Filters is a set of filters used to identify a resource",
63 }
64
65 func (AWSResourceReference) SwaggerDoc() map[string]string {
66 return map_AWSResourceReference
67 }
68
69 var map_BlockDeviceMappingSpec = map[string]string{
70 "": "BlockDeviceMappingSpec describes a block device mapping",
71 "deviceName": "The device name exposed to the machine (for example, /dev/sdh or xvdh).",
72 "ebs": "Parameters used to automatically set up EBS volumes when the machine is launched.",
73 "noDevice": "Suppresses the specified device included in the block device mapping of the AMI.",
74 "virtualName": "The virtual device name (ephemeralN). Machine store volumes are numbered starting from 0. An machine type with 2 available machine store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available machine store volumes depends on the machine type. After you connect to the machine, you must mount the volume.\n\nConstraints: For M3 machines, you must specify machine store volumes in the block device mapping for the machine. When you launch an M3 machine, we ignore any machine store volumes specified in the block device mapping for the AMI.",
75 }
76
77 func (BlockDeviceMappingSpec) SwaggerDoc() map[string]string {
78 return map_BlockDeviceMappingSpec
79 }
80
81 var map_EBSBlockDeviceSpec = map[string]string{
82 "": "EBSBlockDeviceSpec describes a block device for an EBS volume. https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/EbsBlockDevice",
83 "deleteOnTermination": "Indicates whether the EBS volume is deleted on machine termination.",
84 "encrypted": "Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to machines that support Amazon EBS encryption.",
85 "kmsKey": "Indicates the KMS key that should be used to encrypt the Amazon EBS volume.",
86 "iops": "The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the Amazon Elastic Compute Cloud User Guide.\n\nMinimal and maximal IOPS for io1 and gp2 are constrained. Please, check https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html for precise boundaries for individual volumes.\n\nCondition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.",
87 "volumeSize": "The size of the volume, in GiB.\n\nConstraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.\n\nDefault: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.",
88 "volumeType": "The volume type: gp2, io1, st1, sc1, or standard. Default: standard",
89 }
90
91 func (EBSBlockDeviceSpec) SwaggerDoc() map[string]string {
92 return map_EBSBlockDeviceSpec
93 }
94
95 var map_Filter = map[string]string{
96 "": "Filter is a filter used to identify an AWS resource",
97 "name": "Name of the filter. Filter names are case-sensitive.",
98 "values": "Values includes one or more filter values. Filter values are case-sensitive.",
99 }
100
101 func (Filter) SwaggerDoc() map[string]string {
102 return map_Filter
103 }
104
105 var map_LoadBalancerReference = map[string]string{
106 "": "LoadBalancerReference is a reference to a load balancer on AWS.",
107 }
108
109 func (LoadBalancerReference) SwaggerDoc() map[string]string {
110 return map_LoadBalancerReference
111 }
112
113 var map_MetadataServiceOptions = map[string]string{
114 "": "MetadataServiceOptions defines the options available to a user when configuring Instance Metadata Service (IMDS) Options.",
115 "authentication": "Authentication determines whether or not the host requires the use of authentication when interacting with the metadata service. When using authentication, this enforces v2 interaction method (IMDSv2) with the metadata service. When omitted, this means the user has no opinion and the value is left to the platform to choose a good default, which is subject to change over time. The current default is optional. At this point this field represents `HttpTokens` parameter from `InstanceMetadataOptionsRequest` structure in AWS EC2 API https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_InstanceMetadataOptionsRequest.html",
116 }
117
118 func (MetadataServiceOptions) SwaggerDoc() map[string]string {
119 return map_MetadataServiceOptions
120 }
121
122 var map_Placement = map[string]string{
123 "": "Placement indicates where to create the instance in AWS",
124 "region": "Region is the region to use to create the instance",
125 "availabilityZone": "AvailabilityZone is the availability zone of the instance",
126 "tenancy": "Tenancy indicates if instance should run on shared or single-tenant hardware. There are supported 3 options: default, dedicated and host.",
127 }
128
129 func (Placement) SwaggerDoc() map[string]string {
130 return map_Placement
131 }
132
133 var map_SpotMarketOptions = map[string]string{
134 "": "SpotMarketOptions defines the options available to a user when configuring Machines to run on Spot instances. Most users should provide an empty struct.",
135 "maxPrice": "The maximum price the user is willing to pay for their instances Default: On-Demand price",
136 }
137
138 func (SpotMarketOptions) SwaggerDoc() map[string]string {
139 return map_SpotMarketOptions
140 }
141
142 var map_TagSpecification = map[string]string{
143 "": "TagSpecification is the name/value pair for a tag",
144 "name": "Name of the tag",
145 "value": "Value of the tag",
146 }
147
148 func (TagSpecification) SwaggerDoc() map[string]string {
149 return map_TagSpecification
150 }
151
152 var map_AzureBootDiagnostics = map[string]string{
153 "": "AzureBootDiagnostics configures the boot diagnostics settings for the virtual machine. This allows you to configure capturing serial output from the virtual machine on boot. This is useful for debugging software based launch issues.",
154 "storageAccountType": "StorageAccountType determines if the storage account for storing the diagnostics data should be provisioned by Azure (AzureManaged) or by the customer (CustomerManaged).",
155 "customerManaged": "CustomerManaged provides reference to the customer manager storage account.",
156 }
157
158 func (AzureBootDiagnostics) SwaggerDoc() map[string]string {
159 return map_AzureBootDiagnostics
160 }
161
162 var map_AzureCustomerManagedBootDiagnostics = map[string]string{
163 "": "AzureCustomerManagedBootDiagnostics provides reference to a customer managed storage account.",
164 "storageAccountURI": "StorageAccountURI is the URI of the customer managed storage account. The URI typically will be `https://<mystorageaccountname>.blob.core.windows.net/` but may differ if you are using Azure DNS zone endpoints. You can find the correct endpoint by looking for the Blob Primary Endpoint in the endpoints tab in the Azure console.",
165 }
166
167 func (AzureCustomerManagedBootDiagnostics) SwaggerDoc() map[string]string {
168 return map_AzureCustomerManagedBootDiagnostics
169 }
170
171 var map_AzureDiagnostics = map[string]string{
172 "": "AzureDiagnostics is used to configure the diagnostic settings of the virtual machine.",
173 "boot": "AzureBootDiagnostics configures the boot diagnostics settings for the virtual machine. This allows you to configure capturing serial output from the virtual machine on boot. This is useful for debugging software based launch issues.",
174 }
175
176 func (AzureDiagnostics) SwaggerDoc() map[string]string {
177 return map_AzureDiagnostics
178 }
179
180 var map_AzureMachineProviderSpec = map[string]string{
181 "": "AzureMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an Azure virtual machine. It is used by the Azure machine actuator to create a single Machine. Required parameters such as location that are not specified by this configuration, will be defaulted by the actuator. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
182 "userDataSecret": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance",
183 "credentialsSecret": "CredentialsSecret is a reference to the secret with Azure credentials.",
184 "location": "Location is the region to use to create the instance",
185 "vmSize": "VMSize is the size of the VM to create.",
186 "image": "Image is the OS image to use to create the instance.",
187 "osDisk": "OSDisk represents the parameters for creating the OS disk.",
188 "dataDisks": "DataDisk specifies the parameters that are used to add one or more data disks to the machine.",
189 "sshPublicKey": "SSHPublicKey is the public key to use to SSH to the virtual machine.",
190 "publicIP": "PublicIP if true a public IP will be used",
191 "tags": "Tags is a list of tags to apply to the machine.",
192 "securityGroup": "Network Security Group that needs to be attached to the machine's interface. No security group will be attached if empty.",
193 "applicationSecurityGroups": "Application Security Groups that need to be attached to the machine's interface. No application security groups will be attached if zero-length.",
194 "subnet": "Subnet to use for this instance",
195 "publicLoadBalancer": "PublicLoadBalancer to use for this instance",
196 "internalLoadBalancer": "InternalLoadBalancerName to use for this instance",
197 "natRule": "NatRule to set inbound NAT rule of the load balancer",
198 "managedIdentity": "ManagedIdentity to set managed identity name",
199 "vnet": "Vnet to set virtual network name",
200 "zone": "Availability Zone for the virtual machine. If nil, the virtual machine should be deployed to no zone",
201 "networkResourceGroup": "NetworkResourceGroup is the resource group for the virtual machine's network",
202 "resourceGroup": "ResourceGroup is the resource group for the virtual machine",
203 "spotVMOptions": "SpotVMOptions allows the ability to specify the Machine should use a Spot VM",
204 "securityProfile": "SecurityProfile specifies the Security profile settings for a virtual machine.",
205 "ultraSSDCapability": "UltraSSDCapability enables or disables Azure UltraSSD capability for a virtual machine. This can be used to allow/disallow binding of Azure UltraSSD to the Machine both as Data Disks or via Persistent Volumes. This Azure feature is subject to a specific scope and certain limitations. More informations on this can be found in the official Azure documentation for Ultra Disks: (https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd?tabs=azure-portal#ga-scope-and-limitations).\n\nWhen omitted, if at least one Data Disk of type UltraSSD is specified, the platform will automatically enable the capability. If a Perisistent Volume backed by an UltraSSD is bound to a Pod on the Machine, when this field is ommitted, the platform will *not* automatically enable the capability (unless already enabled by the presence of an UltraSSD as Data Disk). This may manifest in the Pod being stuck in `ContainerCreating` phase. This defaulting behaviour may be subject to change in future.\n\nWhen set to \"Enabled\", if the capability is available for the Machine based on the scope and limitations described above, the capability will be set on the Machine. This will thus allow UltraSSD both as Data Disks and Persistent Volumes. If set to \"Enabled\" when the capability can't be available due to scope and limitations, the Machine will go into \"Failed\" state.\n\nWhen set to \"Disabled\", UltraSSDs will not be allowed either as Data Disks nor as Persistent Volumes. In this case if any UltraSSDs are specified as Data Disks on a Machine, the Machine will go into a \"Failed\" state. If instead any UltraSSDs are backing the volumes (via Persistent Volumes) of any Pods scheduled on a Node which is backed by the Machine, the Pod may get stuck in `ContainerCreating` phase.",
206 "acceleratedNetworking": "AcceleratedNetworking enables or disables Azure accelerated networking feature. Set to false by default. If true, then this will depend on whether the requested VMSize is supported. If set to true with an unsupported VMSize, Azure will return an error.",
207 "availabilitySet": "AvailabilitySet specifies the availability set to use for this instance. Availability set should be precreated, before using this field.",
208 "diagnostics": "Diagnostics configures the diagnostics settings for the virtual machine. This allows you to configure boot diagnostics such as capturing serial output from the virtual machine on boot. This is useful for debugging software based launch issues.",
209 }
210
211 func (AzureMachineProviderSpec) SwaggerDoc() map[string]string {
212 return map_AzureMachineProviderSpec
213 }
214
215 var map_AzureMachineProviderStatus = map[string]string{
216 "": "AzureMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains Azure-specific status information. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
217 "vmId": "VMID is the ID of the virtual machine created in Azure.",
218 "vmState": "VMState is the provisioning state of the Azure virtual machine.",
219 "conditions": "Conditions is a set of conditions associated with the Machine to indicate errors or other status.",
220 }
221
222 func (AzureMachineProviderStatus) SwaggerDoc() map[string]string {
223 return map_AzureMachineProviderStatus
224 }
225
226 var map_DataDisk = map[string]string{
227 "": "DataDisk specifies the parameters that are used to add one or more data disks to the machine. A Data Disk is a managed disk that's attached to a virtual machine to store application data. It differs from an OS Disk as it doesn't come with a pre-installed OS, and it cannot contain the boot volume. It is registered as SCSI drive and labeled with the chosen `lun`. e.g. for `lun: 0` the raw disk device will be available at `/dev/disk/azure/scsi1/lun0`.\n\nAs the Data Disk disk device is attached raw to the virtual machine, it will need to be partitioned, formatted with a filesystem and mounted, in order for it to be usable. This can be done by creating a custom userdata Secret with custom Ignition configuration to achieve the desired initialization. At this stage the previously defined `lun` is to be used as the \"device\" key for referencing the raw disk device to be initialized. Once the custom userdata Secret has been created, it can be referenced in the Machine's `.providerSpec.userDataSecret`. For further guidance and examples, please refer to the official OpenShift docs.",
228 "nameSuffix": "NameSuffix is the suffix to be appended to the machine name to generate the disk name. Each disk name will be in format <machineName>_<nameSuffix>. NameSuffix name must start and finish with an alphanumeric character and can only contain letters, numbers, underscores, periods or hyphens. The overall disk name must not exceed 80 chars in length.",
229 "diskSizeGB": "DiskSizeGB is the size in GB to assign to the data disk.",
230 "managedDisk": "ManagedDisk specifies the Managed Disk parameters for the data disk. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is a ManagedDisk with with storageAccountType: \"Premium_LRS\" and diskEncryptionSet.id: \"Default\".",
231 "lun": "Lun Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. This value is also needed for referencing the data disks devices within userdata to perform disk initialization through Ignition (e.g. partition/format/mount). The value must be between 0 and 63.",
232 "cachingType": "CachingType specifies the caching requirements. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is CachingTypeNone.",
233 "deletionPolicy": "DeletionPolicy specifies the data disk deletion policy upon Machine deletion. Possible values are \"Delete\",\"Detach\". When \"Delete\" is used the data disk is deleted when the Machine is deleted. When \"Detach\" is used the data disk is detached from the Machine and retained when the Machine is deleted.",
234 }
235
236 func (DataDisk) SwaggerDoc() map[string]string {
237 return map_DataDisk
238 }
239
240 var map_DataDiskManagedDiskParameters = map[string]string{
241 "": "DataDiskManagedDiskParameters is the parameters of a DataDisk managed disk.",
242 "storageAccountType": "StorageAccountType is the storage account type to use. Possible values include \"Standard_LRS\", \"Premium_LRS\" and \"UltraSSD_LRS\".",
243 "diskEncryptionSet": "DiskEncryptionSet is the disk encryption set properties. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is a DiskEncryptionSet with id: \"Default\".",
244 }
245
246 func (DataDiskManagedDiskParameters) SwaggerDoc() map[string]string {
247 return map_DataDiskManagedDiskParameters
248 }
249
250 var map_DiskEncryptionSetParameters = map[string]string{
251 "": "DiskEncryptionSetParameters is the disk encryption set properties",
252 "id": "ID is the disk encryption set ID Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is: \"Default\".",
253 }
254
255 func (DiskEncryptionSetParameters) SwaggerDoc() map[string]string {
256 return map_DiskEncryptionSetParameters
257 }
258
259 var map_DiskSettings = map[string]string{
260 "": "DiskSettings describe ephemeral disk settings for the os disk.",
261 "ephemeralStorageLocation": "EphemeralStorageLocation enables ephemeral OS when set to 'Local'. Possible values include: 'Local'. See https://docs.microsoft.com/en-us/azure/virtual-machines/ephemeral-os-disks for full details. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is that disks are saved to remote Azure storage.",
262 }
263
264 func (DiskSettings) SwaggerDoc() map[string]string {
265 return map_DiskSettings
266 }
267
268 var map_Image = map[string]string{
269 "": "Image is a mirror of azure sdk compute.ImageReference",
270 "publisher": "Publisher is the name of the organization that created the image",
271 "offer": "Offer specifies the name of a group of related images created by the publisher. For example, UbuntuServer, WindowsServer",
272 "sku": "SKU specifies an instance of an offer, such as a major release of a distribution. For example, 18.04-LTS, 2019-Datacenter",
273 "version": "Version specifies the version of an image sku. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available.",
274 "resourceID": "ResourceID specifies an image to use by ID",
275 "type": "Type identifies the source of the image and related information, such as purchase plans. Valid values are \"ID\", \"MarketplaceWithPlan\", \"MarketplaceNoPlan\", and omitted, which means no opinion and the platform chooses a good default which may change over time. Currently that default is \"MarketplaceNoPlan\" if publisher data is supplied, or \"ID\" if not. For more information about purchase plans, see: https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cli-ps-findimage#check-the-purchase-plan-information",
276 }
277
278 func (Image) SwaggerDoc() map[string]string {
279 return map_Image
280 }
281
282 var map_OSDisk = map[string]string{
283 "osType": "OSType is the operating system type of the OS disk. Possible values include \"Linux\" and \"Windows\".",
284 "managedDisk": "ManagedDisk specifies the Managed Disk parameters for the OS disk.",
285 "diskSizeGB": "DiskSizeGB is the size in GB to assign to the data disk.",
286 "diskSettings": "DiskSettings describe ephemeral disk settings for the os disk.",
287 "cachingType": "CachingType specifies the caching requirements. Possible values include: 'None', 'ReadOnly', 'ReadWrite'. Empty value means no opinion and the platform chooses a default, which is subject to change over time. Currently the default is `None`.",
288 }
289
290 func (OSDisk) SwaggerDoc() map[string]string {
291 return map_OSDisk
292 }
293
294 var map_OSDiskManagedDiskParameters = map[string]string{
295 "": "OSDiskManagedDiskParameters is the parameters of a OSDisk managed disk.",
296 "storageAccountType": "StorageAccountType is the storage account type to use. Possible values include \"Standard_LRS\", \"Premium_LRS\".",
297 "diskEncryptionSet": "DiskEncryptionSet is the disk encryption set properties",
298 }
299
300 func (OSDiskManagedDiskParameters) SwaggerDoc() map[string]string {
301 return map_OSDiskManagedDiskParameters
302 }
303
304 var map_SecurityProfile = map[string]string{
305 "": "SecurityProfile specifies the Security profile settings for a virtual machine or virtual machine scale set.",
306 "encryptionAtHost": "This field indicates whether Host Encryption should be enabled or disabled for a virtual machine or virtual machine scale set. Default is disabled.",
307 }
308
309 func (SecurityProfile) SwaggerDoc() map[string]string {
310 return map_SecurityProfile
311 }
312
313 var map_SpotVMOptions = map[string]string{
314 "": "SpotVMOptions defines the options relevant to running the Machine on Spot VMs",
315 "maxPrice": "MaxPrice defines the maximum price the user is willing to pay for Spot VM instances",
316 }
317
318 func (SpotVMOptions) SwaggerDoc() map[string]string {
319 return map_SpotVMOptions
320 }
321
322 var map_GCPDisk = map[string]string{
323 "": "GCPDisk describes disks for GCP.",
324 "autoDelete": "AutoDelete indicates if the disk will be auto-deleted when the instance is deleted (default false).",
325 "boot": "Boot indicates if this is a boot disk (default false).",
326 "sizeGb": "SizeGB is the size of the disk (in GB).",
327 "type": "Type is the type of the disk (eg: pd-standard).",
328 "image": "Image is the source image to create this disk.",
329 "labels": "Labels list of labels to apply to the disk.",
330 "encryptionKey": "EncryptionKey is the customer-supplied encryption key of the disk.",
331 }
332
333 func (GCPDisk) SwaggerDoc() map[string]string {
334 return map_GCPDisk
335 }
336
337 var map_GCPEncryptionKeyReference = map[string]string{
338 "": "GCPEncryptionKeyReference describes the encryptionKey to use for a disk's encryption.",
339 "kmsKey": "KMSKeyName is the reference KMS key, in the format",
340 "kmsKeyServiceAccount": "KMSKeyServiceAccount is the service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. See https://cloud.google.com/compute/docs/access/service-accounts#compute_engine_service_account for details on the default service account.",
341 }
342
343 func (GCPEncryptionKeyReference) SwaggerDoc() map[string]string {
344 return map_GCPEncryptionKeyReference
345 }
346
347 var map_GCPGPUConfig = map[string]string{
348 "": "GCPGPUConfig describes type and count of GPUs attached to the instance on GCP.",
349 "count": "Count is the number of GPUs to be attached to an instance.",
350 "type": "Type is the type of GPU to be attached to an instance. Supported GPU types are: nvidia-tesla-k80, nvidia-tesla-p100, nvidia-tesla-v100, nvidia-tesla-p4, nvidia-tesla-t4",
351 }
352
353 func (GCPGPUConfig) SwaggerDoc() map[string]string {
354 return map_GCPGPUConfig
355 }
356
357 var map_GCPKMSKeyReference = map[string]string{
358 "": "GCPKMSKeyReference gathers required fields for looking up a GCP KMS Key",
359 "name": "Name is the name of the customer managed encryption key to be used for the disk encryption.",
360 "keyRing": "KeyRing is the name of the KMS Key Ring which the KMS Key belongs to.",
361 "projectID": "ProjectID is the ID of the Project in which the KMS Key Ring exists. Defaults to the VM ProjectID if not set.",
362 "location": "Location is the GCP location in which the Key Ring exists.",
363 }
364
365 func (GCPKMSKeyReference) SwaggerDoc() map[string]string {
366 return map_GCPKMSKeyReference
367 }
368
369 var map_GCPMachineProviderSpec = map[string]string{
370 "": "GCPMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an GCP virtual machine. It is used by the GCP machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
371 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
372 "userDataSecret": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance",
373 "credentialsSecret": "CredentialsSecret is a reference to the secret with GCP credentials.",
374 "canIPForward": "CanIPForward Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes.",
375 "deletionProtection": "DeletionProtection whether the resource should be protected against deletion.",
376 "disks": "Disks is a list of disks to be attached to the VM.",
377 "labels": "Labels list of labels to apply to the VM.",
378 "gcpMetadata": "Metadata key/value pairs to apply to the VM.",
379 "networkInterfaces": "NetworkInterfaces is a list of network interfaces to be attached to the VM.",
380 "serviceAccounts": "ServiceAccounts is a list of GCP service accounts to be used by the VM.",
381 "tags": "Tags list of tags to apply to the VM.",
382 "targetPools": "TargetPools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool",
383 "machineType": "MachineType is the machine type to use for the VM.",
384 "region": "Region is the region in which the GCP machine provider will create the VM.",
385 "zone": "Zone is the zone in which the GCP machine provider will create the VM.",
386 "projectID": "ProjectID is the project in which the GCP machine provider will create the VM.",
387 "gpus": "GPUs is a list of GPUs to be attached to the VM.",
388 "preemptible": "Preemptible indicates if created instance is preemptible.",
389 "onHostMaintenance": "OnHostMaintenance determines the behavior when a maintenance event occurs that might cause the instance to reboot. This is required to be set to \"Terminate\" if you want to provision machine with attached GPUs. Otherwise, allowed values are \"Migrate\" and \"Terminate\". If omitted, the platform chooses a default, which is subject to change over time, currently that default is \"Migrate\".",
390 "restartPolicy": "RestartPolicy determines the behavior when an instance crashes or the underlying infrastructure provider stops the instance as part of a maintenance event (default \"Always\"). Cannot be \"Always\" with preemptible instances. Otherwise, allowed values are \"Always\" and \"Never\". If omitted, the platform chooses a default, which is subject to change over time, currently that default is \"Always\". RestartPolicy represents AutomaticRestart in GCP compute api",
391 "shieldedInstanceConfig": "ShieldedInstanceConfig is the Shielded VM configuration for the VM",
392 "confidentialCompute": "confidentialCompute Defines whether the instance should have confidential compute enabled. If enabled OnHostMaintenance is required to be set to \"Terminate\". If omitted, the platform chooses a default, which is subject to change over time, currently that default is false.",
393 }
394
395 func (GCPMachineProviderSpec) SwaggerDoc() map[string]string {
396 return map_GCPMachineProviderSpec
397 }
398
399 var map_GCPMachineProviderStatus = map[string]string{
400 "": "GCPMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains GCP-specific status information. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
401 "instanceId": "InstanceID is the ID of the instance in GCP",
402 "instanceState": "InstanceState is the provisioning state of the GCP Instance.",
403 "conditions": "Conditions is a set of conditions associated with the Machine to indicate errors or other status",
404 }
405
406 func (GCPMachineProviderStatus) SwaggerDoc() map[string]string {
407 return map_GCPMachineProviderStatus
408 }
409
410 var map_GCPMetadata = map[string]string{
411 "": "GCPMetadata describes metadata for GCP.",
412 "key": "Key is the metadata key.",
413 "value": "Value is the metadata value.",
414 }
415
416 func (GCPMetadata) SwaggerDoc() map[string]string {
417 return map_GCPMetadata
418 }
419
420 var map_GCPNetworkInterface = map[string]string{
421 "": "GCPNetworkInterface describes network interfaces for GCP",
422 "publicIP": "PublicIP indicates if true a public IP will be used",
423 "network": "Network is the network name.",
424 "projectID": "ProjectID is the project in which the GCP machine provider will create the VM.",
425 "subnetwork": "Subnetwork is the subnetwork name.",
426 }
427
428 func (GCPNetworkInterface) SwaggerDoc() map[string]string {
429 return map_GCPNetworkInterface
430 }
431
432 var map_GCPServiceAccount = map[string]string{
433 "": "GCPServiceAccount describes service accounts for GCP.",
434 "email": "Email is the service account email.",
435 "scopes": "Scopes list of scopes to be assigned to the service account.",
436 }
437
438 func (GCPServiceAccount) SwaggerDoc() map[string]string {
439 return map_GCPServiceAccount
440 }
441
442 var map_GCPShieldedInstanceConfig = map[string]string{
443 "": "GCPShieldedInstanceConfig describes the shielded VM configuration of the instance on GCP. Shielded VM configuration allow users to enable and disable Secure Boot, vTPM, and Integrity Monitoring.",
444 "secureBoot": "SecureBoot Defines whether the instance should have secure boot enabled. Secure Boot verify the digital signature of all boot components, and halting the boot process if signature verification fails. If omitted, the platform chooses a default, which is subject to change over time, currently that default is Disabled.",
445 "virtualizedTrustedPlatformModule": "VirtualizedTrustedPlatformModule enable virtualized trusted platform module measurements to create a known good boot integrity policy baseline. The integrity policy baseline is used for comparison with measurements from subsequent VM boots to determine if anything has changed. This is required to be set to \"Enabled\" if IntegrityMonitoring is enabled. If omitted, the platform chooses a default, which is subject to change over time, currently that default is Enabled.",
446 "integrityMonitoring": "IntegrityMonitoring determines whether the instance should have integrity monitoring that verify the runtime boot integrity. Compares the most recent boot measurements to the integrity policy baseline and return a pair of pass/fail results depending on whether they match or not. If omitted, the platform chooses a default, which is subject to change over time, currently that default is Enabled.",
447 }
448
449 func (GCPShieldedInstanceConfig) SwaggerDoc() map[string]string {
450 return map_GCPShieldedInstanceConfig
451 }
452
453 var map_LastOperation = map[string]string{
454 "": "LastOperation represents the detail of the last performed operation on the MachineObject.",
455 "description": "Description is the human-readable description of the last operation.",
456 "lastUpdated": "LastUpdated is the timestamp at which LastOperation API was last-updated.",
457 "state": "State is the current status of the last performed operation. E.g. Processing, Failed, Successful etc",
458 "type": "Type is the type of operation which was last performed. E.g. Create, Delete, Update etc",
459 }
460
461 func (LastOperation) SwaggerDoc() map[string]string {
462 return map_LastOperation
463 }
464
465 var map_LifecycleHook = map[string]string{
466 "": "LifecycleHook represents a single instance of a lifecycle hook",
467 "name": "Name defines a unique name for the lifcycle hook. The name should be unique and descriptive, ideally 1-3 words, in CamelCase or it may be namespaced, eg. foo.example.com/CamelCase. Names must be unique and should only be managed by a single entity.",
468 "owner": "Owner defines the owner of the lifecycle hook. This should be descriptive enough so that users can identify who/what is responsible for blocking the lifecycle. This could be the name of a controller (e.g. clusteroperator/etcd) or an administrator managing the hook.",
469 }
470
471 func (LifecycleHook) SwaggerDoc() map[string]string {
472 return map_LifecycleHook
473 }
474
475 var map_LifecycleHooks = map[string]string{
476 "": "LifecycleHooks allow users to pause operations on the machine at certain prefedined points within the machine lifecycle.",
477 "preDrain": "PreDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination.",
478 "preTerminate": "PreTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained.",
479 }
480
481 func (LifecycleHooks) SwaggerDoc() map[string]string {
482 return map_LifecycleHooks
483 }
484
485 var map_Machine = map[string]string{
486 "": "Machine is the Schema for the machines API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
487 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
488 }
489
490 func (Machine) SwaggerDoc() map[string]string {
491 return map_Machine
492 }
493
494 var map_MachineList = map[string]string{
495 "": "MachineList contains a list of Machine Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
496 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
497 }
498
499 func (MachineList) SwaggerDoc() map[string]string {
500 return map_MachineList
501 }
502
503 var map_MachineSpec = map[string]string{
504 "": "MachineSpec defines the desired state of Machine",
505 "metadata": "ObjectMeta will autopopulate the Node created. Use this to indicate what labels, annotations, name prefix, etc., should be used when creating the Node.",
506 "lifecycleHooks": "LifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle.",
507 "taints": "The list of the taints to be applied to the corresponding Node in additive manner. This list will not overwrite any other taints added to the Node on an ongoing basis by other entities. These taints should be actively reconciled e.g. if you ask the machine controller to apply a taint and then manually remove the taint the machine controller will put it back) but not have the machine controller remove any taints",
508 "providerSpec": "ProviderSpec details Provider-specific configuration to use during node creation.",
509 "providerID": "ProviderID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out machines at provider which could not get registered as Kubernetes nodes. With cluster-api as a generic out-of-tree provider for autoscaler, this field is required by autoscaler to be able to have a provider view of the list of machines. Another list of nodes is queried from the k8s apiserver and then a comparison is done to find out unregistered machines and are marked for delete. This field will be set by the actuators and consumed by higher level entities like autoscaler that will be interfacing with cluster-api as generic provider.",
510 }
511
512 func (MachineSpec) SwaggerDoc() map[string]string {
513 return map_MachineSpec
514 }
515
516 var map_MachineStatus = map[string]string{
517 "": "MachineStatus defines the observed state of Machine",
518 "nodeRef": "NodeRef will point to the corresponding Node if it exists.",
519 "lastUpdated": "LastUpdated identifies when this status was last observed.",
520 "errorReason": "ErrorReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation.\n\nThis field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.",
521 "errorMessage": "ErrorMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption.\n\nThis field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output.",
522 "providerStatus": "ProviderStatus details a Provider-specific status. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field.",
523 "addresses": "Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.",
524 "lastOperation": "LastOperation describes the last-operation performed by the machine-controller. This API should be useful as a history in terms of the latest operation performed on the specific machine. It should also convey the state of the latest-operation for example if it is still on-going, failed or completed successfully.",
525 "phase": "Phase represents the current phase of machine actuation. One of: Failed, Provisioning, Provisioned, Running, Deleting",
526 "conditions": "Conditions defines the current state of the Machine",
527 }
528
529 func (MachineStatus) SwaggerDoc() map[string]string {
530 return map_MachineStatus
531 }
532
533 var map_MachineHealthCheck = map[string]string{
534 "": "MachineHealthCheck is the Schema for the machinehealthchecks API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
535 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
536 "spec": "Specification of machine health check policy",
537 "status": "Most recently observed status of MachineHealthCheck resource",
538 }
539
540 func (MachineHealthCheck) SwaggerDoc() map[string]string {
541 return map_MachineHealthCheck
542 }
543
544 var map_MachineHealthCheckList = map[string]string{
545 "": "MachineHealthCheckList contains a list of MachineHealthCheck Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
546 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
547 }
548
549 func (MachineHealthCheckList) SwaggerDoc() map[string]string {
550 return map_MachineHealthCheckList
551 }
552
553 var map_MachineHealthCheckSpec = map[string]string{
554 "": "MachineHealthCheckSpec defines the desired state of MachineHealthCheck",
555 "selector": "Label selector to match machines whose health will be exercised. Note: An empty selector will match all machines.",
556 "unhealthyConditions": "UnhealthyConditions contains a list of the conditions that determine whether a node is considered unhealthy. The conditions are combined in a logical OR, i.e. if any of the conditions is met, the node is unhealthy.",
557 "maxUnhealthy": "Any farther remediation is only allowed if at most \"MaxUnhealthy\" machines selected by \"selector\" are not healthy. Expects either a postive integer value or a percentage value. Percentage values must be positive whole numbers and are capped at 100%. Both 0 and 0% are valid and will block all remediation.",
558 "nodeStartupTimeout": "Machines older than this duration without a node will be considered to have failed and will be remediated. To prevent Machines without Nodes from being removed, disable startup checks by setting this value explicitly to \"0\". Expects an unsigned duration string of decimal numbers each with optional fraction and a unit suffix, eg \"300ms\", \"1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".",
559 "remediationTemplate": "RemediationTemplate is a reference to a remediation template provided by an infrastructure provider.\n\nThis field is completely optional, when filled, the MachineHealthCheck controller creates a new object from the template referenced and hands off remediation of the machine to a controller that lives outside of Machine API Operator.",
560 }
561
562 func (MachineHealthCheckSpec) SwaggerDoc() map[string]string {
563 return map_MachineHealthCheckSpec
564 }
565
566 var map_MachineHealthCheckStatus = map[string]string{
567 "": "MachineHealthCheckStatus defines the observed state of MachineHealthCheck",
568 "expectedMachines": "total number of machines counted by this machine health check",
569 "currentHealthy": "total number of machines counted by this machine health check",
570 "remediationsAllowed": "RemediationsAllowed is the number of further remediations allowed by this machine health check before maxUnhealthy short circuiting will be applied",
571 "conditions": "Conditions defines the current state of the MachineHealthCheck",
572 }
573
574 func (MachineHealthCheckStatus) SwaggerDoc() map[string]string {
575 return map_MachineHealthCheckStatus
576 }
577
578 var map_UnhealthyCondition = map[string]string{
579 "": "UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration. When the named condition has been in the given status for at least the timeout value, a node is considered unhealthy.",
580 "timeout": "Expects an unsigned duration string of decimal numbers each with optional fraction and a unit suffix, eg \"300ms\", \"1.5h\" or \"2h45m\". Valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".",
581 }
582
583 func (UnhealthyCondition) SwaggerDoc() map[string]string {
584 return map_UnhealthyCondition
585 }
586
587 var map_MachineSet = map[string]string{
588 "": "MachineSet ensures that a specified number of machines replicas are running at any given time. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
589 "metadata": "metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
590 }
591
592 func (MachineSet) SwaggerDoc() map[string]string {
593 return map_MachineSet
594 }
595
596 var map_MachineSetList = map[string]string{
597 "": "MachineSetList contains a list of MachineSet Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
598 "metadata": "metadata is the standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
599 }
600
601 func (MachineSetList) SwaggerDoc() map[string]string {
602 return map_MachineSetList
603 }
604
605 var map_MachineSetSpec = map[string]string{
606 "": "MachineSetSpec defines the desired state of MachineSet",
607 "replicas": "Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1.",
608 "minReadySeconds": "MinReadySeconds is the minimum number of seconds for which a newly created machine should be ready. Defaults to 0 (machine will be considered available as soon as it is ready)",
609 "deletePolicy": "DeletePolicy defines the policy used to identify nodes to delete when downscaling. Defaults to \"Random\". Valid values are \"Random, \"Newest\", \"Oldest\"",
610 "selector": "Selector is a label query over machines that should match the replica count. Label keys and values that must match in order to be controlled by this MachineSet. It must match the machine template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors",
611 "template": "Template is the object that describes the machine that will be created if insufficient replicas are detected.",
612 }
613
614 func (MachineSetSpec) SwaggerDoc() map[string]string {
615 return map_MachineSetSpec
616 }
617
618 var map_MachineSetStatus = map[string]string{
619 "": "MachineSetStatus defines the observed state of MachineSet",
620 "replicas": "Replicas is the most recently observed number of replicas.",
621 "fullyLabeledReplicas": "The number of replicas that have labels matching the labels of the machine template of the MachineSet.",
622 "readyReplicas": "The number of ready replicas for this MachineSet. A machine is considered ready when the node has been created and is \"Ready\".",
623 "availableReplicas": "The number of available replicas (ready for at least minReadySeconds) for this MachineSet.",
624 "observedGeneration": "ObservedGeneration reflects the generation of the most recently observed MachineSet.",
625 "errorReason": "In the event that there is a terminal problem reconciling the replicas, both ErrorReason and ErrorMessage will be set. ErrorReason will be populated with a succinct value suitable for machine interpretation, while ErrorMessage will contain a more verbose string suitable for logging and human consumption.\n\nThese fields should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the MachineTemplate's spec or the configuration of the machine controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the machine controller, or the responsible machine controller itself being critically misconfigured.\n\nAny transient errors that occur during the reconciliation of Machines can be added as events to the MachineSet object and/or logged in the controller's output.",
626 }
627
628 func (MachineSetStatus) SwaggerDoc() map[string]string {
629 return map_MachineSetStatus
630 }
631
632 var map_MachineTemplateSpec = map[string]string{
633 "": "MachineTemplateSpec describes the data needed to create a Machine from a template",
634 "metadata": "Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
635 "spec": "Specification of the desired behavior of the machine. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
636 }
637
638 func (MachineTemplateSpec) SwaggerDoc() map[string]string {
639 return map_MachineTemplateSpec
640 }
641
642 var map_Condition = map[string]string{
643 "": "Condition defines an observation of a Machine API resource operational state.",
644 "type": "Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.",
645 "status": "Status of the condition, one of True, False, Unknown.",
646 "severity": "Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.",
647 "lastTransitionTime": "Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
648 "reason": "The reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.",
649 "message": "A human readable message indicating details about the transition. This field may be empty.",
650 }
651
652 func (Condition) SwaggerDoc() map[string]string {
653 return map_Condition
654 }
655
656 var map_ObjectMeta = map[string]string{
657 "": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. This is a copy of customizable fields from metav1.ObjectMeta.\n\nObjectMeta is embedded in `Machine.Spec`, `MachineDeployment.Template` and `MachineSet.Template`, which are not top-level Kubernetes objects. Given that metav1.ObjectMeta has lots of special cases and read-only fields which end up in the generated CRD validation, having it as a subset simplifies the API and some issues that can impact user experience.\n\nDuring the [upgrade to controller-tools@v2](https://github.com/kubernetes-sigs/cluster-api/pull/1054) for v1alpha2, we noticed a failure would occur running Cluster API test suite against the new CRDs, specifically `spec.metadata.creationTimestamp in body must be of type string: \"null\"`. The investigation showed that `controller-tools@v2` behaves differently than its previous version when handling types from [metav1](k8s.io/apimachinery/pkg/apis/meta/v1) package.\n\nIn more details, we found that embedded (non-top level) types that embedded `metav1.ObjectMeta` had validation properties, including for `creationTimestamp` (metav1.Time). The `metav1.Time` type specifies a custom json marshaller that, when IsZero() is true, returns `null` which breaks validation because the field isn't marked as nullable.\n\nIn future versions, controller-tools@v2 might allow overriding the type and validation for embedded types. When that happens, this hack should be revisited.",
658 "name": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names",
659 "generateName": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
660 "namespace": "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces",
661 "labels": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels",
662 "annotations": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations",
663 "ownerReferences": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
664 }
665
666 func (ObjectMeta) SwaggerDoc() map[string]string {
667 return map_ObjectMeta
668 }
669
670 var map_ProviderSpec = map[string]string{
671 "": "ProviderSpec defines the configuration to use during node creation.",
672 "value": "Value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config.",
673 }
674
675 func (ProviderSpec) SwaggerDoc() map[string]string {
676 return map_ProviderSpec
677 }
678
679 var map_NetworkDeviceSpec = map[string]string{
680 "": "NetworkDeviceSpec defines the network configuration for a virtual machine's network device.",
681 "networkName": "NetworkName is the name of the vSphere network to which the device will be connected.",
682 }
683
684 func (NetworkDeviceSpec) SwaggerDoc() map[string]string {
685 return map_NetworkDeviceSpec
686 }
687
688 var map_NetworkSpec = map[string]string{
689 "": "NetworkSpec defines the virtual machine's network configuration.",
690 "devices": "Devices defines the virtual machine's network interfaces.",
691 }
692
693 func (NetworkSpec) SwaggerDoc() map[string]string {
694 return map_NetworkSpec
695 }
696
697 var map_VSphereMachineProviderSpec = map[string]string{
698 "": "VSphereMachineProviderSpec is the type that will be embedded in a Machine.Spec.ProviderSpec field for an VSphere virtual machine. It is used by the vSphere machine actuator to create a single Machine. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
699 "userDataSecret": "UserDataSecret contains a local reference to a secret that contains the UserData to apply to the instance",
700 "credentialsSecret": "CredentialsSecret is a reference to the secret with vSphere credentials.",
701 "template": "Template is the name, inventory path, or instance UUID of the template used to clone new machines.",
702 "workspace": "Workspace describes the workspace to use for the machine.",
703 "network": "Network is the network configuration for this machine's VM.",
704 "numCPUs": "NumCPUs is the number of virtual processors in a virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.",
705 "numCoresPerSocket": "NumCPUs is the number of cores among which to distribute CPUs in this virtual machine. Defaults to the analogue property value in the template from which this machine is cloned.",
706 "memoryMiB": "MemoryMiB is the size of a virtual machine's memory, in MiB. Defaults to the analogue property value in the template from which this machine is cloned.",
707 "diskGiB": "DiskGiB is the size of a virtual machine's disk, in GiB. Defaults to the analogue property value in the template from which this machine is cloned. This parameter will be ignored if 'LinkedClone' CloneMode is set.",
708 "snapshot": "Snapshot is the name of the snapshot from which the VM was cloned",
709 "cloneMode": "CloneMode specifies the type of clone operation. The LinkedClone mode is only support for templates that have at least one snapshot. If the template has no snapshots, then CloneMode defaults to FullClone. When LinkedClone mode is enabled the DiskGiB field is ignored as it is not possible to expand disks of linked clones. Defaults to FullClone. When using LinkedClone, if no snapshots exist for the source template, falls back to FullClone.",
710 }
711
712 func (VSphereMachineProviderSpec) SwaggerDoc() map[string]string {
713 return map_VSphereMachineProviderSpec
714 }
715
716 var map_VSphereMachineProviderStatus = map[string]string{
717 "": "VSphereMachineProviderStatus is the type that will be embedded in a Machine.Status.ProviderStatus field. It contains VSphere-specific status information. Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).",
718 "instanceId": "InstanceID is the ID of the instance in VSphere",
719 "instanceState": "InstanceState is the provisioning state of the VSphere Instance.",
720 "conditions": "Conditions is a set of conditions associated with the Machine to indicate errors or other status",
721 "taskRef": "TaskRef is a managed object reference to a Task related to the machine. This value is set automatically at runtime and should not be set or modified by users.",
722 }
723
724 func (VSphereMachineProviderStatus) SwaggerDoc() map[string]string {
725 return map_VSphereMachineProviderStatus
726 }
727
728 var map_Workspace = map[string]string{
729 "": "WorkspaceConfig defines a workspace configuration for the vSphere cloud provider.",
730 "server": "Server is the IP address or FQDN of the vSphere endpoint.",
731 "datacenter": "Datacenter is the datacenter in which VMs are created/located.",
732 "folder": "Folder is the folder in which VMs are created/located.",
733 "datastore": "Datastore is the datastore in which VMs are created/located.",
734 "resourcePool": "ResourcePool is the resource pool in which VMs are created/located.",
735 }
736
737 func (Workspace) SwaggerDoc() map[string]string {
738 return map_Workspace
739 }
740
741
742
View as plain text