sigs.k8s.io/cluster-api/bootstrap/kubeadm@v0.0.0-20191016155141-23a891785b60/config-capi/crds/cluster.sigs.k8s.io_clusters.yaml (about)

     1  
     2  ---
     3  apiVersion: apiextensions.k8s.io/v1beta1
     4  kind: CustomResourceDefinition
     5  metadata:
     6    creationTimestamp: null
     7    name: clusters.cluster.sigs.k8s.io
     8  spec:
     9    group: cluster.sigs.k8s.io
    10    names:
    11      kind: Cluster
    12      plural: clusters
    13      shortNames:
    14      - cl
    15    scope: Namespaced
    16    subresources:
    17      status: {}
    18    validation:
    19      openAPIV3Schema:
    20        description: / [Cluster] Cluster is the Schema for the clusters API
    21        properties:
    22          apiVersion:
    23            description: 'APIVersion defines the versioned schema of this representation
    24              of an object. Servers should convert recognized schemas to the latest
    25              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
    26            type: string
    27          kind:
    28            description: 'Kind is a string value representing the REST resource this
    29              object represents. Servers may infer this from the endpoint the client
    30              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
    31            type: string
    32          metadata:
    33            description: ObjectMeta is metadata that all persisted resources must have,
    34              which includes all objects users must create.
    35            properties:
    36              annotations:
    37                additionalProperties:
    38                  type: string
    39                description: 'Annotations is an unstructured key value map stored with
    40                  a resource that may be set by external tools to store and retrieve
    41                  arbitrary metadata. They are not queryable and should be preserved
    42                  when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
    43                type: object
    44              clusterName:
    45                description: The name of the cluster which the object belongs to. This
    46                  is used to distinguish resources with same name and namespace in different
    47                  clusters. This field is not set anywhere right now and apiserver is
    48                  going to ignore it if set in create or update request.
    49                type: string
    50              creationTimestamp:
    51                description: "CreationTimestamp is a timestamp representing the server
    52                  time when this object was created. It is not guaranteed to be set
    53                  in happens-before order across separate operations. Clients may not
    54                  set this value. It is represented in RFC3339 form and is in UTC. \n
    55                  Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"
    56                format: date-time
    57                type: string
    58              deletionGracePeriodSeconds:
    59                description: Number of seconds allowed for this object to gracefully
    60                  terminate before it will be removed from the system. Only set when
    61                  deletionTimestamp is also set. May only be shortened. Read-only.
    62                format: int64
    63                type: integer
    64              deletionTimestamp:
    65                description: "DeletionTimestamp is RFC 3339 date and time at which this
    66                  resource will be deleted. This field is set by the server when a graceful
    67                  deletion is requested by the user, and is not directly settable by
    68                  a client. The resource is expected to be deleted (no longer visible
    69                  from resource lists, and not reachable by name) after the time in
    70                  this field, once the finalizers list is empty. As long as the finalizers
    71                  list contains items, deletion is blocked. Once the deletionTimestamp
    72                  is set, this value may not be unset or be set further into the future,
    73                  although it may be shortened or the resource may be deleted prior
    74                  to this time. For example, a user may request that a pod is deleted
    75                  in 30 seconds. The Kubelet will react by sending a graceful termination
    76                  signal to the containers in the pod. After that 30 seconds, the Kubelet
    77                  will send a hard termination signal (SIGKILL) to the container and
    78                  after cleanup, remove the pod from the API. In the presence of network
    79                  partitions, this object may still exist after this timestamp, until
    80                  an administrator or automated process can determine the resource is
    81                  fully terminated. If not set, graceful deletion of the object has
    82                  not been requested. \n Populated by the system when a graceful deletion
    83                  is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"
    84                format: date-time
    85                type: string
    86              finalizers:
    87                description: Must be empty before the object is deleted from the registry.
    88                  Each entry is an identifier for the responsible component that will
    89                  remove the entry from the list. If the deletionTimestamp of the object
    90                  is non-nil, entries in this list can only be removed.
    91                items:
    92                  type: string
    93                type: array
    94              generateName:
    95                description: "GenerateName is an optional prefix, used by the server,
    96                  to generate a unique name ONLY IF the Name field has not been provided.
    97                  If this field is used, the name returned to the client will be different
    98                  than the name passed. This value will also be combined with a unique
    99                  suffix. The provided value has the same validation rules as the Name
   100                  field, and may be truncated by the length of the suffix required to
   101                  make the value unique on the server. \n If this field is specified
   102                  and the generated name exists, the server will NOT return a 409 -
   103                  instead, it will either return 201 Created or 500 with Reason ServerTimeout
   104                  indicating a unique name could not be found in the time allotted,
   105                  and the client should retry (optionally after the time indicated in
   106                  the Retry-After header). \n Applied only if Name is not specified.
   107                  More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency"
   108                type: string
   109              generation:
   110                description: A sequence number representing a specific generation of
   111                  the desired state. Populated by the system. Read-only.
   112                format: int64
   113                type: integer
   114              initializers:
   115                description: "An initializer is a controller which enforces some system
   116                  invariant at object creation time. This field is a list of initializers
   117                  that have not yet acted on this object. If nil or empty, this object
   118                  has been completely initialized. Otherwise, the object is considered
   119                  uninitialized and is hidden (in list/watch and get calls) from clients
   120                  that haven't explicitly asked to observe uninitialized objects. \n
   121                  When an object is created, the system will populate this list with
   122                  the current set of initializers. Only privileged users may set or
   123                  modify this list. Once it is empty, it may not be modified further
   124                  by any user. \n DEPRECATED - initializers are an alpha field and will
   125                  be removed in v1.15."
   126                properties:
   127                  pending:
   128                    description: Pending is a list of initializers that must execute
   129                      in order before this object is visible. When the last pending
   130                      initializer is removed, and no failing result is set, the initializers
   131                      struct will be set to nil and the object is considered as initialized
   132                      and visible to all clients.
   133                    items:
   134                      description: Initializer is information about an initializer that
   135                        has not yet completed.
   136                      properties:
   137                        name:
   138                          description: name of the process that is responsible for initializing
   139                            this object.
   140                          type: string
   141                      required:
   142                      - name
   143                      type: object
   144                    type: array
   145                  result:
   146                    description: If result is set with the Failure field, the object
   147                      will be persisted to storage and then deleted, ensuring that other
   148                      clients can observe the deletion.
   149                    properties:
   150                      apiVersion:
   151                        description: 'APIVersion defines the versioned schema of this
   152                          representation of an object. Servers should convert recognized
   153                          schemas to the latest internal value, and may reject unrecognized
   154                          values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
   155                        type: string
   156                      code:
   157                        description: Suggested HTTP return code for this status, 0 if
   158                          not set.
   159                        format: int32
   160                        type: integer
   161                      details:
   162                        description: Extended data associated with the reason.  Each
   163                          reason may define its own extended details. This field is
   164                          optional and the data returned is not guaranteed to conform
   165                          to any schema except that defined by the reason type.
   166                        properties:
   167                          causes:
   168                            description: The Causes array includes more details associated
   169                              with the StatusReason failure. Not all StatusReasons may
   170                              provide detailed causes.
   171                            items:
   172                              description: StatusCause provides more information about
   173                                an api.Status failure, including cases when multiple
   174                                errors are encountered.
   175                              properties:
   176                                field:
   177                                  description: "The field of the resource that has caused
   178                                    this error, as named by its JSON serialization.
   179                                    May include dot and postfix notation for nested
   180                                    attributes. Arrays are zero-indexed.  Fields may
   181                                    appear more than once in an array of causes due
   182                                    to fields having multiple errors. Optional. \n Examples:
   183                                    \  \"name\" - the field \"name\" on the current
   184                                    resource   \"items[0].name\" - the field \"name\"
   185                                    on the first array entry in \"items\""
   186                                  type: string
   187                                message:
   188                                  description: A human-readable description of the cause
   189                                    of the error.  This field may be presented as-is
   190                                    to a reader.
   191                                  type: string
   192                                reason:
   193                                  description: A machine-readable description of the
   194                                    cause of the error. If this value is empty there
   195                                    is no information available.
   196                                  type: string
   197                              type: object
   198                            type: array
   199                          group:
   200                            description: The group attribute of the resource associated
   201                              with the status StatusReason.
   202                            type: string
   203                          kind:
   204                            description: 'The kind attribute of the resource associated
   205                              with the status StatusReason. On some operations may differ
   206                              from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
   207                            type: string
   208                          name:
   209                            description: The name attribute of the resource associated
   210                              with the status StatusReason (when there is a single name
   211                              which can be described).
   212                            type: string
   213                          retryAfterSeconds:
   214                            description: If specified, the time in seconds before the
   215                              operation should be retried. Some errors may indicate
   216                              the client must take an alternate action - for those errors
   217                              this field may indicate how long to wait before taking
   218                              the alternate action.
   219                            format: int32
   220                            type: integer
   221                          uid:
   222                            description: 'UID of the resource. (when there is a single
   223                              resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
   224                            type: string
   225                        type: object
   226                      kind:
   227                        description: 'Kind is a string value representing the REST resource
   228                          this object represents. Servers may infer this from the endpoint
   229                          the client submits requests to. Cannot be updated. In CamelCase.
   230                          More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
   231                        type: string
   232                      message:
   233                        description: A human-readable description of the status of this
   234                          operation.
   235                        type: string
   236                      metadata:
   237                        description: 'Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
   238                        properties:
   239                          continue:
   240                            description: continue may be set if the user set a limit
   241                              on the number of items returned, and indicates that the
   242                              server has more data available. The value is opaque and
   243                              may be used to issue another request to the endpoint that
   244                              served this list to retrieve the next set of available
   245                              objects. Continuing a consistent list may not be possible
   246                              if the server configuration has changed or more than a
   247                              few minutes have passed. The resourceVersion field returned
   248                              when using this continue value will be identical to the
   249                              value in the first response, unless you have received
   250                              this token from an error message.
   251                            type: string
   252                          resourceVersion:
   253                            description: 'String that identifies the server''s internal
   254                              version of this object that can be used by clients to
   255                              determine when objects have changed. Value must be treated
   256                              as opaque by clients and passed unmodified back to the
   257                              server. Populated by the system. Read-only. More info:
   258                              https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency'
   259                            type: string
   260                          selfLink:
   261                            description: selfLink is a URL representing this object.
   262                              Populated by the system. Read-only.
   263                            type: string
   264                        type: object
   265                      reason:
   266                        description: A machine-readable description of why this operation
   267                          is in the "Failure" status. If this value is empty there is
   268                          no information available. A Reason clarifies an HTTP status
   269                          code but does not override it.
   270                        type: string
   271                      status:
   272                        description: 'Status of the operation. One of: "Success" or
   273                          "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status'
   274                        type: string
   275                    type: object
   276                required:
   277                - pending
   278                type: object
   279              labels:
   280                additionalProperties:
   281                  type: string
   282                description: 'Map of string keys and values that can be used to organize
   283                  and categorize (scope and select) objects. May match selectors of
   284                  replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
   285                type: object
   286              managedFields:
   287                description: "ManagedFields maps workflow-id and version to the set
   288                  of fields that are managed by that workflow. This is mostly for internal
   289                  housekeeping, and users typically shouldn't need to set or understand
   290                  this field. A workflow can be the user's name, a controller's name,
   291                  or the name of a specific apply path like \"ci-cd\". The set of fields
   292                  is always in the version that the workflow used when modifying the
   293                  object. \n This field is alpha and can be changed or removed without
   294                  notice."
   295                items:
   296                  description: ManagedFieldsEntry is a workflow-id, a FieldSet and the
   297                    group version of the resource that the fieldset applies to.
   298                  properties:
   299                    apiVersion:
   300                      description: APIVersion defines the version of this resource that
   301                        this field set applies to. The format is "group/version" just
   302                        like the top-level APIVersion field. It is necessary to track
   303                        the version of a field set because it cannot be automatically
   304                        converted.
   305                      type: string
   306                    fields:
   307                      additionalProperties: true
   308                      description: Fields identifies a set of fields.
   309                      type: object
   310                    manager:
   311                      description: Manager is an identifier of the workflow managing
   312                        these fields.
   313                      type: string
   314                    operation:
   315                      description: Operation is the type of operation which lead to
   316                        this ManagedFieldsEntry being created. The only valid values
   317                        for this field are 'Apply' and 'Update'.
   318                      type: string
   319                    time:
   320                      description: Time is timestamp of when these fields were set.
   321                        It should always be empty if Operation is 'Apply'
   322                      format: date-time
   323                      type: string
   324                  type: object
   325                type: array
   326              name:
   327                description: 'Name must be unique within a namespace. Is required when
   328                  creating resources, although some resources may allow a client to
   329                  request the generation of an appropriate name automatically. Name
   330                  is primarily intended for creation idempotence and configuration definition.
   331                  Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
   332                type: string
   333              namespace:
   334                description: "Namespace defines the space within each name must be unique.
   335                  An empty namespace is equivalent to the \"default\" namespace, but
   336                  \"default\" is the canonical representation. Not all objects are required
   337                  to be scoped to a namespace - the value of this field for those objects
   338                  will be empty. \n Must be a DNS_LABEL. Cannot be updated. More info:
   339                  http://kubernetes.io/docs/user-guide/namespaces"
   340                type: string
   341              ownerReferences:
   342                description: List of objects depended by this object. If ALL objects
   343                  in the list have been deleted, this object will be garbage collected.
   344                  If this object is managed by a controller, then an entry in this list
   345                  will point to this controller, with the controller field set to true.
   346                  There cannot be more than one managing controller.
   347                items:
   348                  description: OwnerReference contains enough information to let you
   349                    identify an owning object. An owning object must be in the same
   350                    namespace as the dependent, or be cluster-scoped, so there is no
   351                    namespace field.
   352                  properties:
   353                    apiVersion:
   354                      description: API version of the referent.
   355                      type: string
   356                    blockOwnerDeletion:
   357                      description: If true, AND if the owner has the "foregroundDeletion"
   358                        finalizer, then the owner cannot be deleted from the key-value
   359                        store until this reference is removed. Defaults to false. To
   360                        set this field, a user needs "delete" permission of the owner,
   361                        otherwise 422 (Unprocessable Entity) will be returned.
   362                      type: boolean
   363                    controller:
   364                      description: If true, this reference points to the managing controller.
   365                      type: boolean
   366                    kind:
   367                      description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
   368                      type: string
   369                    name:
   370                      description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
   371                      type: string
   372                    uid:
   373                      description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids'
   374                      type: string
   375                  required:
   376                  - apiVersion
   377                  - kind
   378                  - name
   379                  - uid
   380                  type: object
   381                type: array
   382              resourceVersion:
   383                description: "An opaque value that represents the internal version of
   384                  this object that can be used by clients to determine when objects
   385                  have changed. May be used for optimistic concurrency, change detection,
   386                  and the watch operation on a resource or set of resources. Clients
   387                  must treat these values as opaque and passed unmodified back to the
   388                  server. They may only be valid for a particular resource or set of
   389                  resources. \n Populated by the system. Read-only. Value must be treated
   390                  as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"
   391                type: string
   392              selfLink:
   393                description: SelfLink is a URL representing this object. Populated by
   394                  the system. Read-only.
   395                type: string
   396              uid:
   397                description: "UID is the unique in time and space value for this object.
   398                  It is typically generated by the server on successful creation of
   399                  a resource and is not allowed to change on PUT operations. \n Populated
   400                  by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
   401                type: string
   402            type: object
   403          spec:
   404            description: / [ClusterSpec] ClusterSpec defines the desired state of Cluster
   405            properties:
   406              clusterNetwork:
   407                description: Cluster network configuration
   408                properties:
   409                  pods:
   410                    description: The network ranges from which Pod networks are allocated.
   411                    properties:
   412                      cidrBlocks:
   413                        items:
   414                          type: string
   415                        type: array
   416                    required:
   417                    - cidrBlocks
   418                    type: object
   419                  serviceDomain:
   420                    description: Domain name for services.
   421                    type: string
   422                  services:
   423                    description: The network ranges from which service VIPs are allocated.
   424                    properties:
   425                      cidrBlocks:
   426                        items:
   427                          type: string
   428                        type: array
   429                    required:
   430                    - cidrBlocks
   431                    type: object
   432                required:
   433                - pods
   434                - serviceDomain
   435                - services
   436                type: object
   437              providerSpec:
   438                description: Provider-specific serialized configuration to use during
   439                  cluster creation. It is recommended that providers maintain their
   440                  own versioned API types that should be serialized/deserialized from
   441                  this field.
   442                properties:
   443                  value:
   444                    description: Value is an inlined, serialized representation of the
   445                      resource configuration. It is recommended that providers maintain
   446                      their own versioned API types that should be serialized/deserialized
   447                      from this field, akin to component config.
   448                    type: object
   449                type: object
   450            type: object
   451          status:
   452            description: / [ClusterStatus] ClusterStatus defines the observed state
   453              of Cluster
   454            properties:
   455              apiEndpoints:
   456                description: APIEndpoint represents the endpoint to communicate with
   457                  the IP.
   458                items:
   459                  description: / [APIEndpoint] APIEndpoint represents a reachable Kubernetes
   460                    API endpoint.
   461                  properties:
   462                    host:
   463                      description: The hostname on which the API server is serving.
   464                      type: string
   465                    port:
   466                      description: The port on which the API server is serving.
   467                      type: integer
   468                  required:
   469                  - host
   470                  - port
   471                  type: object
   472                type: array
   473              errorMessage:
   474                description: If set, indicates that there is a problem reconciling the
   475                  state, and will be set to a descriptive error message.
   476                type: string
   477              errorReason:
   478                description: If set, indicates that there is a problem reconciling the
   479                  state, and will be set to a token value suitable for programmatic
   480                  interpretation.
   481                type: string
   482              providerStatus:
   483                description: Provider-specific status. It is recommended that providers
   484                  maintain their own versioned API types that should be serialized/deserialized
   485                  from this field.
   486                type: object
   487            type: object
   488        type: object
   489    versions:
   490    - name: v1alpha2
   491      served: true
   492      storage: true
   493  status:
   494    acceptedNames:
   495      kind: ""
   496      plural: ""
   497    conditions: []
   498    storedVersions: []