-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add glossary to documentation (#1001)
* add glossary as a separate file Add a more definitive glossary in a separate file, pulling terms from other existing locations as the starting point. * replace inline glossary with link to new document * fix title in metadata * add more reviewers based on cluster-api-admins and cluster-api-maintainers * credit tim as an author * fill in horizontal scaling definition * add glossary to gitbook source
- Loading branch information
1 parent
d48025d
commit f96ac27
Showing
3 changed files
with
164 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,161 @@ | ||
--- | ||
title: Glossary | ||
authors: | ||
- "@dhellmann" | ||
- "@timothysc" | ||
reviewers: | ||
- "@timothysc" | ||
- "@justinsb" | ||
- "@detiber" | ||
- "@davidewatson" | ||
- "@vincepri" | ||
creation-date: 2019-06-10 | ||
last-updated: 2019-06-10 | ||
--- | ||
|
||
<!-- | ||
Formatting instructions for this document: | ||
- Create level 3 section for each glossary entry so other documents can consistently link to the definition. | ||
- Use a bullet list to define sub-entries or variations. | ||
- Wrap each sub-entry or variation in double underscores to have it rendered with emphasis. | ||
- Use semantic linefeeds (https://rhodesmill.org/brandon/2012/one-sentence-per-line/) | ||
--> | ||
|
||
# Glossary | ||
|
||
This document defines the terms used in other documents created by the Cluster API group. | ||
|
||
## Table of Contents | ||
|
||
[A](#a) | [B](#b) | [C](#c) | [D](#d) | [H](#h) | [I](#i) | [K](#k) | [M](#m) | [O](#o) | [P](#p) | [S](#s) | [W](#w) | ||
|
||
## A | ||
|
||
### Add-ons | ||
|
||
Services beyond the fundamental components of Kubernetes. | ||
|
||
* __Core Add-ons__: Addons that are required to deploy a Kubernetes-conformant cluster: DNS, kube-proxy, CNI. | ||
* __Additional Add-ons__: Addons that are not required for a Kubernetes-conformant cluster (e.g. metrics/Heapster, Dashboard). | ||
|
||
## B | ||
|
||
### Bootstrap | ||
|
||
The process of turning a server into a Kubernetes node. This may involve assembling data to provide when creating the server that backs the Machine, as well as runtime configuration of the software running on that server. | ||
|
||
## C | ||
|
||
### Cluster | ||
|
||
A full Kubernetes deployment. See Management Cluster and Workload Cluster | ||
|
||
### Cluster API | ||
|
||
Or __Cluster API project__ | ||
|
||
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. | ||
|
||
### Control plane | ||
|
||
The set of Kubernetes services that form the basis of a cluster. See also https://kubernetes.io/docs/concepts/#kubernetes-control-plane There are two variants: | ||
|
||
* __Self-provisioned__: A Kubernetes control plane consisting of pods or machines wholly managed by a single Cluster API deployment. | ||
* __External__: A control plane offered and controlled by some system other than Cluster API (e.g., GKE, AKS, EKS, IKS). | ||
|
||
## D | ||
|
||
### Default implementation | ||
|
||
A feature implementation offered as part of the Cluster API project, infrastructure providers can swap it out for a different one. | ||
|
||
## H | ||
|
||
### Horizontal Scaling | ||
|
||
The ability to add more machines based on policy and well defined metrics. For example, add a machine to a cluster when CPU load average > (X) for a period of time (Y). | ||
|
||
### Host | ||
|
||
see [Server](#server) | ||
|
||
## I | ||
|
||
### Infrastructure provider | ||
|
||
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. | ||
|
||
### Instance | ||
|
||
see [Server](#server) | ||
|
||
### Immutability | ||
|
||
A resource that does not mutate. In kubernetes we often state the instance of a running pod is immutable or does not change once it is run. In order to make a change, a new pod is run. In the context of [Cluster API](#cluster-api) we often refer to an running instance of a [Machine](#machine) is considered immutable, from a [Cluster API](#cluster-api) perspective. | ||
|
||
## K | ||
|
||
### Kubernetes-conformant | ||
|
||
Or __Kubernetes-compliant__ | ||
|
||
A cluster that passes the Kubernetes conformance tests. | ||
|
||
### K/K | ||
|
||
Refers to the [main Kubernetes git repository](https://github.com/kubernetes/kubernetes) or the main Kubernetes project. | ||
|
||
## M | ||
|
||
### Machine | ||
|
||
Or __Machine Resource__ | ||
|
||
The Custom Resource for Kubernetes that represents a request to have a place to run kubelet. | ||
|
||
See also: [Server](#server) | ||
|
||
### Manage a cluster | ||
|
||
Perform create, scale, upgrade, or destroy operations on the cluster. | ||
|
||
### Management cluster | ||
|
||
The cluster where one or more Infrastructure Providers run, and where resources (e.g. Machines) are stored. Typically referred to when you are provisioning multiple clusters. | ||
|
||
## O | ||
|
||
### Operating system | ||
|
||
Or __OS__ | ||
|
||
A generically understood combination of a kernel and system-level userspace interface, such as Linux or Windows, as opposed to a particular distribution. | ||
|
||
## P | ||
|
||
### Provider | ||
|
||
See [Infrastructure Provider](#user-content-infrastructure-provider) | ||
|
||
### Provider implementation | ||
|
||
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. | ||
|
||
## S | ||
|
||
### Scaling | ||
|
||
Unless otherwise specified, this refers to horizontal scaling. | ||
|
||
### Server | ||
|
||
The infrastructure that backs a [Machine Resource](#user-content-machine), typically either a cloud instance, virtual machine, or physical host. | ||
|
||
## W | ||
|
||
### Workload cluster | ||
|
||
A cluster whose lifecycle is managed by the Management cluster. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters