-
Notifications
You must be signed in to change notification settings - Fork 168
/
values-schema.yaml
3326 lines (3321 loc) · 105 KB
/
values-schema.yaml
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: 'http://json-schema.org/draft-07/schema'
version: 3
additionalProperties: true
definitions:
rawValues:
description: "May define value overrides for a chart. WARNING: these values currently have no schema and can't be validated as such, and may break deployment. You are on your own here."
type: object
alerts:
additionalProperties: false
properties:
email:
additionalProperties: false
properties:
critical:
$ref: '#/definitions/email'
description: One or more email addresses (comma separated) for critical events.
x-secret: ''
nonCritical:
$ref: '#/definitions/email'
description: One or more email addresses (comma separated) for non-critical events.
x-secret: ''
groupInterval:
default: 5m
description: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
$ref: '#/definitions/duration'
msteams:
additionalProperties: false
properties:
highPrio:
description: The high prio web hook.
$ref: '#/definitions/wordCharacterPattern'
x-secret: ''
lowPrio:
description: The low prio web hook.
$ref: '#/definitions/wordCharacterPattern'
x-secret: ''
receivers:
description: Notification receivers.
items:
enum:
- slack
- msteams
- opsgenie
- email
- none
type: string
type: array
uniqueItems: true
repeatInterval:
default: 3h
description: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).
$ref: '#/definitions/duration'
slack:
additionalProperties: false
properties:
channel:
default: mon-otomi
description: The Slack channel for non-critical notifications.
$ref: '#/definitions/wordCharacterPattern'
channelCrit:
default: mon-otomi-crit
description: The Slack channel for critical notifications.
$ref: '#/definitions/wordCharacterPattern'
url:
$ref: '#/definitions/url'
description: A Slack webhook URL.
x-secret: ''
opsgenie:
additionalProperties: false
properties:
apiKey:
description: The api key to use for authn
$ref: '#/definitions/wordCharacterPattern'
x-secret: ''
url:
$ref: '#/definitions/url'
description: A Slack webhook URL.
x-secret: ''
responders:
type: array
items:
allOf:
- properties:
type:
type: string
enum:
- team
- user
- escalation
- schedule
- oneOf:
- title: ID
required: [id]
properties:
id:
$ref: '#/definitions/wordCharacterPattern'
- title: Name
required: [name]
properties:
name:
$ref: '#/definitions/idName'
- title: Username
required: [username]
properties:
username:
$ref: '#/definitions/wordCharacterPattern'
required: [type]
annotations:
$ref: '#/definitions/labelsAnnotations'
description: A set of annotations.
autoscaling:
additionalProperties: false
properties:
maxReplicas:
type: integer
default: 10
minReplicas:
type: integer
default: 1
autoscalingEnabled:
additionalProperties: false
properties:
enabled:
default: true
type: boolean
maxReplicas:
type: integer
default: 10
minReplicas:
type: integer
default: 1
targetCPUUtilizationPercentage:
type: integer
default: 80
targetMemoryUtilizationPercentage:
type: integer
default: 80
akamai:
definitions:
dns:
properties:
host:
title: Akamai API host
description: Akamai Edgegrid API server
$ref: '#/definitions/wordCharacterPattern'
accessToken:
title: Akamai access token
description: Akamai Edgegrid API access token
$ref: '#/definitions/wordCharacterPattern'
x-secret: ''
clientToken:
title: Akamai client token
description: Akamai Edgegrid API client token
$ref: '#/definitions/wordCharacterPattern'
x-secret: ''
clientSecret:
title: Akamai client secret
description: Akamai Edgegrid API client secret
$ref: '#/definitions/wordCharacterPattern'
x-secret: ''
required:
- host
- accessToken
- clientToken
- clientSecret
aws:
definitions:
accessKey:
title: AWS access key
description: An AWS access key ID.
$ref: '#/definitions/wordCharacterPattern'
x-secret: ''
secretKey:
title: AWS secret key
description: An AWS secret key.
type: string
x-secret: ''
region:
title: AWS region
description: An AWS region.
$ref: '#/definitions/wordCharacterPattern'
role:
description: Role may be set explicitly if no metadata can be accessed.
example: arn:aws:iam::YYYYYYYYYYYY:role/dns-manager
$ref: '#/definitions/wordCharacterPattern'
azure:
definitions:
clientId:
title: Azure client id
description: An Azure client id.
$ref: '#/definitions/wordCharacterPattern'
clientSecret:
title: Azure client secret
description: An Azure client secret.
type: string
x-secret: ''
dns:
properties:
resourceGroup:
$ref: '#/definitions/azure/definitions/resourceGroup'
hostedZoneName:
title: Hosted zone name
description: Name of the DNS zone that should be used.
$ref: '#/definitions/wordCharacterPattern'
tenantId:
$ref: '#/definitions/azure/definitions/tenantId'
subscriptionId:
$ref: '#/definitions/azure/definitions/subscriptionId'
aadClientId:
$ref: '#/definitions/azure/definitions/clientId'
aadClientSecret:
$ref: '#/definitions/azure/definitions/clientSecret'
title: Client secret
type: string
description: Azure Application Client Secret
x-secret: ''
required:
- tenantId
- subscriptionId
- resourceGroup
- aadClientId
- aadClientSecret
environment:
title: Azure environment
description: An Azure environment.
type: string
default: AzurePublicCloud
enum:
- AzurePublicCloud
- AzureChinaCloud
- AzureUSGovernment
- AzureGermanCloud
tenantId:
title: Azure tenant id
description: An Azure tenant id.
$ref: '#/definitions/wordCharacterPattern'
subscriptionId:
title: Azure subscription id
description: An Azure subscription id.
$ref: '#/definitions/wordCharacterPattern'
resourceGroup:
title: Resource group
description: An Azure resource group.
$ref: '#/definitions/wordCharacterPattern'
cluster:
additionalProperties: false
properties:
apiServer:
description: Used to generate KUBECONFIG for download, for local access to target cluster.
pattern: '^https:\/\/.*'
domainSuffix:
$ref: '#/definitions/domain'
description: Domain suffix for the cluster. Also added to list of dns zones in the Otomi Console.
k8sContext:
$ref: '#/definitions/k8sContext'
description: Optional. Must be set for development mode and must point to an existing context in KUBECONFIG.
name:
$ref: '#/definitions/clusterName'
description: Short name that will be used in construction of cluster domain and messaging.
owner:
$ref: '#/definitions/idName'
description: The name of the organization owning the cluster.
default: otomi
provider:
$ref: '#/definitions/provider'
required:
- name
- provider
clusterName:
$ref: '#/definitions/wordCharacterPattern'
type: string
containerSpecNoSec:
properties:
image:
$ref: '#/definitions/image'
resources:
$ref: '#/definitions/resources'
env:
$ref: '#/definitions/env'
files:
$ref: '#/definitions/files'
nativeSecrets:
$ref: '#/definitions/nativeSecrets'
description: Reserved for internal use.
secrets:
$ref: '#/definitions/secrets'
secretMounts:
$ref: '#/definitions/secretMounts'
command:
type: array
items:
type: string
args:
type: array
items:
type: string
required:
- image
- resources
containerSpec:
allOf:
- $ref: '#/definitions/securityContext'
- $ref: '#/definitions/containerSpecNoSec'
cpuQuantity:
description: Amount of cpu cores, or slice of cpu core in millis.
examples:
- '1'
- 200m
pattern: ^([1-9][0-9]*|([0]|[1-9]+)\\.[0-9]{1,3}|[1-9][0-9]*m)$
type: string
backup:
type: object
description: PV backups
properties:
name:
$ref: '#/definitions/wordCharacterPattern'
ttl:
$ref: '#/definitions/backupTtl'
schedule:
$ref: '#/definitions/backupSchedule'
snapshotVolumes:
type: boolean
default: false
labelSelector:
$ref: '#/definitions/labels'
description: Individual objects must match this label selector to be included in the backup.
domain:
pattern: ^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))|([a-f0-9:]+:+)+[a-f0-9]+$
type: string
droneGit:
properties:
clientID:
$ref: '#/definitions/wordCharacterPattern'
clientSecretValue:
type: string
x-secret: ''
duration:
description: 'Prometheus duration (See: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#configuration-file)'
pattern: '((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0)'
type: string
default: 1d
email:
pattern: '^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$'
type: string
env:
additionalProperties: false
examples:
- FOO: bar
- bar: foo
patternProperties:
'[a-zA-Z_]{1,}[a-zA-Z0-9_]*':
maxLength: 131072
type: string
nullable: true
type: object
title: Environment variables
files:
additionalProperties: false
description: Dictionary of absolute path > content pairs.
patternProperties:
'^[/].*':
type: string
google:
additionalProperties: false
definitions:
accountJson:
type: string
x-secret: ''
project:
$ref: '#/definitions/wordCharacterPattern'
hostPort:
pattern: '^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]):()([1-9]|[1-5]?[0-9]{2,4}|6[1-4][0-9]{3}|65[1-4][0-9]{2}|655[1-2][0-9]|6553[1-5])$'
type: string
idName:
description: A lowercase name that starts with a letter and may contain dashes.
pattern: '^[a-z0-9]([-a-z0-9]*[a-z0-9])$'
type: string
image:
additionalProperties: false
properties:
pullPolicy:
default: IfNotPresent
enum:
- IfNotPresent
- Always
type: string
repository:
$ref: '#/definitions/repository'
tag:
default: latest
$ref: '#/definitions/wordCharacterPattern'
title: Container image
imagePullPolicy:
default: IfNotPresent
enum:
- IfNotPresent
- Always
type: string
imageTag:
x-default: stable
pattern: '[\w][\w.-]{0,127}'
type: string
x-message: a valid container registry image tag
imageSimple:
properties:
tag:
$ref: '#/definitions/imageTag'
pullPolicy:
$ref: '#/definitions/imagePullPolicy'
required:
- tag
type: object
title: Container image
ingressNginx:
additionalProperties: false
properties:
_rawValues:
$ref: '#/definitions/rawValues'
tracing:
description: Configure Nginx for tracing. Requires Otel Collector to be enabled.
propterties:
enabled:
default: false
type: boolean
samplingRatio:
type: string
default: '0.01'
autoscaling:
additionalProperties: false
properties:
enabled:
default: true
type: boolean
maxReplicas:
type: integer
default: 10
minReplicas:
type: integer
default: 1
targetCPUUtilizationPercentage:
type: integer
default: 80
targetMemoryUtilizationPercentage:
type: integer
default: 80
maxBodySize:
type: string
default: 1024m
maxBodySizeBytes:
type: integer
minimum: 0
default: 1073741824
description: Needed for modsecurity. Should correspond to maxBodySize, but expressed in bytes.
modsecurity:
title: MOD Security
description: Enables MOD Security functionality.
properties:
block:
description: Makes nginx block requests that are marked as violating the modsec rules.
type: boolean
default: false
enabled:
type: boolean
default: false
owasp:
description: Turns on the default OWASP rule set for modsec. See
type: boolean
default: true
type: object
image:
properties:
tag:
$ref: '#/definitions/imageTag'
x-default: v1.0.5
pullPolicy:
$ref: '#/definitions/imagePullPolicy'
resources:
controller:
$ref: '#/definitions/resources'
opentelemetry:
$ref: '#/definitions/resources'
defaultBackend:
$ref: '#/definitions/resources'
service:
properties:
annotations:
$ref: '#/definitions/annotations'
ingressClassParameters:
type: object
properties:
entrypoint:
description: A public IP address that has a route to a private loadbalancer ip, allowing access to private clusters. (Provider "custom" only.)
type: string
network:
title: Load balancer type
type: string
enum:
- public
default: public
loadBalancerIP:
title: Load balancer IP address
description: A static IP address assigned to a load balancer
type: string
sourceIpAddressFiltering:
title: Source IP address filtering
type: string
description: 'Whitelist source IP address ranges. The value is a comma separated list of CIDRs, e.g. 10.0.0.0/24,172.10.0.1'
annotations:
properties:
annotations:
$ref: '#/definitions/annotations'
ipV4Address:
type: string
pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
jobs:
description: You may pass an array of Job objects. The Kubernetes API accepts
a Job specification, which is meant for run-to-completion apps (e.g. batch
Jobs).
items:
type: object
allOf:
- properties:
id:
type: string
readOnly: true
type: object
- $ref: '#/definitions/jobSpec'
- $ref: '#/definitions/podSpec'
type: array
jobSpec:
properties:
type:
default: Job
enum:
- Job
- CronJob
type: string
name:
$ref: '#/definitions/idName'
title: Name
description: A job name
example: some-job
enabled:
default: true
type: boolean
runPolicy:
default: OnSpecChange
description: |
If runPolicy is set to 'Always', the job controller will always be re-deployed after a successful deployment with Helm.
If runPolicy is set to 'OnSpecChange', the job controller will only be re-deployed if one changes this specification.
enum:
- Always
- OnSpecChange
type: string
schedule:
default: 0 1 * * *
description: Must give a cron-type expression if the job type is 'Cronjob'.
type: string
script:
$ref: '#/definitions/script'
shell:
default: /bin/sh
description: Full path to a shell binary that exists in the image.
type: string
ttlSecondsAfterFinished:
default: 86400
description: Time To Live after job is finished in seconds. Will be removed afterwards.
minimum: 0
title: TTL after finished
type: integer
init:
type: array
items:
$ref: '#/definitions/containerSpec'
nullable: true
required:
- name
- script
- type
type: object
k8sContext:
description: The cluster k8s context as found in $KUBECONFIG.
$ref: '#/definitions/wordCharacterPattern'
labels:
$ref: '#/definitions/labelsAnnotations'
description: A set of labels.
labelsAnnotations:
additionalProperties: false
patternProperties:
'^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]){1,253}\/)?([a-z0-9A-Z]+[a-z0-9A-Z-_.]+[a-z0-9A-Z]){1,63}$':
pattern: '^((.){1,253}\/)?(.){1,63}$'
type: string
logLevel:
type: string
default: info
enum:
- error
- warn
- info
- debug
- trace
memoryQuantity:
description: Amount of memory. Valid units are E|P|T|G|M|K|Ei|Pi|Ti|Gi|Mi|Ki.
examples:
- 1Mi
- 0.5M
pattern: '^([0-9]+\.)?[0-9]+(E|P|T|G|M|K|Ei|Pi|Ti|Gi|Mi|Ki)?$'
type: string
nativeSecrets:
description: List of kubernetes secret names.
additionalProperties: false
patternProperties:
'[a-zA-Z_]{1,}[a-zA-Z0-9_]*':
maxLength: 131072
type: string
nullable: true
type: object
title: Kubernetes secrets
netpol:
type: object
properties:
name:
type: string
title: Network Policy name
description: 'A unique name for the network policy'
ruleType:
properties:
ingress:
properties:
toLabelName:
type: string
title: Selector label name
description: 'The name of the Pod selector label'
toLabelValue:
type: string
title: Selector label value
description: 'The value of the Pod selector label'
mode:
default: AllowOnly
enum:
- AllowOnly
- AllowAll
allow:
title: Add team or team with service
type: array
items:
type: object
properties:
fromLabelName:
type: string
title: Selector label name
description: 'The name of the Pod selector label'
fromLabelValue:
type: string
title: Selector label value
description: 'The value of the Pod selector label'
fromNamespace:
type: string
title: Namespace name
description: 'The name of the namespace'
required:
- fromNamespace
egress:
properties:
domain:
title: FQDN or IP address
$ref: '#/definitions/domain'
ports:
properties:
number:
title: Port number
type: integer
minimum: 1
maximum: 65535
protocol:
title: Protocol
type: string
enum: [HTTPS, HTTP, TCP]
default: HTTPS
required:
- number
- protocol
default:
- number: 443
protocol: HTTPS
required:
- domain
path:
description: An absolute path
type: string
pattern: '^[/].*$'
podSecurityContext:
allOf:
- $ref: '#/definitions/securityContext'
- properties:
fsGroup:
description: Supplementary group ID. Volumes that support ownership management are modified to be owned and writable by this ID.
$ref: '#/definitions/unixOwnerId'
fsGroupChangePolicy:
description: |
'Defines behavior for changing ownership and permission of the volume before being exposed inside a Pod. This field only applies to volume types that support fsGroup controlled ownership and permissions.
This field has two possible values:
- OnRootMismatch: Only change permissions and ownership if permission and ownership of root directory does not match with expected permissions of the volume. This could help shorten the time it takes to change ownership and permission of a volume.
- Always: Always change permission and ownership of the volume when volume is mounted.'
type: string
enum:
- Always
- OnRootMismatch
description: Security context for the pod.
title: Pod security context
podSpec:
allOf:
- properties:
annotations:
$ref: '#/definitions/annotations'
title: Pod annotations
type: object
- $ref: '#/definitions/podSecurityContext'
- $ref: '#/definitions/containerSpec'
type: object
portNumber:
maximum: 32768
minimum: 80
type: integer
provider:
type: string
description: Enter the cloud provider of the cluster.
enum:
- custom
- linode
default: linode
registry:
pattern: '^[a-z0-9]+(?:[._-][a-z0-9]+)*$'
type: string
repoUrl:
description: Path to a remote git repo with or without protocol prefix of either https:// or file:// (https:// used if omitted)
pattern: '^(https://|file://)?(.+@)*([\w\d\.]+)(:[\d]+){0,1}/*(.*)$'
type: string
repository:
description: A container image repository.
pattern: '^[a-z0-9]+(?:[/._-]{1,2}[a-z0-9]+)*$'
type: string
resource:
additionalProperties: false
properties:
cpu:
$ref: '#/definitions/cpuQuantity'
memory:
$ref: '#/definitions/memoryQuantity'
required:
- cpu
- memory
resources:
additionalProperties: false
description: Compute resources for containers.
properties:
limits:
$ref: '#/definitions/resource'
description: Requested resources (best effort).
requests:
$ref: '#/definitions/resource'
description: Requested resources (guaranteed).
required:
- limits
- requests
title: Pod resources
unixOwnerIdRange:
type: object
additionalProperties: false
required: [min, max]
properties:
min:
type: integer
minimum: 0
maximum: 65535
max:
type: integer
minimum: 0
maximum: 65535
unixOwnerId:
description: The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
type: integer
minimum: 0
maximum: 65535
default: 1001
script:
description: May specify a non-empty string containing an executable script.
type: string
properties:
id:
readOnly: true
type: string
name:
$ref: '#/definitions/idName'
required:
- name
- type
backupSchedule:
default: 0 0 * * *
description: Cron-type expression to schedule the backup. Defaults to once a day at 00:00.
type: string
secret:
type: object
properties:
id:
readOnly: true
type: string
clusterWide:
description: Will create the secret in all namespaces.
type: boolean
default: false
teamWide:
description: Will create the secret in all team-* namespaces.
type: boolean
default: false
name:
$ref: '#/definitions/idName'
namespace:
$ref: '#/definitions/idName'
description: A kubernetes namespace.
required:
- name
oneOf:
- title: Generic
properties:
type:
default: generic
enum:
- generic
entries:
type: array
items:
description: A property name at vaultPath
minItems: 1
# a valid secret key must consist of alphanumeric characters, '-', '_' or '.' (e.g. 'key.name', or 'KEY_NAME', or 'key-name' )
pattern: '^[-._a-zA-Z0-9]+$'
type: string
uniqueItems: true
required:
- type
- entries
- title: Docker registry
properties:
type:
default: docker-registry
enum:
- docker-registry
type: string
required:
- type
- title: TLS
properties:
type:
default: tls
enum:
- tls
type: string
crt:
type: string
default: 'tls.crt'
key:
type: string
default: 'tls.key'
ca:
type: string
default: 'ca.crt'
required:
- type
- crt
- key
secrets:
description: List of secret names that will have their props injected as env vars into the container.
items:
type: string
pattern: '[a-zA-Z_]{1,}[a-zA-Z0-9_]*'
nullable: true
title: Secrets
type: array
secretMounts:
description: Dictionary of absolute folder path > secret name. Will mount the contents of the secret in the container at the specified folder path.
examples:
- /foo: bar
nullable: true
patternProperties:
'^[/].*$':
type: string
title: Secret mounts
type: object
secretTemplates:
definitions:
otomiAdminUsername:
x-secret: 'admin'
securityContext:
additionalProperties:
uniqueItems: true
properties:
runAsUser:
$ref: '#/definitions/unixOwnerId'
runAsNonRoot:
description: Enforces that the container must run as non root. This implies that the UID must also be set with runAsUser.
type: boolean
default: true
runAsGroup:
description: The GID to run the entrypoint of the container process. Defaults to group specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
$ref: '#/definitions/unixOwnerId'
service:
additionalProperties: false
properties:
authz:
additionalProperties: false
description: Identifies a workload to authorize.
properties:
forwardOriginalToken:
default: false
description: If true istio will forward the bearer token instead of removing it from the headers.
type: boolean
workload:
$ref: '#/definitions/labelsAnnotations'
trafficControl:
title: Traffic Control
description: Split traffic between multiple services (blue/green, canary)
properties:
enabled:
type: boolean
default: false
weightV1:
type: integer
default: 90
weightV2:
type: integer
default: 10
certName:
description: The name of a TLS secret known to exist in the team namespace.
example: www-example-com
type: string
domain:
description: A custom service domain name (max 64 bytes).
maxLength: 64
$ref: '#/definitions/wordCharacterPattern'
forwardPath:
default: false
description: Whether to forward the path into the service, or 'terminate' it.
type: boolean
hasCert:
description: Select when a certificate exists and should not be generated.
type: boolean
headers:
properties:
response:
properties:
set:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
required:
- name
- value
request:
properties:
set:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
required:
- name
- value
hide:
description: Used by otomi console to determine wether to render it on screen or not. Only used by core services.
type: boolean
host:
description: Reference to another core service name. Used by otomi console to show a variation of a core service with a different path (i.e. Loki). Only used by core services.
$ref: '#/definitions/wordCharacterPattern'
id:
description: Unique identifier created by and used in API. Optional.
type: string
auth:
description: Available only for core apps.
type: boolean
isShared:
description: When true the service will get it's own domain by prefixing the app name to the cluster domain. Mostly used by core apps.
type: boolean
ksvc:
type: object
properties:
predeployed:
description: Set this flag it the service is managed by knative service
type: boolean
default: false
logo: