-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathcndi_config.schema.json
592 lines (592 loc) · 21.3 KB
/
cndi_config.schema.json
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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "cndi_config",
"$comment": "The root of the cndi config schema",
"description": "A configuration file for CNDI that defines the hardware and software of your cluster",
"required": ["infrastructure"],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"provider": { "const": "aws" }
},
"required": ["provider"]
},
"then": {
"properties": {
"distribution": {
"enum": ["microk8s", "eks", "clusterless"]
}
}
}
},
{
"if": {
"properties": {
"provider": { "const": "gcp" }
},
"required": ["provider"]
},
"then": {
"properties": {
"distribution": {
"enum": ["microk8s", "gke", "clusterless"]
}
}
}
},
{
"if": {
"properties": {
"provider": { "const": "azure" }
},
"required": ["provider"]
},
"then": {
"properties": {
"distribution": {
"enum": ["microk8s", "aks", "clusterless"]
}
}
}
},
{
"if": {
"properties": {
"provider": { "const": "dev" }
},
"required": ["provider"]
},
"then": {
"properties": {
"distribution": {
"enum": ["microk8s"]
}
}
}
}
],
"properties": {
"project_name": {
"type": "string",
"description": "The name of the cndi project, should be unique in your personal ecosystem.",
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"cndi_version": {
"type": "string",
"description": "The version of cndi config api to use.",
"pattern": "v2",
"default": "v2"
},
"provider": {
"type": "string",
"description": "The cloud provider to use for the infrastructure.",
"enum": ["aws", "gcp", "azure", "dev"]
},
"distribution": {
"type": "string",
"description": "The distribution of Kubernetes to use for the infrastructure.",
"enum": ["microk8s", "eks", "gke", "aks", "clusterless"]
},
"infrastructure": {
"type": "object",
"description": "An object which defines the infrastructure resources CNDI should deploy.",
"required": ["cndi"],
"properties": {
"terraform": {
"properties": {
"terraform": {},
"provider": {},
"variable": {},
"locals": {},
"data": {},
"resource": {},
"module": {},
"output": {}
},
"additionalProperties": false
},
"cndi": {
"type": "object",
"description": "An object which contains the resources CNDI should deploy, which are defined by the CNDI project.",
"required": ["nodes"],
"additionalProperties": false,
"properties": {
"argocd": {
"type": "object",
"description": "An object which defines the ArgoCD resources CNDI should deploy.",
"properties": {
"hostname": {
"type": "string",
"description": "The hostname on which to make your CNDI ArgoCD available."
}
}
},
"observability": {
"type": "object",
"description": "An object which defines the observability resources CNDI should deploy.",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether or not to deploy the observability resources."
},
"mode": {
"type": "string",
"enum": ["in_cluster"]
},
"grafana": {
"type": "object",
"description": "An object which defines the Grafana resources CNDI should deploy.",
"properties": {
"hostname": {
"type": "string",
"description": "The hostname on which to make your CNDI Observability Dashboards available."
}
},
"additionalProperties": false
},
"kube_prometheus_stack": {
"type": "object",
"description": "An object which defines the kube_prometheus_stack resources CNDI should deploy.",
"properties": {
"targetRevision": {
"type": "string",
"description": "The version or revision of the Loki Helm Chart to deploy."
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether or not to deploy the Loki resources."
},
"values": {
"type": "object",
"description": "An object which defines the values to be passed to the kube-prometheus-stack Helm Chart."
}
},
"additionalProperties": false
},
"loki": {
"type": "object",
"description": "An object which defines the Loki resources CNDI should deploy.",
"properties": {
"targetRevision": {
"type": "string",
"description": "The version or revision of the Loki Helm Chart to deploy."
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether or not to deploy the Loki resources."
},
"values": {
"type": "object",
"description": "An object which defines the values to be passed to the Loki Helm Chart."
}
},
"additionalProperties": false
},
"promtail": {
"type": "object",
"description": "An object which defines the Promtail resources CNDI should deploy.",
"properties": {
"targetRevision": {
"type": "string",
"description": "The version or revision of the Promtail Helm Chart to deploy."
},
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether or not to deploy the Loki resources."
},
"values": {
"type": "object",
"description": "An object which defines the values to be passed to the Loki Helm Chart."
}
},
"additionalProperties": false
}
}
},
"network": {
"type": "object",
"description": "An object which defines the properties of the network in which your cluster will be deployed.",
"properties": {
"mode": {
"type": "string",
"enum": ["create", "insert"]
}
},
"if": {
"properties": {
"mode": { "const": "create" }
}
},
"then": {
"additionalProperties": false,
"properties": {
"mode": {
"type": "string",
"enum": ["create"]
},
"vnet_address_space": {
"type": "string",
"description": "The address space used to create your CNDI cluster virtual network in 'create' mode.",
"default": "10.0.0.0/16"
}
}
},
"else": {
"additionalProperties": false,
"properties": {
"mode": {
"type": "string",
"enum": ["insert"]
},
"vnet_identifier": {
"type": "string",
"description": "The identifier of the virtual network which to deploy your cluster."
},
"subnet_address_space": {
"type": "string",
"description": "The address space used to create your CNDI cluster subnet in 'insert' mode.",
"default": "10.0.0.0/20"
}
}
}
},
"functions": {
"type": "object",
"properties": {
"hostname": {
"type": "string",
"description": "The hostname on which to make your CNDI Functions available."
}
}
},
"external_dns": {
"type": "object",
"description": "An optional object to configure the Bitnami external-dns Kubernetes controller.",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether or not to deploy the external-dns controller."
},
"provider": {
"type": "string",
"description": "The DNS provider the external-dns controller should send updates to."
},
"domain_filters": {
"description": "An array of domain name filters which the external-dns controller should apply updates to.",
"type": "array",
"items": {
"type": "string"
}
},
"values": {
"type": "object"
}
},
"additionalProperties": false
},
"reloader": {
"type": "object",
"description": "An optional object which permits disabling the reloader Kubernetes controller.",
"properties": {
"enabled": {
"type": "boolean",
"default": true
}
},
"additionalProperties": false
},
"cert_manager": {
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"self_signed": {
"type": "boolean",
"description": "Whether or not the certificate should be self-signed (insecure).\n Can only be true if \"email\" is not defined.",
"default": false
},
"email": {
"type": "string",
"description": "The email address let's encrypt should attach to your certificates.\n Can only be used if \"self_signed\" is false or undefined."
}
},
"oneOf": [
{
"properties": {
"self_signed": { "const": true },
"email": {
"not": {}
},
"enabled": {
"type": "boolean",
"default": true
}
},
"required": ["self_signed"],
"additionalProperties": false
},
{
"properties": {
"self_signed": { "enum": [false] },
"email": {},
"enabled": {
"type": "boolean",
"default": true
}
},
"required": ["email"],
"additionalProperties": false
}
],
"additionalProperties": false
},
"open_ports": {
"type": "array",
"description": "An array of ports to open on the cluster.",
"items": {
"type": "object",
"description": "A port to open or close for TCP traffic into the cluster.",
"properties": {
"number": {
"type": "number",
"description": "The number of the port to open TCP traffic for.",
"minimum": 1,
"maximum": 65535
},
"name": {
"type": "string"
},
"disable": {
"type": "boolean",
"default": false
},
"namespace": {
"type": "string",
"description": "The Kubernetes Namespace of the Service to open the port for."
},
"service": {
"type": "string",
"description": "The Kubernetes Service to open the port for."
}
}
}
},
"nodes": {
"$comment": "An array of CNDI cluster nodes to deploy.",
"minItems": 1,
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"description": "An object which defines the properties of a new Kubernetes node for CNDI to deploy. At least one must be have the \"role\" property set to \"leader\".",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "The name of the node or node group to deploy."
},
"role": {
"type": "string",
"description": "Role of the node",
"enum": ["leader", "controller", "worker"]
},
"instance_type": {},
"volume_size": {
"type": "number",
"description": "The amount of disk to allocate to the node in G.",
"minimum": 1
},
"count": {
"type": "number",
"description": "The number of nodes to deploy.",
"minimum": 1,
"default": 1
},
"disk": {
"oneOf": [
{
"type": "string",
"description": "The amount of disk to allocate to the node.",
"pattern": "^[0-9]+(?:G|M|K)$"
},
{
"type": "number",
"description": "The amount of disk to allocate to the node in G.",
"minimum": 1
}
]
},
"memory": {
"oneOf": [
{
"type": "string",
"description": "The amount of memory to allocate to the node.",
"pattern": "^[0-9]+(?:G|M|K)$"
},
{
"type": "number",
"description": "The amount of memory to allocate to the node in G.",
"minimum": 1
}
]
}
}
}
},
"ingress": {
"type": "object",
"additionalProperties": false,
"properties": {
"nginx": {
"type": "object",
"additionalProperties": false,
"properties": {
"public": {
"description": "An object which defines the properties of the public nginx ingress controller.",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether or not to deploy the public ingress-nginx controller."
},
"values": {
"type": "object",
"description": "An object which defines the values to be passed to the public ingress-nginx Helm Chart."
}
}
},
"private": {
"type": "object",
"description": "An object which defines the properties of the private nginx ingress controller.",
"properties": {
"additionalProperties": false,
"enabled": {
"type": "boolean",
"default": false,
"description": "Whether or not to deploy the private ingress-nginx controller."
},
"values": {
"type": "object",
"description": "An object which defines the values to be passed to the private ingress-nginx Helm Chart."
}
}
}
}
}
}
}
}
}
}
},
"cluster_manifests": {
"type": "object",
"description": "An object which contains all manifests that CNDI should apply to your cluster.",
"additionalProperties": false,
"patternProperties": {
"^[a-z0-9]+(?:-[a-z0-9]+)*$": {
"type": "object",
"description": "An object which represents a single manifest CNDI should apply to your cluster.",
"required": ["kind", "apiVersion", "metadata"],
"properties": {
"kind": {
"type": "string",
"description": "The kind of Kubernetes resource to deploy."
},
"apiVersion": {
"type": "string",
"description": "The API version of the Kubernetes resource to deploy."
},
"metadata": {
"type": "object",
"description": "The metadata of the Kubernetes resource to deploy.",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "The name of the Kubernetes resource to deploy."
},
"namespace": {
"type": "string",
"description": "The namespace of the Kubernetes resource to deploy."
},
"labels": {
"type": "object",
"description": "The labels of the Kubernetes resource to deploy.",
"additionalProperties": true
},
"annotations": {
"type": "object",
"description": "The annotations of the Kubernetes resource to deploy.",
"additionalProperties": true
}
}
},
"spec": {
"type": "object",
"description": "The spec of the Kubernetes resource to deploy.",
"additionalProperties": true
}
}
}
}
},
"applications": {
"type": "object",
"description": "An object that defines how to generate an ArgoCD Application CRD.",
"additionalProperties": false,
"patternProperties": {
"^[a-z0-9]+(?:-[a-z0-9]+)*$": {
"type": "object",
"required": ["targetRevision", "destinationNamespace", "repoURL"],
"oneOf": [
{
"required": ["chart"]
},
{
"required": ["path"]
}
],
"properties": {
"targetRevision": {
"type": "string",
"description": "The version or revision of the Helm Chart to deploy."
},
"repoURL": {
"type": "string",
"description": "The URL of the git-hosted Helm Chart or Helm repository to deploy."
},
"destinationNamespace": {
"type": "string",
"description": "The namespace in your CNDI Kubernetes cluster to deploy the Helm Chart to."
},
"chart": {
"type": "string",
"description": "The name of the Helm Chart to deploy."
},
"path": {
"type": "string",
"description": "The path to the Helm Chart from the root of the git-hosted repository."
},
"values": {
},
"syncPolicy": {
}
}
}
}
}
}
}