Skip to content

Commit 8604eff

Browse files
authored
Merge pull request #6845 from killianmuldoon/docs/expand-glossary
📖 Add Clusterclass and RuntimeSDK terms to glossary
2 parents ef7172a + c019219 commit 8604eff

File tree

1 file changed

+81
-1
lines changed

1 file changed

+81
-1
lines changed

docs/book/src/reference/glossary.md

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Table of Contents
22

3-
[A](#a) | [B](#b) | [C](#c) | [D](#d) | [H](#h) | [I](#i) | [K](#k) | [M](#m) | [N](#n) | [O](#o) | [P](#p) | [S](#s) | [T](#t) | [W](#w)
3+
[A](#a) | [B](#b) | [C](#c) | [D](#d) | [E](#e) | [H](#h) | [I](#i) | [K](#k) | [L](#l)| [M](#m) | [N](#n) | [O](#o) | [P](#p) | [R](#r) | [S](#s) | [T](#t) | [W](#w)
44

55
# A
66
---
@@ -84,12 +84,21 @@ Cluster API Provider Azure
8484

8585
A full Kubernetes deployment. See Management Cluster and Workload Cluster.
8686

87+
### ClusterClass
88+
89+
A collection of templates that define a topology (control plane and workers) to be used to continuously reconcile one or more Clusters.
90+
See [ClusterClass](../tasks/experimental-features/cluster-class/index.md)
91+
8792
### Cluster API
8893

8994
Or __Cluster API project__
9095

9196
The Cluster API sub-project of the SIG-cluster-lifecycle. It is also used to refer to the software components, APIs, and community that produce them.
9297

98+
### Cluster API Runtime
99+
100+
The Cluster API execution model, a set of controllers cooperating in managing the Kubernetes cluster lifecycle.
101+
93102
### Control plane
94103

95104
The set of Kubernetes services that form the basis of a cluster. See also [https://kubernetes.io/docs/concepts/#kubernetes-control-plane](https://kubernetes.io/docs/concepts/#kubernetes-control-plane) There are two variants:
@@ -104,6 +113,19 @@ The set of Kubernetes services that form the basis of a cluster. See also [https
104113

105114
A feature implementation offered as part of the Cluster API project, infrastructure providers can swap it out for a different one.
106115

116+
# E
117+
---
118+
119+
### External patch
120+
121+
[Patch](#patch) generated by an external component using [Runtime SDK](#runtime-sdk). Alternative to [inline patch](#inline-patch).
122+
123+
### External patch extension
124+
125+
A [runtime extension] that implements a [topology mutation hook]
126+
127+
See [Runtime Extension](#runtime-extension), [topology mutation hook](#topology-mutation-hook)
128+
107129
# H
108130
---
109131

@@ -122,6 +144,10 @@ see [Server](#server)
122144

123145
A source of computational resources (e.g. machines, networking, etc.). Examples for cloud include AWS, Azure, Google, etc.; for bare metal include VMware, MAAS, metal3.io, etc. When there is more than one way to obtain resources from the same infrastructure provider (e.g. EC2 vs. EKS) each way is referred to as a variant.
124146

147+
### Inline patch
148+
149+
A [patch](#patch) defined inline in a [ClusterClass](#clusterclass). An alternative to an [external patch](#external-patch).
150+
125151
### Instance
126152

127153
see [Server](#server)
@@ -143,6 +169,13 @@ A cluster that passes the Kubernetes conformance tests.
143169

144170
Refers to the [main Kubernetes git repository](https://github.com/kubernetes/kubernetes) or the main Kubernetes project.
145171

172+
# L
173+
---
174+
175+
### Lifecycle hook
176+
A [Runtime Hook](#runtime-hook) that allows external components to interact with the lifecycle of a Cluster.
177+
178+
See [Implementing Lifecycle Hooks](../tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md)
146179
# M
147180
---
148181

@@ -191,6 +224,10 @@ A generically understood combination of a kernel and system-level userspace inte
191224
# P
192225
---
193226

227+
### Patch
228+
229+
A set of instructions describing modifications to a Kubernetes object. Examples include JSON Patch and JSON Merge Patch.
230+
194231
### Pivot
195232

196233
Pivot is a process for moving the provider components and declared cluster-api resources from a Source Management cluster to a Target Management cluster.
@@ -210,6 +247,27 @@ it usually contains Custom Resource Definitions (CRDs), Deployments (to run the
210247

211248
Existing Cluster API implementations consist of generic and infrastructure provider-specific logic. The [infrastructure provider](#infrastructure-provider)-specific logic is currently maintained in infrastructure provider repositories.
212249

250+
# R
251+
---
252+
253+
### Runtime Extension
254+
255+
An external component which is part of a system built on top of Cluster API that can handle requests for a specific Runtime Hook.
256+
257+
See [Runtime SDK](#runtime-sdk)
258+
259+
### Runtime Hook
260+
261+
A single, well identified, extension point allowing applications built on top of Cluster API to hook into specific moments of the [Cluster API Runtime](#cluster-api-runtime), e.g. [BeforeClusterUpgrade](../tasks/experimental-features/runtime-sdk/implement-lifecycle-hooks.md#beforeclusterupgrade), [TopologyMutationHook](#topology-mutation-hook).
262+
263+
See [Runtime SDK](#runtime-sdk)
264+
265+
### Runtime SDK
266+
267+
A developer toolkit required to build Runtime Hooks and Runtime Extensions.
268+
269+
See [Runtime SDK](../tasks/experimental-features/runtime-sdk/index.md)
270+
213271
# S
214272
---
215273

@@ -226,9 +284,31 @@ is running as a static pod.
226284

227285
The infrastructure that backs a [Machine Resource](#machine), typically either a cloud instance, virtual machine, or physical host.
228286

287+
# T
288+
---
289+
290+
### Topology
291+
292+
A field in the Cluster object spec that allows defining and managing the shape of the Cluster's control plane and worker machines from a single point of control. The Cluster's topology is based on a [ClusterClass](#clusterclass).
293+
294+
See [ClusterClass](#clusterclass)
295+
296+
297+
### Topology Mutation Hook
298+
299+
A [Runtime Hook](#runtime-hook) that allows external components to generate [patches](#patch) for customizing Kubernetes objects that are part of a [Cluster topology](#topology).
300+
301+
See [Topology Mutation](../tasks/experimental-features/runtime-sdk/implement-topology-mutation-hook.md)
302+
229303
# W
230304
---
231305

232306
### Workload Cluster
233307

234308
A cluster created by a ClusterAPI controller, which is *not* a bootstrap cluster, and is meant to be used by end-users, as opposed to by CAPI tooling.
309+
310+
### WorkerClass
311+
312+
A collection of templates that define a set of worker nodes in the cluster. A ClusterClass contains zero or more WorkerClass definitions.
313+
314+
See [ClusterClass](#clusterclass)

0 commit comments

Comments
 (0)