Cluster information
A cluster information resource (ClusterInformation) represents what Calico records about the cluster as a whole: the Calico version it runs, its type, its unique ID, and whether its datastore is ready.
ClusterInformation is a cluster-scoped resource.
Calico creates and manages one cluster information resource, named default.
You can read it, but you can't create, change, or delete it with kubectl, or with the calicoctl create, apply, replace, patch, or delete commands.
The calicoctl version command shows calicoVersion and clusterType as the cluster version and the cluster type.
calicoctl reads this resource to check that its own version matches the cluster's version.
A user who runs calicoctl needs get access to the resource.
Without that access, calicoctl commands fail unless the user adds the --allow-version-mismatch flag.
For kubectl commands, you can use the aliases clusterinformation.projectcalico.org, clusterinformations.projectcalico.org, clusterinformation.p, and clusterinformations.p.
You can also use the short name clusterinfo.
For calicoctl commands, you can use the aliases clusterinformation, clusterinformations, clusterinfo, and clusterinfos.
Definition
Metadata
| Field | Description | Accepted Values | Schema | Default |
|---|---|---|---|---|
| name | The name of this cluster information resource. Calico always uses the name default. | default | string |
Spec
| Field | Description | Accepted Values | Schema | Default |
|---|---|---|---|---|
| clusterGUID | A unique ID for the cluster, made of 32 hexadecimal characters. | string | ||
| clusterType | A comma-separated list of words that describe the cluster, such as typha,kdd,k8s,operator,bgp,kubeadm. | string | ||
| calicoVersion | The version of Calico that the cluster runs, such as v3.33.1. | string | ||
| datastoreReady | Whether the datastore is ready for use. In API server mode, the calicoctl datastore migrate lock command sets this field to false, and the calicoctl datastore migrate unlock command sets it to true. | true, false | boolean | |
| variant | The product variant. Calico doesn't set this field. | string |
The Calico Enterprise API has one more field, cnxVersion.
Calico doesn't have that field.