Skip to content

Commit f96ac27

Browse files
dhellmannk8s-ci-robot
dhellmann
authored and
k8s-ci-robot
committed
add glossary to documentation (kubernetes-sigs#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
1 parent d48025d commit f96ac27

File tree

3 files changed

+164
-0
lines changed

3 files changed

+164
-0
lines changed

‎docs/book/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
## Getting Started
66

7+
* [Glossary](../glossary.md)
78
* [Existing Providers](getting_started/existing_providers.md)
89

910
## Common Code

‎docs/glossary.md

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
---
2+
title: Glossary
3+
authors:
4+
- "@dhellmann"
5+
- "@timothysc"
6+
reviewers:
7+
- "@timothysc"
8+
- "@justinsb"
9+
- "@detiber"
10+
- "@davidewatson"
11+
- "@vincepri"
12+
creation-date: 2019-06-10
13+
last-updated: 2019-06-10
14+
---
15+
16+
<!--
17+
18+
Formatting instructions for this document:
19+
20+
- Create level 3 section for each glossary entry so other documents can consistently link to the definition.
21+
- Use a bullet list to define sub-entries or variations.
22+
- Wrap each sub-entry or variation in double underscores to have it rendered with emphasis.
23+
- Use semantic linefeeds (https://rhodesmill.org/brandon/2012/one-sentence-per-line/)
24+
25+
-->
26+
27+
# Glossary
28+
29+
This document defines the terms used in other documents created by the Cluster API group.
30+
31+
## Table of Contents
32+
33+
[A](#a) | [B](#b) | [C](#c) | [D](#d) | [H](#h) | [I](#i) | [K](#k) | [M](#m) | [O](#o) | [P](#p) | [S](#s) | [W](#w)
34+
35+
## A
36+
37+
### Add-ons
38+
39+
Services beyond the fundamental components of Kubernetes.
40+
41+
* __Core Add-ons__: Addons that are required to deploy a Kubernetes-conformant cluster: DNS, kube-proxy, CNI.
42+
* __Additional Add-ons__: Addons that are not required for a Kubernetes-conformant cluster (e.g. metrics/Heapster, Dashboard).
43+
44+
## B
45+
46+
### Bootstrap
47+
48+
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.
49+
50+
## C
51+
52+
### Cluster
53+
54+
A full Kubernetes deployment. See Management Cluster and Workload Cluster
55+
56+
### Cluster API
57+
58+
Or __Cluster API project__
59+
60+
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.
61+
62+
### Control plane
63+
64+
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:
65+
66+
* __Self-provisioned__: A Kubernetes control plane consisting of pods or machines wholly managed by a single Cluster API deployment.
67+
* __External__: A control plane offered and controlled by some system other than Cluster API (e.g., GKE, AKS, EKS, IKS).
68+
69+
## D
70+
71+
### Default implementation
72+
73+
A feature implementation offered as part of the Cluster API project, infrastructure providers can swap it out for a different one.
74+
75+
## H
76+
77+
### Horizontal Scaling
78+
79+
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).
80+
81+
### Host
82+
83+
see [Server](#server)
84+
85+
## I
86+
87+
### Infrastructure provider
88+
89+
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.
90+
91+
### Instance
92+
93+
see [Server](#server)
94+
95+
### Immutability
96+
97+
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.
98+
99+
## K
100+
101+
### Kubernetes-conformant
102+
103+
Or __Kubernetes-compliant__
104+
105+
A cluster that passes the Kubernetes conformance tests.
106+
107+
### K/K
108+
109+
Refers to the [main Kubernetes git repository](https://github.com/kubernetes/kubernetes) or the main Kubernetes project.
110+
111+
## M
112+
113+
### Machine
114+
115+
Or __Machine Resource__
116+
117+
The Custom Resource for Kubernetes that represents a request to have a place to run kubelet.
118+
119+
See also: [Server](#server)
120+
121+
### Manage a cluster
122+
123+
Perform create, scale, upgrade, or destroy operations on the cluster.
124+
125+
### Management cluster
126+
127+
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.
128+
129+
## O
130+
131+
### Operating system
132+
133+
Or __OS__
134+
135+
A generically understood combination of a kernel and system-level userspace interface, such as Linux or Windows, as opposed to a particular distribution.
136+
137+
## P
138+
139+
### Provider
140+
141+
See [Infrastructure Provider](#user-content-infrastructure-provider)
142+
143+
### Provider implementation
144+
145+
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.
146+
147+
## S
148+
149+
### Scaling
150+
151+
Unless otherwise specified, this refers to horizontal scaling.
152+
153+
### Server
154+
155+
The infrastructure that backs a [Machine Resource](#user-content-machine), typically either a cloud instance, virtual machine, or physical host.
156+
157+
## W
158+
159+
### Workload cluster
160+
161+
A cluster whose lifecycle is managed by the Management cluster.

‎docs/scope-and-objectives.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ We are building a set of Kubernetes cluster management APIs to enable common clu
4040

4141
## Glossary
4242

43+
[See glossary.md](glossary.md)
44+
4345
- __Cluster API__: Unless otherwise specified, this refers to the project as a whole.
4446
- __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.
4547
- __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.

0 commit comments

Comments
 (0)