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