-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathvalues.schema.json
1813 lines (1813 loc) · 79.7 KB
/
values.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
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "https://json-schema.org/draft-07/schema#",
"properties": {
"imagePullPolicy": {
"type": "string",
"description": "The Kubernetes image pull policy",
"default": "IfNotPresent"
},
"imagePullSecrets": {
"type": "array",
"default": [],
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Secret"
}
}
}
},
"isMultiNodeCluster": {
"type": "boolean",
"description": "Whether the Kubernetes cluster has multiple nodes; this will affect affinities and add requirements to scheduling.",
"default": true
},
"staticCpuManagerPolicy": {
"type": "boolean",
"description": "Whether the Kubernetes cluster has been configured with a static CPU manager policy. This is an optimization for RonDB data nodes. These have a scheduler which executes jobs within hundreds of microseconds (very quick). If the data nodes are pinned to CPUs, they can run CPU spnning to avoid context switching inbetween jobs.",
"default": false
},
"terminationGracePeriodSeconds": {
"type": "integer",
"description": "TerminationGracePeriodSeconds for data nodes. For debugging. When removing the *entire* cluster, taking down data nodes will hang, since they try to contact the MGMd on shutdown. Hence, this is a way of shortening this wait.",
"default": 60,
"minimum": 10
},
"priorityClass": {
"type": "string",
"default": "rondb-high-priority"
},
"enableSecurityContext": {
"type": "boolean",
"default": true
},
"serviceAccountAnnotations": {
"type": "object",
"default": {}
},
"networkPolicy": {
"type": "object",
"properties": {
"mgmds": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to limit ingress for MGMd pods"
},
"ingressSelectors": {
"type": "array",
"default": [],
"items": {
"type": "object",
"properties": {
"namespaceSelector": {
"$ref": "#/$defs/selector"
},
"podSelector": {
"$ref": "#/$defs/selector"
}
}
}
}
}
},
"ndbmtds": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true,
"description": "Whether to limit ingress for data node pods. If there is an empty API slot in the config.ini, any host can connect to them."
},
"ingressSelectors": {
"type": "array",
"default": [],
"items": {
"type": "object",
"properties": {
"namespaceSelector": {
"$ref": "#/$defs/selector"
},
"podSelector": {
"$ref": "#/$defs/selector"
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"mgmd": {
"type": "object",
"properties": {
"statefulSetName": {
"type": "string",
"default": "mgmds"
},
"headlessClusterIp": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "headless-mgmds"
},
"port": {
"type": "integer",
"default": 1186
},
"annotations": {
"type": "object",
"default": {}
}
},
"required": [
"name"
]
}
},
"required": [
"statefulSetName",
"headlessClusterIp"
]
},
"ndbmtd": {
"type": "object",
"properties": {
"statefulSet": {
"type": "object",
"properties": {
"podAnnotations": {
"type": "object",
"default": {}
}
}
}
}
},
"mysqld": {
"type": "object",
"properties": {
"statefulSet": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "mysqlds"
},
"endToEndTls": {
"type": "object",
"properties": {
"enabled": {
"description": "Whether to use end-to-end encryption for MySQLd Pods. This is recommended for high-security use cases. For MySQLds this is especially recommended since they use raw TCP connections and thereby by-pass TLS Ingress-rules. Otherwise, Ingress-TCP can also be configured directly via the Ingress controller (not in this Helmchart).",
"enabled": "boolean",
"default": false
},
"secretName": {
"type": "string",
"description": "Name of the TLS Secret",
"default": "mysqld-end-to-end-tls"
},
"supplyOwnSecret": {
"enabled": "boolean",
"default": false,
"description": "Whether the Helmchart user will create a TLS Secret outside of this Helmchart. Otherwise we rely on cert-manager to create one."
},
"filenames": {
"$ref": "#/$defs/tlsFilenames"
}
},
"required": [
"enabled",
"secretName",
"supplyOwnSecret",
"filenames"
]
}
},
"required": [
"name",
"endToEndTls"
]
},
"headlessClusterIp": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "headless-mysqlds"
},
"port": {
"type": "integer",
"default": 3306
}
},
"required": [
"name",
"port"
]
},
"clusterIp": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "mysqld"
},
"port": {
"type": "integer",
"default": 3306
},
"annotations": {
"type": "object",
"default": {}
}
},
"required": [
"name",
"port"
]
},
"externalLoadBalancer": {
"type": "object",
"description": "Configuration for load balancer service to be used for external access",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"default": "mysqld-external"
},
"class": {
"type": [
"string",
"null"
],
"default": null
},
"annotations": {
"type": "object",
"description": "Cloud provider load balancer specific annotations.",
"default": {}
},
"port": {
"type": "integer",
"description": "Port to expose the service on",
"default": 3306
}
}
},
"exporter": {
"type": "object",
"description": "Configuration for mysqld exporter",
"properties": {
"metricsPort": {
"type": "integer",
"default": 9104
}
}
},
"addSysNiceCapability": {
"type": "boolean",
"default": true
}
},
"required": [
"statefulSet",
"headlessClusterIp",
"clusterIp"
]
},
"rdrs": {
"type": "object",
"properties": {
"clusterIp": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "rdrs"
},
"annotations": {
"type": "object",
"default": {
"consul.hashicorp.com/service-name": "rdrs",
"prometheus.io/path": "/metrics",
"prometheus.io/port": "4406",
"prometheus.io/scheme": "https",
"prometheus.io/scrape": "true"
}
}
},
"required": [
"name"
]
},
"statefulSet": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "rdrs"
},
"endToEndTls": {
"type": "object",
"properties": {
"enabled": {
"description": "Whether to use end-to-end encryption for RDRS Pods. This is recommended for high-security use cases.",
"enabled": "boolean",
"default": false
},
"secretName": {
"type": "string",
"description": "Name of the TLS Secret",
"default": "rdrs-end-to-end-tls"
},
"supplyOwnSecret": {
"enabled": "boolean",
"default": false,
"description": "Whether the Helmchart user will create a TLS Secret outside of this Helmchart. Otherwise we rely on cert-manager to create one."
},
"filenames": {
"$ref": "#/$defs/tlsFilenames"
}
},
"required": [
"enabled",
"secretName",
"supplyOwnSecret",
"filenames"
]
}
},
"required": [
"name",
"endToEndTls"
]
},
"headlessClusterIpName": {
"type": "string",
"default": "rdrs-cluster-ip"
},
"externalLoadBalancer": {
"type": "object",
"description": "Configuration for load balancer service to be used for external access",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"name": {
"type": "string",
"default": "rdrs-external"
},
"class": {
"type": [
"string",
"null"
],
"default": null
},
"annotations": {
"type": "object",
"description": "Cloud provider load balancer specific annotations.",
"default": {}
}
}
},
"ingress": {
"type": "object",
"description": "Configuration of Ingress for RDRS",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"class": {
"type": "string",
"default": "nginx"
},
"useDefaultBackend": {
"type": "boolean",
"description": "Whether to use the RDRS as a default backend for the Ingress; this makes it reachable without specifying a subdomain; i.e. an IP can be used instead.",
"default": true
},
"dnsNames": {
"type": "array",
"items": {
"type": "string",
"description": "DNS names used for Ingress rules. These will also be used in the TLS certificate."
},
"default": [],
"examples": [
"rondb.com"
]
},
"tls": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "WARN: Nginx-ingress will always use encryption even if this is disabled. By enabling this, we simply have more control over the TLS Secret. The TLS Secrets are placed onto the Ingress controller instance. Ingress TLS is currently only supported with cert-manager (RonDB-standalone)",
"default": true
},
"ipAddresses": {
"type": "array",
"items": {
"type": "string",
"description": "This will work if the a default backend is activated for the Ingress. A value here can be the external IP of the Ingress Controller"
},
"default": [],
"examples": [
"127.0.0.1"
]
}
}
}
}
}
},
"required": [
"clusterIp",
"statefulSet",
"headlessClusterIpName"
]
},
"binlogServers": {
"type": "object",
"properties": {
"statefulSet": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "mysqld-binlog-servers"
},
"endToEndTls": {
"type": "object",
"properties": {
"enabled": {
"description": "Whether to use end-to-end encryption for MySQL binlog server Pods. This is recommended for high-security use cases. For MySQLds this is especially recommended since they use raw TCP connections and thereby by-pass TLS Ingress-rules. Otherwise, Ingress-TCP can also be configured directly via the Ingress controller (not in this Helmchart).",
"enabled": "boolean",
"default": false
},
"secretName": {
"type": "string",
"description": "Name of the TLS Secret",
"default": "binlog-end-to-end-tls"
},
"supplyOwnSecret": {
"enabled": "boolean",
"default": false,
"description": "Whether the Helmchart user will create a TLS Secret outside of this Helmchart. Otherwise we rely on cert-manager to create one."
},
"filenames": {
"$ref": "#/$defs/tlsFilenames"
}
},
"required": [
"enabled",
"secretName",
"supplyOwnSecret",
"filenames"
]
}
},
"required": [
"name",
"endToEndTls"
]
},
"headlessClusterIp": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "headless-binlog-servers"
},
"port": {
"type": "integer",
"default": 3306
}
},
"required": [
"name",
"port"
]
},
"externalLoadBalancers": {
"type": "object",
"description": "One LoadBalancer per binlog server; Creating an (alternative) Ingress per binlog server is difficult",
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"namePrefix": {
"type": "string",
"default": "binlog-server"
},
"class": {
"type": [
"string",
"null"
],
"default": null
},
"annotations": {
"type": "object",
"description": "Cloud provider load balancer specific annotations.",
"default": {}
},
"port": {
"type": "integer",
"description": "Port to expose the service on",
"default": 3306
}
}
}
},
"required": [
"statefulSet",
"headlessClusterIp"
]
},
"replicaAppliers": {
"type": "object",
"properties": {
"statefulSet": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "mysqld-replica-appliers"
},
"endToEndTls": {
"type": "object",
"properties": {
"enabled": {
"description": "Whether to use end-to-end encryption for MySQL replica applier Pods. This is recommended for high-security use cases. For MySQLds this is especially recommended since they use raw TCP connections and thereby by-pass TLS Ingress-rules. Otherwise, Ingress-TCP can also be configured directly via the Ingress controller (not in this Helmchart).",
"enabled": "boolean",
"default": false
},
"secretName": {
"type": "string",
"description": "Name of the TLS Secret",
"default": "replica-applier-end-to-end-tls"
},
"supplyOwnSecret": {
"enabled": "boolean",
"default": false,
"description": "Whether the Helmchart user will create a TLS Secret outside of this Helmchart. Otherwise we rely on cert-manager to create one."
},
"filenames": {
"$ref": "#/$defs/tlsFilenames"
}
},
"required": [
"enabled",
"secretName",
"supplyOwnSecret",
"filenames"
]
}
},
"required": [
"name",
"endToEndTls"
]
},
"headlessClusterIp": {
"type": "object",
"properties": {
"name": {
"type": "string",
"default": "headless-replica-appliers"
},
"port": {
"type": "integer",
"default": 3306
}
},
"required": [
"name",
"port"
]
}
},
"required": [
"statefulSet",
"headlessClusterIp"
]
}
},
"required": [
"mgmd",
"mysqld",
"rdrs"
]
},
"images": {
"type": "object",
"description": "Information for Docker images used in the cluster",
"properties": {
"rondb": {
"type": "object",
"properties": {
"registry": {
"type": "string",
"default": "docker.io"
},
"repository": {
"type": "string",
"default": "hopsworks"
},
"name": {
"type": "string",
"default": "rondb"
},
"tag": {
"type": "string",
"description": "The version of RonDB to use; This should always be equivalent to .Chart.AppVersion",
"default": "22.10.7-0.7"
}
}
},
"toolbox": {
"type": "object",
"properties": {
"registry": {
"type": "string",
"default": "docker.io"
},
"repository": {
"type": "string",
"default": "hopsworks"
},
"name": {
"type": "string",
"default": "hwutils"
},
"tag": {
"type": "string",
"default": "0.7"
}
}
},
"dataValidation": {
"type": "object",
"properties": {
"registry": {
"type": "string",
"default": "docker.io"
},
"repository": {
"type": "string",
"default": ""
},
"name": {
"type": "string",
"default": "python"
},
"tag": {
"type": "string",
"default": "3.12-slim"
}
}
},
"mysqldExporter": {
"type": "object",
"properties": {
"registry": {
"type": "string",
"default": "docker.hops.works"
},
"repository": {
"type": "string",
"default": "hopsworks"
},
"name": {
"type": "string",
"default": "mysqld_exporter"
},
"tag": {
"type": "string",
"default": "0.11.2"
}
}
}
},
"required": [
"rondb",
"toolbox",
"dataValidation"
]
},
"mysql": {
"type": "object",
"description": "How to initialize MySQL",
"properties": {
"sqlInitContent": {
"type": "object",
"description": "SQL to run *only once* at cluster startup. Try to make these scripts idempotent, in case they are re-run by accident. Do so by e.g. using `IF NOT EXISTS` in the SQL commands.",
"default": {},
"examples": [
{
"createMyUser": "CREATE USER foo IF NOT EXISTS;"
}
]
},
"supplyOwnSecret": {
"type": "boolean",
"default": false,
"description": "If set to false, the Helmchart will auto-generate MySQL passwords. When running Global Replication as a secondary cluster, this should be set to true. Otherwise, the replication of ALTER root password will fail the cluster."
},
"clusterUser": {
"type": "string",
"description": "The MySQL user for K8s probes, benchmarks and for the standard my.cnf file.",
"default": "helm"
},
"exporter": {
"type": "object",
"description": "MySQL exporter configuration",
"properties": {
"enabled": {
"type": "boolean",
"default": false
},
"username": {
"type": "string",
"default": "exporter"
},
"maxUserConnections": {
"type": "integer",
"default": 3
}
}
},
"credentialsSecretName": {
"type": "string",
"description": "Secret name for MySQL users' passwords",
"minLength": 1,
"default": "mysql-passwords"
},
"users": {
"type": "array",
"default": [],
"items": {
"type": "object",
"properties": {
"username": {
"type": "string",
"description": "The username of the MySQL database user.",
"minLength": 1
},
"host": {
"type": "string",
"description": "The host from which the MySQL user can connect.",
"minLength": 1,
"examples": [
"%"
]
},
"privileges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"database": {
"type": "string",
"description": "The MySQL database to which the privileges apply.",
"minLength": 1,
"examples": [
"*"
]
},
"table": {
"type": "string",
"description": "The MySQL table to which the privileges apply.",
"minLength": 1,
"examples": [
"*"
]
},
"withGrantOption": {
"type": "boolean",
"description": "Whether the user has the GRANT OPTION privilege.",
"default": false
},
"privileges": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"description": "Privileges for the specific MySQL database.table.",
"minLength": 1,
"examples": [
"ALL",
"SELECT"
]
}
}
},
"required": [
"database",
"table",
"privileges"
],
"additionalProperties": false
},
"description": "Privileges assigned to the MySQL user."
}
},
"required": [
"username",
"host",
"privileges"
],
"additionalProperties": false
},
"description": "A list of MySQL users and their privileges."
}
},
"required": [
"sqlInitContent",
"exporter",
"credentialsSecretName",
"users"
]
},
"clusterSize": {
"type": "object",
"description": "Horizontal cluster size",
"properties": {
"activeDataReplicas": {
"type": "integer",
"description": "How many replicas each node group has. When descreasing this value, try going down by 1 at a time. Too many nodes leaving at once can cause issues with leader elections.",
"minimum": 1,
"maximum": 3,
"default": 2
},
"numNodeGroups": {
"type": "integer",
"minimum": 1,
"default": 1
},
"minNumMySQLServers": {
"type": "integer",
"minimum": 1,
"description": "A minimum amount of MySQL servers",
"default": 1
},
"maxNumMySQLServers": {
"type": "integer",
"minimum": 1,
"description": "The maximum amount of MySQL servers we will auto-scale to. It is represented as number of slots in RonDB's config.ini. Changing this will only take effect if the ConfigMap for config.ini is updated and the MGMd is restarted.",
"default": 5
},
"minNumRdrs": {
"type": "integer",
"minimum": 0,
"default": 1
},
"maxNumRdrs": {
"type": "integer",
"minimum": 0,
"default": 2
}
},
"required": [
"activeDataReplicas",
"numNodeGroups",
"minNumMySQLServers",
"maxNumMySQLServers",
"minNumRdrs",
"maxNumRdrs"
]
},
"resources": {
"type": "object",
"description": "Vertical cluster size",
"properties": {
"limits": {
"type": "object",
"description": "Kubernetes resource limits",
"properties": {
"cpus": {
"type": "object",
"description": "CPU resources per RonDB service type",
"properties": {
"mgmds": {
"type": "number",
"default": 0.2
},
"ndbmtds": {
"type": "number",
"default": 2
},
"mysqlds": {
"type": "number",
"default": 2
},
"rdrs": {
"type": "number",
"default": 2
},
"benchs": {
"type": "number",
"default": 2
},
"restore": {
"type": "number",
"default": 1
},
"mysqldExporters": {
"type": "number",
"default": 0.2
}
}
},
"memory": {
"type": "object",
"description": "Memory resources per RonDB service type",
"properties": {
"ndbmtdsMiB": {
"type": "integer",
"description": "It is recommended to keep this above 5GiB, otherwise some memory parts will be configured manually.",
"default": 5000,
"minimum": 2800
},
"mysqldMiB": {
"type": "integer",
"description": "This can usually be kept at the default independent of the load",
"default": 1400
},
"rdrsMiB": {
"type": "integer",
"default": 500
},
"benchsMiB": {
"type": "integer",
"default": 500
},
"mysqldExportersMiB": {
"type": "integer",
"default": 100
}
}
}
}
},
"requests": {
"type": "object",
"description": "Kubernetes resource requests; Note that data nodes will only apply limits, not requests",
"properties": {
"cpus": {
"type": "object",
"description": "CPU resources per RonDB service type",
"properties": {
"mgmds": {
"type": "number",
"default": 0.2
},
"mysqlds": {
"type": "number",
"default": 1
},
"rdrs": {
"type": "number",
"default": 1
},
"benchs": {
"type": "number",
"default": 1
},
"mysqldExporters": {
"type": "number",
"default": 0.02
}
}
},
"memory": {