Skip to content

Add basic terminology page for SIG-MC. #8536

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+39 −0
Open

Add basic terminology page for SIG-MC. #8536

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86321af
Add basic terminology page for SIG-MC.
lauralorenz Jul 30, 2025
48c8d46
Align with community comment on website glossary PR
lauralorenz Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions sig-multicluster/terminology.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Terminology

This file contains terminology in common use by the SIG-Multicluster community, as well as aliases those terms may be used by past or present.

For more information, see individual subprojects and documents, or the SIG-Multicluster website at https://multicluster.sigs.k8s.io/.

## About API

### Also known as:

- ClusterProperty

### Previously known as:

- ClusterClaim API
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice to have it. I remember this term was only used during the discussion.



## ClusterProfile API

### Previously known as:

- Cluster Inventory
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But this term is now used as the repo name and in the readme https://github.com/kubernetes-sigs/cluster-inventory-api.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea I had though that while this is no longer the name of the CRD it was actually intended to preserve as the name of the API? (Similar to About API <> ClusterProperty)

Defer to @ryanzhang-oss @corentone for a more authoritative answer.

Copy link
Contributor Author

@lauralorenz lauralorenz Aug 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is a bit different to About API <> ClusterProperty to me because the Kind is also called ClusterProfile. That being said if the common usage is to refer to it as Cluster Inventory regardless of the CRD and Kind name then this PR should reflect that. I think this one got in its state at least partially because the repo name is Cluster Inventory API and that is harder to change from the Github beauracracy perspective.... anyways part of this effort could be that we decide to cleanup our documents IF we think Cluster Inventory shouldn't be a colloquial name for this.

But overall ya I defer to @ryanzhang-oss and @corentone or their delegates and will update accordingly :)



## ClusterSet


## Multicluster Services API

### Also known as:

- MCS
- MCS API


## Namespace Sameness


## Work API