Skip to content

Commit 90a1735

Browse files
committed
address comments
1 parent 3566366 commit 90a1735

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

site-src/concepts/cluster-profile-api.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@ This document provides an overview of the [ClusterProfile API](https://github.co
44

55
![Alt](../images/cluster-profile-api.png "ClusterProfile API")
66

7-
A Cluster Profile is essentially an individual member of the Cluster Inventory that details the properties and status of a cluster.
8-
This API proposes a universal, standardized interface that defines how cluster information should be presented
7+
A Cluster Profile is a namespace-level resource and essentially represents an individual member of the Cluster Inventory
8+
that details properties and status of a cluster. This API proposes a standardized interface that defines how cluster information should be presented
99
and interacted with across different platforms and implementations.
1010

1111
You can read more details about the API in the [KEP-4322](https://github.com/kubernetes/enhancements/blob/master/keps/sig-multicluster/4322-cluster-inventory/README.md).
1212

1313
## Terminology
1414

15-
- **Cluster Inventory**: A conceptual term referring to a collection of clusters.
15+
- **Cluster Inventory**: A conceptual term referring to a collection of clusters. A cluster inventory may or may not represent
16+
a [ClusterSet](../api-types/cluster-set.md). A cluster inventory is considered a clusterSet if all its member clusters adhere to the
17+
[namespace sameness](https://github.com/kubernetes/community/blob/master/sig-multicluster/namespace-sameness-position-statement.md) principle.
1618

1719
- **Cluster Manager**: An entity that creates the ClusterProfile API object per member cluster,
1820
and keeps their status up-to-date. Each cluster manager MUST be identified with a unique name.
@@ -26,6 +28,8 @@ You can read more details about the API in the [KEP-4322](https://github.com/kub
2628

2729
## API Example
2830

31+
[CRD definition](https://github.com/kubernetes-sigs/cluster-inventory-api/blob/main/config/crd/bases/multicluster.x-k8s.io_clusterprofiles.yaml)
32+
2933
```yaml
3034
apiVersion: multicluster.x-k8s.io/v1alpha1
3135
kind: ClusterProfile
48.1 KB
Loading

0 commit comments

Comments
 (0)