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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
|
=======================
Metrics Developer Guide
=======================
Anible File Organization
========================
Ansible-Server
--------------
Please follow the following file structure:
.. code-block:: bash
ansible-server
| ansible.cfg
| hosts
|
+---group_vars
| all.yml
|
+---playbooks
| clean.yaml
| setup.yaml
|
\---roles
+---clean-monitoring
| \---tasks
| main.yml
|
+---monitoring
+---files
| | monitoring-namespace.yaml
| |
| +---alertmanager
| | alertmanager-config.yaml
| | alertmanager-deployment.yaml
| | alertmanager-service.yaml
| | alertmanager1-deployment.yaml
| | alertmanager1-service.yaml
| |
| +---cadvisor
| | cadvisor-daemonset.yaml
| | cadvisor-service.yaml
| |
| +---collectd-exporter
| | collectd-exporter-deployment.yaml
| | collectd-exporter-service.yaml
| |
| +---grafana
| | grafana-datasource-config.yaml
| | grafana-deployment.yaml
| | grafana-pv.yaml
| | grafana-pvc.yaml
| | grafana-service.yaml
| |
| +---kube-state-metrics
| | kube-state-metrics-deployment.yaml
| | kube-state-metrics-service.yaml
| |
| +---node-exporter
| | nodeexporter-daemonset.yaml
| | nodeexporter-service.yaml
| |
| \---prometheus
| main-prometheus-service.yaml
| prometheus-config.yaml
| prometheus-deployment.yaml
| prometheus-pv.yaml
| prometheus-pvc.yaml
| prometheus-service.yaml
| prometheus1-deployment.yaml
| prometheus1-service.yaml
|
\---tasks
main.yml
Ansible - Client
----------------
Please follow the following file structure:
.. code-block:: bash
ansible-server
| ansible.cfg
| hosts
|
+---group_vars
| all.yml
|
+---playbooks
| clean.yaml
| setup.yaml
|
\---roles
+---clean-collectd
| \---tasks
| main.yml
|
+---collectd
+---files
| collectd.conf.j2
|
\---tasks
main.yml
Summary of Roles
================
A brief description of the Ansible playbook roles,
which are used to deploy the monitoring cluster
Ansible Server Roles
--------------------
Ansible Server, this part consists of the roles used to deploy
Prometheus Alertmanager Grafana stack on the server-side
Role: Monitoring
~~~~~~~~~~~~~~~~
Deployment and configuration of PAG stack along with collectd-exporter,
cadvisor and node-exporter.
Role: Clean-Monitoring
~~~~~~~~~~~~~~~~~~~~~~
Removes all the components deployed by the Monitoring role.
File-Task Mapping and Configurable Parameters
================================================
Ansible Server
----------------
Role: Monitoring
~~~~~~~~~~~~~~~~~~~
Alert Manager
^^^^^^^^^^^^^^^
File: alertmanager-config.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/alertmanager/alertmanager-config.yaml
Task: Configures Receivers for alertmanager
Summary: A configmap, currently configures webhook for alertmanager,
can be used to configure any kind of receiver
Configurable Parameters:
receiver.url: change to the webhook receiver's URL
route: Can be used to add receivers
File: alertmanager-deployment.yaml
''''''''''''''''''''''''''''''''''
Path : monitoring/files/alertmanager/alertmanager-deployment.yaml
Task: Deploys alertmanager instance
Summary: A Deployment, deploys 1 replica of alertmanager
File: alertmanager-service.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/alertmanager/alertmanager-service.yaml
Task: Creates a K8s service for alertmanager
Summary: A Nodeport type of service, so that user can create "silences",
view the status of alerts from the native alertmanager dashboard / UI.
Configurable Parameters:
spec.type: Options : NodePort, ClusterIP, LoadBalancer
spec.ports: Edit / add ports to be handled by the service
**Note: alertmanager1-deployment, alertmanager1-service are the same as
alertmanager-deployment and alertmanager-service respectively.**
CAdvisor
^^^^^^^^^^^
File: cadvisor-daemonset.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/cadvisor/cadvisor-daemonset.yaml
Task: To create a cadvisor daemonset
Summary: A daemonset, used to scrape data of the kubernetes cluster itself,
its a daemonset so an instance is run on every node.
Configurable Parameters:
spec.template.spec.ports: Port of the container
File: cadvisor-service.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/cadvisor/cadvisor-service.yaml
Task: To create a cadvisor service
Summary: A ClusterIP service for cadvisor to communicate with prometheus
Configurable Parameters:
spec.ports: Add / Edit ports
Collectd Exporter
^^^^^^^^^^^^^^^^^^^^
File: collectd-exporter-deployment.yaml
''''''''''''''''''''''''''''''''''''''''''
Path : monitoring/files/collectd-exporter/collectd-exporter-deployment.yaml
Task: To create a collectd replica
Summary: A deployment, acts as receiver for collectd data sent by client machines,
prometheus pulls data from this exporter
Configurable Parameters:
spec.template.spec.ports: Port of the container
File: collectd-exporter.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/collectd-exporter/collectd-exporter.yaml
Task: To create a collectd service
Summary: A NodePort service for collectd-exporter to hold data for prometheus
to scrape
Configurable Parameters:
spec.ports: Add / Edit ports
Grafana
^^^^^^^^^
File: grafana-datasource-config.yaml
''''''''''''''''''''''''''''''''''''''''''
Path : monitoring/files/grafana/grafana-datasource-config.yaml
Task: To create config file for grafana
Summary: A configmap, adds prometheus datasource in grafana
File: grafana-deployment.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/grafana/grafana-deployment.yaml
Task: To create a grafana deployment
Summary: The grafana deployment creates a single replica of grafana,
with preconfigured prometheus datasource.
Configurable Parameters:
spec.template.spec.ports: Edit ports
spec.template.spec.env: Add / Edit environment variables
File: grafana-pv.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/grafana/grafana-pv.yaml
Task: To create a persistent volume for grafana
Summary: A persistent volume for grafana.
Configurable Parameters:
spec.capacity.storage: Increase / decrease size
spec.accessModes: To change the way PV is accessed.
spec.nfs.server: To change the ip address of NFS server
spec.nfs.path: To change the path of the server
File: grafana-pvc.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/grafana/grafana-pvc.yaml
Task: To create a persistent volume claim for grafana
Summary: A persistent volume claim for grafana.
Configurable Parameters:
spec.resources.requests.storage: Increase / decrease size
File: grafana-service.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/grafana/grafana-service.yaml
Task: To create a service for grafana
Summary: A Nodeport type of service, so that users actually connect to,
view the dashboard / UI.
Configurable Parameters:
spec.type: Options : NodePort, ClusterIP, LoadBalancer
spec.ports: Edit / add ports to be handled by the service
Kube State Metrics
^^^^^^^^^^^^^^^^^^^^
File: kube-state-metrics-deployment.yaml
''''''''''''''''''''''''''''''''''''''''
Path : monitoring/files/kube-state-metrics/kube-state-metrics-deployment.yaml
Task: To create a kube-state-metrics instance
Summary: A deployment, used to collect metrics of the kubernetes cluster iteself
Configurable Parameters:
spec.template.spec.containers.ports: Port of the container
File: kube-state-metrics-service.yaml
'''''''''''''''''''''''''''''''''''''
Path : monitoring/files/kube-state-metrics/kube-state-metrics-service.yaml
Task: To create a collectd service
Summary: A NodePort service for collectd-exporter to hold data for prometheus
to scrape
Configurable Parameters:
spec.ports: Add / Edit ports
Node Exporter
^^^^^^^^^^^^^^^
File: node-exporter-daemonset.yaml
''''''''''''''''''''''''''''''''''
Path : monitoring/files/node-exporter/node-exporter-daemonset.yaml
Task: To create a node exporter daemonset
Summary: A daemonset, used to scrape data of the host machines / node,
its a daemonset so an instance is run on every node.
Configurable Parameters:
spec.template.spec.ports: Port of the container
File: node-exporter-service.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/node-exporter/node-exporter-service.yaml
Task: To create a node exporter service
Summary: A ClusterIP service for node exporter to communicate with Prometheus
Configurable Parameters:
spec.ports: Add / Edit ports
Prometheus
^^^^^^^^^^^^^
File: prometheus-config.yaml
''''''''''''''''''''''''''''''''''''''''''
Path : monitoring/files/prometheus/prometheus-config.yaml
Task: To create a config file for Prometheus
Summary: A configmap, adds alert rules.
Configurable Parameters:
data.alert.rules: Add / Edit alert rules
File: prometheus-deployment.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/prometheus/prometheus-deployment.yaml
Task: To create a Prometheus deployment
Summary: The Prometheus deployment creates a single replica of Prometheus,
with preconfigured Prometheus datasource.
Configurable Parameters:
spec.template.spec.affinity: To change the node affinity,
make sure only 1 instance of prometheus is
running on 1 node.
spec.template.spec.ports: Add / Edit container port
File: prometheus-pv.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/prometheus/prometheus-pv.yaml
Task: To create a persistent volume for Prometheus
Summary: A persistent volume for Prometheus.
Configurable Parameters:
spec.capacity.storage: Increase / decrease size
spec.accessModes: To change the way PV is accessed.
spec.hostpath.path: To change the path of the volume
File: prometheus-pvc.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/prometheus/prometheus-pvc.yaml
Task: To create a persistent volume claim for Prometheus
Summary: A persistent volume claim for Prometheus.
Configurable Parameters:
spec.resources.requests.storage: Increase / decrease size
File: prometheus-service.yaml
'''''''''''''''''''''''''''''''''
Path : monitoring/files/prometheus/prometheus-service.yaml
Task: To create a service for prometheus
Summary: A Nodeport type of service, prometheus native dashboard
available here.
Configurable Parameters:
spec.type: Options : NodePort, ClusterIP, LoadBalancer
spec.ports: Edit / add ports to be handled by the service
File: main-prometheus-server.yaml
'''''''''''''''''''''''''''''''''''
Path: monitoring/files/prometheus/main-prometheus-service.yaml
Task: A service that connects both prometheus instances.
Summary: A Nodeport service for other services to connect to the Prometheus cluster.
As HA Prometheus needs to independent instances of Prometheus scraping the same inputs
having the same configuration
**Note: prometheus-deployment, prometheus1-service are the same as
prometheus-deployment and prometheus-service respectively.**
Ansible Client Roles
----------------------
Role: Collectd
~~~~~~~~~~~~~~~~~~
File: main.yml
^^^^^^^^^^^^^^^^
Path: collectd/tasks/main.yaml
Task: Install collectd along with prerequisites
Associated template file:
collectd.conf.j2
Path: collectd/files/collectd.conf.j2
Summary: Edit this file to change the default configuration to
be installed on the client's machine
|
