Repository navigation
Expand file tree
/
Copy pathvalues.schema.json
More file actions
1309 lines (1309 loc) · 44.7 KB
/
Copy pathvalues.schema.json
File metadata and controls
1309 lines (1309 loc) · 44.7 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
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#",
"$comment": "Schema of the values of the proTES chart: app-values.schema.json of the library chart foca-common 0.4.0 (released with FOCA 0.20; scripts/check_release_pins.py checks that Chart.yaml and Chart.lock pin it), with the app's key (protes, with extraEnv) and Flower (flower) added; update it with the library chart",
"$defs": {
"tmpSizeLimit": {
"type": [
"string",
"integer",
"null"
],
"pattern": "^([0-9]+(\\.[0-9]*)?|\\.[0-9]+)([KMGTPE]i|[mkMGTPE]|[eE][+-]?[0-9]+)?$",
"not": {
"type": "string",
"pattern": "^(0+(\\.0*)?|\\.0+)([KMGTPE]i|[mkMGTPE]|[eE][+-]?[0-9]+)?$",
"$comment": "Rejects all-zero quantities (Go regular expressions have no lookahead)"
},
"minimum": 1,
"description": "Size limit of the emptyDir at /tmp: a positive Kubernetes quantity (e.g., 64Mi) or number of bytes; none if null"
},
"persistence": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"size": {
"type": "string",
"pattern": "^([0-9]+(\\.[0-9]*)?|\\.[0-9]+)([KMGTPE]i|[mkMGTPE]|[eE][+-]?[0-9]+)?$",
"not": {
"pattern": "^(0+(\\.0*)?|\\.0+)([KMGTPE]i|[mkMGTPE]|[eE][+-]?[0-9]+)?$",
"$comment": "Rejects all-zero quantities (Go regular expressions have no lookahead)"
},
"description": "Size of the PersistentVolumeClaim: a positive Kubernetes quantity (e.g., 1Gi)"
},
"accessModes": {
"type": "array",
"minItems": 1,
"items": {
"enum": [
"ReadWriteOnce",
"ReadWriteOncePod",
"ReadWriteMany"
]
},
"description": "Access modes of the PersistentVolumeClaim (writable modes only, as the data is written there); ReadWriteOnce if not set"
},
"storageClass": {
"type": "string",
"description": "Storage class of the PersistentVolumeClaim; the cluster's default class if empty; - disables dynamic provisioning"
},
"existingClaim": {
"type": "string",
"description": "Existing PersistentVolumeClaim to use instead of the component's own"
},
"resourcePolicy": {
"enum": [
"",
"keep"
],
"description": "keep: Helm keeps the component's own PersistentVolumeClaim (and its data) when the release is uninstalled or the claim is removed from it; empty: Helm deletes it"
}
},
"description": "Volume with a component's data: a PersistentVolumeClaim if enabled, otherwise an emptyDir"
},
"parentRefs": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"additionalProperties": false,
"properties": {
"group": {
"type": "string"
},
"kind": {
"type": "string",
"minLength": 1
},
"namespace": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"sectionName": {
"type": "string",
"minLength": 1
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535
}
}
},
"description": "Gateway API parent references (group, kind, namespace, name, sectionName, port), e.g., a Gateway and one of its listeners"
},
"app": {
"type": "object",
"required": [
"image",
"probePath"
],
"properties": {
"image": {
"type": "string",
"minLength": 1,
"description": "App image repository, optionally with a tag or digest"
},
"imagePullPolicy": {
"enum": [
"Always",
"IfNotPresent",
"Never"
],
"description": "Pull policy of the app image; Always if not set"
},
"tag": {
"type": "string",
"description": "App image tag; defaults to the chart's appVersion"
},
"replicas": {
"type": "integer",
"minimum": 1,
"description": "Number of the app's pods"
},
"podDisruptionBudget": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": [
"boolean",
"null"
],
"description": "Create a PodDisruptionBudget of the app's pods if there is more than one (replicas); true if null"
},
"minAvailable": {
"type": [
"integer",
"string",
"null"
],
"minimum": 0,
"pattern": "^(100|[1-9]?[0-9])%$",
"description": "Pods that voluntary disruptions (e.g., node drains) keep available: a number or a percentage (e.g., 50%); not set if null"
},
"maxUnavailable": {
"type": [
"integer",
"string",
"null"
],
"minimum": 0,
"pattern": "^(100|[1-9]?[0-9])%$",
"description": "Pods that voluntary disruptions (e.g., node drains) may evict at once: a number or a percentage (e.g., 50%); 1 if neither it nor minAvailable is set"
}
},
"not": {
"$comment": "Rejects setting both minAvailable and maxUnavailable (null counts as not set)",
"properties": {
"minAvailable": {
"not": {
"type": "null"
}
},
"maxUnavailable": {
"not": {
"type": "null"
}
}
},
"required": [
"minAvailable",
"maxUnavailable"
]
}
},
"probePath": {
"type": "string",
"pattern": "^/",
"description": "Path of the app's probes"
},
"startupProbe": {
"type": [
"object",
"null"
],
"description": "Replaces the default startup probe of the app's container, if not empty"
},
"readinessProbe": {
"type": [
"object",
"null"
],
"description": "Replaces the default readiness probe of the app's container, if not empty"
},
"livenessProbe": {
"type": [
"object",
"null"
],
"description": "Replaces the default liveness probe of the app's container, if not empty"
},
"ingress": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Create an Ingress, for any ingress controller (not with httpRoute.enabled); otherwise an OpenShift Route, if route.enabled, the cluster serves route.openshift.io/v1 and httpRoute is disabled"
},
"className": {
"type": "string",
"description": "Ingress class; the cluster's default class if empty"
},
"annotations": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "Annotations of the Ingress, e.g., for the ingress controller (the chart sets none for particular controllers); take precedence over those set by the chart for https, null removes them"
},
"https": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Request a certificate from cert-manager and serve HTTPS"
},
"issuer": {
"type": "string",
"description": "cert-manager ClusterIssuer"
}
}
}
}
},
"httpRoute": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Create a Gateway API HTTPRoute attached to parentRefs (not with ingress.enabled)"
},
"annotations": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
},
"description": "Annotations of the HTTPRoute"
},
"parentRefs": {
"allOf": [
{
"$ref": "#/$defs/parentRefs"
}
],
"description": "Gateways (or listeners, via sectionName or port) that the HTTPRoute attaches to, e.g., the HTTPS listener of a shared Gateway; required if enabled"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"minLength": 1
}
}
},
"description": "Filters of the HTTPRoute's rule (HTTPRouteFilter), e.g., an ExtensionRef to a resource of the Gateway implementation for body size or rate limits"
},
"httpsRedirect": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Create a second HTTPRoute, attached to httpsRedirect.parentRefs, that redirects HTTP to HTTPS (301)"
},
"parentRefs": {
"allOf": [
{
"$ref": "#/$defs/parentRefs"
}
],
"description": "HTTP listeners of the Gateway for the redirect; must not attach to the listeners of httpRoute.parentRefs; required if enabled"
}
}
}
}
},
"route": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Create an OpenShift Route for all paths if neither ingress nor httpRoute is enabled and the cluster serves route.openshift.io/v1; true if not set"
},
"annotations": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "string"
},
"description": "Annotations of the OpenShift Route, e.g., for rate limits of the router"
}
}
},
"networkPolicy": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Create a NetworkPolicy allowing connections to the app only from ingressFrom"
},
"ingressFrom": {
"type": "array",
"items": {
"type": "object",
"minProperties": 1,
"additionalProperties": false,
"properties": {
"podSelector": {
"type": "object"
},
"namespaceSelector": {
"type": "object"
},
"ipBlock": {
"type": "object",
"required": [
"cidr"
],
"additionalProperties": false,
"properties": {
"cidr": {
"type": "string",
"minLength": 1
},
"except": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
}
}
},
"anyOf": [
{
"required": [
"ipBlock"
],
"maxProperties": 1
},
{
"not": {
"required": [
"ipBlock"
]
}
}
]
},
"description": "NetworkPolicy peers allowed to connect to the app, e.g., the pods of the ingress controller or Gateway; no defaults, as they depend on the cluster; must not be empty if enabled"
}
}
},
"podSecurityContext": {
"type": "object",
"description": "Security context of the pod (runAsUser, runAsGroup and fsGroup are omitted on OpenShift)"
},
"securityContext": {
"type": "object",
"description": "Security context of the container (runAsUser and runAsGroup are omitted on OpenShift)"
},
"tmpSizeLimit": {
"$ref": "#/$defs/tmpSizeLimit"
},
"preStopSleepSeconds": {
"type": "integer",
"minimum": 0,
"maximum": 300,
"description": "Seconds that the app keeps serving after its pod is deleted (preStop hook); 0 omits the hook"
},
"gunicorn": {
"type": "object",
"additionalProperties": false,
"required": [
"workers",
"threads",
"timeout",
"gracefulTimeout",
"keepalive",
"extraArgs"
],
"description": "Settings of Gunicorn, the WSGI server of the app image (via GUNICORN_CMD_ARGS); omit them if the image does not run Gunicorn",
"properties": {
"workers": {
"type": "integer",
"minimum": 1,
"maximum": 64,
"description": "Worker processes; each loads the whole app"
},
"threads": {
"type": "integer",
"minimum": 1,
"maximum": 256,
"description": "Threads per worker"
},
"timeout": {
"type": "integer",
"minimum": 1,
"maximum": 3600,
"description": "Seconds after which workers whose main loop does not respond are restarted (slow requests in threads do not count)"
},
"gracefulTimeout": {
"type": "integer",
"minimum": 0,
"maximum": 3600,
"description": "Seconds that workers get to finish requests on shutdown; the termination grace period is this plus preStopSleepSeconds plus 10 seconds"
},
"keepalive": {
"type": "integer",
"minimum": 0,
"maximum": 3600,
"description": "Seconds after which idle keep-alive connections are closed (0: no keep-alive); longer than the idle timeout of the proxy's connections to the app"
},
"extraArgs": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[^']*$"
},
"description": "Further Gunicorn options (no single quotes); --bind/-b, --preload and --graceful-timeout are rejected"
}
}
},
"resources": {
"type": "object",
"description": "Resource requests and limits of the container"
}
},
"description": "Settings of the app container (under the key of the app chart, e.g., cloudRegistry)"
}
},
"type": "object",
"properties": {
"nameOverride": {
"type": "string",
"description": "Replaces the chart name in resource names and labels; set at installation only"
},
"fullnameOverride": {
"type": "string",
"description": "Replaces the name of the app resources (MongoDB resources get the suffix -mongodb); set at installation only"
},
"hostName": {
"type": "string",
"description": "Public host name of the app (of the Ingress, HTTPRoute or Route)"
},
"publicUrl": {
"type": "string",
"pattern": "^([hH][tT][tT][pP][sS]?://[^?#\\s]+)?$",
"description": "Public URL of the app as clients see it, if not https://<hostName>/ (e.g., with the path prefix of a proxy); sets server.public_url"
},
"config": {
"type": [
"object",
"null"
],
"description": "App config overriding the base config in the image (merged by FOCA)",
"properties": {
"server": {
"type": [
"object",
"null"
],
"properties": {
"max_content_length": {
"type": "integer",
"minimum": 1,
"description": "Size limit of request bodies, in bytes"
}
}
}
}
},
"tes": {
"type": "object",
"additionalProperties": false,
"properties": {
"backends": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"url"
],
"properties": {
"type": {
"const": "ga4gh-tes"
},
"url": {
"type": "string",
"minLength": 1,
"description": "Base URL of the TES instance, without /ga4gh/tes/v1"
},
"apiPath": {
"type": "string",
"pattern": "^/([A-Za-z0-9._~-]+(/[A-Za-z0-9._~-]+)*/?)?$",
"description": "Path of the TES API, relative to url (api_path), if not /ga4gh/tes/v1; e.g., /v1 for TESP"
},
"audience": {
"type": "string",
"minLength": 1,
"description": "Audience of the access tokens of proTES for the TES instance, requested with config.custom.tes.client_credentials.audience_parameter; defaults to url"
},
"urlSchemes": {
"type": "array",
"minItems": 1,
"items": {
"enum": [
"https",
"http"
]
},
"description": "Allowed schemes of url (url_schemes); https only by default"
},
"id": {
"type": "string",
"minLength": 1,
"description": "Identifier of the entry; defaults to the normalized URL"
},
"auth": {
"enum": [
"client_credentials",
"basic",
"none"
],
"description": "Credentials of proTES for the backend"
},
"basic": {
"type": "object",
"additionalProperties": false,
"required": [
"usernameEnv",
"passwordEnv"
],
"properties": {
"usernameEnv": {
"type": "string",
"minLength": 1
},
"passwordEnv": {
"type": "string",
"minLength": 1
}
},
"description": "Environment variables with the HTTP Basic credentials (auth: basic)"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Labels of the backends, e.g., {region: eu-north}"
},
"location": {
"type": "object",
"additionalProperties": false,
"required": [
"latitude",
"longitude"
],
"properties": {
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"description": "Location of the backend"
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"type",
"url"
],
"properties": {
"type": {
"const": "ga4gh-service-registry"
},
"url": {
"type": "string",
"minLength": 1,
"description": "Base URL of the registry's API"
},
"urlSchemes": {
"type": "array",
"minItems": 1,
"items": {
"enum": [
"https",
"http"
]
},
"description": "Allowed schemes of url (url_schemes); https only by default"
},
"id": {
"type": "string",
"minLength": 1,
"description": "Identifier of the entry; defaults to the normalized URL"
},
"refreshInterval": {
"type": "integer",
"minimum": 1
},
"maxStale": {
"type": "integer",
"minimum": 1
},
"timeout": {
"type": "number",
"exclusiveMinimum": 0
},
"versions": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1
}
},
"environments": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"auth": {
"enum": [
"client_credentials",
"none"
],
"description": "Credentials of proTES for the discovered backends"
},
"allowPrivateAddresses": {
"type": "boolean"
},
"registryAllowPrivateAddresses": {
"type": "boolean"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Labels of the backends, e.g., {region: eu-north}"
}
}
}
]
},
"description": "TES backends, in order (custom.tes.backends, with camelCase keys)"
}
}
},
"plugins": {
"type": "object",
"additionalProperties": false,
"description": "Plugins that process new tasks, rendered into the plugins section of the app config with its keys (see deployment/README.md, Configuration); empty values are left out",
"definitions": {
"step": {
"type": "object",
"additionalProperties": false,
"required": [
"alternatives"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier of the step",
"pattern": "^[a-z0-9][a-z0-9_.-]{0,63}$"
},
"alternatives": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"plugin"
],
"properties": {
"plugin": {
"type": "string",
"description": "Identifier of the plugin",
"maxLength": 128,
"pattern": "^[a-z0-9][a-z0-9_-]*(\\.[a-z0-9][a-z0-9_-]*)*$"
},
"params": {
"type": "object",
"description": "Parameters of the plugin, kept as they are"
}
}
},
"description": "Plugins with parameters, tried in order"
},
"timeout": {
"type": "number",
"exclusiveMinimum": 0,
"description": "Time limit of each plugin of the step, in seconds"
},
"onFailure": {
"enum": [
"fail",
"skip"
],
"description": "Whether the request fails (fail, the default) or the step is skipped if all alternatives fail (on_failure)"
},
"ifMissingPhase": {
"enum": [
"request",
"route",
"forward",
"response"
],
"description": "Phase that the step needs (if_missing_phase)"
}
}
}
},
"properties": {
"available": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"properties": {
"distribution": {
"type": "string",
"minLength": 1,
"description": "Distribution (package) that must provide the plugin"
},
"version": {
"type": "string",
"minLength": 1,
"description": "Version specifier of the distribution"
},
"config": {
"type": "object",
"description": "Admin settings of the plugin, kept as they are"
},
"clientSelectable": {
"type": "boolean",
"description": "Whether clients may choose the plugin in pipelines of their own (client_selectable)"
},
"roles": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Roles that may choose the plugin; any if empty"
},
"enabled": {
"type": "boolean",
"description": "Whether the plugin is enabled"
},
"store": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether the plugin keeps its entries in the database (shared by all replicas); if false, each process keeps them in memory"
},
"maxEntrySize": {
"type": "integer",
"minimum": 1,
"description": "Maximum size of values, in bytes of compact JSON (max_entry_size)"
},
"maxTtl": {
"type": "number",
"minimum": 0.001,
"maximum": 315360000,
"description": "Maximum time to live of entries, in seconds, at most 10 years (max_ttl)"
}
},
"description": "Settings of the plugin's key-value store (ctx.store), replacing those of config.plugins.defaults.store"
}
}
},
"description": "Installed plugins that may be used, by identifier (FOCA's built-in ones always are)",
"propertyNames": {
"maxLength": 128,
"pattern": "^[a-z0-9][a-z0-9_-]*(\\.[a-z0-9][a-z0-9_-]*)*$"
}
},
"pipeline": {
"type": "array",
"items": {
"$ref": "#/properties/plugins/definitions/step"
},
"description": "Steps that process each new task; the app's default pipeline (random routing, without third-party lookups) if empty"
},
"presets": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/properties/plugins/definitions/step"
}
},
"description": "Pipelines that clients may choose by name",
"propertyNames": {
"pattern": "^[a-z0-9][a-z0-9-]{0,63}$"
}
},
"clientPipelines": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"allowed": {
"type": "array",
"items": {
"enum": [
"presets",
"inline"
]
},
"minItems": 1
},
"maxSteps": {
"type": "integer",
"minimum": 1
},
"maxAlternatives": {
"type": "integer",
"minimum": 1
},
"maxSize": {
"type": "integer",
"minimum": 1
},
"roles": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"prepend": {
"type": "array",
"items": {
"$ref": "#/properties/plugins/definitions/step"
}
},
"append": {
"type": "array",
"items": {
"$ref": "#/properties/plugins/definitions/step"
}
}
},
"description": "Whether and how clients may choose pipelines (client_pipelines; off by default)"
},
"clientBackends": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"maxItems": {
"type": "integer",
"minimum": 1
}
},
"description": "Whether and how clients may choose TES instances (client_backends)"
},
"tags": {
"type": "object",
"additionalProperties": false,
"properties": {
"prefix": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9_.-]{0,31}\\.$"
},
"maxRouteEntries": {
"type": "integer",
"minimum": 1
}
},
"description": "Reserved tags"
},
"provenance": {
"type": "object",
"additionalProperties": false,
"properties": {
"recordFailed": {
"type": "boolean"
},
"secretHeaders": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
}
},
"description": "Records of pipeline runs"
}
}
},
"pluginStore": {
"type": "object",
"additionalProperties": false,
"properties": {
"existingSecret": {
"type": "string",
"description": "Secret with the key secret of the plugin store (key store-key-secret), passed to the app and the worker as FOCA_PLUGINS_STORE_KEY_SECRET; none if empty"
}
},
"description": "Secret of the plugin store of gateway apps (the other settings are in config.plugins)"
},
"mongodb": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Deploy the bundled MongoDB; if false, set config.db.host (and port) of an external one"
},
"image": {
"type": "string",
"description": "MongoDB image, pinned to a patch version or digest"
},
"imagePullPolicy": {
"enum": [
"Always",
"IfNotPresent",
"Never"
],
"description": "Pull policy of the MongoDB image; Always if not set"
},
"auth": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Require MongoDB credentials"
},
"existingSecret": {
"type": "string",
"description": "Secret with the MongoDB credentials (keys username and password, and root-username and root-password for the bundled MongoDB); required if authentication is enabled"
}
}