openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Code Issues Releases Activity

adding Cluster API terms to glossary

Browse Source
This commit is contained in:
Jeana Routh
2024-07-30 11:21:12 -04:00
parent aff1c83247
commit 8da37ff030
1 changed files with 33 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
contributing_to_docs/term_glossary.adoc
View File

@@ -148,6 +148,39 @@ Usage: cluster
The collection of controllers, pods, and services and related DNS and networking
routing configuration that are defined on the system.
''''
=== Cluster API
Usage: Cluster API
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]]^
For more information, see the link:https://github.com/kubernetes-sigs/cluster-api[Cluster API project repository].
Depending on the platform and version support status, Cluster API replaces Terraform in the OpenShift installation process and can be used to manage machines.
The only legitimate use of the term "CAPI" in documentation is within the name of the downstream OpenShift _Cluster CAPI Operator_.
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].
Do not use: CAPI
''''
=== Cluster API provider implementations
Usage examples: Cluster API Provider AWS, Cluster API Provider GCP, Cluster API Provider OpenStack
A platform-specific implementation of the Cluster API that supports cloud provider infrastructure.
[NOTE]
====
* Do not insert the word "for" before the platform name.
* Do not use initialisms.
* 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].
====
Do not use: CAPA, CAPG, CAPIBM, CAPK, CAPZ, CAPX, CAPO, CAPOCI, CAPV, Cluster API Provider for AWS
''''
=== cluster service version