github.com/giantswarm/apiextensions/v2@v2.6.2/config/crd/v1beta1/infrastructure.cluster.x-k8s.io_azureclusters.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: azureclusters.infrastructure.cluster.x-k8s.io
    10  spec:
    11    additionalPrinterColumns:
    12    - JSONPath: .metadata.labels.cluster\.x-k8s\.io/cluster-name
    13      description: Cluster to which this AzureCluster belongs
    14      name: Cluster
    15      type: string
    16    - JSONPath: .status.ready
    17      name: Ready
    18      type: boolean
    19    - JSONPath: .spec.resourceGroup
    20      name: Resource Group
    21      priority: 1
    22      type: string
    23    - JSONPath: .spec.subscriptionID
    24      name: SubscriptionID
    25      priority: 1
    26      type: string
    27    - JSONPath: .spec.location
    28      name: Location
    29      priority: 1
    30      type: string
    31    - JSONPath: .spec.controlPlaneEndpoint.host
    32      description: Control Plane Endpoint
    33      name: Endpoint
    34      priority: 1
    35      type: string
    36    group: infrastructure.cluster.x-k8s.io
    37    names:
    38      categories:
    39      - cluster-api
    40      kind: AzureCluster
    41      listKind: AzureClusterList
    42      plural: azureclusters
    43      singular: azurecluster
    44    scope: Namespaced
    45    subresources:
    46      status: {}
    47    validation:
    48      openAPIV3Schema:
    49        description: AzureCluster is the Schema for the azureclusters API
    50        properties:
    51          apiVersion:
    52            description: 'APIVersion defines the versioned schema of this representation
    53              of an object. Servers should convert recognized schemas to the latest
    54              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
    55            type: string
    56          kind:
    57            description: 'Kind is a string value representing the REST resource this
    58              object represents. Servers may infer this from the endpoint the client
    59              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    60            type: string
    61          metadata:
    62            type: object
    63          spec:
    64            description: AzureClusterSpec defines the desired state of AzureCluster
    65            properties:
    66              additionalTags:
    67                additionalProperties:
    68                  type: string
    69                description: AdditionalTags is an optional set of tags to add to Azure
    70                  resources managed by the Azure provider, in addition to the ones added
    71                  by default.
    72                type: object
    73              controlPlaneEndpoint:
    74                description: ControlPlaneEndpoint represents the endpoint used to communicate
    75                  with the control plane.
    76                properties:
    77                  host:
    78                    description: The hostname on which the API server is serving.
    79                    type: string
    80                  port:
    81                    description: The port on which the API server is serving.
    82                    format: int32
    83                    type: integer
    84                required:
    85                - host
    86                - port
    87                type: object
    88              location:
    89                type: string
    90              networkSpec:
    91                description: NetworkSpec encapsulates all things related to Azure network.
    92                properties:
    93                  subnets:
    94                    description: Subnets is the configuration for the control-plane
    95                      subnet and the node subnet.
    96                    items:
    97                      description: SubnetSpec configures an Azure subnet.
    98                      properties:
    99                        cidrBlock:
   100                          description: CidrBlock is the CIDR block to be used when the
   101                            provider creates a managed Vnet.
   102                          type: string
   103                        id:
   104                          description: ID defines a unique identifier to reference this
   105                            resource.
   106                          type: string
   107                        internalLBIPAddress:
   108                          description: InternalLBIPAddress is the IP address that will
   109                            be used as the internal LB private IP. For the control plane
   110                            subnet only.
   111                          type: string
   112                        name:
   113                          description: Name defines a name for the subnet resource.
   114                          type: string
   115                        role:
   116                          description: Role defines the subnet role (eg. Node, ControlPlane)
   117                          type: string
   118                        routeTable:
   119                          description: RouteTable defines the route table that should
   120                            be attached to this subnet.
   121                          properties:
   122                            id:
   123                              type: string
   124                            name:
   125                              type: string
   126                          type: object
   127                        securityGroup:
   128                          description: SecurityGroup defines the NSG (network security
   129                            group) that should be attached to this subnet.
   130                          properties:
   131                            id:
   132                              type: string
   133                            ingressRule:
   134                              description: IngressRules is a slice of Azure ingress
   135                                rules for security groups.
   136                              items:
   137                                description: IngressRule defines an Azure ingress rule
   138                                  for security groups.
   139                                properties:
   140                                  description:
   141                                    type: string
   142                                  destination:
   143                                    description: Destination - The destination address
   144                                      prefix. CIDR or destination IP range. Asterix
   145                                      '*' can also be used to match all source IPs.
   146                                      Default tags such as 'VirtualNetwork', 'AzureLoadBalancer'
   147                                      and 'Internet' can also be used.
   148                                    type: string
   149                                  destinationPorts:
   150                                    description: DestinationPorts - The destination
   151                                      port or range. Integer or range between 0 and
   152                                      65535. Asterix '*' can also be used to match all
   153                                      ports.
   154                                    type: string
   155                                  name:
   156                                    type: string
   157                                  priority:
   158                                    description: Priority - A number between 100 and
   159                                      4096. Each rule should have a unique value for
   160                                      priority. Rules are processed in priority order,
   161                                      with lower numbers processed before higher numbers.
   162                                      Once traffic matches a rule, processing stops.
   163                                    format: int32
   164                                    type: integer
   165                                  protocol:
   166                                    description: SecurityGroupProtocol defines the protocol
   167                                      type for a security group rule.
   168                                    type: string
   169                                  source:
   170                                    description: Source - The CIDR or source IP range.
   171                                      Asterix '*' can also be used to match all source
   172                                      IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer'
   173                                      and 'Internet' can also be used. If this is an
   174                                      ingress rule, specifies where network traffic
   175                                      originates from.
   176                                    type: string
   177                                  sourcePorts:
   178                                    description: SourcePorts - The source port or range.
   179                                      Integer or range between 0 and 65535. Asterix
   180                                      '*' can also be used to match all ports.
   181                                    type: string
   182                                required:
   183                                - description
   184                                - name
   185                                - protocol
   186                                type: object
   187                              type: array
   188                            name:
   189                              type: string
   190                            tags:
   191                              additionalProperties:
   192                                type: string
   193                              description: Tags defines a map of tags.
   194                              type: object
   195                          type: object
   196                      required:
   197                      - name
   198                      type: object
   199                    type: array
   200                  vnet:
   201                    description: Vnet is the configuration for the Azure virtual network.
   202                    properties:
   203                      cidrBlock:
   204                        description: CidrBlock is the CIDR block to be used when the
   205                          provider creates a managed virtual network.
   206                        type: string
   207                      id:
   208                        description: ID is the identifier of the virtual network this
   209                          provider should use to create resources.
   210                        type: string
   211                      name:
   212                        description: Name defines a name for the virtual network resource.
   213                        type: string
   214                      resourceGroup:
   215                        description: ResourceGroup is the name of the resource group
   216                          of the existing virtual network or the resource group where
   217                          a managed virtual network should be created.
   218                        type: string
   219                      tags:
   220                        additionalProperties:
   221                          type: string
   222                        description: Tags is a collection of tags describing the resource.
   223                        type: object
   224                    required:
   225                    - name
   226                    type: object
   227                type: object
   228              resourceGroup:
   229                type: string
   230              subscriptionID:
   231                type: string
   232            required:
   233            - location
   234            type: object
   235          status:
   236            description: AzureClusterStatus defines the observed state of AzureCluster
   237            properties:
   238              bastion:
   239                description: VM describes an Azure virtual machine.
   240                properties:
   241                  addresses:
   242                    description: Addresses contains the addresses associated with the
   243                      Azure VM.
   244                    items:
   245                      description: NodeAddress contains information for the node's address.
   246                      properties:
   247                        address:
   248                          description: The node address.
   249                          type: string
   250                        type:
   251                          description: Node address type, one of Hostname, ExternalIP
   252                            or InternalIP.
   253                          type: string
   254                      required:
   255                      - address
   256                      - type
   257                      type: object
   258                    type: array
   259                  availabilityZone:
   260                    type: string
   261                  id:
   262                    type: string
   263                  identity:
   264                    description: VMIdentity defines the identity of the virtual machine,
   265                      if configured.
   266                    enum:
   267                    - None
   268                    - SystemAssigned
   269                    - UserAssigned
   270                    type: string
   271                  image:
   272                    description: Storage profile
   273                    properties:
   274                      id:
   275                        description: ID specifies an image to use by ID
   276                        type: string
   277                      marketplace:
   278                        description: Marketplace specifies an image to use from the
   279                          Azure Marketplace
   280                        properties:
   281                          offer:
   282                            description: Offer specifies the name of a group of related
   283                              images created by the publisher. For example, UbuntuServer,
   284                              WindowsServer
   285                            minLength: 1
   286                            type: string
   287                          publisher:
   288                            description: Publisher is the name of the organization that
   289                              created the image
   290                            minLength: 1
   291                            type: string
   292                          sku:
   293                            description: SKU specifies an instance of an offer, such
   294                              as a major release of a distribution. For example, 18.04-LTS,
   295                              2019-Datacenter
   296                            minLength: 1
   297                            type: string
   298                          version:
   299                            description: Version specifies the version of an image sku.
   300                              The allowed formats are Major.Minor.Build or 'latest'.
   301                              Major, Minor, and Build are decimal numbers. Specify 'latest'
   302                              to use the latest version of an image available at deploy
   303                              time. Even if you use 'latest', the VM image will not
   304                              automatically update after deploy time even if a new version
   305                              becomes available.
   306                            minLength: 1
   307                            type: string
   308                        required:
   309                        - offer
   310                        - publisher
   311                        - sku
   312                        - version
   313                        type: object
   314                      sharedGallery:
   315                        description: SharedGallery specifies an image to use from an
   316                          Azure Shared Image Gallery
   317                        properties:
   318                          gallery:
   319                            description: Gallery specifies the name of the shared image
   320                              gallery that contains the image
   321                            minLength: 1
   322                            type: string
   323                          name:
   324                            description: Name is the name of the image
   325                            minLength: 1
   326                            type: string
   327                          resourceGroup:
   328                            description: ResourceGroup specifies the resource group
   329                              containing the shared image gallery
   330                            minLength: 1
   331                            type: string
   332                          subscriptionID:
   333                            description: SubscriptionID is the identifier of the subscription
   334                              that contains the shared image gallery
   335                            minLength: 1
   336                            type: string
   337                          version:
   338                            description: Version specifies the version of the marketplace
   339                              image. The allowed formats are Major.Minor.Build or 'latest'.
   340                              Major, Minor, and Build are decimal numbers. Specify 'latest'
   341                              to use the latest version of an image available at deploy
   342                              time. Even if you use 'latest', the VM image will not
   343                              automatically update after deploy time even if a new version
   344                              becomes available.
   345                            minLength: 1
   346                            type: string
   347                        required:
   348                        - gallery
   349                        - name
   350                        - resourceGroup
   351                        - subscriptionID
   352                        - version
   353                        type: object
   354                    type: object
   355                  name:
   356                    type: string
   357                  osDisk:
   358                    description: OSDisk defines the operating system disk for a VM.
   359                    properties:
   360                      diffDiskSettings:
   361                        description: DiffDiskSettings describe ephemeral disk settings
   362                          for the os disk.
   363                        properties:
   364                          option:
   365                            description: Option enables ephemeral OS when set to "Local"
   366                              See https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks
   367                              for full details
   368                            enum:
   369                            - Local
   370                            type: string
   371                        required:
   372                        - option
   373                        type: object
   374                      diskSizeGB:
   375                        format: int32
   376                        type: integer
   377                      managedDisk:
   378                        description: ManagedDisk defines the managed disk options for
   379                          a VM.
   380                        properties:
   381                          storageAccountType:
   382                            type: string
   383                        required:
   384                        - storageAccountType
   385                        type: object
   386                      osType:
   387                        type: string
   388                    required:
   389                    - diskSizeGB
   390                    - managedDisk
   391                    - osType
   392                    type: object
   393                  startupScript:
   394                    type: string
   395                  tags:
   396                    additionalProperties:
   397                      type: string
   398                    description: Tags defines a map of tags.
   399                    type: object
   400                  vmSize:
   401                    description: Hardware profile
   402                    type: string
   403                  vmState:
   404                    description: State - The provisioning state, which only appears
   405                      in the response.
   406                    type: string
   407                type: object
   408              conditions:
   409                description: Conditions defines current service state of the AzureCluster.
   410                items:
   411                  description: Condition defines an observation of a Cluster API resource
   412                    operational state.
   413                  properties:
   414                    lastTransitionTime:
   415                      description: Last time the condition transitioned from one status
   416                        to another. This should be when the underlying condition changed.
   417                        If that is not known, then using the time when the API field
   418                        changed is acceptable.
   419                      format: date-time
   420                      type: string
   421                    message:
   422                      description: A human readable message indicating details about
   423                        the transition. This field may be empty.
   424                      type: string
   425                    reason:
   426                      description: The reason for the condition's last transition in
   427                        CamelCase. The specific API may choose whether or not this field
   428                        is considered a guaranteed API. This field may not be empty.
   429                      type: string
   430                    severity:
   431                      description: Severity provides an explicit classification of Reason
   432                        code, so the users or machines can immediately understand the
   433                        current situation and act accordingly. The Severity field MUST
   434                        be set only when Status=False.
   435                      type: string
   436                    status:
   437                      description: Status of the condition, one of True, False, Unknown.
   438                      type: string
   439                    type:
   440                      description: Type of condition in CamelCase or in foo.example.com/CamelCase.
   441                        Many .condition.type values are consistent across resources
   442                        like Available, but because arbitrary conditions can be useful
   443                        (see .node.status.conditions), the ability to deconflict is
   444                        important.
   445                      type: string
   446                  required:
   447                  - status
   448                  - type
   449                  type: object
   450                type: array
   451              failureDomains:
   452                additionalProperties:
   453                  description: FailureDomainSpec is the Schema for Cluster API failure
   454                    domains. It allows controllers to understand how many failure domains
   455                    a cluster can optionally span across.
   456                  properties:
   457                    attributes:
   458                      additionalProperties:
   459                        type: string
   460                      description: Attributes is a free form map of attributes an infrastructure
   461                        provider might use or require.
   462                      type: object
   463                    controlPlane:
   464                      description: ControlPlane determines if this failure domain is
   465                        suitable for use by control plane machines.
   466                      type: boolean
   467                  type: object
   468                description: 'FailureDomains specifies the list of unique failure domains
   469                  for the location/region of the cluster. A FailureDomain maps to Availability
   470                  Zone with an Azure Region (if the region support them). An Availability
   471                  Zone is a separate data center within a region and they can be used
   472                  to ensure the cluster is more resilient to failure. See: https://docs.microsoft.com/en-us/azure/availability-zones/az-overview
   473                  This list will be used by Cluster API to try and spread the machines
   474                  across the failure domains.'
   475                type: object
   476              network:
   477                description: Network encapsulates the state of Azure networking resources.
   478                properties:
   479                  apiServerIp:
   480                    description: APIServerIP is the Kubernetes API server public IP
   481                      address.
   482                    properties:
   483                      dnsName:
   484                        type: string
   485                      id:
   486                        type: string
   487                      ipAddress:
   488                        type: string
   489                      name:
   490                        type: string
   491                    type: object
   492                  apiServerLb:
   493                    description: APIServerLB is the Kubernetes API server load balancer.
   494                    properties:
   495                      backendPool:
   496                        description: BackendPool defines a load balancer backend pool
   497                        properties:
   498                          id:
   499                            type: string
   500                          name:
   501                            type: string
   502                        type: object
   503                      frontendIpConfig:
   504                        description: FrontendIPConfig - DO NOT USE this empty struct
   505                          is here to preserve backwards compatibility and should be
   506                          removed in v1alpha4
   507                        type: object
   508                      id:
   509                        type: string
   510                      name:
   511                        type: string
   512                      sku:
   513                        description: SKU defines an Azure load balancer SKU.
   514                        type: string
   515                      tags:
   516                        additionalProperties:
   517                          type: string
   518                        description: Tags defines a map of tags.
   519                        type: object
   520                    type: object
   521                type: object
   522              ready:
   523                description: Ready is true when the provider resource is ready.
   524                type: boolean
   525            type: object
   526        type: object
   527    version: v1alpha3
   528    versions:
   529    - name: v1alpha3
   530      served: true
   531      storage: true
   532  status:
   533    acceptedNames:
   534      kind: ""
   535      plural: ""
   536    conditions: []
   537    storedVersions: []