forked from backstage/charts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathvalues.schema.tmpl.json
786 lines (786 loc) · 33.8 KB
/
values.schema.tmpl.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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"title": "Backstage chart schema",
"properties": {
"global": {
"title": "Global parameters.",
"type": "object",
"properties": {
"imageRegistry": {
"title": "Global Docker image registry",
"type": "string",
"default": ""
},
"imagePullSecrets": {
"title": "Global Docker registry secret names as an array",
"type": "array",
"default": [],
"items": {
"type": "string"
},
"uniqueItems": true,
"examples": [
[
"myRegistryKeySecretName"
]
]
}
}
},
"kubeVersion": {
"title": "Override Kubernetes version",
"type": "string",
"default": ""
},
"nameOverride": {
"title": "String to partially override common.names.fullname",
"type": "string",
"default": ""
},
"fullnameOverride": {
"title": "String to fully override common.names.fullname",
"type": "string",
"default": ""
},
"clusterDomain": {
"title": "Default Kubernetes cluster domain",
"type": "string",
"default": "cluster.local"
},
"commonLabels": {
"title": "Labels to add to all deployed objects",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"commonAnnotations": {
"title": "Annotations to add to all deployed objects",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"extraDeploy": {
"title": "Array of extra objects to deploy with the release",
"type": "array",
"default": [],
"items": {
"type": [
"string",
"object"
]
},
"uniqueItems": true
},
"diagnosticMode": {
"title": "Enable diagnostic mode in the Deployment",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"title": "Enable diagnostic mode",
"description": "All probes will be disabled and the command will be overridden",
"type": "boolean",
"default": false
},
"command": {
"title": "Command to override all containers in the Deployment",
"type": "array",
"items": {
"type": "string"
},
"default": [
"sleep"
]
},
"args": {
"title": "Args to override all containers in the Deployment",
"type": "array",
"items": {
"type": "string"
},
"default": [
"infinity"
]
}
}
},
"ingress": {
"title": "Ingress parameters",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"title": "Enable the creation of the ingress resource",
"type": "boolean",
"default": false
},
"className": {
"title": "Name of the IngressClass cluster resource which defines which controller will implement the resource.",
"type": "string",
"default": "",
"examples": [
"nginx"
]
},
"annotations": {
"title": "Additional annotations for the Ingress resource",
"type": "object",
"default": {},
"additionalProperties": {
"type": "string"
}
},
"host": {
"title": "Hostname to be used to expose the route to access the backstage application.",
"type": "string",
"default": "",
"examples": [
"backstage.10.0.0.1.nip.io"
]
},
"tls": {
"title": "Ingress TLS parameters",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"title": "Enable TLS configuration",
"description": "TLS for the host defined at `ingress.host` parameter",
"type": "boolean",
"default": false
},
"secretName": {
"title": "The name to which the TLS Secret will be called",
"type": "string",
"default": ""
}
}
}
}
},
"backstage": {
"title": "Backstage parameters",
"type": "object",
"additionalProperties": false,
"properties": {
"replicas": {
"title": "Number of deployment replicas",
"type": "integer",
"minimum": 0,
"default": 1
},
"revisionHistoryLimit": {
"title": "The count of deployment revisions",
"type": "integer",
"minimum": 0,
"default": 10
},
"image": {
"title": "Image parameters",
"type": "object",
"additionalProperties": false,
"properties": {
"registry": {
"title": "Backstage image registry",
"type": "string",
"default": "ghcr.io",
"examples": [
"ghcr.io",
"quay.io",
"docker.io"
]
},
"repository": {
"title": "Backstage image repository",
"type": "string",
"default": "backstage/backstage"
},
"tag": {
"title": "Backstage image tag",
"description": "Immutable tags are recommended.",
"type": "string",
"default": "latest"
},
"pullPolicy": {
"title": "Specify a imagePullPolicy.",
"description": "Ref: https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy",
"type": "string",
"default": "Always",
"enum": [
"Always",
"IfNotPresent"
]
},
"pullSecrets": {
"title": "Optionally specify an array of imagePullSecrets.",
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/",
"type": "array",
"items": {
"type": "string"
},
"default": [],
"examples": [
"myRegistryKeySecretName"
]
},
"debug": {
"title": "Set to true if you would like to see extra information on logs",
"type": "boolean",
"default": false
}
}
},
"containerPorts": {
"title": "Container ports on the Deployment",
"type": "object",
"additionalProperties": false,
"properties": {
"backend": {
"title": "Backstage backend port.",
"type": "integer",
"default": 7007
}
}
},
"command": {
"title": "Backstage container command",
"type": "array",
"items": {
"type": "string"
},
"default": [
"node",
"packages/backend"
]
},
"args": {
"title": "Backstage container command arguments",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"extraAppConfig": {
"title": "Extra app configuration files to inline into command arguments",
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"filename": {
"type": "string"
},
"configMapRef": {
"type": "string"
}
}
},
"default": []
},
"extraContainers": {
"title": "Deployment sidecars.",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"default": []
},
"extraEnvVars": {
"title": "Backstage container environment variables",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar"
},
"default": [],
"examples": [
[
{
"name": "APP_CONFIG_backend_cache_store",
"value": "memory"
}
]
]
},
"extraEnvVarsCM": {
"title": "Backstage container environment variables from existing ConfigMaps",
"type": "array",
"description": "Translates into array of `envFrom.[].configMapRef.name`",
"items": {
"type": "string"
},
"default": [],
"examples": [
[
"my-backstage-configmap"
]
]
},
"extraEnvVarsSecrets": {
"title": "Backstage container environment variables from existing Secrets",
"type": "array",
"description": "Translates into array of `envFrom.[].secretRef.name`",
"items": {
"type": "string"
},
"default": [],
"examples": [
[
"my-backstage-secrets"
]
]
},
"extraVolumeMounts": {
"title": "Backstage container additional volume mounts",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"default": []
},
"extraVolumes": {
"title": "Backstage container additional volumes",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Volume"
},
"default": []
},
"initContainers": {
"title": "Backstage container init containers",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
},
"default": []
},
"installDir": {
"title": "Directory containing the backstage installation",
"type": "string",
"default": "/app"
},
"resources": {
"title": "Resource requests/limits",
"description": "Ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#resource-requests-and-limits-of-pod-and-container",
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements",
"default": {},
"examples": [
{
"limits": {
"memory": "1Gi",
"cpu": "1000m"
},
"requests": {
"memory": "250Mi",
"cpu": "100m"
}
}
]
},
"readinessProbe": {
"title": "Readiness probe",
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 30,
"periodSeconds": 10,
"successThreshold": 2,
"timeoutSeconds": 2
}
]
},
"livenessProbe": {
"title": "Liveness probe",
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
]
},
"startupProbe": {
"title": "Startup probe",
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/",
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Probe",
"default": {},
"examples": [
{
"failureThreshold": 3,
"httpGet": {
"path": "/healthcheck",
"port": 7007,
"scheme": "HTTP"
},
"initialDelaySeconds": 60,
"periodSeconds": 10,
"successThreshold": 1,
"timeoutSeconds": 2
}
]
},
"podSecurityContext": {
"title": "Security settings for a Pod.",
"description": "The security settings that you specify for a Pod apply to all Containers in the Pod. Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod",
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {}
},
"containerSecurityContext": {
"title": "Security settings for a Container.",
"description": "Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container",
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.SecurityContext",
"default": {}
},
"appConfig": {
"title": "Generates ConfigMap and configures it in the Backstage pods",
"type": [
"object",
"string"
],
"default": {},
"examples": [
{
"app": {
"baseUrl": "https://somedomain.tld"
}
}
]
},
"nodeSelector": {
"title": "Node labels for pod assignment",
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"tolerations": {
"title": "Node tolerations for server scheduling to nodes with taints",
"description": "Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/",
"type": "array",
"items": {
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.api.core.v1.Toleration"
},
"default": []
},
"podAnnotations": {
"title": "Annotations to add to the backend deployment pods",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"podLabels": {
"title": "Labels to add to the backend deployment pods",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"annotations": {
"title": "Additional custom annotations for the `Deployment` resource",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
}
}
},
"service": {
"title": "Service parameters",
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"title": "Kubernetes Service type",
"type": "string",
"default": "ClusterIP",
"enum": [
"ClusterIP",
"NodePort",
"LoadBalancer",
"ExternalName"
]
},
"ports": {
"title": "Backstage svc port for client connections",
"type": "object",
"additionalProperties": false,
"properties": {
"backend": {
"title": "Backstage svc port number",
"type": "integer",
"default": 7007
},
"name": {
"title": "Backstage svc port name",
"type": "string",
"default": "http-backend"
},
"targetPort": {
"title": "Backstage svc target port referencing receiving pod container port",
"type": "string",
"default": "backend"
}
}
},
"nodePorts": {
"title": "Node port for the Backstage client connections",
"type": "object",
"additionalProperties": false,
"properties": {
"backend": {
"title": "Node port for backend",
"type": [
"string",
"integer"
],
"default": "",
"minimum": 30000,
"maximum": 32767
}
}
},
"sessionAffinity": {
"title": "Control where client requests go, to the same pod or round-robin",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#session-stickiness",
"type": "string",
"default": "None",
"enum": [
"None",
"ClientIP"
]
},
"clusterIP": {
"title": "Backstage service Cluster IP",
"type": "string",
"default": ""
},
"loadBalancerIP": {
"title": "Backstage service Load Balancer IP",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"type": "string",
"default": ""
},
"loadBalancerSourceRanges": {
"title": "Load Balancer sources",
"description": "Ref: https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer",
"type": "array",
"items": {
"type": "string"
},
"default": [],
"examples": [
"10.10.10.0/24"
]
},
"externalTrafficPolicy": {
"title": "Backstage service external traffic policy",
"description": "Ref: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip",
"type": "string",
"default": "Cluster",
"enum": [
"Cluster",
"Local"
]
},
"annotations": {
"title": "Additional custom annotations for Backstage service",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"extraPorts": {
"title": "Extra ports to expose in the Backstage service",
"type": "array",
"items": {
"type": "object"
},
"default": []
}
}
},
"networkPolicy": {
"title": "Network policies",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"title": "Specifies whether a NetworkPolicy should be created",
"type": "boolean",
"default": false
},
"ingressRules": {
"title": "Custom egress rules for the network policy",
"type": "object",
"additionalProperties": false,
"properties": {
"customRules": {
"title": "",
"type": "array",
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyIngressRule"
}
},
"namespaceSelector": {
"title": "Namespace Selector.",
"description": "Selects Namespaces using cluster scoped-labels.",
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"default": {}
},
"podSelector": {
"title": "Pod Selector.",
"description": "Selects selects Pods in this namespace.",
"$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/master/_definitions.json#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"default": {}
}
}
},
"egressRules": {
"title": "Custom egress rules for the network policy",
"type": "object",
"additionalProperties": false,
"properties": {
"customRules": {
"title": "",
"type": "array",
"items": {
"$ref": "https://kubernetesjsonschema.dev/v1.8.7/_definitions.json#/definitions/io.k8s.api.networking.v1.NetworkPolicyEgressRule"
}
},
"denyConnectionsToExternal": {
"title": "Deny external connections. Should not be enabled when working with an external database.",
"type": "boolean",
"default": false
}
}
}
}
},
"postgresql": {
"title": "PostgreSQL chart configuration",
"description": "Ref. https://github.com/bitnami/charts/blob/master/bitnami/postgresql/values.yaml",
"$ref": "https://raw.githubusercontent.com/bitnami/charts/main/bitnami/postgresql/values.schema.json"
},
"serviceAccount": {
"title": "Service Account Configuration",
"type": "object",
"additionalProperties": false,
"properties": {
"create": {
"title": "Enable the creation of a ServiceAccount for Backstage pods",
"type": "boolean",
"default": false
},
"name": {
"title": "Name of the ServiceAccount to use",
"description": "If not set and `serviceAccount.create` is true, a name is generated",
"type": "string",
"default": ""
},
"labels": {
"title": "Additional custom labels to the service ServiceAccount.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"annotations": {
"title": "Additional custom annotations for the ServiceAccount.",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"automountServiceAccountToken": {
"title": "Auto-mount the service account token in the pod",
"type": "boolean",
"default": true
}
}
},
"metrics": {
"title": "Metrics configuration",
"description": "Allows configuring your backstage instance as a scrape target for Prometheus. Ref: https://github.com/prometheus/prometheus",
"type": "object",
"additionalProperties": false,
"properties": {
"serviceMonitor": {
"title": "ServiceMonitor configuration",
"description": "A custom resource that is consumed by Prometheus Operator. Ref: https://github.com/prometheus-operator/prometheus-operator",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"title": "If enabled, a ServiceMonitor resource for Prometheus Operator is created",
"description": "Prometheus Operator must be installed in your cluster prior to enabling.",
"type": "boolean",
"default": false
},
"annotations": {
"title": "ServiceMonitor annotations",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"labels": {
"title": "Additional ServiceMonitor labels",
"type": "object",
"additionalProperties": {
"type": "string"
},
"default": {}
},
"interval": {
"title": "ServiceMonitor scrape interval",
"type": [
"string",
"null"
],
"default": null
},
"path": {
"title": "ServiceMonitor endpoint path",
"description": "ote that the /metrics endpoint is NOT present in a freshly scaffolded Backstage app. To setup, follow the Prometheus metrics tutorial. https://github.com/backstage/backstage/blob/master/contrib/docs/tutorials/prometheus-metrics.md",
"type": "string",
"default": "/metrics"
}
}
}
}
}
}
}