Repository navigation
Expand file tree
/
Copy pathvalues.schema.json
More file actions
912 lines (912 loc) · 31.3 KB
/
Copy pathvalues.schema.json
File metadata and controls
912 lines (912 loc) · 31.3 KB
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
{
"$schema": "https://json-schema.org/draft-07/schema#",
"$comment": "Checks the structure of the values (maps where the templates expect maps, scalars where they expect scalars) and rejects unknown keys of the chart's own maps (e.g., typos). Scalars are of any scalar type, as tools may set strings, except for the switches ingress.enabled and transfer.enabled (booleans) and values with ranges. tesk.strategy is closed, as a Kubernetes DeploymentStrategy has two fields only. Open on purpose: the maps with Kubernetes' fields (tesk.podSecurityContext, tesk.securityContext, the probes, the resource lists of tesk.resources, ingress.annotations), as in foca-common, and global and enabled, which Helm and parent charts (condition: tesk.enabled) set. Keys of earlier versions of the chart ($defs/removed) pass here, and fail in the templates with their replacements (see tesk.removedValues in templates/_helpers.tpl)",
"type": "object",
"$defs": {
"scalar": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"map": {
"type": [
"object",
"string",
"null"
],
"$comment": "A string (e.g., empty) replaces the default map, as in earlier versions of the chart"
},
"image": {
"type": "object",
"properties": {
"repository": {
"type": "string",
"description": "Image repository, without the tag"
},
"tag": {
"$ref": "#/$defs/scalar",
"description": "Image tag"
}
},
"additionalProperties": false
},
"resourceList": {
"type": [
"object",
"null"
],
"additionalProperties": {
"$ref": "#/$defs/scalar"
}
},
"removed": {
"description": "Removed: the chart fails and names the key that replaces it (tesk.removedValues in templates/_helpers.tpl)"
},
"switch": {
"type": "boolean"
},
"timestamp": {
"type": [
"string",
"null"
],
"pattern": "^([0-9]{4}-[0-9]{2}-[0-9]{2}|[0-9]{4}-[0-9]{1,2}-[0-9]{1,2}([Tt]|[ \\t]+)[0-9]{1,2}:[0-9]{2}:[0-9]{2}(\\.[0-9]*)?([ \\t]*(Z|[-+][0-9]{1,2}(:[0-9]{2})?))?)?$",
"$comment": "A YAML 1.1 timestamp, as tesk-api's SnakeYAML resolves it (two-digit month and day without a time), or empty; the same pattern as in tesk.serviceInfo (templates/_helpers.tpl)"
}
},
"properties": {
"nameOverride": {
"$ref": "#/$defs/scalar",
"description": "Replaces the chart name (tesk) in the names of the objects and in the label app.kubernetes.io/name"
},
"fullnameOverride": {
"$ref": "#/$defs/scalar",
"description": "Replaces the prefix of the names of the objects (by default derived from the release name)"
},
"hostName": {
"$ref": "#/$defs/scalar",
"description": "Host name (FQDN) of the API, for the Ingress or the OpenShift Route"
},
"storage": {
"$ref": "#/$defs/scalar",
"description": "Storage backend that the chart sets up: s3, openstack, or anything else for none"
},
"storageClass": {
"$ref": "#/$defs/scalar",
"description": "Storage class of the tasks' PVCs; empty uses the cluster's default class"
},
"tesk": {
"type": "object",
"properties": {
"image": {
"description": "Image of the API: a map of repository, tag and pull policy (a string, the form of earlier versions of the chart, fails in the templates with a hint)",
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"repository": {
"type": "string"
},
"tag": {
"$ref": "#/$defs/scalar"
},
"pullPolicy": {
"enum": [
"Always",
"IfNotPresent",
"Never",
"",
null
]
}
},
"additionalProperties": false
}
]
},
"port": {
"type": [
"integer",
"string"
],
"description": "Port of the API's container and Service"
},
"tesApiBasePath": {
"$ref": "#/$defs/scalar",
"description": "Base path of the TES API"
},
"taskmaster": {
"type": "object",
"properties": {
"image": {
"$ref": "#/$defs/image"
}
},
"additionalProperties": false
},
"filer": {
"type": "object",
"properties": {
"image": {
"$ref": "#/$defs/image"
},
"podSecurityContext": {
"type": [
"object",
"null"
],
"description": "Security context of the filer's pods (fields of a Kubernetes PodSecurityContext), replacing the taskmaster's default; {} leaves it out, null keeps the default"
},
"securityContext": {
"type": [
"object",
"null"
],
"description": "Security context of the filer's container (fields of a Kubernetes SecurityContext), replacing the taskmaster's default; {} leaves it out, null keeps the default"
}
},
"additionalProperties": false
},
"executor": {
"type": "object",
"properties": {
"securityContext": {
"type": [
"object",
"null"
],
"description": "Security context of the executors' pods: the fields that tesk-api reads",
"additionalProperties": false,
"properties": {
"runAsUser": {
"type": "integer",
"minimum": 0,
"description": "User ID of the executors' containers",
"maximum": 2147483647
},
"runAsGroup": {
"type": "integer",
"minimum": 0,
"description": "Primary group ID of the executors' containers",
"maximum": 2147483647
},
"fsGroup": {
"type": "integer",
"minimum": 0,
"description": "Group that owns the pod's volumes (e.g., the task's PVC), for volume types whose ownership Kubernetes manages",
"maximum": 2147483647
},
"runAsNonRoot": {
"type": "boolean",
"description": "Refuse to start executors that would run as root"
}
}
}
},
"additionalProperties": false
},
"debug": {
"$ref": "#/$defs/scalar",
"description": "Debug logging in the taskmasters"
},
"executorRetries": {
"$ref": "#/$defs/scalar",
"description": "Retries of an executor's job on errors"
},
"filerRetries": {
"$ref": "#/$defs/scalar",
"description": "Retries of a filer's job on errors"
},
"filerHttpTimeout": {
"type": [
"number",
"string",
"null"
],
"exclusiveMinimum": 0,
"maximum": 1000000,
"pattern": "^(|0*[1-9][0-9]{0,5}(\\.[0-9]+)?|0*1000000(\\.0+)?|0*\\.[0-9]*[1-9][0-9]*)$",
"description": "Timeout of the filer's HTTP(S) requests, in seconds (connecting and each read), up to 1000000; empty uses the filer's default"
},
"keepFailedPvcs": {
"enum": [
true,
false,
"true",
"false",
"",
null
],
"description": "Keep the PVCs of tasks that fail or are cancelled (true or false; empty is false); by default, the taskmaster deletes them"
},
"taskTtlSeconds": {
"type": [
"integer",
"string",
"null"
],
"minimum": 0,
"maximum": 2147483647,
"pattern": "^[0-9]*$",
"description": "Seconds after which Kubernetes deletes a finished task's jobs (0 to 2147483647); empty or null keeps them"
},
"maxQueueSeconds": {
"type": [
"integer",
"string",
"null"
],
"minimum": 1,
"maximum": 2147483647,
"pattern": "^[0-9]*$",
"description": "Seconds that a pod of a task may wait for a node before the task fails (1 to 2147483647); empty or null waits forever"
},
"resources": {
"type": [
"object",
"null"
],
"description": "Resources of the API's container (requests and limits)",
"properties": {
"limits": {
"$ref": "#/$defs/resourceList"
},
"requests": {
"$ref": "#/$defs/resourceList"
},
"claims": {
"type": [
"array",
"null"
],
"description": "Dynamic resources (DRA) of the container"
}
},
"additionalProperties": false
},
"startupProbe": {
"type": [
"object",
"null"
],
"description": "The startup probe of the API's container (fields of a Kubernetes probe, and enabled), merged with the chart's defaults"
},
"readinessProbe": {
"type": [
"object",
"null"
],
"description": "The readiness probe of the API's container (fields of a Kubernetes probe, and enabled), merged with the chart's defaults"
},
"livenessProbe": {
"type": [
"object",
"null"
],
"description": "The liveness probe of the API's container (fields of a Kubernetes probe, and enabled), merged with the chart's defaults"
},
"securityContext": {
"type": [
"object",
"null"
],
"description": "Security context of the API's container (fields of a Kubernetes SecurityContext), merged with the defaults; null removes it; its key enabled (of earlier versions of the chart) is listed as removed, but as the map is open, only the templates reject it",
"properties": {
"enabled": {
"$ref": "#/$defs/removed"
}
}
},
"swaggerUi": {
"description": "Swagger UI of the API (enabled: true or false); the templates check the values",
"properties": {
"enabled": {}
},
"additionalProperties": false
},
"cors": {
"type": [
"object",
"null"
],
"description": "Cross-origin requests (CORS) of browser clients",
"properties": {
"allowedOrigins": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"pattern": "^(?i:https?)://(([A-Za-z0-9]([A-Za-z0-9-]*[A-Za-z0-9])?\\.)*[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?\\.?|(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}|\\[(([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|([0-9A-Fa-f]{1,4}:){1,7}:|([0-9A-Fa-f]{1,4}:){1,6}:[0-9A-Fa-f]{1,4}|([0-9A-Fa-f]{1,4}:){1,5}(:[0-9A-Fa-f]{1,4}){1,2}|([0-9A-Fa-f]{1,4}:){1,4}(:[0-9A-Fa-f]{1,4}){1,3}|([0-9A-Fa-f]{1,4}:){1,3}(:[0-9A-Fa-f]{1,4}){1,4}|([0-9A-Fa-f]{1,4}:){1,2}(:[0-9A-Fa-f]{1,4}){1,5}|[0-9A-Fa-f]{1,4}:(:[0-9A-Fa-f]{1,4}){1,6}|:((:[0-9A-Fa-f]{1,4}){1,7}|:)|([0-9A-Fa-f]{1,4}:){6}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}|::([0-9A-Fa-f]{1,4}:){0,5}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3}|([0-9A-Fa-f]{1,4}:){1,4}:([0-9A-Fa-f]{1,4}:){0,1}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])(\\.(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])){3})\\])(:[1-9][0-9]{0,4})?/?$",
"allOf": [
{
"not": {
"pattern": "^((?i:http)://[^/]*:80|(?i:https)://[^/]*:443)/?$"
}
},
{
"not": {
"pattern": ":(6553[6-9]|655[4-9][0-9]|65[6-9][0-9]{2}|6[6-9][0-9]{3}|[7-9][0-9]{4})/?$"
}
}
]
},
"description": "Origins of browser clients that may call the API: http or https, an ASCII host name (punycode for international ones, no _), an IPv4 address as four decimal numbers or an IPv6 address in brackets, and a port unless the default (1-65535, no leading zeros); no wildcards, paths, user info or commas"
}
},
"additionalProperties": false
},
"podSecurityContext": {
"type": [
"object",
"null"
],
"description": "Security context of the API's pod (fields of a Kubernetes PodSecurityContext), merged with the defaults; null removes it"
},
"strategy": {
"type": [
"object",
"null"
],
"description": "Update strategy of the API's Deployment (the fields of a Kubernetes DeploymentStrategy), merged with the default (type Recreate, so an empty map keeps it); null, or type null without rollingUpdate, leaves Kubernetes' default (RollingUpdate). The templates reject rollingUpdate with type Recreate",
"properties": {
"type": {
"enum": [
"Recreate",
"RollingUpdate",
null
]
},
"rollingUpdate": {
"type": [
"object",
"null"
],
"properties": {
"maxSurge": {
"type": [
"integer",
"string",
"null"
]
},
"maxUnavailable": {
"type": [
"integer",
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"tes_api_base_path": {
"$ref": "#/$defs/removed"
},
"taskmaster_image_name": {
"$ref": "#/$defs/removed"
},
"taskmaster_image_version": {
"$ref": "#/$defs/removed"
},
"taskmaster_filer_image_name": {
"$ref": "#/$defs/removed"
},
"taskmaster_filer_image_version": {
"$ref": "#/$defs/removed"
},
"executor_retries": {
"$ref": "#/$defs/removed"
},
"filer_retries": {
"$ref": "#/$defs/removed"
},
"limitsCpu": {
"$ref": "#/$defs/removed"
},
"limitsMemory": {
"$ref": "#/$defs/removed"
},
"requestsCpu": {
"$ref": "#/$defs/removed"
},
"requestsMemory": {
"$ref": "#/$defs/removed"
}
},
"additionalProperties": false
},
"transfer": {
"type": "object",
"properties": {
"enabled": {
"$ref": "#/$defs/switch",
"description": "Support for file: URLs on a shared PVC"
},
"wesBasePath": {
"$ref": "#/$defs/scalar",
"description": "Path where the workflow engine sees the shared volume"
},
"tesBasePath": {
"$ref": "#/$defs/scalar",
"description": "Path where the filer mounts the shared PVC"
},
"pvcName": {
"$ref": "#/$defs/scalar",
"description": "Name of the shared PVC"
},
"active": {
"$ref": "#/$defs/removed"
},
"wes_base_path": {
"$ref": "#/$defs/removed"
},
"tes_base_path": {
"$ref": "#/$defs/removed"
},
"pvc_name": {
"$ref": "#/$defs/removed"
}
},
"additionalProperties": false
},
"auth": {
"type": "object",
"properties": {
"mode": {
"$ref": "#/$defs/scalar",
"description": "auth requires OIDC access tokens; noauth leaves all endpoints open"
},
"userInfoUri": {
"type": [
"string",
"null"
],
"pattern": "^(https?://[^/?#\\s]+[^\\s]*)?$",
"description": "User info endpoint of the OIDC provider, at which tesk-api validates tokens and reads the groups or the claim (an HTTP(S) URL); empty uses tesk-api's default (ELIXIR AAI)"
},
"groups": {
"type": [
"object",
"null"
],
"description": "Group model of tesk-api (tesk-api docs/access-control.md#configuration); empty values use tesk-api's defaults (ELIXIR AAI)",
"additionalProperties": false,
"properties": {
"claim": {
"$ref": "#/$defs/scalar",
"description": "Claim of the user info with the group memberships"
},
"prefix": {
"$ref": "#/$defs/scalar",
"description": "Text before the group names in the claim"
},
"suffix": {
"$ref": "#/$defs/scalar",
"description": "Text after the group names in the claim"
},
"parentGroup": {
"$ref": "#/$defs/scalar",
"description": "Parent group of the environment group; only used if envBaseGroup is empty"
},
"adminSubgroup": {
"$ref": "#/$defs/scalar",
"description": "Subgroup of the admins, below the environment group and each team group"
}
}
},
"envSubgroup": {
"$ref": "#/$defs/scalar",
"description": "Environment group below groups.parentGroup; only used if envBaseGroup is empty"
},
"envBaseGroup": {
"$ref": "#/$defs/scalar",
"description": "Full name of the environment group (without prefix and suffix); replaces groups.parentGroup and envSubgroup"
},
"serviceInfoPublic": {
"$ref": "#/$defs/scalar",
"description": "With mode auth, whether GET /service-info answers without a token"
},
"legacyUserLabels": {
"enum": [
true,
false,
"true",
"false",
null
],
"description": "With mode auth, whether tasks created by tesk-api before 1.2.0 are matched to their creators by their old creator label"
},
"claim": {
"type": [
"object",
"null"
],
"description": "With mode auth: authorisation without groups, by a claim of the user info (tesk-api docs/access-control.md)",
"additionalProperties": false,
"properties": {
"enabled": {
"enum": [
true,
false,
"true",
"false",
null
],
"description": "Whether users with one of the values in the claim are authorised without groups"
},
"name": {
"type": [
"string",
"null"
],
"description": "Name of the claim in the user info, e.g., eduperson_entitlement"
},
"values": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"pattern": "^[^,]*[^,\\s][^,]*$"
},
"description": "Values of the claim, one of which a user needs (compared exactly); non-blank, without commas"
}
}
},
"tokenClients": {
"type": [
"object",
"null"
],
"description": "With mode auth: access tokens of allow-listed clients, checked by tesk-api without the user info (docs/deployment.md, Tokens of services)",
"additionalProperties": false,
"properties": {
"enabled": {
"enum": [
true,
false,
"true",
"false",
null
],
"description": "Whether tokens of the listed clients are accepted; needs issuer, clients and mode auth"
},
"issuer": {
"type": [
"string",
"null"
],
"pattern": "^(https://[^/?#\\s]+[^\\s]*)?$",
"description": "Issuer of the tokens (an HTTPS URL), compared exactly with the claim iss"
},
"jwksUri": {
"type": [
"string",
"null"
],
"pattern": "^(https://[^/?#\\s]+[^\\s]*)?$",
"description": "JWKS URI of the issuer (an HTTPS URL); empty uses the one of the issuer's discovery document"
},
"audience": {
"type": [
"string",
"null"
],
"description": "Audience that the claim aud must contain; required unless allowAnyAudience is true"
},
"allowAnyAudience": {
"enum": [
true,
false,
"true",
"false",
null
],
"description": "Whether tokens for any audience are accepted if audience is empty (also tokens a listed client got for other services)"
},
"claim": {
"type": [
"string",
"null"
],
"description": "Claim of the token with the client ID; empty uses tesk-api's default, client_id"
},
"clients": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"pattern": "^[^,]*[^,\\s][^,]*$"
},
"description": "IDs of the clients whose tokens are accepted; non-blank, without commas"
},
"requireAtJwt": {
"enum": [
true,
false,
"true",
"false",
null
],
"description": "Whether the token's header must have the type at+jwt (RFC 9068); null leaves tesk-api's default (true)"
},
"requireClientSubject": {
"enum": [
true,
false,
"true",
"false",
null
],
"description": "Whether the token's sub must be the client ID; null leaves tesk-api's default (true)"
}
}
},
"clientId": {
"$ref": "#/$defs/scalar",
"description": "ID of the OIDC client of the Swagger UI"
},
"clientSecret": {
"$ref": "#/$defs/scalar",
"description": "Deprecated: secret of the OIDC client of the Swagger UI, ignored by tesk-api 1.2.0 and later (the Swagger UI is a public client); only passed on to older tesk-api images"
},
"swaggerOauth": {
"type": [
"object",
"null"
],
"description": "Endpoints of the OIDC provider for the Swagger UI's client, and its scopes; empty values use tesk-api's defaults (ELIXIR AAI)",
"additionalProperties": false,
"properties": {
"authorizationEndpoint": {
"type": [
"string",
"null"
],
"pattern": "^(https?://[^/?#\\s]+[^\\s]*)?$",
"description": "Authorisation endpoint of the provider (an HTTP(S) URL)"
},
"tokenEndpoint": {
"type": [
"string",
"null"
],
"pattern": "^(https?://[^/?#\\s]+[^\\s]*)?$",
"description": "Token endpoint of the provider (an HTTP(S) URL); only used with the authorisation code grant"
},
"scopes": {
"type": [
"string",
"null"
],
"description": "Comma-separated scopes that the Swagger UI offers, each as <scope>:<description>"
}
}
},
"envBasegroup": {
"$ref": "#/$defs/removed"
},
"env_subgroup": {
"$ref": "#/$defs/removed"
},
"env_basegroup": {
"$ref": "#/$defs/removed"
},
"service_info_public": {
"$ref": "#/$defs/removed"
},
"client_id": {
"$ref": "#/$defs/removed"
},
"client_secret": {
"$ref": "#/$defs/removed"
}
},
"additionalProperties": false
},
"serviceInfo": {
"type": [
"object",
"null"
],
"description": "Service info, the answer of GET /service-info (GA4GH service-info specification); type and version are set by the chart",
"additionalProperties": false,
"properties": {
"existingConfigMap": {
"type": [
"string",
"null"
],
"description": "Name of a ConfigMap of your own with the key service-info.yaml, instead of the chart's; the other fields are then not used, but still checked"
},
"id": {
"$ref": "#/$defs/scalar",
"description": "Unique ID of the deployment, in reverse domain notation (required)"
},
"name": {
"$ref": "#/$defs/scalar",
"description": "Name of the service (required)"
},
"description": {
"$ref": "#/$defs/scalar",
"description": "Description of the service"
},
"organization": {
"type": [
"object",
"null"
],
"description": "The organisation that runs the service",
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/$defs/scalar",
"description": "Name of the organisation (required)"
},
"url": {
"$ref": "#/$defs/scalar",
"description": "URL of the organisation (required)"
}
}
},
"contactUrl": {
"$ref": "#/$defs/scalar",
"description": "Where users get support, e.g., a mailto: URL"
},
"documentationUrl": {
"$ref": "#/$defs/scalar",
"description": "Documentation for users of the service"
},
"createdAt": {
"$ref": "#/$defs/timestamp",
"description": "When the service was created: a date (2026-11-10) or a date and time (2026-11-10T12:00:00Z)"
},
"updatedAt": {
"$ref": "#/$defs/timestamp",
"description": "When the service was last updated: a date or a date and time"
},
"environment": {
"$ref": "#/$defs/scalar",
"description": "Environment of the service, e.g., test or prod"
},
"storage": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "Storage locations that tasks can use, e.g., s3://bucket"
}
}
},
"service": {
"type": "object",
"properties": {
"type": {
"$ref": "#/$defs/scalar",
"description": "Type of the API's Service: NodePort, LoadBalancer, or empty for ClusterIP"
},
"nodePort": {
"$ref": "#/$defs/scalar",
"description": "Node port with type NodePort"
},
"node_port": {
"$ref": "#/$defs/removed"
}
},
"additionalProperties": false
},
"ftp": {
"type": "object",
"properties": {
"classicFtpSecret": {
"$ref": "#/$defs/scalar",
"description": "Name of the secret with the FTP username and password, created if one of them is set; null uses <prefix>-ftp, empty creates none"
},
"netrcSecret": {
"$ref": "#/$defs/scalar",
"description": "Name of the secret with a .netrc file; empty creates none"
},
"hosts": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"pattern": "^(\\[[0-9A-Fa-f:.]+\\]|[^\\[\\]:,@/?#*\\s\\x00-\\x1f\\x7f]+)(:0*(6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3}))?$"
},
"description": "Hosts (host or host:port, without user information, path, whitespace or empty port) that the FTP credentials of classicFtpSecret are sent to; empty sends them to no host"
},
"username": {
"$ref": "#/$defs/scalar",
"description": "FTP username"
},
"password": {
"$ref": "#/$defs/scalar",
"description": "FTP password"
},
"hostIp": {
"$ref": "#/$defs/scalar",
"description": "IP of an FTP server outside the cluster, as pods see the host"
},
"hostip": {
"$ref": "#/$defs/removed"
},
"classic_ftp_secret": {
"$ref": "#/$defs/removed"
},
"netrc_secret": {
"$ref": "#/$defs/removed"
}
},
"additionalProperties": false
},
"ingress": {
"type": "object",
"properties": {
"enabled": {
"$ref": "#/$defs/switch",
"description": "Creates an Ingress; false creates an OpenShift Route instead, on OpenShift"
},
"className": {
"$ref": "#/$defs/scalar",
"description": "Ingress class; empty uses the cluster's default class"
},
"path": {
"$ref": "#/$defs/scalar",
"description": "Path of the Ingress, and the context path of the API"
},
"tlsSecretName": {
"$ref": "#/$defs/scalar",
"description": "Secret with the TLS certificate of hostName; empty switches TLS off"
},
"annotations": {
"$ref": "#/$defs/map",
"description": "Annotations of the Ingress"
},
"rules": {
"$ref": "#/$defs/removed"
},
"ingressClassName": {
"$ref": "#/$defs/removed"
},
"tls_secret_name": {
"$ref": "#/$defs/removed"
}
},
"additionalProperties": false
},
"global": {
"type": "object",
"description": "Global values, which Helm passes on to all charts; the chart reads none"
},
"enabled": {
"type": [
"boolean",
"null"
],
"description": "Set by parent charts that include this one with condition: tesk.enabled; the chart reads none"
},
"host_name": {
"$ref": "#/$defs/removed"
}
},
"additionalProperties": false
}