Skip to content

Commit 0bb17d1

Browse files
authored
Merge pull request #18 from j1m-ryan/describe-about-api
Add description of the About API
2 parents 21a353e + 6321010 commit 0bb17d1

File tree

2 files changed

+34
-1
lines changed

2 files changed

+34
-1
lines changed

site-src/concepts/about-api.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,34 @@
1-
# About API Overview
1+
# About API Overview
2+
3+
This document provides an overview of the About API.
4+
5+
![Alt](../images/about-api.png "About API")
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.
34+

site-src/images/about-api.png

150 KB
Loading

0 commit comments

Comments
 (0)