ftd 0.2.0

ftd: FifthTry Document Format
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
-- import: ft

-- ftd.color efefef: #efefef
dark: #efefef

-- ftd.color white: white
dark: white

-- ftd.color ebe2ce: #ebe2ce
dark: #ebe2ce

-- ftd.color d9e7f8: #d9e7f8
dark: #d9e7f8

-- ftd.color dc9eb3: #dc9eb3
dark: #dc9eb3

-- ftd.color 76c2c4: #76c2c4
dark: #76c2c4

-- ftd.color fce251: #fce251
dark: #fce251

-- ftd.color d2d2ce: #d2d2ce
dark: #d2d2ce

-- ftd.color f09483: #f09483
dark: #f09483

-- ftd.color yellow: yellow
dark: yellow

-- string info: Click on various components to see the related-information.
-- string kubernetes-info:

Kubernetes: A Kubernetes cluster consists of a set of worker machines, called nodes, that run containerized applications. Every cluster has at least one worker node.

The worker node(s) host the Pods that are the components of the application workload. The control plane manages the worker nodes and the Pods in the cluster. In production environments, the control plane usually runs across multiple computers and a cluster usually runs multiple nodes, providing fault-tolerance and high availability.


-- string control-panel-info:

Control Panel: The control planes components make global decisions about the cluster (for example, scheduling), as well as detecting and responding to cluster events (for example, starting up a new pod when a deployments replicas field is unsatisfied).

Control plane components can be run on any machine in the cluster. However, for simplicity, set up scripts typically start all control plane components on the same machine, and do not run user containers on this machine. See Creating Highly Available clusters with kubeadm for an example control plane setup that runs across multiple VMs.


-- string kube-apiserver-info:

Kube Api Server: The API server is a component of the Kubernetes control plane that exposes the Kubernetes API. The API server is the front end for the Kubernetes control plane.

The main implementation of a Kubernetes API server is kube-apiserver. kube-apiserver is designed to scale horizontally—that is, it scales by deploying more instances. You can run several instances of kube-apiserver and balance traffic between those instances.


-- string etcd-info:

etcd: Consistent and highly-available key value store used as Kubernetes backing store for all cluster data.

If your Kubernetes cluster uses etcd as its backing store, make sure you have a back up plan for those data.


-- string kube-controller-manager-info:

Kube Controller Manager: Control plane component that runs controller processes.

Logically, each controller is a separate process, but to reduce complexity, they are all compiled into a single binary and run in a single process.


-- string node-controller-info: Node controller: Responsible for noticing and responding when nodes go down.
-- string replication-controller-info: Replication Controller: Watches for Job objects that represent one-off tasks, then creates Pods to run those tasks to completion.
-- string endpoints-controller-info: Endpoints controller: Populates the Endpoints object (that is, joins Services & Pods).
-- string service-account-token-controller-info: Service Account & Token controllers: Create default accounts and API access tokens for new namespaces.

-- string cloud-controller-manager-info:

Cloud controller manager: A Kubernetes control plane component that embeds cloud-specific control logic. The cloud controller manager lets you link your cluster into your cloud providers API, and separates out the components that interact with that cloud platform from components that only interact with your cluster.
The cloud-controller-manager only runs controllers that are specific to your cloud provider. If you are running Kubernetes on your own premises, or in a learning environment inside your own PC, the cluster does not have a cloud controller manager.

As with the kube-controller-manager, the cloud-controller-manager combines several logically independent control loops into a single binary that you run as a single process. You can scale horizontally (run more than one copy) to improve performance or to help tolerate failures.

-- string cloud-node-controller-info: Node controller: For checking the cloud provider to determine if a node has been deleted in the cloud after it stops responding
-- string cloud-route-controller-info:  Route controller: For setting up routes in the underlying cloud infrastructure
-- string cloud-service-controller-info: Service controller: For creating, updating and deleting cloud provider load balancers

-- string nodes-info: Node Components: Node components run on every node, maintaining running pods and providing the Kubernetes runtime environment.

-- string kubelet-info:

Kubelet: An agent that runs on each node in the cluster. It makes sure that containers are running in a Pod.

The kubelet takes a set of PodSpecs that are provided through various mechanisms and ensures that the containers described in those PodSpecs are running and healthy. The kubelet doesnt manage containers which were not created by Kubernetes.

-- string kube-proxy-info:

Kube-proxy: kube-proxy is a network proxy that runs on each node in your cluster, implementing part of the Kubernetes Service concept.

kube-proxy maintains network rules on nodes. These network rules allow network communication to your Pods from network sessions inside or outside of your cluster.

kube-proxy uses the operating system packet filtering layer if there is one and its available. Otherwise, kube-proxy forwards the traffic itself.

-- string container-runtime-info:

Container runtime: The container runtime is the software that is responsible for running containers.

Kubernetes supports several container runtimes: Docker, containerd, CRI-O, and any implementation of the Kubernetes CRI (Container Runtime Interface).



-- ftd.column:
background-color: $efefef
width: fill
height: fill
padding: 40

-- ft.h0: Architectural Diagram

-- ftd.scene:
background-color: $white
width: 1350
height: 540
align: center
$on-click$: $info = $kubernetes-info

--- control-panel:
left: 50
top: 20
$on-click$: $info = $control-panel-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- nodes:
top: 20
right: 50
$on-click$: $info = $nodes-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- ftd.text: Kubernetes Architecture
bottom: 10
left: 10

--- vertical-line:
length: 231
top: 207
left: 612

--- vertical-line:
length: 46
top: 154
right: 462

--- vertical-line:
length: 46
top: 266
right: 462

--- horizontal-line:
length: 113
top: 154
right: 506


-- ftd.column:
background-color: $ebe2ce
width: fill
padding: 10
margin-top: 20

--- ftd.column:
width: fill
padding: 10
border-width: 1
spacing: 5

--- ftd.text: Notes:
/style: bold

--- ftd.text:

$info



-- ftd.scene control-panel:
background-color: $d9e7f8
border-color if $MOUSE-IN: $yellow
border-width if $MOUSE-IN: 3
border-width: 2
width: 600
height: 460
align: center

--- ftd.text: Control Panel
top: 5
left: 5

--- kube-controller-manager:
top: 50
left: 20
$on-click$: $info = $kube-controller-manager-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- kube-api-server:
top: 50
right: 35
$on-click$: $info = $kube-apiserver-info
$on-click$: stop-propagation
$on-click$: prevent-default


--- etcd:
top: 220
left: 40


--- cloud-controller-manager:
top: 300
left: 20
$on-click$: $info = $cloud-controller-manager-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- vertical-line:
length: 42
top: 100
right: 135

--- vertical-line:
length: 353
top: 250
left: 108

--- horizontal-line:
length: 50
top: 251
left: 304


-- ftd.text etcd: etcd
padding: 20
border-width: 1
border-radius: 30
background-color: $white
border-color if $MOUSE-IN: $yellow
border-width if $MOUSE-IN: 3
$on-click$: $info = $etcd-info
$on-click$: stop-propagation
$on-click$: prevent-default



-- ftd.column kube-controller-manager:

--- box:
background-color: $dc9eb3
title: Kube Controller Manager

--- text-block: Node Controller
$on-click$: $info = $node-controller-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- text-block: Replication Controller
$on-click$: $info = $replication-controller-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- text-block: Endpoints Controller
$on-click$: $info = $endpoints-controller-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- text-block: Service Account & Token Controller
$on-click$: $info = $service-account-token-controller-info
$on-click$: stop-propagation
$on-click$: prevent-default



-- ftd.column cloud-controller-manager:

--- box:
background-color: $76c2c4
title: Cloud Controller Manager

--- text-block: Node Controller
$on-click$: $info = $cloud-node-controller-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- text-block: Route Controller
$on-click$: $info = $cloud-route-controller-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- text-block: Service Controller
$on-click$: $info = $cloud-service-controller-info
$on-click$: stop-propagation
$on-click$: prevent-default





-- ftd.row kube-api-server:
width: 100
height: 270
background-color: $fce251
border-width: 1
padding: 20
border-color if $MOUSE-IN: $yellow
border-width if $MOUSE-IN: 3

--- ftd.text: Kube Api Server
align: center






-- ftd.scene nodes:
background-color: $d2d2ce
border-width: 2
width: 600
height: 460
align: center
border-color if $MOUSE-IN: $yellow
border-width if $MOUSE-IN: 3

--- ftd.text: Nodes
top: 5
left: 5

--- ftd.column:
top: 50
left: 90
background-color: $f09483
width: 400
height: 300
border-width: 1

--- container: ftd.main

--- worker-node:
top: 70
left: 115




-- ftd.scene worker-node:
background-color: $f09483
width: 400
height: 300
border-width: 1

--- ftd.text: Worker Node
top: 5
left: 5

--- text-block: Kubelet
left: 70
top: 50
$on-click$: $info = $kubelet-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- text-block: Kube Proxy
left: 70
top: 150
$on-click$: $info = $kube-proxy-info
$on-click$: stop-propagation
$on-click$: prevent-default

--- text-block: Container Runtime
left: 180
top: 100
$on-click$: $info = $container-runtime-info
$on-click$: stop-propagation
$on-click$: prevent-default



-- ftd.column box:
optional ftd.color background-color:
string title:
background-color: $background-color
border-width: 1
spacing: 20
width: 400
align: center
open: true
append-at: box-id
padding: 15
border-color if $MOUSE-IN: $yellow
border-width if $MOUSE-IN: 3

--- ftd.text: $title
top: 5
left: 5

--- ftd.row:
spacing: space-around
width: fill
top: 40
left: 0
id: box-id



-- ftd.text text-block: $text
caption text:
background-color: $white
width: 80
padding: 5
align: center
border-width: 1
border-color if $MOUSE-IN: $yellow
border-width if $MOUSE-IN: 3

-- ftd.row vertical-line:
string length:
width: $length
height: 1
border-width: 1
open: false

-- ftd.row horizontal-line:
string length:
height: $length
width: 1
border-width: 1
open: false