github.com/giantswarm/apiextensions/v2@v2.6.2/config/crd/v1beta1/infrastructure.cluster.x-k8s.io_azuremachines.yaml (about)

     1  
     2  ---
     3  apiVersion: apiextensions.k8s.io/v1beta1
     4  kind: CustomResourceDefinition
     5  metadata:
     6    annotations:
     7      controller-gen.kubebuilder.io/version: v0.2.4
     8    creationTimestamp: null
     9    name: azuremachines.infrastructure.cluster.x-k8s.io
    10  spec:
    11    additionalPrinterColumns:
    12    - JSONPath: .status.ready
    13      description: AzureMachine ready status
    14      name: Ready
    15      type: string
    16    - JSONPath: .status.vmState
    17      description: Azure VM provisioning state
    18      name: State
    19      type: string
    20    - JSONPath: .metadata.labels.cluster\.x-k8s\.io/cluster-name
    21      description: Cluster to which this AzureMachine belongs
    22      name: Cluster
    23      priority: 1
    24      type: string
    25    - JSONPath: .metadata.ownerReferences[?(@.kind=="Machine")].name
    26      description: Machine object to which this AzureMachine belongs
    27      name: Machine
    28      priority: 1
    29      type: string
    30    - JSONPath: .spec.providerID
    31      description: Azure VM ID
    32      name: VM ID
    33      priority: 1
    34      type: string
    35    - JSONPath: .spec.vmSize
    36      description: Azure VM Size
    37      name: VM Size
    38      priority: 1
    39      type: string
    40    group: infrastructure.cluster.x-k8s.io
    41    names:
    42      categories:
    43      - cluster-api
    44      kind: AzureMachine
    45      listKind: AzureMachineList
    46      plural: azuremachines
    47      singular: azuremachine
    48    scope: Namespaced
    49    subresources:
    50      status: {}
    51    validation:
    52      openAPIV3Schema:
    53        description: AzureMachine is the Schema for the azuremachines API
    54        properties:
    55          apiVersion:
    56            description: 'APIVersion defines the versioned schema of this representation
    57              of an object. Servers should convert recognized schemas to the latest
    58              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
    59            type: string
    60          kind:
    61            description: 'Kind is a string value representing the REST resource this
    62              object represents. Servers may infer this from the endpoint the client
    63              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    64            type: string
    65          metadata:
    66            type: object
    67          spec:
    68            description: AzureMachineSpec defines the desired state of AzureMachine
    69            properties:
    70              acceleratedNetworking:
    71                description: AcceleratedNetworking enables or disables Azure accelerated
    72                  networking. If omitted, it will be set based on whether the requested
    73                  VMSize supports accelerated networking. If AcceleratedNetworking is
    74                  set to true with a VMSize that does not support it, Azure will return
    75                  an error.
    76                type: boolean
    77              additionalTags:
    78                additionalProperties:
    79                  type: string
    80                description: AdditionalTags is an optional set of tags to add to an
    81                  instance, in addition to the ones added by default by the Azure provider.
    82                  If both the AzureCluster and the AzureMachine specify the same tag
    83                  name with different values, the AzureMachine's value takes precedence.
    84                type: object
    85              allocatePublicIP:
    86                description: AllocatePublicIP allows the ability to create dynamic public
    87                  ips for machines where this value is true.
    88                type: boolean
    89              availabilityZone:
    90                description: 'DEPRECATED: use FailureDomain instead'
    91                properties:
    92                  enabled:
    93                    type: boolean
    94                  id:
    95                    type: string
    96                type: object
    97              dataDisks:
    98                description: DataDisk specifies the parameters that are used to add
    99                  one or more data disks to the machine
   100                items:
   101                  description: DataDisk specifies the parameters that are used to add
   102                    one or more data disks to the machine.
   103                  properties:
   104                    diskSizeGB:
   105                      description: DiskSizeGB is the size in GB to assign to the data
   106                        disk.
   107                      format: int32
   108                      type: integer
   109                    lun:
   110                      description: Lun Specifies the logical unit number of the data
   111                        disk. This value is used to identify data disks within the VM
   112                        and therefore must be unique for each data disk attached to
   113                        a VM. The value must be between 0 and 63.
   114                      format: int32
   115                      type: integer
   116                    nameSuffix:
   117                      description: NameSuffix is the suffix to be appended to the machine
   118                        name to generate the disk name. Each disk name will be in format
   119                        <machineName>_<nameSuffix>.
   120                      type: string
   121                  required:
   122                  - diskSizeGB
   123                  - nameSuffix
   124                  type: object
   125                type: array
   126              failureDomain:
   127                description: FailureDomain is the failure domain unique identifier this
   128                  Machine should be attached to, as defined in Cluster API. This relates
   129                  to an Azure Availability Zone
   130                type: string
   131              identity:
   132                default: None
   133                description: Identity is the type of identity used for the virtual machine.
   134                  The type 'SystemAssigned' is an implicitly created identity. The generated
   135                  identity will be assigned a Subscription contributor role. The type
   136                  'UserAssigned' is a standalone Azure resource provided by the user
   137                  and assigned to the VM
   138                enum:
   139                - None
   140                - SystemAssigned
   141                - UserAssigned
   142                type: string
   143              image:
   144                description: Image is used to provide details of an image to use during
   145                  VM creation. If image details are omitted the image will default the
   146                  Azure Marketplace "capi" offer, which is based on Ubuntu.
   147                properties:
   148                  id:
   149                    description: ID specifies an image to use by ID
   150                    type: string
   151                  marketplace:
   152                    description: Marketplace specifies an image to use from the Azure
   153                      Marketplace
   154                    properties:
   155                      offer:
   156                        description: Offer specifies the name of a group of related
   157                          images created by the publisher. For example, UbuntuServer,
   158                          WindowsServer
   159                        minLength: 1
   160                        type: string
   161                      publisher:
   162                        description: Publisher is the name of the organization that
   163                          created the image
   164                        minLength: 1
   165                        type: string
   166                      sku:
   167                        description: SKU specifies an instance of an offer, such as
   168                          a major release of a distribution. For example, 18.04-LTS,
   169                          2019-Datacenter
   170                        minLength: 1
   171                        type: string
   172                      version:
   173                        description: Version specifies the version of an image sku.
   174                          The allowed formats are Major.Minor.Build or 'latest'. Major,
   175                          Minor, and Build are decimal numbers. Specify 'latest' to
   176                          use the latest version of an image available at deploy time.
   177                          Even if you use 'latest', the VM image will not automatically
   178                          update after deploy time even if a new version becomes available.
   179                        minLength: 1
   180                        type: string
   181                    required:
   182                    - offer
   183                    - publisher
   184                    - sku
   185                    - version
   186                    type: object
   187                  sharedGallery:
   188                    description: SharedGallery specifies an image to use from an Azure
   189                      Shared Image Gallery
   190                    properties:
   191                      gallery:
   192                        description: Gallery specifies the name of the shared image
   193                          gallery that contains the image
   194                        minLength: 1
   195                        type: string
   196                      name:
   197                        description: Name is the name of the image
   198                        minLength: 1
   199                        type: string
   200                      resourceGroup:
   201                        description: ResourceGroup specifies the resource group containing
   202                          the shared image gallery
   203                        minLength: 1
   204                        type: string
   205                      subscriptionID:
   206                        description: SubscriptionID is the identifier of the subscription
   207                          that contains the shared image gallery
   208                        minLength: 1
   209                        type: string
   210                      version:
   211                        description: Version specifies the version of the marketplace
   212                          image. The allowed formats are Major.Minor.Build or 'latest'.
   213                          Major, Minor, and Build are decimal numbers. Specify 'latest'
   214                          to use the latest version of an image available at deploy
   215                          time. Even if you use 'latest', the VM image will not automatically
   216                          update after deploy time even if a new version becomes available.
   217                        minLength: 1
   218                        type: string
   219                    required:
   220                    - gallery
   221                    - name
   222                    - resourceGroup
   223                    - subscriptionID
   224                    - version
   225                    type: object
   226                type: object
   227              location:
   228                type: string
   229              osDisk:
   230                description: OSDisk specifies the parameters for the operating system
   231                  disk of the machine
   232                properties:
   233                  diffDiskSettings:
   234                    description: DiffDiskSettings describe ephemeral disk settings for
   235                      the os disk.
   236                    properties:
   237                      option:
   238                        description: Option enables ephemeral OS when set to "Local"
   239                          See https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks
   240                          for full details
   241                        enum:
   242                        - Local
   243                        type: string
   244                    required:
   245                    - option
   246                    type: object
   247                  diskSizeGB:
   248                    format: int32
   249                    type: integer
   250                  managedDisk:
   251                    description: ManagedDisk defines the managed disk options for a
   252                      VM.
   253                    properties:
   254                      storageAccountType:
   255                        type: string
   256                    required:
   257                    - storageAccountType
   258                    type: object
   259                  osType:
   260                    type: string
   261                required:
   262                - diskSizeGB
   263                - managedDisk
   264                - osType
   265                type: object
   266              providerID:
   267                description: ProviderID is the unique identifier as specified by the
   268                  cloud provider.
   269                type: string
   270              spotVMOptions:
   271                description: SpotVMOptions allows the ability to specify the Machine
   272                  should use a Spot VM
   273                properties:
   274                  maxPrice:
   275                    description: MaxPrice defines the maximum price the user is willing
   276                      to pay for Spot VM instances
   277                    type: number
   278                type: object
   279              sshPublicKey:
   280                type: string
   281              userAssignedIdentities:
   282                description: UserAssignedIdentities is a list of standalone Azure identities
   283                  provided by the user The lifecycle of a user-assigned identity is
   284                  managed separately from the lifecycle of the AzureMachine.
   285                items:
   286                  description: UserAssignedIdentity defines the user-assigned identities
   287                    provided by the user to be assigned to Azure resources.
   288                  properties:
   289                    providerID:
   290                      description: 'ProviderID is the identification ID of the user-assigned
   291                        Identity, the format of an identity is: ''azure:///subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'''
   292                      type: string
   293                  required:
   294                  - providerID
   295                  type: object
   296                type: array
   297              vmSize:
   298                type: string
   299            required:
   300            - location
   301            - osDisk
   302            - sshPublicKey
   303            - vmSize
   304            type: object
   305          status:
   306            description: AzureMachineStatus defines the observed state of AzureMachine
   307            properties:
   308              addresses:
   309                description: Addresses contains the Azure instance associated addresses.
   310                items:
   311                  description: NodeAddress contains information for the node's address.
   312                  properties:
   313                    address:
   314                      description: The node address.
   315                      type: string
   316                    type:
   317                      description: Node address type, one of Hostname, ExternalIP or
   318                        InternalIP.
   319                      type: string
   320                  required:
   321                  - address
   322                  - type
   323                  type: object
   324                type: array
   325              conditions:
   326                description: Conditions defines current service state of the AzureMachine.
   327                items:
   328                  description: Condition defines an observation of a Cluster API resource
   329                    operational state.
   330                  properties:
   331                    lastTransitionTime:
   332                      description: Last time the condition transitioned from one status
   333                        to another. This should be when the underlying condition changed.
   334                        If that is not known, then using the time when the API field
   335                        changed is acceptable.
   336                      format: date-time
   337                      type: string
   338                    message:
   339                      description: A human readable message indicating details about
   340                        the transition. This field may be empty.
   341                      type: string
   342                    reason:
   343                      description: The reason for the condition's last transition in
   344                        CamelCase. The specific API may choose whether or not this field
   345                        is considered a guaranteed API. This field may not be empty.
   346                      type: string
   347                    severity:
   348                      description: Severity provides an explicit classification of Reason
   349                        code, so the users or machines can immediately understand the
   350                        current situation and act accordingly. The Severity field MUST
   351                        be set only when Status=False.
   352                      type: string
   353                    status:
   354                      description: Status of the condition, one of True, False, Unknown.
   355                      type: string
   356                    type:
   357                      description: Type of condition in CamelCase or in foo.example.com/CamelCase.
   358                        Many .condition.type values are consistent across resources
   359                        like Available, but because arbitrary conditions can be useful
   360                        (see .node.status.conditions), the ability to deconflict is
   361                        important.
   362                      type: string
   363                  required:
   364                  - status
   365                  - type
   366                  type: object
   367                type: array
   368              failureMessage:
   369                description: "ErrorMessage will be set in the event that there is a
   370                  terminal problem reconciling the Machine and will contain a more verbose
   371                  string suitable for logging and human consumption. \n This field should
   372                  not be set for transitive errors that a controller faces that are
   373                  expected to be fixed automatically over time (like service outages),
   374                  but instead indicate that something is fundamentally wrong with the
   375                  Machine's spec or the configuration of the controller, and that manual
   376                  intervention is required. Examples of terminal errors would be invalid
   377                  combinations of settings in the spec, values that are unsupported
   378                  by the controller, or the responsible controller itself being critically
   379                  misconfigured. \n Any transient errors that occur during the reconciliation
   380                  of Machines can be added as events to the Machine object and/or logged
   381                  in the controller's output."
   382                type: string
   383              failureReason:
   384                description: "ErrorReason will be set in the event that there is a terminal
   385                  problem reconciling the Machine and will contain a succinct value
   386                  suitable for machine interpretation. \n This field should not be set
   387                  for transitive errors that a controller faces that are expected to
   388                  be fixed automatically over time (like service outages), but instead
   389                  indicate that something is fundamentally wrong with the Machine's
   390                  spec or the configuration of the controller, and that manual intervention
   391                  is required. Examples of terminal errors would be invalid combinations
   392                  of settings in the spec, values that are unsupported by the controller,
   393                  or the responsible controller itself being critically misconfigured.
   394                  \n Any transient errors that occur during the reconciliation of Machines
   395                  can be added as events to the Machine object and/or logged in the
   396                  controller's output."
   397                type: string
   398              ready:
   399                description: Ready is true when the provider resource is ready.
   400                type: boolean
   401              vmState:
   402                description: VMState is the provisioning state of the Azure virtual
   403                  machine.
   404                type: string
   405            type: object
   406        type: object
   407    version: v1alpha3
   408    versions:
   409    - name: v1alpha3
   410      served: true
   411      storage: true
   412  status:
   413    acceptedNames:
   414      kind: ""
   415      plural: ""
   416    conditions: []
   417    storedVersions: []