diff --git a/mkdocs.yml b/mkdocs.yml index 6d12ada..026bf7d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,6 +43,8 @@ nav: - Guides: - Index: guides/index.md - Implementation Guidelines: guides/guidelines.md + - Glossary: + - Index: references/glossary/index.md - Reference: - Namespace Sameness: concepts/namespace-sameness.md - ClusterSet: api-types/cluster-set.md diff --git a/site-src/references/glossary/index.md b/site-src/references/glossary/index.md new file mode 100644 index 0000000..7508258 --- /dev/null +++ b/site-src/references/glossary/index.md @@ -0,0 +1,24 @@ +# Glossary + +About API: A cluster-local CRD to store arbitrary properties about a cluster. +See [About API Overview](concepts/about-api.md). + +ClusterProfile API: A CRD intended to store information about member clusters in +a clusterset. See [ClusterProfile API Overview](concepts/clusterprofile-api.md). + +ClusterSet: A group of clusters governed by a single authority, with a high +degree of trust, and in which namespace sameness applies. See [ClusterSet +reference](api-types/clusterset.md). + +Multicluster Services API: An CRD composed of the ServiceExport and +ServiceImport Kinds, used to facilitate accessing Services across clusters. See +[Multicluster Services API Overview](concepts/multicluster-services-api.md). + +Namespace Sameness: A property of clusters in clustersets, in which Kubernetes +objects of the same name in the same namespace are expected to behave similarly +across the clusterset. See [Namespace Sameness +reference](api-types/namespace-sameness.md). + +Work API: A CRD defining the Work Kind, intended to facilitate distributing +workloads across multiple clusters. See [Work API +Overview](concepts/work-api.md).