github.com/giantswarm/apiextensions/v2@v2.6.2/config/crd/v1beta1/cluster.x-k8s.io_clusters.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: clusters.cluster.x-k8s.io
    10  spec:
    11    additionalPrinterColumns:
    12    - JSONPath: .status.phase
    13      description: Cluster status such as Pending/Provisioning/Provisioned/Deleting/Failed
    14      name: Phase
    15      type: string
    16    group: cluster.x-k8s.io
    17    names:
    18      categories:
    19      - cluster-api
    20      kind: Cluster
    21      listKind: ClusterList
    22      plural: clusters
    23      shortNames:
    24      - cl
    25      singular: cluster
    26    scope: Namespaced
    27    subresources:
    28      status: {}
    29    version: v1alpha2
    30    versions:
    31    - name: v1alpha2
    32      schema:
    33        openAPIV3Schema:
    34          description: Cluster is the Schema for the clusters API
    35          properties:
    36            apiVersion:
    37              description: 'APIVersion defines the versioned schema of this representation
    38                of an object. Servers should convert recognized schemas to the latest
    39                internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
    40              type: string
    41            kind:
    42              description: 'Kind is a string value representing the REST resource this
    43                object represents. Servers may infer this from the endpoint the client
    44                submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    45              type: string
    46            metadata:
    47              type: object
    48            spec:
    49              description: ClusterSpec defines the desired state of Cluster
    50              properties:
    51                clusterNetwork:
    52                  description: Cluster network configuration
    53                  properties:
    54                    apiServerPort:
    55                      description: APIServerPort specifies the port the API Server should
    56                        bind to. Defaults to 6443.
    57                      format: int32
    58                      type: integer
    59                    pods:
    60                      description: The network ranges from which Pod networks are allocated.
    61                      properties:
    62                        cidrBlocks:
    63                          items:
    64                            type: string
    65                          type: array
    66                      required:
    67                      - cidrBlocks
    68                      type: object
    69                    serviceDomain:
    70                      description: Domain name for services.
    71                      type: string
    72                    services:
    73                      description: The network ranges from which service VIPs are allocated.
    74                      properties:
    75                        cidrBlocks:
    76                          items:
    77                            type: string
    78                          type: array
    79                      required:
    80                      - cidrBlocks
    81                      type: object
    82                  type: object
    83                infrastructureRef:
    84                  description: InfrastructureRef is a reference to a provider-specific
    85                    resource that holds the details for provisioning infrastructure
    86                    for a cluster in said provider.
    87                  properties:
    88                    apiVersion:
    89                      description: API version of the referent.
    90                      type: string
    91                    fieldPath:
    92                      description: 'If referring to a piece of an object instead of
    93                        an entire object, this string should contain a valid JSON/Go
    94                        field access statement, such as desiredState.manifest.containers[2].
    95                        For example, if the object reference is to a container within
    96                        a pod, this would take on a value like: "spec.containers{name}"
    97                        (where "name" refers to the name of the container that triggered
    98                        the event) or if no container name is specified "spec.containers[2]"
    99                        (container with index 2 in this pod). This syntax is chosen
   100                        only to have some well-defined way of referencing a part of
   101                        an object. TODO: this design is not final and this field is
   102                        subject to change in the future.'
   103                      type: string
   104                    kind:
   105                      description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
   106                      type: string
   107                    name:
   108                      description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   109                      type: string
   110                    namespace:
   111                      description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   112                      type: string
   113                    resourceVersion:
   114                      description: 'Specific resourceVersion to which this reference
   115                        is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
   116                      type: string
   117                    uid:
   118                      description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
   119                      type: string
   120                  type: object
   121              type: object
   122            status:
   123              description: ClusterStatus defines the observed state of Cluster
   124              properties:
   125                apiEndpoints:
   126                  description: APIEndpoints represents the endpoints to communicate
   127                    with the control plane.
   128                  items:
   129                    description: APIEndpoint represents a reachable Kubernetes API endpoint.
   130                    properties:
   131                      host:
   132                        description: The hostname on which the API server is serving.
   133                        type: string
   134                      port:
   135                        description: The port on which the API server is serving.
   136                        type: integer
   137                    required:
   138                    - host
   139                    - port
   140                    type: object
   141                  type: array
   142                controlPlaneInitialized:
   143                  description: ControlPlaneInitialized defines if the control plane
   144                    has been initialized.
   145                  type: boolean
   146                errorMessage:
   147                  description: ErrorMessage indicates that there is a problem reconciling
   148                    the state, and will be set to a descriptive error message.
   149                  type: string
   150                errorReason:
   151                  description: ErrorReason indicates that there is a problem reconciling
   152                    the state, and will be set to a token value suitable for programmatic
   153                    interpretation.
   154                  type: string
   155                infrastructureReady:
   156                  description: InfrastructureReady is the state of the infrastructure
   157                    provider.
   158                  type: boolean
   159                phase:
   160                  description: Phase represents the current phase of cluster actuation.
   161                    E.g. Pending, Running, Terminating, Failed etc.
   162                  type: string
   163              type: object
   164          type: object
   165      served: true
   166      storage: false
   167    - name: v1alpha3
   168      schema:
   169        openAPIV3Schema:
   170          description: Cluster is the Schema for the clusters API
   171          properties:
   172            apiVersion:
   173              description: 'APIVersion defines the versioned schema of this representation
   174                of an object. Servers should convert recognized schemas to the latest
   175                internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
   176              type: string
   177            kind:
   178              description: 'Kind is a string value representing the REST resource this
   179                object represents. Servers may infer this from the endpoint the client
   180                submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
   181              type: string
   182            metadata:
   183              type: object
   184            spec:
   185              description: ClusterSpec defines the desired state of Cluster
   186              properties:
   187                clusterNetwork:
   188                  description: Cluster network configuration.
   189                  properties:
   190                    apiServerPort:
   191                      description: APIServerPort specifies the port the API Server should
   192                        bind to. Defaults to 6443.
   193                      format: int32
   194                      type: integer
   195                    pods:
   196                      description: The network ranges from which Pod networks are allocated.
   197                      properties:
   198                        cidrBlocks:
   199                          items:
   200                            type: string
   201                          type: array
   202                      required:
   203                      - cidrBlocks
   204                      type: object
   205                    serviceDomain:
   206                      description: Domain name for services.
   207                      type: string
   208                    services:
   209                      description: The network ranges from which service VIPs are allocated.
   210                      properties:
   211                        cidrBlocks:
   212                          items:
   213                            type: string
   214                          type: array
   215                      required:
   216                      - cidrBlocks
   217                      type: object
   218                  type: object
   219                controlPlaneEndpoint:
   220                  description: ControlPlaneEndpoint represents the endpoint used to
   221                    communicate with the control plane.
   222                  properties:
   223                    host:
   224                      description: The hostname on which the API server is serving.
   225                      type: string
   226                    port:
   227                      description: The port on which the API server is serving.
   228                      format: int32
   229                      type: integer
   230                  required:
   231                  - host
   232                  - port
   233                  type: object
   234                controlPlaneRef:
   235                  description: ControlPlaneRef is an optional reference to a provider-specific
   236                    resource that holds the details for provisioning the Control Plane
   237                    for a Cluster.
   238                  properties:
   239                    apiVersion:
   240                      description: API version of the referent.
   241                      type: string
   242                    fieldPath:
   243                      description: 'If referring to a piece of an object instead of
   244                        an entire object, this string should contain a valid JSON/Go
   245                        field access statement, such as desiredState.manifest.containers[2].
   246                        For example, if the object reference is to a container within
   247                        a pod, this would take on a value like: "spec.containers{name}"
   248                        (where "name" refers to the name of the container that triggered
   249                        the event) or if no container name is specified "spec.containers[2]"
   250                        (container with index 2 in this pod). This syntax is chosen
   251                        only to have some well-defined way of referencing a part of
   252                        an object. TODO: this design is not final and this field is
   253                        subject to change in the future.'
   254                      type: string
   255                    kind:
   256                      description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
   257                      type: string
   258                    name:
   259                      description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   260                      type: string
   261                    namespace:
   262                      description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   263                      type: string
   264                    resourceVersion:
   265                      description: 'Specific resourceVersion to which this reference
   266                        is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
   267                      type: string
   268                    uid:
   269                      description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
   270                      type: string
   271                  type: object
   272                infrastructureRef:
   273                  description: InfrastructureRef is a reference to a provider-specific
   274                    resource that holds the details for provisioning infrastructure
   275                    for a cluster in said provider.
   276                  properties:
   277                    apiVersion:
   278                      description: API version of the referent.
   279                      type: string
   280                    fieldPath:
   281                      description: 'If referring to a piece of an object instead of
   282                        an entire object, this string should contain a valid JSON/Go
   283                        field access statement, such as desiredState.manifest.containers[2].
   284                        For example, if the object reference is to a container within
   285                        a pod, this would take on a value like: "spec.containers{name}"
   286                        (where "name" refers to the name of the container that triggered
   287                        the event) or if no container name is specified "spec.containers[2]"
   288                        (container with index 2 in this pod). This syntax is chosen
   289                        only to have some well-defined way of referencing a part of
   290                        an object. TODO: this design is not final and this field is
   291                        subject to change in the future.'
   292                      type: string
   293                    kind:
   294                      description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
   295                      type: string
   296                    name:
   297                      description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   298                      type: string
   299                    namespace:
   300                      description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
   301                      type: string
   302                    resourceVersion:
   303                      description: 'Specific resourceVersion to which this reference
   304                        is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
   305                      type: string
   306                    uid:
   307                      description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
   308                      type: string
   309                  type: object
   310                paused:
   311                  description: Paused can be used to prevent controllers from processing
   312                    the Cluster and all its associated objects.
   313                  type: boolean
   314              type: object
   315            status:
   316              description: ClusterStatus defines the observed state of Cluster
   317              properties:
   318                conditions:
   319                  description: Conditions defines current service state of the cluster.
   320                  items:
   321                    description: Condition defines an observation of a Cluster API resource
   322                      operational state.
   323                    properties:
   324                      lastTransitionTime:
   325                        description: Last time the condition transitioned from one status
   326                          to another. This should be when the underlying condition changed.
   327                          If that is not known, then using the time when the API field
   328                          changed is acceptable.
   329                        format: date-time
   330                        type: string
   331                      message:
   332                        description: A human readable message indicating details about
   333                          the transition. This field may be empty.
   334                        type: string
   335                      reason:
   336                        description: The reason for the condition's last transition
   337                          in CamelCase. The specific API may choose whether or not this
   338                          field is considered a guaranteed API. This field may not be
   339                          empty.
   340                        type: string
   341                      severity:
   342                        description: Severity provides an explicit classification of
   343                          Reason code, so the users or machines can immediately understand
   344                          the current situation and act accordingly. The Severity field
   345                          MUST be set only when Status=False.
   346                        type: string
   347                      status:
   348                        description: Status of the condition, one of True, False, Unknown.
   349                        type: string
   350                      type:
   351                        description: Type of condition in CamelCase or in foo.example.com/CamelCase.
   352                          Many .condition.type values are consistent across resources
   353                          like Available, but because arbitrary conditions can be useful
   354                          (see .node.status.conditions), the ability to deconflict is
   355                          important.
   356                        type: string
   357                    required:
   358                    - status
   359                    - type
   360                    type: object
   361                  type: array
   362                controlPlaneInitialized:
   363                  description: ControlPlaneInitialized defines if the control plane
   364                    has been initialized.
   365                  type: boolean
   366                controlPlaneReady:
   367                  description: ControlPlaneReady defines if the control plane is ready.
   368                  type: boolean
   369                failureDomains:
   370                  additionalProperties:
   371                    description: FailureDomainSpec is the Schema for Cluster API failure
   372                      domains. It allows controllers to understand how many failure
   373                      domains a cluster can optionally span across.
   374                    properties:
   375                      attributes:
   376                        additionalProperties:
   377                          type: string
   378                        description: Attributes is a free form map of attributes an
   379                          infrastructure provider might use or require.
   380                        type: object
   381                      controlPlane:
   382                        description: ControlPlane determines if this failure domain
   383                          is suitable for use by control plane machines.
   384                        type: boolean
   385                    type: object
   386                  description: FailureDomains is a slice of failure domain objects synced
   387                    from the infrastructure provider.
   388                  type: object
   389                failureMessage:
   390                  description: FailureMessage indicates that there is a fatal problem
   391                    reconciling the state, and will be set to a descriptive error message.
   392                  type: string
   393                failureReason:
   394                  description: FailureReason indicates that there is a fatal problem
   395                    reconciling the state, and will be set to a token value suitable
   396                    for programmatic interpretation.
   397                  type: string
   398                infrastructureReady:
   399                  description: InfrastructureReady is the state of the infrastructure
   400                    provider.
   401                  type: boolean
   402                observedGeneration:
   403                  description: ObservedGeneration is the latest generation observed
   404                    by the controller.
   405                  format: int64
   406                  type: integer
   407                phase:
   408                  description: Phase represents the current phase of cluster actuation.
   409                    E.g. Pending, Running, Terminating, Failed etc.
   410                  type: string
   411              type: object
   412          type: object
   413      served: true
   414      storage: true
   415  status:
   416    acceptedNames:
   417      kind: ""
   418      plural: ""
   419    conditions: []
   420    storedVersions: []