Skip to content

Commit 8da37ff

Browse files
committed
adding Cluster API terms to glossary
1 parent aff1c83 commit 8da37ff

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

contributing_to_docs/term_glossary.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,39 @@ Usage: cluster
148148
The collection of controllers, pods, and services and related DNS and networking
149149
routing configuration that are defined on the system.
150150

151+
''''
152+
=== Cluster API
153+
154+
Usage: Cluster API
155+
156+
Cluster API is a Kubernetes subproject focused on providing declarative APIs and tooling to simplify provisioning, upgrading, and operating multiple Kubernetes clusters.^[link:https://github.com/kubernetes-sigs/cluster-api?tab=readme-ov-file#-what-is-the-cluster-api[1]]^
157+
For more information, see the link:https://github.com/kubernetes-sigs/cluster-api[Cluster API project repository].
158+
159+
Depending on the platform and version support status, Cluster API replaces Terraform in the OpenShift installation process and can be used to manage machines.
160+
161+
The only legitimate use of the term "CAPI" in documentation is within the name of the downstream OpenShift _Cluster CAPI Operator_.
162+
To avoid using "CAPI" in plain text when referring to this Operator, use the `{cluster-capi-operator}` attribute in the link:https://github.com/openshift/openshift-docs/blob/main/_attributes/common-attributes.adoc[common attributes file].
163+
164+
Do not use: CAPI
165+
166+
''''
167+
=== Cluster API provider implementations
168+
169+
Usage examples: Cluster API Provider AWS, Cluster API Provider GCP, Cluster API Provider OpenStack
170+
171+
A platform-specific implementation of the Cluster API that supports cloud provider infrastructure.
172+
173+
[NOTE]
174+
====
175+
* Do not insert the word "for" before the platform name.
176+
177+
* Do not use initialisms.
178+
179+
* To avoid common typos, use the attributes in the _Cluster API terminology_ section of the link:https://github.com/openshift/openshift-docs/blob/main/_attributes/common-attributes.adoc[common attributes file].
180+
====
181+
182+
Do not use: CAPA, CAPG, CAPIBM, CAPK, CAPZ, CAPX, CAPO, CAPOCI, CAPV, Cluster API Provider for AWS
183+
151184
''''
152185
=== cluster service version
153186

0 commit comments

Comments
 (0)