From defd875932e3819ee8c5e41d7a9fc338dcfeb4ee Mon Sep 17 00:00:00 2001 From: fabriziopandini Date: Tue, 27 Sep 2022 11:17:20 +0200 Subject: [PATCH] Address feedback --- docs/book/src/reference/glossary.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/book/src/reference/glossary.md b/docs/book/src/reference/glossary.md index b48ba7474e7f..747fbea64de1 100644 --- a/docs/book/src/reference/glossary.md +++ b/docs/book/src/reference/glossary.md @@ -26,7 +26,7 @@ A temporary cluster that is used to provision a Target Management cluster. ### Bootstrap provider Refers to a [provider](#provider) that implements a solution for the [bootstrap](#bootstrap) process. -Bootstrap providers interaction with Cluster API is based on what defined in the [Cluster API contract](#contract). +Bootstrap providers interaction with Cluster API is based on what is defined in the [Cluster API contract](#contract). See [CABPK](#CABPK). @@ -121,8 +121,8 @@ The Cluster API execution model, a set of controllers cooperating in managing th Or __Cluster API contract__ -Defines a set of rules a [provider](#provider) is expected to comply in order to interact with Cluster API. -Those rules can define a fields the provider must implement on its own CRDs and/or a list of behaviours +Defines a set of rules a [provider](#provider) is expected to comply with in order to interact with Cluster API. +Those rules can define fields the provider must implement on its own CRDs and/or a list of behaviours the provider is expected to implement. ### Control plane @@ -135,15 +135,15 @@ The set of Kubernetes services that form the basis of a cluster. See also [https ### Control plane provider Refers to a [provider](#provider) that implements a solution for the management of a Kubernetes [control plane][#control-plane]. -Control plane providers interaction with Cluster API is based on what defined in the [Cluster API contract](#contract). +Control plane providers interaction with Cluster API is based on what is defined in the [Cluster API contract](#contract). See [KCP](#KCP). ### Core provider Refers to a [provider](#provider) that implements Cluster API core controllers; if you -consider that the first project that must be deployed in a management Cluster is Cluster API itself, it should clear why -the Cluster API project is also referred as a core provider. +consider that the first project that must be deployed in a management Cluster is Cluster API itself, it should be clear why +the Cluster API project is also referred to as the core provider. See [CAPI](#cluster-api). @@ -153,7 +153,7 @@ See [CAPI](#cluster-api). ### Default implementation A feature implementation offered as part of the Cluster API project and maintained by the CAPI core team; usually -default implementation can be swapped out for a different one. e.g. [KCP](#KCP) is a default implementation for +default implementation can be swapped out with different implementations. e.g. [KCP](#KCP) is a default implementation for a [control plane provider](#control-plane-provider) . # E @@ -187,9 +187,9 @@ see [Server](#server) Refers to a [provider](#provider) that implements provisioning of infrastructure/computational resources required by the Cluster or by Machines (e.g. VMs, networking, etc.). -Infrastructure providers interaction with Cluster API is based on what defined in the [Cluster API contract](#contract). +Infrastructure providers interaction with Cluster API is based on what is defined in the [Cluster API contract](#contract). -Examples for cloud include AWS, Azure, Google, etc.; for bare metal include VMware, MAAS, metal3.io, etc. +Examples for clouds 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 in AWS) each way is referred to as a variant. See e.g. [CAPA][#CAPA], [CAPC][#CAPC], [CAPD][#CAPD], [CAPG][#CAPG], [CAPH][#CAPH], [CAPIBM][#CAPIBM], [CAPN][#CAPN], @@ -303,7 +303,7 @@ This term was originally used as abbreviation for [Infrastructure provider](#inf to refer to any project that can be deployed and provides a functionality to the Cluster API management Cluster. See [Bootstrap provider](#bootstrap-provider), [Control plane provider](#control-plane-provider), [Core provider](#core-provider), -[Infrastructure provider](#infrastructure-provider), [IPAM provider](#ipam-provider) [Runtime extensions provider](#runtime-extensions-provider). +[Infrastructure provider](#infrastructure-provider), [IPAM provider](#ipam-provider) [Runtime extension provider](#runtime-extension-provider). ### Provider components @@ -328,10 +328,10 @@ An external component which is part of a system built on top of Cluster API that See [Runtime SDK](#runtime-sdk) -### Runtime Extensions provider +### Runtime Extension provider Refers to a [provider](#provider) that implements one or more [runtime extensions](#runtime-extension). -Bootstrap providers interaction with Cluster API are based on the Open API spec for [runtime hooks](#runtime-hook). +Runtime Extension providers interaction with Cluster API are based on the Open API spec for [runtime hooks](#runtime-hook). ### Runtime Hook