-
Notifications
You must be signed in to change notification settings - Fork 54
Expand file tree
/
Copy pathconfiguration.schema.json
More file actions
897 lines (897 loc) · 41.9 KB
/
configuration.schema.json
File metadata and controls
897 lines (897 loc) · 41.9 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
{
"$schema" : "https://json-schema.org/draft/2020-12/schema",
"$defs" : {
"HelmConfigWithValues-nullable" : {
"type" : [ "object", "null" ],
"properties" : {
"chart" : {
"type" : [ "string", "null" ],
"description" : "Name of the Helm chart"
},
"repoURL" : {
"type" : [ "string", "null" ],
"description" : "Repository url from which the Helm chart should be obtained"
},
"values" : {
"$ref" : "#/$defs/Map(String,Object)-nullable",
"description" : "Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration"
},
"version" : {
"type" : [ "string", "null" ],
"description" : "The version of the Helm chart to be installed"
}
},
"additionalProperties" : false
},
"Map(String,Object)-nullable" : {
"type" : [ "object", "null" ]
},
"Map(String,String)" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"ScmProviderType-nullable" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "string",
"enum" : [ "GITLAB", "SCM_MANAGER" ]
} ]
}
},
"type" : "object",
"properties" : {
"application" : {
"type" : [ "object", "null" ],
"properties" : {
"baseUrl" : {
"type" : [ "string", "null" ],
"description" : "the external base url (TLD) for all tools, e.g. https://example.com or http://localhost:8080. The individual -url params for argocd, grafana and vault take precedence."
},
"clusterAdmin" : {
"type" : [ "boolean", "null" ],
"description" : "Binds ArgoCD controllers to cluster-admin ClusterRole"
},
"destroy" : {
"type" : [ "boolean", "null" ],
"description" : "Unroll playground"
},
"gitEmail" : {
"type" : [ "string", "null" ],
"description" : "Sets git author and committer email used for initial commits"
},
"gitName" : {
"type" : [ "string", "null" ],
"description" : "Sets git author and committer name used for initial commits"
},
"gopNamespace" : {
"type" : [ "string", "null" ],
"description" : "If set, GOP stores specific information in this namespace."
},
"insecure" : {
"type" : [ "boolean", "null" ],
"description" : "Sets insecure-mode in cURL which skips cert validation"
},
"mirrorRepos" : {
"type" : [ "boolean", "null" ],
"description" : "Changes the sources of deployed tools so they are not pulled from the internet, but are pulled from git and work in air-gapped environments."
},
"namePrefix" : {
"type" : [ "string", "null" ],
"description" : "Set name-prefix for repos, jobs, namespaces"
},
"namespaceIsolation" : {
"type" : [ "boolean", "null" ],
"description" : "Configure tools to explicitly work with the given namespaces only, and not cluster-wide. This way GOP can be installed without having cluster-admin permissions."
},
"netpols" : {
"type" : [ "boolean", "null" ],
"description" : "Sets Network Policies"
},
"openshift" : {
"type" : [ "boolean", "null" ],
"description" : "When set, openshift specific resources and configurations are applied"
},
"password" : {
"type" : [ "string", "null" ],
"description" : "Set initial admin passwords"
},
"podResources" : {
"type" : [ "boolean", "null" ],
"description" : "Write kubernetes resource requests and limits on each pod"
},
"profile" : {
"type" : [ "string", "null" ],
"description" : "Use predefined profile (full, only-argocd, operator-mandants aso.)"
},
"skipCrds" : {
"type" : [ "boolean", "null" ],
"description" : "Skip installation of CRDs. This requires prior installation of CRDs"
},
"urlSeparatorHyphen" : {
"type" : [ "boolean", "null" ],
"description" : "Use hyphens instead of dots to separate application name from base-url"
},
"username" : {
"type" : [ "string", "null" ],
"description" : "Set initial admin username"
},
"yes" : {
"type" : [ "boolean", "null" ],
"description" : "Skip confirmation"
}
},
"additionalProperties" : false,
"description" : "Application configuration parameter for GOP"
},
"content" : {
"type" : [ "object", "null" ],
"properties" : {
"allowedStaticsWhitelist" : {
"description" : "Whitelist for Statics freemarker is allowing in user templates",
"type" : [ "array", "null" ],
"items" : {
"type" : "string"
}
},
"helmReleases" : {
"description" : "",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"properties" : {
"chart" : {
"type" : [ "string", "null" ],
"description" : "Helm chart name to install. For HTTP(S) repos this is the chart name from the repo index; for OCI this is the chart artifact name."
},
"name" : {
"type" : [ "string", "null" ],
"description" : "Logical name of the Helm release. Used as the feature folder name under 'apps/<name>' and as default for 'releaseName' if not set."
},
"namespace" : {
"type" : [ "string", "null" ],
"description" : "Kubernetes namespace to deploy the release into."
},
"releaseName" : {
"type" : [ "string", "null" ],
"description" : "Helm release name. If empty, the value of 'name' is used."
},
"repoURL" : {
"type" : [ "string", "null" ],
"description" : "Helm repository URL to fetch the chart from. Use an HTTP(S) Helm repo (must provide an index.yaml) or an OCI registry URL (oci://...)."
},
"values" : {
"$ref" : "#/$defs/Map(String,Object)-nullable",
"description" : "Optional inline Helm values. These values are merged on top of 'valuesFile' (if set) and override keys from the file. Use this for small overrides without maintaining a separate file."
},
"valuesPath" : {
"type" : [ "string", "null" ],
"description" : "Optional path to a YAML values file to load Helm values from.The file must be accessible locally on the machine running GOP. Inline 'values' will be merged on top (inline overrides file)."
},
"version" : {
"type" : [ "string", "null" ],
"description" : "Chart version to deploy. Required for Helm charts in Argo CD. For HTTP(S) Helm repos you may use a SemVer range like '*' to always pick the newest version. For OCI registries, specify an explicit version/tag."
}
},
"additionalProperties" : false
}
},
"namespaces" : {
"description" : "Additional kubernetes namespaces. These are authorized to Argo CD, supplied with image pull secrets, monitored by prometheus, etc. Namespaces can be templates, e.g. ${config.application.namePrefix}staging",
"type" : [ "array", "null" ],
"items" : {
"type" : "string"
}
},
"repos" : {
"description" : "ContentLoader repos to push into target environment",
"type" : [ "array", "null" ],
"items" : {
"type" : "object",
"properties" : {
"createJenkinsJob" : {
"type" : [ "boolean", "null" ],
"description" : "If true, creates a Jenkins job, if jenkinsfile exists in one of the content repo's branches."
},
"credentials" : {
"type" : [ "object", "null" ],
"properties" : {
"passwordKey" : {
"type" : [ "string", "null" ],
"description" : "Credentials Object to authenticate against content repo. Allows using a K8s Secret"
},
"secretName" : {
"type" : [ "string", "null" ],
"description" : "Credentials Object to authenticate against content repo. Allows using a K8s Secret"
},
"secretNamespace" : {
"type" : [ "string", "null" ],
"description" : "Credentials Object to authenticate against content repo. Allows using a K8s Secret"
},
"username" : {
"type" : [ "string", "null" ],
"description" : "Credentials Object to authenticate against content repo. Allows using a K8s Secret"
},
"usernameKey" : {
"type" : [ "string", "null" ],
"description" : "Credentials Object to authenticate against content repo. Allows using a K8s Secret"
}
},
"additionalProperties" : false,
"description" : "Credentials Object to authenticate against content repo. Allows using a K8s Secret"
},
"overwriteMode" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "string",
"enum" : [ "INIT", "RESET", "UPGRADE" ]
} ],
"description" : "This defines, how customer repos will be updated.\nINIT - push only if repo does not exist.\nRESET - delete all files after cloning source - files not in content are deleted\nUPGRADE - clone and copy - existing files will be overwritten, files not in content are kept. For type: MIRROR reset and upgrade have same result: in both cases source repo will be force pushed to target repo."
},
"path" : {
"type" : [ "string", "null" ],
"description" : "Path within the content repo to process"
},
"ref" : {
"type" : [ "string", "null" ],
"description" : "Reference for a specific branch, tag, or commit. Emtpy defaults to default branch of the repo. With type MIRROR: ref must not be a commit hash; Choosing a ref only mirrors the ref but does not delete other branches/tags!"
},
"target" : {
"type" : [ "string", "null" ],
"description" : "Target repo for the repository in the for of namespace/name. Must contain one slash to separate namespace from name."
},
"targetRef" : {
"type" : [ "string", "null" ],
"description" : "Reference for a specific branch or tag in the target repo of a MIRROR or COPY repo. If ref is a tag, targetRef is treated as tag as well. Except: targetRef is full ref like refs/heads/my-branch or refs/tags/my-tag. Empty defaults to the source ref."
},
"templating" : {
"type" : [ "boolean", "null" ],
"description" : "When true, template all files ending in .ftl within the repo"
},
"type" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "string",
"enum" : [ "FOLDER_BASED", "COPY", "MIRROR" ]
} ],
"description" : "ContentLoader Repos can either be:\ncopied (only the files, starting on ref, starting at path within the repo. Requires target)\n, mirrored (FORCE pushes ref or the whole git repo if no ref set). Requires target, does not allow path and template.)\nfolderBased (folder structure is interpreted as repos. That is, root folder becomes namespace in SCM, sub folders become repository names in SCM, files are copied. Requires target.)"
},
"url" : {
"type" : [ "string", "null" ],
"description" : "URL of the content repo. Mandatory for each type."
}
},
"additionalProperties" : false
}
},
"useWhitelist" : {
"type" : [ "boolean", "null" ],
"description" : "Enables the whitelist for statics in content templating"
},
"variables" : {
"$ref" : "#/$defs/Map(String,Object)-nullable",
"description" : "Additional variables to use in custom templates."
}
},
"additionalProperties" : false,
"description" : "Config parameters for content, i.e. end-user or tenant applications as opposed to cluster-resources"
},
"features" : {
"type" : [ "object", "null" ],
"properties" : {
"argocd" : {
"type" : [ "object", "null" ],
"properties" : {
"active" : {
"type" : [ "boolean", "null" ],
"description" : "Install ArgoCD"
},
"emailFrom" : {
"type" : [ "string", "null" ],
"description" : "Notifications, define Argo CD sender email address"
},
"emailToAdmin" : {
"type" : [ "string", "null" ],
"description" : "Notifications, define Argo CD admin recipient email address"
},
"emailToUser" : {
"type" : [ "string", "null" ],
"description" : "Notifications, define Argo CD user / app-team recipient email address"
},
"env" : {
"description" : "Pass a list of env vars to Argo CD components. Currently only works with operator",
"type" : [ "array", "null" ],
"items" : {
"$ref" : "#/$defs/Map(String,String)",
"additionalProperties" : {
"type" : "string"
}
}
},
"namespace" : {
"type" : [ "string", "null" ],
"description" : "Defines the kubernetes namespace for ArgoCD"
},
"operator" : {
"type" : [ "boolean", "null" ],
"description" : "Install ArgoCD via an already running ArgoCD Operator"
},
"resourceInclusionsCluster" : {
"type" : [ "string", "null" ],
"description" : "Internal Kubernetes API Server URL https://IP:PORT (kubernetes.default.svc). Needed in argocd-operator resourceInclusions. Use this parameter if argocd.operator=true and NOT running inside a Pod (remote mode). Full URL needed, for example: https://100.125.0.1:443"
},
"url" : {
"type" : [ "string", "null" ],
"description" : "The URL where argocd is accessible. It has to be the full URL with http:// or https://"
},
"values" : {
"$ref" : "#/$defs/Map(String,Object)-nullable",
"description" : "Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration"
}
},
"additionalProperties" : false,
"description" : "Config Parameter for the ArgoCD Operator"
},
"certManager" : {
"type" : [ "object", "null" ],
"properties" : {
"active" : {
"type" : [ "boolean", "null" ],
"description" : "Sets and enables Cert Manager"
},
"helm" : {
"type" : [ "object", "null" ],
"properties" : {
"acmeSolverImage" : {
"type" : [ "string", "null" ],
"description" : "Sets acmeSolver Image for Cert Manager"
},
"cainjectorImage" : {
"type" : [ "string", "null" ],
"description" : "Sets cainjector Image for Cert Manager"
},
"chart" : {
"type" : [ "string", "null" ],
"description" : "Name of the Helm chart"
},
"image" : {
"type" : [ "string", "null" ],
"description" : "Sets image for Cert Manager"
},
"repoURL" : {
"type" : [ "string", "null" ],
"description" : "Repository url from which the Helm chart should be obtained"
},
"startupAPICheckImage" : {
"type" : [ "string", "null" ],
"description" : "Sets startupAPICheck Image for Cert Manager"
},
"values" : {
"$ref" : "#/$defs/Map(String,Object)-nullable",
"description" : "Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration"
},
"version" : {
"type" : [ "string", "null" ],
"description" : "The version of the Helm chart to be installed"
},
"webhookImage" : {
"type" : [ "string", "null" ],
"description" : "Sets webhook Image for Cert Manager"
}
},
"additionalProperties" : false,
"description" : "Common Config parameters for the Helm package manager: Name of Chart (chart), URl of Helm-Repository (repoURL) and Chart Version (version). Note: These config is intended to obtain the chart from a different source (e.g. in air-gapped envs), not to use a different version of a helm chart. Using a different helm chart or version to the one used in the GOP version will likely cause errors."
},
"issuer" : {
"type" : [ "string", "null" ],
"description" : "Sets and enables Cert Manager"
}
},
"additionalProperties" : false,
"description" : "Config parameters for the Cert Manager"
},
"ingress" : {
"type" : [ "object", "null" ],
"properties" : {
"active" : {
"type" : [ "boolean", "null" ],
"description" : "Sets and enables Ingress Controller"
},
"helm" : {
"type" : [ "object", "null" ],
"properties" : {
"chart" : {
"type" : [ "string", "null" ],
"description" : "Name of the Helm chart"
},
"image" : {
"type" : [ "string", "null" ],
"description" : "The image of the Helm chart to be installed"
},
"repoURL" : {
"type" : [ "string", "null" ],
"description" : "Repository url from which the Helm chart should be obtained"
},
"values" : {
"$ref" : "#/$defs/Map(String,Object)-nullable",
"description" : "Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration"
},
"version" : {
"type" : [ "string", "null" ],
"description" : "The version of the Helm chart to be installed"
}
},
"additionalProperties" : false,
"description" : "Common Config parameters for the Helm package manager: Name of Chart (chart), URl of Helm-Repository (repoURL) and Chart Version (version). Note: These config is intended to obtain the chart from a different source (e.g. in air-gapped envs), not to use a different version of a helm chart. Using a different helm chart or version to the one used in the GOP version will likely cause errors."
}
},
"additionalProperties" : false,
"description" : "Config parameters for the Ingress Controller"
},
"mail" : {
"type" : [ "object", "null" ],
"properties" : {
"smtpAddress" : {
"type" : [ "string", "null" ],
"description" : "Sets smtp port of external Mailserver"
},
"smtpPassword" : {
"type" : [ "string", "null" ],
"description" : "Sets smtp password of external Mailserver"
},
"smtpPort" : {
"type" : [ "integer", "null" ],
"description" : "Sets smtp port of external Mailserver"
},
"smtpUser" : {
"type" : [ "string", "null" ],
"description" : "Sets smtp username for external Mailserver"
}
},
"additionalProperties" : false,
"description" : "Config parameters for mail servers"
},
"monitoring" : {
"type" : [ "object", "null" ],
"properties" : {
"active" : {
"type" : [ "boolean", "null" ],
"description" : "Installs the Kube-Prometheus-Stack. This includes Prometheus, the Prometheus operator, Grafana and some extra resources"
},
"grafanaEmailFrom" : {
"type" : [ "string", "null" ],
"description" : "Notifications, define grafana alerts sender email address"
},
"grafanaEmailTo" : {
"type" : [ "string", "null" ],
"description" : "Notifications, define grafana alerts recipient email address"
},
"grafanaUrl" : {
"type" : [ "string", "null" ],
"description" : "Sets url for grafana"
},
"helm" : {
"type" : [ "object", "null" ],
"properties" : {
"chart" : {
"type" : [ "string", "null" ],
"description" : "Name of the Helm chart"
},
"grafanaImage" : {
"type" : [ "string", "null" ],
"description" : "Sets image for grafana"
},
"grafanaSidecarImage" : {
"type" : [ "string", "null" ],
"description" : "Sets image for grafana's sidecar"
},
"prometheusConfigReloaderImage" : {
"type" : [ "string", "null" ],
"description" : "Sets image for prometheus-operator's config-reloader"
},
"prometheusImage" : {
"type" : [ "string", "null" ],
"description" : "Sets image for prometheus"
},
"prometheusOperatorImage" : {
"type" : [ "string", "null" ],
"description" : "Sets image for prometheus-operator"
},
"repoURL" : {
"type" : [ "string", "null" ],
"description" : "Repository url from which the Helm chart should be obtained"
},
"values" : {
"$ref" : "#/$defs/Map(String,Object)-nullable",
"description" : "Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration"
},
"version" : {
"type" : [ "string", "null" ],
"description" : "The version of the Helm chart to be installed"
}
},
"additionalProperties" : false,
"description" : "Common Config parameters for the Helm package manager: Name of Chart (chart), URl of Helm-Repository (repoURL) and Chart Version (version). Note: These config is intended to obtain the chart from a different source (e.g. in air-gapped envs), not to use a different version of a helm chart. Using a different helm chart or version to the one used in the GOP version will likely cause errors."
}
},
"additionalProperties" : false,
"description" : "Config parameters for the Monitoring system (prometheus)"
},
"secrets" : {
"type" : [ "object", "null" ],
"properties" : {
"externalSecrets" : {
"type" : [ "object", "null" ],
"properties" : {
"helm" : {
"type" : [ "object", "null" ],
"properties" : {
"certControllerImage" : {
"type" : [ "string", "null" ],
"description" : "Sets image for external secrets operator's controller"
},
"chart" : {
"type" : [ "string", "null" ],
"description" : "Name of the Helm chart"
},
"image" : {
"type" : [ "string", "null" ],
"description" : "Sets image for external secrets operator"
},
"repoURL" : {
"type" : [ "string", "null" ],
"description" : "Repository url from which the Helm chart should be obtained"
},
"values" : {
"$ref" : "#/$defs/Map(String,Object)-nullable",
"description" : "Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration"
},
"version" : {
"type" : [ "string", "null" ],
"description" : "The version of the Helm chart to be installed"
},
"webhookImage" : {
"type" : [ "string", "null" ],
"description" : "Sets image for external secrets operator's webhook"
}
},
"additionalProperties" : false,
"description" : "Common Config parameters for the Helm package manager: Name of Chart (chart), URl of Helm-Repository (repoURL) and Chart Version (version). Note: These config is intended to obtain the chart from a different source (e.g. in air-gapped envs), not to use a different version of a helm chart. Using a different helm chart or version to the one used in the GOP version will likely cause errors."
}
},
"additionalProperties" : false,
"description" : "Config parameters for the external secrets operator"
},
"vault" : {
"type" : [ "object", "null" ],
"properties" : {
"helm" : {
"type" : [ "object", "null" ],
"properties" : {
"chart" : {
"type" : [ "string", "null" ],
"description" : "Name of the Helm chart"
},
"image" : {
"type" : [ "string", "null" ],
"description" : "Sets image for vault"
},
"repoURL" : {
"type" : [ "string", "null" ],
"description" : "Repository url from which the Helm chart should be obtained"
},
"values" : {
"$ref" : "#/$defs/Map(String,Object)-nullable",
"description" : "Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration"
},
"version" : {
"type" : [ "string", "null" ],
"description" : "The version of the Helm chart to be installed"
}
},
"additionalProperties" : false,
"description" : "Common Config parameters for the Helm package manager: Name of Chart (chart), URl of Helm-Repository (repoURL) and Chart Version (version). Note: These config is intended to obtain the chart from a different source (e.g. in air-gapped envs), not to use a different version of a helm chart. Using a different helm chart or version to the one used in the GOP version will likely cause errors."
},
"mode" : {
"anyOf" : [ {
"type" : "null"
}, {
"type" : "string",
"enum" : [ "dev", "prod" ]
} ],
"description" : "Installs Hashicorp vault and the external secrets operator. Possible values: dev, prod."
},
"url" : {
"type" : [ "string", "null" ],
"description" : "Sets url for vault ui"
}
},
"additionalProperties" : false,
"description" : "Config parameters for the secrets-vault"
}
},
"additionalProperties" : false,
"description" : "Config parameters for the secrets management"
}
},
"additionalProperties" : false,
"description" : "Config parameters for features or tools"
},
"jenkins" : {
"type" : [ "object", "null" ],
"properties" : {
"active" : {
"type" : [ "boolean", "null" ],
"description" : "Installs Jenkins as CI server"
},
"additionalEnvs" : {
"anyOf" : [ {
"type" : "null"
}, {
"$ref" : "#/$defs/Map(String,String)"
} ],
"description" : "Set additional environments to Jenkins",
"additionalProperties" : {
"type" : "string"
}
},
"helm" : {
"$ref" : "#/$defs/HelmConfigWithValues-nullable",
"description" : "Common Config parameters for the Helm package manager: Name of Chart (chart), URl of Helm-Repository (repoURL) and Chart Version (version). Note: These config is intended to obtain the chart from a different source (e.g. in air-gapped envs), not to use a different version of a helm chart. Using a different helm chart or version to the one used in the GOP version will likely cause errors."
},
"mavenCentralMirror" : {
"type" : [ "string", "null" ],
"description" : "URL for maven mirror, used by applications built in Jenkins"
},
"metricsPassword" : {
"type" : [ "string", "null" ],
"description" : "Mandatory when jenkins-url is set and monitoring enabled"
},
"metricsUsername" : {
"type" : [ "string", "null" ],
"description" : "Mandatory when jenkins-url is set and monitoring enabled"
},
"password" : {
"type" : [ "string", "null" ],
"description" : "Mandatory when jenkins-url is set"
},
"skipPlugins" : {
"type" : [ "boolean", "null" ],
"description" : "Skips plugin installation. Use with caution! If the plugins are not installed up front, the installation will likely fail. The intended use case for this is after the first installation, for config changes only. Do not use on first installation or upgrades."
},
"skipRestart" : {
"type" : [ "boolean", "null" ],
"description" : "Skips restarting Jenkins after plugin installation. Use with caution! If the plugins are not installed up front, the installation will likely fail. The intended use case for this is after the first installation, for config changes only. Do not use on first installation or upgrades."
},
"url" : {
"type" : [ "string", "null" ],
"description" : "The url of your external jenkins"
},
"username" : {
"type" : [ "string", "null" ],
"description" : "Mandatory when jenkins-url is set"
}
},
"additionalProperties" : false,
"description" : "Config parameters for Jenkins CI/CD Pipeline Server"
},
"multiTenant" : {
"type" : [ "object", "null" ],
"properties" : {
"centralArgocdNamespace" : {
"type" : [ "string", "null" ],
"description" : "Namespace for the centralized Argocd"
},
"gitlab" : {
"type" : [ "object", "null" ],
"properties" : {
"parentGroupId" : {
"type" : [ "string", "null" ],
"description" : "Main Group for Gitlab where the GOP creates it's groups/repos"
},
"password" : {
"type" : [ "string", "null" ],
"description" : "Password for SCM Manager authentication"
},
"url" : {
"type" : [ "string", "null" ],
"description" : "URL for external Gitlab"
},
"username" : {
"type" : [ "string", "null" ],
"description" : "GitLab username for API access. Must be 'oauth2' when using Personal Access Token (PAT) authentication"
}
},
"additionalProperties" : false,
"description" : "Config for GITLAB"
},
"scmManager" : {
"type" : [ "object", "null" ],
"properties" : {
"internal" : {
"type" : [ "boolean", "null" ],
"description" : "SCM for Central Management is running on the same cluster, so k8s internal URLs can be used for access"
},
"namespace" : {
"type" : [ "string", "null" ],
"description" : "Namespace where to find the Central SCMM"
},
"password" : {
"type" : [ "string", "null" ],
"description" : "CENTRAL SCMM password"
},
"url" : {
"type" : [ "string", "null" ],
"description" : "URL for the centralized Management Repo"
},
"username" : {
"type" : [ "string", "null" ],
"description" : "CENTRAL SCMM username"
}
},
"additionalProperties" : false,
"description" : "Config for GITLAB"
},
"scmProviderType" : {
"$ref" : "#/$defs/ScmProviderType-nullable",
"description" : "The SCM provider type. Possible values: SCM_MANAGER, GITLAB"
},
"useDedicatedInstance" : {
"type" : [ "boolean", "null" ],
"description" : "Toggles the Dedicated Instances Mode. See docs for more info"
}
},
"additionalProperties" : false,
"description" : "Multi Tenant Configs"
},
"registry" : {
"type" : [ "object", "null" ],
"properties" : {
"active" : {
"type" : [ "boolean", "null" ],
"description" : "Installs a simple cluster-local registry for demonstration purposes. Warning: Registry does not provide authentication!"
},
"createImagePullSecrets" : {
"type" : [ "boolean", "null" ],
"description" : "Create image pull secrets for registry and proxy-registry for all GOP namespaces and helm charts. Uses proxy-username, read-only-username or registry-username (in this order). Use this if your cluster is not auto-provisioned with credentials for your private registries or if you configure individual helm images to be pulled from the proxy-registry that requires authentication."
},
"helm" : {
"$ref" : "#/$defs/HelmConfigWithValues-nullable",
"description" : "Common Config parameters for the Helm package manager: Name of Chart (chart), URl of Helm-Repository (repoURL) and Chart Version (version). Note: These config is intended to obtain the chart from a different source (e.g. in air-gapped envs), not to use a different version of a helm chart. Using a different helm chart or version to the one used in the GOP version will likely cause errors."
},
"internalPort" : {
"type" : [ "integer", "null" ],
"description" : "Port of registry registry. Ignored when a registry*url params are set"
},
"password" : {
"type" : [ "string", "null" ],
"description" : "Optional when registry-url is set"
},
"path" : {
"type" : [ "string", "null" ],
"description" : "Optional when registry-url is set"
},
"proxyPassword" : {
"type" : [ "string", "null" ],
"description" : "Use with registry-proxy-url, added to Jenkins as credentials and created as pull secrets, when create-image-pull-secrets is set."
},
"proxyPath" : {
"type" : [ "string", "null" ],
"description" : "Optional when registry-proxy-url is set and the registry is running on a non root web path."
},
"proxyUrl" : {
"type" : [ "string", "null" ],
"description" : "The url of your proxy-registry. Used in pipelines to authorize pull base images. Use in conjunction with petclinic base image. Used in helm charts when create-image-pull-secrets is set. Use in conjunction with helm.*image fields."
},
"proxyUsername" : {
"type" : [ "string", "null" ],
"description" : "Use with registry-proxy-url, added to Jenkins as credentials and created as pull secrets, when create-image-pull-secrets is set."
},
"readOnlyPassword" : {
"type" : [ "string", "null" ],
"description" : "Optional alternative password for registry-url with read-only permissions that is used when create-image-pull-secrets is set."
},
"readOnlyUsername" : {
"type" : [ "string", "null" ],
"description" : "Optional alternative username for registry-url with read-only permissions that is used when create-image-pull-secrets is set."
},
"url" : {
"type" : [ "string", "null" ],
"description" : "The url of your external registry, used for pushing images"
},
"username" : {
"type" : [ "string", "null" ],
"description" : "Optional when registry-url is set"
}
},
"additionalProperties" : false,
"description" : "Config parameters for Registry"
},
"scm" : {
"type" : [ "object", "null" ],
"properties" : {
"gitlab" : {
"type" : [ "object", "null" ],
"properties" : {
"gitOpsUsername" : {
"type" : [ "string", "null" ],
"description" : "Username for the Gitops User"
},
"internal" : {
"type" : [ "boolean", "null" ],
"description" : "True if Gitlab is running in the same K8s cluster. For now we only support access by external URL"
},
"parentGroupId" : {
"type" : [ "string", "null" ],
"description" : "Number for the Gitlab Group where the repos and subgroups should be created"
},
"password" : {
"type" : [ "string", "null" ],
"description" : "PAT Token for the account. Needs read/write repo permissions. See docs for mor information"
},
"url" : {
"type" : [ "string", "null" ],
"description" : "Base URL for the Gitlab instance"
},
"username" : {
"type" : [ "string", "null" ],
"description" : "Defaults to: oauth2.0 when PAT token is given."
}
},
"additionalProperties" : false,
"description" : "Config for GITLAB"
},
"scmManager" : {
"type" : [ "object", "null" ],
"properties" : {
"gitOpsUsername" : {
"type" : [ "string", "null" ],
"description" : "Username for the Gitops User"
},
"helm" : {
"$ref" : "#/$defs/HelmConfigWithValues-nullable",
"description" : "Common Config parameters for the Helm package manager: Name of Chart (chart), URl of Helm-Repository (repoURL) and Chart Version (version). Note: These config is intended to obtain the chart from a different source (e.g. in air-gapped envs), not to use a different version of a helm chart. Using a different helm chart or version to the one used in the GOP version will likely cause errors."
},
"namespace" : {
"type" : [ "string", "null" ],
"description" : "Namespace where SCM-Manager should run"
},
"password" : {
"type" : [ "string", "null" ],
"description" : "Mandatory when scmm-url is set"
},
"skipPlugins" : {
"type" : [ "boolean", "null" ],
"description" : "Skips plugin installation. Use with caution! If the plugins are not installed up front, the installation will likely fail. The intended use case for this is after the first installation, for config changes only. Do not use on first installation or upgrades."
},
"skipRestart" : {
"type" : [ "boolean", "null" ],
"description" : "Skips restarting SCM-Manager after plugin installation. Use with caution! If the plugins are not installed up front, the installation will likely fail. The intended use case for this is after the first installation, for config changes only. Do not use on first installation or upgrades.'"
},
"url" : {
"type" : [ "string", "null" ],
"description" : "The host of your external scm-manager"
},
"username" : {
"type" : [ "string", "null" ],
"description" : "Mandatory when scmm-url is set"
}
},
"additionalProperties" : false,
"description" : "Config for GITLAB"
},
"scmProviderType" : {
"$ref" : "#/$defs/ScmProviderType-nullable",
"description" : "The SCM provider type. Possible values: SCM_MANAGER, GITLAB"
}
},
"additionalProperties" : false,
"description" : "Config parameters for Scm"
}
},
"additionalProperties" : false
}