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

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