Skip to content

Commit e62f033

Browse files
committed
Fix anchor and spelling issues in docs/scope-and-objectives.md
Signed-off-by: chymy <[email protected]>
1 parent cc12985 commit e62f033

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

docs/scope-and-objectives.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,20 @@ This is a living document that is refined over time. It serves as guard rails fo
3838

3939
## Table of Contents
4040

41-
* [Statement and Objectives](#cluster-api-statement-and-objectives)
42-
* [Metadata](#metadata)
41+
* [Cluster API Scope and Objectives](#cluster-api-scope-and-objectives)
4342
* [Table of Contents](#table-of-contents)
4443
* [Summary](#summary)
44+
* [What is Cluster API?](#what-is-cluster-api)
4545
* [Glossary](#glossary)
4646
* [Motivation](#motivation)
4747
* [Goals](#goals)
48-
* [Non\-goals](#non-goals)
48+
* [Non-goals](#non-goals)
4949
* [Requirements](#requirements)
50-
* [Workstreams](#workstreams)
50+
* [Foundation](#foundation)
51+
* [User Experience](#user-experience)
52+
* [Organization](#organization)
53+
* [Validation](#validation)
54+
* [Extension](#extension)
5155

5256
## Summary
5357

@@ -61,18 +65,18 @@ We are building a set of Kubernetes cluster management APIs to enable common clu
6165

6266
## Glossary
6367

64-
[See ./book/GLOSSARY.md](./book/GLOSSARY.md)
68+
[See ./book/GLOSSARY.md](./book/src/reference/glossary.md)
6569

6670
- __Cluster API__: Unless otherwise specified, this refers to the project as a whole.
6771
- __Infrastructure provider__: Refers to the source of computational resources (e.g. machines, networking, etc.). Examples for cloud include AWS, Azure, Google, etc.; for bare metal include VMware, MAAS, 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.
6872
- __Provider implementation__: Existing Cluster API implementations consist of generic and infrastructure provider-specific logic. The infrastructure provider-specific logic is currently maintained in infrastructure provider repositories.
69-
- __Kubernetes-conformant__: A cluster that passes the Kubernetes conformance tests.
73+
- __Kubernetes-conformance__: A cluster that passes the Kubernetes conformance tests.
7074
- __Scaling__: Unless otherwise specified, this refers to horizontal scaling.
7175
- __Control plane__:
7276
- __Self-provisioned__: A Kubernetes control plane consisting of pods or machines wholly managed by a single Cluster API deployment.
7377
- __External__: A control plane offered and controlled by some system other than Cluster API (e.g., GKE, AKS, EKS, IKS).
74-
- __Core Add-ons__: Addons that are required to deploy a Kubernetes-conformant cluster: DNS, kube-proxy, CNI.
75-
- __Additional Add-ons__: Addons that are not required for a Kubernetes-conformant cluster (e.g. metrics/Heapster, Dashboard).
78+
- __Core Add-ons__: Addons that are required to deploy a Kubernetes-conformance cluster: DNS, kube-proxy, CNI.
79+
- __Additional Add-ons__: Addons that are not required for a Kubernetes-conformance cluster (e.g. metrics/Heapster, Dashboard).
7680
- __Management cluster__: The cluster where one or more Cluster API providers run, and where resources (e.g. Machines) are stored.
7781
- __Workload cluster__: A cluster whose lifecycle is managed by the Management cluster.
7882
- __Operating system__: A generically understood combination of a kernel and system-level userspace interface, such as Linux or Windows, as opposed to a particular distribution.
@@ -89,7 +93,7 @@ As a result, existing popular deployment mechanisms that manage Kubernetes clust
8993

9094
### Goals
9195

92-
- To manage the lifecycle (create, scale, upgrade, destroy) of Kubernetes-conformant clusters using a declarative API.
96+
- To manage the lifecycle (create, scale, upgrade, destroy) of Kubernetes-conformance clusters using a declarative API.
9397
- To work in different environments, both on-premises and in the cloud.
9498
- To define common operations, provide a default implementation, and provide the ability to swap out implementations for alternative ones.
9599
- To reuse and integrate existing ecosystem components rather than duplicating their functionality (e.g. node-problem-detector, cluster autoscaler, SIG-Multi-cluster).
@@ -99,9 +103,9 @@ As a result, existing popular deployment mechanisms that manage Kubernetes clust
99103

100104
- To add these APIs to Kubernetes core (kubernetes/kubernetes).
101105
- This API should live in a namespace outside the core and follow the best practices defined by api-reviewers, but is not subject to core-api constraints.
102-
- To manage the lifecycle of infrastructure unrelated to the running of Kubernetes-conformant clusters.
106+
- To manage the lifecycle of infrastructure unrelated to the running of Kubernetes-conformance clusters.
103107
- To force all Kubernetes lifecycle products (kops, kubespray, GKE, AKS, EKS, IKS etc.) to support or use these APIs.
104-
- To manage non-Cluster API provisioned Kubernetes-conformant clusters.
108+
- To manage non-Cluster API provisioned Kubernetes-conformance clusters.
105109
- To manage a single cluster spanning multiple infrastructure providers.
106110
- To configure a machine at any time other than create or upgrade.
107111
- To duplicate functionality that exists or is coming to other tooling, e.g., updating kubelet configuration (c.f. dynamic kubelet configuration), or updating apiserver, controller-manager, scheduler configuration (c.f. component-config effort) after the cluster is deployed.

0 commit comments

Comments
 (0)