You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This document provides an overview of the About API.
4
+
5
+

6
+
7
+
The About API allows metadata to be attached to individual clusters.
8
+
The fundamental resource defined in the API is the ClusterProperty CRD.
9
+
10
+
You can read more details about the API in [KEP-2149](https://github.com/kubernetes/enhancements/tree/master/keps/sig-multicluster/2149-clusterid).
11
+
12
+
## ClusterProperty CRD
13
+
14
+
The ClusterProperty CRD is proposed to give a Kubernetes-native way of identifying clusters, however, it can be used to store any metadata about a cluster.
15
+
16
+
### Example
17
+
18
+
```
19
+
apiVersion: about.k8s.io/v1
20
+
kind: ClusterProperty
21
+
metadata:
22
+
name: cluster.clusterset.k8s.io
23
+
spec:
24
+
value: cluster-1
25
+
```
26
+
27
+
In the above example the ClusterProperty CRD is used to identify a cluster with the id of `cluster-1`. The key in this example `cluster.clusterset.k8s.io`, is one of the two proposed well-known properties.
28
+
29
+
### Well-known properties
30
+
There are two well-known properties proposed:
31
+
32
+
-`cluster.clusterset.k8s.io` A unique ID or name of the cluster. The value is implementation-specific, but it should be unique within the scope of the cluster set.
33
+
-`clusterset.k8s.io` The cluster set that the cluster belongs to. A cluster which is part of a cluster set should have this property set.
0 commit comments