Fixes for `deploy.yaml`. (#15551)
* Fix deploy.yaml formatting and syntax. * Deploy entry schema fixes. - Rename `description` to `install_description` to avoid clashing with key that will be used for the tooltips for the integration cards. - Add `most_popular` key to match up with collector integrations.
Austin S. Hemmelgarn committed
Jul 26, 2023 at 11:32 UTC
34c178bab1197d8d5234516430dcec2800f8b389
2 files changed
+115
-99
integrations/deploy.yaml
+108
-97
@@ -8,7 +8,8 @@
8
icon_filename: 'linux.png'
9
keywords:
10
- linux
11
- description: 'Run the following command on your node to install and claim Netdata:'
11
+ most_popular: true
12
+ install_description: 'Run the following command on your node to install and claim Netdata:'
13
methods:
14
- method: wget
15
commands:
@@ -44,6 +45,7 @@
45
name: Ubuntu
46
link: https://ubuntu.com/
47
icon_filename: 'ubuntu.png'
48
+ most_popular: false
49
platform_info:
50
group: 'include'
51
distro: 'ubuntu'
@@ -55,6 +57,7 @@
57
name: Debian
58
link: https://www.debian.org/
59
icon_filename: 'debian.png'
60
+ most_popular: false
61
platform_info:
62
group: 'include'
63
distro: 'debian'
@@ -66,6 +69,7 @@
69
name: Fedora
70
link: https://www.fedoraproject.org/
71
icon_filename: 'fedora.png'
72
+ most_popular: false
73
platform_info:
74
group: 'include'
75
distro: 'fedora'
@@ -77,6 +81,7 @@
81
name: Red Hat Enterprise Linux
82
link: https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux
83
icon_filename: 'rhel.png'
84
+ most_popular: false
85
platform_info:
86
group: 'include'
87
distro: 'rhel'
@@ -88,6 +93,7 @@
93
name: Alma Linux
94
link: https://almalinux.org/
95
icon_filename: 'alma.png'
96
+ most_popular: false
97
platform_info:
98
group: 'include'
99
distro: 'almalinux'
@@ -99,6 +105,7 @@
105
name: Alpine Linux
106
link: https://www.alpinelinux.org/
107
icon_filename: 'alpine.png'
108
+ most_popular: false
109
platform_info:
110
group: 'include'
111
distro: 'alpinelinux'
@@ -110,6 +117,7 @@
117
name: Amazon Linux
118
link: https://aws.amazon.com/amazon-linux-2/
119
icon_filename: 'amazonlinux.png'
120
+ most_popular: false
121
platform_info:
122
group: 'include'
123
distro: 'amazonlinux'
@@ -121,6 +129,7 @@
129
name: Arch Linux
130
link: https://archlinux.org/
131
icon_filename: 'archlinux.png'
132
+ most_popular: false
133
platform_info:
134
group: 'include'
135
distro: 'archlinux'
@@ -132,6 +141,7 @@
141
name: CentOS
142
link: https://www.centos.org/
143
icon_filename: 'centos.png'
144
+ most_popular: false
145
platform_info:
146
group: 'include'
147
distro: 'centos'
@@ -143,6 +153,7 @@
153
name: Manjaro Linux
154
link: https://manjaro.org/
155
icon_filename: 'manjaro.png'
156
+ most_popular: false
157
platform_info:
158
group: 'include'
159
distro: 'archlinux'
@@ -154,6 +165,7 @@
165
name: Oracle Linux
166
link: https://www.oracle.com/linux/
167
icon_filename: 'oraclelinux.png'
168
+ most_popular: false
169
platform_info:
170
group: 'include'
171
distro: 'oraclelinux'
@@ -165,52 +177,53 @@
177
name: SUSE Linux
178
link: https://www.suse.com/
179
icon_filename: 'openSUSE.png'
180
+ most_popular: false
181
+ platform_info:
182
group: 'include'
183
distro: 'opensuse'
184
quick_start: -1
171
--
172
- id: deploy-macos
185
+- id: deploy-macos
186
meta:
187
name: MacOS
188
link: ''
189
categories:
190
- deploy.operating-systems
191
icon_filename: ''
192
+ most_popular: true
193
keywords:
194
- MacOS
195
- mac
182
- description: 'Run the following command on your Intel based OSX, macOS servers to install and claim Netdata:'
196
+ install_description: 'Run the following command on your Intel based OSX, macOS servers to install and claim Netdata:'
197
methods:
198
- method: curl
199
commands:
200
- channel: nightly
201
command: >
188
- curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
202
+ curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
203
--nightly-channel --claim-token {% claim_token %} --claim-url {% claim_url %}
204
- channel: stable
205
command: >
192
- curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
206
+ curl https://my-netdata.io/kickstart.sh > /tmp/netdata-kickstart.sh && sh /tmp/netdata-kickstart.sh
207
--stable-channel --claim-token {% claim_token %} --claim-url {% claim_url %}
194
- additional_info: &ref_containers >
195
- Did you know you can also deploy Netdata on your OS using {% goToCategory categoryId="deploy.docker-kubernetes" %}Kubernetes{% /goToCategory %} or {% goToCategory categoryId="deploy.docker-kubernetes" %}Docker{% /goToCategory %}?
208
+ additional_info: *ref_containers
209
related_resources: {}
210
platform_info:
211
group: 'include'
212
distro: 'macos'
213
quick_start: 5
201
--
202
- id: deploy-docker
214
+- id: deploy-docker
215
meta:
216
name: Docker
217
link: ''
218
categories:
219
- deploy.docker-kubernetes
220
icon_filename: 'docker.png'
221
+ most_popular: true
222
keywords:
223
- docker
224
- container
225
- containers
213
- description: |
226
+ install_description: |
227
Install and connect new Docker containers
228
Find the commands for `docker run`, `docker compose` or `Docker Swarm`. On the last two you can copy the configs, then run `docker-compose up -d` in the same directory as the `docker-compose.yml`
229
```
@@ -290,9 +303,9 @@
303
- /etc/os-release:/host/etc/os-release:ro
304
- /var/run/docker.sock:/var/run/docker.sock:ro
305
environment:
293
- - NETDATA_CLAIM_TOKEN={% claim_token %}
294
- - NETDATA_CLAIM_URL={% claim_url %}
295
- - NETDATA_CLAIM_ROOMS=
306
+ - NETDATA_CLAIM_TOKEN={% claim_token %}
307
+ - NETDATA_CLAIM_URL={% claim_url %}
308
+ - NETDATA_CLAIM_ROOMS=
309
volumes:
310
netdataconfig:
311
netdatalib:
@@ -323,9 +336,9 @@
336
- /etc/os-release:/host/etc/os-release:ro
337
- /var/run/docker.sock:/var/run/docker.sock:ro
338
environment:
326
- - NETDATA_CLAIM_TOKEN={% claim_token %}
327
- - NETDATA_CLAIM_URL={% claim_url %}
328
- - NETDATA_CLAIM_ROOMS=
339
+ - NETDATA_CLAIM_TOKEN={% claim_token %}
340
+ - NETDATA_CLAIM_URL={% claim_url %}
341
+ - NETDATA_CLAIM_ROOMS=
342
volumes:
343
netdataconfig:
344
netdatalib:
@@ -335,81 +348,78 @@
348
- channel: nightly
349
command: |
350
version: '3'
338
- services:
339
- netdata:
340
- image: netdata/netdata:edge
341
- container_name: netdata
342
- ports:
343
- - 19999:19999
344
- restart: unless-stopped
345
- cap_add:
346
- - SYS_PTRACE
347
- security_opt:
348
- - apparmor:unconfined
349
- volumes:
350
- - netdataconfig:/etc/netdata
351
- - netdatalib:/var/lib/netdata
352
- - netdatacache:/var/cache/netdata
353
- - /etc/passwd:/host/etc/passwd:ro
354
- - /etc/group:/host/etc/group:ro
355
- - /proc:/host/proc:ro
356
- - /sys:/host/sys:ro
357
- - /etc/os-release:/host/etc/os-release:ro
358
- - /etc/hostname:/etc/hostname:ro
359
- environment:
360
- - NETDATA_CLAIM_TOKEN={% claim_token %}
361
- - NETDATA_CLAIM_URL={% claim_url %}
362
- - NETDATA_CLAIM_ROOMS=
363
- deploy:
364
- mode: global
365
-
366
- volumes:
367
- netdataconfig:
368
- netdatalib:
369
- netdatacache:
351
+ services:
352
+ netdata:
353
+ image: netdata/netdata:edge
354
+ container_name: netdata
355
+ ports:
356
+ - 19999:19999
357
+ restart: unless-stopped
358
+ cap_add:
359
+ - SYS_PTRACE
360
+ security_opt:
361
+ - apparmor:unconfined
362
+ volumes:
363
+ - netdataconfig:/etc/netdata
364
+ - netdatalib:/var/lib/netdata
365
+ - netdatacache:/var/cache/netdata
366
+ - /etc/passwd:/host/etc/passwd:ro
367
+ - /etc/group:/host/etc/group:ro
368
+ - /proc:/host/proc:ro
369
+ - /sys:/host/sys:ro
370
+ - /etc/os-release:/host/etc/os-release:ro
371
+ - /etc/hostname:/etc/hostname:ro
372
+ environment:
373
+ - NETDATA_CLAIM_TOKEN={% claim_token %}
374
+ - NETDATA_CLAIM_URL={% claim_url %}
375
+ - NETDATA_CLAIM_ROOMS=
376
+ deploy:
377
+ mode: global
378
+ volumes:
379
+ netdataconfig:
380
+ netdatalib:
381
+ netdatacache:
382
- channel: stable
383
command: |
384
version: '3'
373
- services:
374
- netdata:
375
- image: netdata/netdata:stable
376
- container_name: netdata
377
- ports:
378
- - 19999:19999
379
- restart: unless-stopped
380
- cap_add:
381
- - SYS_PTRACE
382
- security_opt:
383
- - apparmor:unconfined
384
- volumes:
385
- - netdataconfig:/etc/netdata
386
- - netdatalib:/var/lib/netdata
387
- - netdatacache:/var/cache/netdata
388
- - /etc/passwd:/host/etc/passwd:ro
389
- - /etc/group:/host/etc/group:ro
390
- - /proc:/host/proc:ro
391
- - /sys:/host/sys:ro
392
- - /etc/os-release:/host/etc/os-release:ro
393
- - /etc/hostname:/etc/hostname:ro
394
- environment:
395
- - NETDATA_CLAIM_TOKEN={% claim_token %}
396
- - NETDATA_CLAIM_URL={% claim_url %}
397
- - NETDATA_CLAIM_ROOMS=
398
- deploy:
399
- mode: global
400
-
401
- volumes:
402
- netdataconfig:
403
- netdatalib:
404
- netdatacache:
385
+ services:
386
+ netdata:
387
+ image: netdata/netdata:stable
388
+ container_name: netdata
389
+ ports:
390
+ - 19999:19999
391
+ restart: unless-stopped
392
+ cap_add:
393
+ - SYS_PTRACE
394
+ security_opt:
395
+ - apparmor:unconfined
396
+ volumes:
397
+ - netdataconfig:/etc/netdata
398
+ - netdatalib:/var/lib/netdata
399
+ - netdatacache:/var/cache/netdata
400
+ - /etc/passwd:/host/etc/passwd:ro
401
+ - /etc/group:/host/etc/group:ro
402
+ - /proc:/host/proc:ro
403
+ - /sys:/host/sys:ro
404
+ - /etc/os-release:/host/etc/os-release:ro
405
+ - /etc/hostname:/etc/hostname:ro
406
+ environment:
407
+ - NETDATA_CLAIM_TOKEN={% claim_token %}
408
+ - NETDATA_CLAIM_URL={% claim_url %}
409
+ - NETDATA_CLAIM_ROOMS=
410
+ deploy:
411
+ mode: global
412
+ volumes:
413
+ netdataconfig:
414
+ netdatalib:
415
+ netdatacache:
416
additional_info: ''
417
related_resources: {}
418
platform_info:
419
group: 'no_include'
420
distro: 'docker'
421
quick_start: 3
411
--
412
- id: deploy-kubernetes
422
+- id: deploy-kubernetes
423
meta:
424
name: Kubernetes
425
link: ''
@@ -420,7 +430,7 @@
430
- kubernetes
431
- container
432
- Orchestrator
423
- description: |
433
+ install_description: |
434
**Use helm install to install Netdata on your Kubernetes cluster**
435
For a new installation use `helm install`` or for existing clusters add the content below to your `override.yamland`` then run `helm upgrade -f override.yml netdata netdata/netdata`
436
methods:
@@ -448,48 +458,48 @@
458
command: |
459
image:
460
tag: latest
451
-
461
+
462
restarter:
463
enabled: true
454
-
464
+
465
parent:
466
claiming:
467
enabled: true
468
token: {% claim_token %}
459
- rooms:
460
-
469
+ rooms:
470
+
471
child:
472
claiming:
473
enabled: true
474
token: {% claim_token %}
465
- rooms:
475
+ rooms:
476
- channel: stable
477
command: |
478
image:
479
tag: stable
470
-
480
+
481
restarter:
482
enabled: true
473
-
483
+
484
parent:
485
claiming:
486
enabled: true
487
token: {% claim_token %}
478
- rooms:
479
-
488
+ rooms:
489
+
490
child:
491
claiming:
492
enabled: true
493
token: {% claim_token %}
484
- rooms:
494
+ rooms:
495
additional_info: ''
496
related_resources: {}
497
+ most_popular: true
498
platform_info:
499
group: ''
500
distro: ''
501
quick_start: 4
491
--
492
- id: deploy-windows
502
+- id: deploy-windows
503
meta:
504
name: Windows
505
link: ''
@@ -498,7 +508,7 @@
508
icon_filename: 'windows.png'
509
keywords:
510
- windows
501
- description: |
511
+ install_description: |
512
1. Install [Windows Exporter](https://github.com/prometheus-community/windows_exporter) on every Windows host you want to monitor.
513
2. Install Netdata agent on Linux, FreeBSD or Mac.
514
3. Configure Netdata to collect data remotely from your Windows hosts by adding one job per host to windows.conf file. See the [configuration section](https://learn.netdata.cloud/docs/data-collection/monitor-anything/System%20Metrics/Windows-machines#configuration) for details.
@@ -526,6 +536,7 @@
536
--stable-channel --claim-token {% claim_token %} --claim-url {% claim_url %}
537
additional_info: ''
538
related_resources: {}
539
+ most_popular: true
540
platform_info:
541
group: ''
542
distro: ''
integrations/schemas/deploy.json
+7
-2
@@ -15,7 +15,11 @@
15
"keywords": {
16
"$ref": "./shared.json#/$defs/keywords"
17
},
18
- "description": {
18
+ "most_popular": {
19
+ "type": "boolean",
20
+ "description": "If true, the integration is sorted to the top of the list of integrations."
21
+ },
22
+ "install_description": {
23
"type": "string",
24
"description": "Describes basic information about how to deploy on this platform."
25
},
@@ -100,7 +104,8 @@
104
"id",
105
"meta",
106
"keywords",
103
- "description",
107
+ "most_popular",
108
+ "install_description",
109
"methods",
110
"additional_info",
111
"related_resources",