Last generated July 30, 2020

Cluster

Cluster is the Schema for the clusters API

Full name:
clusters.cluster.x-k8s.io
Group:
cluster.x-k8s.io
Singular name:
cluster
Plural name:
clusters
Scope:
Namespaced
Versions:
v1alpha2v1alpha3

Version v1alpha2

Example CR


apiVersion: infrastructure.giantswarm.io/v1alpha2
kind: Cluster
metadata:
  annotations:
    giantswarm.io/docs: https://pkg.go.dev/sigs.k8s.io/cluster-api/api/v1alpha2?tab=doc#Cluster
  creationTimestamp: null
  name: ca1p0
spec:
  infrastructureRef:
    apiVersion: infrastructure.giantswarm.io/v1alpha2
    kind: AWSCluster
    name: ca1p0
    namespace: default
    resourceVersion: "57975957"
    uid: 2dc05fcd-ba76-4135-b9ea-76955e3a7966

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object

.spec

object

ClusterSpec defines the desired state of Cluster

.spec.clusterNetwork

object

Cluster network configuration

.spec.clusterNetwork.apiServerPort

integer

APIServerPort specifies the port the API Server should bind to. Defaults to 6443.

.spec.clusterNetwork.pods

object

The network ranges from which Pod networks are allocated.

.spec.clusterNetwork.pods.cidrBlocks

array Required

.spec.clusterNetwork.pods.cidrBlocks[*]

string

.spec.clusterNetwork.serviceDomain

string

Domain name for services.

.spec.clusterNetwork.services

object

The network ranges from which service VIPs are allocated.

.spec.clusterNetwork.services.cidrBlocks

array Required

.spec.clusterNetwork.services.cidrBlocks[*]

string

.spec.infrastructureRef

object

InfrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider.

.spec.infrastructureRef.apiVersion

string

API version of the referent.

.spec.infrastructureRef.fieldPath

string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

.spec.infrastructureRef.kind

.spec.infrastructureRef.name

.spec.infrastructureRef.namespace

.spec.infrastructureRef.resourceVersion

string

.spec.infrastructureRef.uid

.status

object

ClusterStatus defines the observed state of Cluster

.status.apiEndpoints

array

APIEndpoints represents the endpoints to communicate with the control plane.

.status.apiEndpoints[*]

object

APIEndpoint represents a reachable Kubernetes API endpoint.

.status.apiEndpoints[*].host

string Required

The hostname on which the API server is serving.

.status.apiEndpoints[*].port

integer Required

The port on which the API server is serving.

.status.controlPlaneInitialized

boolean

ControlPlaneInitialized defines if the control plane has been initialized.

.status.errorMessage

string

ErrorMessage indicates that there is a problem reconciling the state, and will be set to a descriptive error message.

.status.errorReason

string

ErrorReason indicates that there is a problem reconciling the state, and will be set to a token value suitable for programmatic interpretation.

.status.infrastructureReady

boolean

InfrastructureReady is the state of the infrastructure provider.

.status.phase

string

Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.

Version v1alpha3

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object

.spec

object

ClusterSpec defines the desired state of Cluster

.spec.clusterNetwork

object

Cluster network configuration.

.spec.clusterNetwork.apiServerPort

integer

APIServerPort specifies the port the API Server should bind to. Defaults to 6443.

.spec.clusterNetwork.pods

object

The network ranges from which Pod networks are allocated.

.spec.clusterNetwork.pods.cidrBlocks

array Required

.spec.clusterNetwork.pods.cidrBlocks[*]

string

.spec.clusterNetwork.serviceDomain

string

Domain name for services.

.spec.clusterNetwork.services

object

The network ranges from which service VIPs are allocated.

.spec.clusterNetwork.services.cidrBlocks

array Required

.spec.clusterNetwork.services.cidrBlocks[*]

string

.spec.controlPlaneEndpoint

object

ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.

.spec.controlPlaneEndpoint.host

string Required

The hostname on which the API server is serving.

.spec.controlPlaneEndpoint.port

integer Required

The port on which the API server is serving.

.spec.controlPlaneRef

object

ControlPlaneRef is an optional reference to a provider-specific resource that holds the details for provisioning the Control Plane for a Cluster.

.spec.controlPlaneRef.apiVersion

string

API version of the referent.

.spec.controlPlaneRef.fieldPath

string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

.spec.controlPlaneRef.kind

.spec.controlPlaneRef.name

.spec.controlPlaneRef.namespace

.spec.controlPlaneRef.resourceVersion

string

.spec.controlPlaneRef.uid

.spec.infrastructureRef

object

InfrastructureRef is a reference to a provider-specific resource that holds the details for provisioning infrastructure for a cluster in said provider.

.spec.infrastructureRef.apiVersion

string

API version of the referent.

.spec.infrastructureRef.fieldPath

string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: “spec.containers{name}” (where “name” refers to the name of the container that triggered the event) or if no container name is specified “spec.containers[2]” (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

.spec.infrastructureRef.kind

.spec.infrastructureRef.name

.spec.infrastructureRef.namespace

.spec.infrastructureRef.resourceVersion

string

.spec.infrastructureRef.uid

.spec.paused

boolean

Paused can be used to prevent controllers from processing the Cluster and all its associated objects.

.status

object

ClusterStatus defines the observed state of Cluster

.status.conditions

array

Conditions defines current service state of the cluster.

.status.conditions[*]

object

Condition defines an observation of a Cluster API resource operational state.

.status.conditions[*].lastTransitionTime

string

Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

.status.conditions[*].message

string

A human readable message indicating details about the transition. This field may be empty.

.status.conditions[*].reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

.status.conditions[*].severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

.status.conditions[*].status

string Required

Status of the condition, one of True, False, Unknown.

.status.conditions[*].type

string Required

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.controlPlaneInitialized

boolean

ControlPlaneInitialized defines if the control plane has been initialized.

.status.controlPlaneReady

boolean

ControlPlaneReady defines if the control plane is ready.

.status.failureDomains

object

FailureDomains is a slice of failure domain objects synced from the infrastructure provider.

.status.failureMessage

string

FailureMessage indicates that there is a fatal problem reconciling the state, and will be set to a descriptive error message.

.status.failureReason

string

FailureReason indicates that there is a fatal problem reconciling the state, and will be set to a token value suitable for programmatic interpretation.

.status.infrastructureReady

boolean

InfrastructureReady is the state of the infrastructure provider.

.status.observedGeneration

integer

ObservedGeneration is the latest generation observed by the controller.

.status.phase

string

Phase represents the current phase of cluster actuation. E.g. Pending, Running, Terminating, Failed etc.


This documentation page shows information based on apiextensions v0.4.19.