Skip to content

Commit 206403d

Browse files
authored
Merge pull request #23 from cainelli/fix-about-api-version
Fix about api version
2 parents bf57aa1 + 8b18246 commit 206403d

File tree

3 files changed

+27
-33
lines changed

3 files changed

+27
-33
lines changed

site-src/api-types/cluster-set.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ ClusterSet represents a specific pattern implemented by various organizations. A
1414
A cluster's ClusterSet membership is stored in the about.k8s.io/ClusterProperty `clusterset.k8s.io`.
1515

1616
## Cluster Metadata
17-
The ClusterSet is a Cluster-scoped ClusterProperty CRD (Customer Resource Definition), that stores a name and a value.
17+
The ClusterSet is a Cluster-scoped ClusterProperty CRD (Customer Resource Definition), that stores a name and a value.
1818

1919
This property can be used to:
2020

2121
- uniquely identify clusters using a clusterID
2222

23-
```yaml
24-
apiVersion: about.k8s.io/v1
23+
```
24+
apiVersion: about.k8s.io/v1beta1
2525
kind: ClusterProperty
2626
metadata:
2727
name: cluster.clusterset.k8s.io
@@ -31,29 +31,24 @@ This property can be used to:
3131
3232
- uniquely identify the membership of a cluster in a ClusterSet for the lifetime of the membership.
3333
34-
```yaml
35-
apiVersion: about.k8s.io/v1
34+
```
35+
apiVersion: about.k8s.io/v1beta1
3636
kind: ClusterProperty
3737
metadata:
3838
name: clusterset.k8s.io
3939
spec:
4040
value: mycoolclusterset
4141
```
42-
42+
4343
- Provide a reference point for multi-cluster tooling to build on within a cluster set, for example for DNS labels, for logging and tracing, etc.
4444
4545
- Provide extra metadata space to store other cluster properties that might otherwise be implemented as ad-hoc annotations on semantically adjacent objects.
4646
47-
```yaml
48-
apiVersion: about.k8s.io/v1
47+
```
48+
apiVersion: about.k8s.io/v1beta1
4949
kind: ClusterProperty
5050
metadata:
5151
name: fingerprint.mycoolimplementation.com
5252
spec:
5353
value: '{"major": "1","minor": "18","gitVersion": "v1.18.2","gitCommit": "52c56ce7a8272c798dbc29846288d7cd9fbae032","gitTreeState": "clean","buildDate": "2020-04-30T20:19:45Z","goVersion": "go1.13.9","compiler": "gc","platform": "linux/amd64"}'
5454
```
55-
56-
57-
58-
59-

site-src/concepts/about-api.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,30 @@ This document provides an overview of the About API.
44

55
![Alt](../images/about-api.png "About API")
66

7-
The About API allows metadata to be attached to individual clusters.
7+
The About API allows metadata to be attached to individual clusters.
88
The fundamental resource defined in the API is the ClusterProperty CRD.
99

1010
You can read more details about the API in [KEP-2149](https://github.com/kubernetes/enhancements/tree/master/keps/sig-multicluster/2149-clusterid).
1111

1212
## ClusterProperty CRD
1313

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.
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.
1515

1616
### Example
1717

18-
```yaml
19-
apiVersion: about.k8s.io/v1
18+
```
19+
apiVersion: about.k8s.io/v1beta1
2020
kind: ClusterProperty
2121
metadata:
2222
name: cluster.clusterset.k8s.io
2323
spec:
2424
value: cluster-1
2525
```
2626

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.
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.
2828

2929
### Well-known properties
3030
There are two well-known properties proposed:
3131

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-
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.

site-src/references/yaml.json

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
"Work": {
33
"prefix": ["Work"],
44
"body": [
5-
"apiVersion: multicluster.x-k8s.io/v1alpha1",
6-
"kind: Work",
5+
"apiVersion: multicluster.x-k8s.io/v1alpha1",
6+
"kind: Work",
77
"metadata:",
88
"\tname: ${1:work-name}",
99
"\tnamespace: ${2:cluster-name}",
@@ -20,8 +20,8 @@
2020
"ServiceImport": {
2121
"prefix": ["ServiceImport"],
2222
"body": [
23-
"apiVersion: multicluster.x-k8s.io/v1alpha1",
24-
"kind: ServiceImport",
23+
"apiVersion: multicluster.x-k8s.io/v1alpha1",
24+
"kind: ServiceImport",
2525
"metadata:",
2626
"\tname: ${1:service-name}",
2727
"\tnamespace: ${2:demo}",
@@ -39,8 +39,8 @@
3939
"ServiceExport": {
4040
"prefix": ["ServiceExport"],
4141
"body": [
42-
"apiVersion: multicluster.x-k8s.io/v1alpha1",
43-
"kind: ServiceExport",
42+
"apiVersion: multicluster.x-k8s.io/v1alpha1",
43+
"kind: ServiceExport",
4444
"metadata:",
4545
"\tname: ${1:service-name}",
4646
"\tnamespace: ${2:demo}"
@@ -50,8 +50,8 @@
5050
"EndPointSlice": {
5151
"prefix": ["EndPointSlice"],
5252
"body": [
53-
"apiVersion: discovery.k8s.io/v1beta1",
54-
"kind: EndPointSlice",
53+
"apiVersion: discovery.k8s.io/v1beta1",
54+
"kind: EndPointSlice",
5555
"metadata:",
5656
"\tname: ${1:imported-service-cluster-name}",
5757
"\tnamespace: ${2:demo}",
@@ -82,8 +82,8 @@
8282
"ClusterSet (About API)": {
8383
"prefix": ["ClusterSet"],
8484
"body": [
85-
"apiVersion: about.k8s.io/v1",
86-
"kind: ClusterProperty",
85+
"apiVersion: about.k8s.io/v1beta1",
86+
"kind: ClusterProperty",
8787
"metadata:",
8888
"\tname: clusterset.k8s.io",
8989
"spec:",
@@ -94,7 +94,7 @@
9494
"Cluster (About API)": {
9595
"prefix": ["Cluster"],
9696
"body": [
97-
"apiVersion: about.k8s.io/v1",
97+
"apiVersion: about.k8s.io/v1beta1",
9898
"kind: ClusterProperty",
9999
"metadata:",
100100
"\tname: cluster.clusterset.k8s.io",
@@ -104,4 +104,4 @@
104104
"description": "Cluster object as described in the About API (https://github.com/kubernetes/enhancements/tree/master/keps/sig-multicluster/2149-clusterid)"
105105
}
106106

107-
}
107+
}

0 commit comments

Comments
 (0)