forked from zarf-dev/zarf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathzarf.schema.json
1156 lines (1156 loc) · 37.6 KB
/
zarf.schema.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
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/2020-12/schema",
"$id": "https://github.com/zarf-dev/zarf/src/types/zarf-package",
"$defs": {
"BigBang": {
"properties": {
"version": {
"type": "string",
"description": "The version of Big Bang to use."
},
"repo": {
"type": "string",
"description": "Override repo to pull Big Bang from instead of Repo One."
},
"valuesFiles": {
"items": {
"type": "string"
},
"type": "array",
"description": "The list of values files to pass to Big Bang; these will be merged together."
},
"skipFlux": {
"type": "boolean",
"description": "Whether to skip deploying flux; Defaults to false."
},
"fluxPatchFiles": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional paths to Flux kustomize strategic merge patch files."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version"
],
"description": "BigBang holds the configuration for the Big Bang extension.",
"patternProperties": {
"^x-": {}
}
},
"Constant": {
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Z0-9_]+$",
"description": "The name to be used for the constant"
},
"value": {
"type": "string",
"description": "The value to set for the constant during deploy"
},
"description": {
"type": "string",
"description": "A description of the constant to explain its purpose on package create or deploy confirmation prompts"
},
"autoIndent": {
"type": "boolean",
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_CONST_."
},
"pattern": {
"type": "string",
"description": "An optional regex pattern that a constant value must match before a package can be created."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"value"
],
"description": "Constant are constants that can be used to dynamically template K8s resources or run in actions.",
"patternProperties": {
"^x-": {}
}
},
"DeprecatedZarfComponentScripts": {
"properties": {
"showOutput": {
"type": "boolean",
"description": "Show the output of the script during package deployment."
},
"timeoutSeconds": {
"type": "integer",
"description": "Timeout in seconds for the script."
},
"retry": {
"type": "boolean",
"description": "Retry the script if it fails."
},
"prepare": {
"items": {
"type": "string"
},
"type": "array",
"description": "Scripts to run before the component is added during package create."
},
"before": {
"items": {
"type": "string"
},
"type": "array",
"description": "Scripts to run before the component is deployed."
},
"after": {
"items": {
"type": "string"
},
"type": "array",
"description": "Scripts to run after the component successfully deploys."
}
},
"additionalProperties": false,
"type": "object",
"description": "DeprecatedZarfComponentScripts are scripts that run before or after a component is deployed.",
"patternProperties": {
"^x-": {}
}
},
"InteractiveVariable": {
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Z0-9_]+$",
"description": "The name to be used for the variable"
},
"sensitive": {
"type": "boolean",
"description": "Whether to mark this variable as sensitive to not print it in the log"
},
"autoIndent": {
"type": "boolean",
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_."
},
"pattern": {
"type": "string",
"description": "An optional regex pattern that a variable value must match before a package deployment can continue."
},
"type": {
"type": "string",
"enum": [
"raw",
"file"
],
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)"
},
"description": {
"type": "string",
"description": "A description of the variable to be used when prompting the user a value"
},
"default": {
"type": "string",
"description": "The default value to use for the variable"
},
"prompt": {
"type": "boolean",
"description": "Whether to prompt the user for input for this variable"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"description": "InteractiveVariable is a variable that can be used to prompt a user for more information",
"patternProperties": {
"^x-": {}
}
},
"Shell": {
"properties": {
"windows": {
"type": "string",
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
]
},
"linux": {
"type": "string",
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
]
},
"darwin": {
"type": "string",
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
]
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"Variable": {
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Z0-9_]+$",
"description": "The name to be used for the variable"
},
"sensitive": {
"type": "boolean",
"description": "Whether to mark this variable as sensitive to not print it in the log"
},
"autoIndent": {
"type": "boolean",
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_."
},
"pattern": {
"type": "string",
"description": "An optional regex pattern that a variable value must match before a package deployment can continue."
},
"type": {
"type": "string",
"enum": [
"raw",
"file"
],
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"description": "Variable represents a variable that has a value set programmatically",
"patternProperties": {
"^x-": {}
}
},
"ZarfBuildData": {
"properties": {
"terminal": {
"type": "string",
"description": "The machine name that created this package."
},
"user": {
"type": "string",
"description": "The username who created this package."
},
"architecture": {
"type": "string",
"description": "The architecture this package was created on."
},
"timestamp": {
"type": "string",
"description": "The timestamp when this package was created."
},
"version": {
"type": "string",
"description": "The version of Zarf used to build this package."
},
"migrations": {
"items": {
"type": "string"
},
"type": "array",
"description": "Any migrations that have been run on this package."
},
"registryOverrides": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "Any registry domains that were overridden on package create when pulling images."
},
"differential": {
"type": "boolean",
"description": "Whether this package was created with differential components."
},
"differentialPackageVersion": {
"type": "string",
"description": "Version of a previously built package used as the basis for creating this differential package."
},
"differentialMissing": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of components that were not included in this package due to differential packaging."
},
"lastNonBreakingVersion": {
"type": "string",
"description": "The minimum version of Zarf that does not have breaking package structure changes."
},
"flavor": {
"type": "string",
"description": "The flavor of Zarf used to build this package."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"terminal",
"user",
"architecture",
"timestamp",
"version"
],
"description": "ZarfBuildData is written during the packager.Create() operation to track details of the created package.",
"patternProperties": {
"^x-": {}
}
},
"ZarfChart": {
"properties": {
"name": {
"type": "string",
"description": "The name of the chart within Zarf; note that this must be unique and does not need to be the same as the name in the chart repo."
},
"version": {
"type": "string",
"description": "The version of the chart to deploy; for git-based charts this is also the tag of the git repo by default (when not using the '@' syntax for 'repos')."
},
"url": {
"type": "string",
"description": "The URL of the OCI registry, chart repository, or git repo where the helm chart is stored.",
"examples": [
"OCI registry: oci://ghcr.io/stefanprodan/charts/podinfo",
"helm chart repo: https://stefanprodan.github.io/podinfo",
"git repo: https://github.com/stefanprodan/podinfo (note the '@' syntax for 'repos' is supported here too)"
]
},
"repoName": {
"type": "string",
"description": "The name of a chart within a Helm repository (defaults to the Zarf name of the chart)."
},
"gitPath": {
"type": "string",
"description": "(git repo only) The sub directory to the chart within a git repo.",
"examples": [
"charts/your-chart"
]
},
"localPath": {
"type": "string",
"description": "The path to a local chart's folder or .tgz archive."
},
"namespace": {
"type": "string",
"description": "The namespace to deploy the chart to."
},
"releaseName": {
"type": "string",
"description": "The name of the Helm release to create (defaults to the Zarf name of the chart)."
},
"noWait": {
"type": "boolean",
"description": "Whether to not wait for chart resources to be ready before continuing."
},
"valuesFiles": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of local values file paths or remote URLs to include in the package; these will be merged together when deployed."
},
"variables": {
"items": {
"$ref": "#/$defs/ZarfChartVariable"
},
"type": "array",
"description": "[alpha] List of variables to set in the Helm chart."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"description": "ZarfChart defines a helm chart to be deployed.",
"patternProperties": {
"^x-": {}
}
},
"ZarfChartVariable": {
"properties": {
"name": {
"type": "string",
"pattern": "^[A-Z0-9_]+$",
"description": "The name of the variable."
},
"description": {
"type": "string",
"description": "A brief description of what the variable controls."
},
"path": {
"type": "string",
"description": "The path within the Helm chart values where this variable applies."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"description",
"path"
],
"description": "ZarfChartVariable represents a variable that can be set for a Helm chart overrides.",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponent": {
"properties": {
"name": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9\\-]*$",
"description": "The name of the component."
},
"description": {
"type": "string",
"description": "Message to include during package deploy describing the purpose of this component."
},
"default": {
"type": "boolean",
"description": "Determines the default Y/N state for installing this component on package deploy."
},
"required": {
"type": "boolean",
"description": "Do not prompt user to install this component."
},
"only": {
"$ref": "#/$defs/ZarfComponentOnlyTarget",
"description": "Filter when this component is included in package creation or deployment."
},
"group": {
"type": "string",
"description": "[Deprecated] Create a user selector field based on all components in the same group. This will be removed in Zarf v1.0.0. Consider using 'only.flavor' instead."
},
"cosignKeyPath": {
"type": "string",
"description": "[Deprecated] Specify a path to a public key to validate signed online resources. This will be removed in Zarf v1.0.0."
},
"import": {
"$ref": "#/$defs/ZarfComponentImport",
"description": "Import a component from another Zarf package."
},
"manifests": {
"items": {
"$ref": "#/$defs/ZarfManifest"
},
"type": "array",
"description": "Kubernetes manifests to be included in a generated Helm chart on package deploy."
},
"charts": {
"items": {
"$ref": "#/$defs/ZarfChart"
},
"type": "array",
"description": "Helm charts to install during package deploy."
},
"dataInjections": {
"items": {
"$ref": "#/$defs/ZarfDataInjection"
},
"type": "array",
"description": "Datasets to inject into a container in the target cluster."
},
"files": {
"items": {
"$ref": "#/$defs/ZarfFile"
},
"type": "array",
"description": "Files or folders to place on disk during package deployment."
},
"images": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of OCI images to include in the package."
},
"repos": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of git repos to include in the package."
},
"extensions": {
"$ref": "#/$defs/ZarfComponentExtensions",
"description": "Extend component functionality with additional features."
},
"scripts": {
"$ref": "#/$defs/DeprecatedZarfComponentScripts",
"description": "[Deprecated] (replaced by actions) Custom commands to run before or after package deployment. This will be removed in Zarf v1.0.0."
},
"actions": {
"$ref": "#/$defs/ZarfComponentActions",
"description": "Custom commands to run at various stages of a package lifecycle."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"description": "ZarfComponent is the primary functional grouping of assets to deploy by Zarf.",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentAction": {
"properties": {
"mute": {
"type": "boolean",
"description": "Hide the output of the command during package deployment (default false)."
},
"maxTotalSeconds": {
"type": "integer",
"description": "Timeout in seconds for the command (default to 0, no timeout for cmd actions and 300, 5 minutes for wait actions)."
},
"maxRetries": {
"type": "integer",
"description": "Retry the command if it fails up to given number of times (default 0)."
},
"dir": {
"type": "string",
"description": "The working directory to run the command in (default is CWD)."
},
"env": {
"items": {
"type": "string"
},
"type": "array",
"description": "Additional environment variables to set for the command."
},
"cmd": {
"type": "string",
"description": "The command to run. Must specify either cmd or wait for the action to do anything."
},
"shell": {
"$ref": "#/$defs/Shell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems."
},
"setVariable": {
"type": "string",
"pattern": "^[A-Z0-9_]+$",
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0."
},
"setVariables": {
"items": {
"$ref": "#/$defs/Variable"
},
"type": "array",
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package."
},
"description": {
"type": "string",
"description": "Description of the action to be displayed during package execution instead of the command."
},
"wait": {
"$ref": "#/$defs/ZarfComponentActionWait",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
}
},
"additionalProperties": false,
"type": "object",
"description": "ZarfComponentAction represents a single action to run during a zarf package operation.",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentActionDefaults": {
"properties": {
"mute": {
"type": "boolean",
"description": "Hide the output of commands during execution (default false)."
},
"maxTotalSeconds": {
"type": "integer",
"description": "Default timeout in seconds for commands (default to 0, no timeout)."
},
"maxRetries": {
"type": "integer",
"description": "Retry commands given number of times if they fail (default 0)."
},
"dir": {
"type": "string",
"description": "Working directory for commands (default CWD)."
},
"env": {
"items": {
"type": "string"
},
"type": "array",
"description": "Additional environment variables for commands."
},
"shell": {
"$ref": "#/$defs/Shell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems."
}
},
"additionalProperties": false,
"type": "object",
"description": "ZarfComponentActionDefaults sets the default configs for child actions.",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentActionSet": {
"properties": {
"defaults": {
"$ref": "#/$defs/ZarfComponentActionDefaults",
"description": "Default configuration for all actions in this set."
},
"before": {
"items": {
"$ref": "#/$defs/ZarfComponentAction"
},
"type": "array",
"description": "Actions to run at the start of an operation."
},
"after": {
"items": {
"$ref": "#/$defs/ZarfComponentAction"
},
"type": "array",
"description": "Actions to run at the end of an operation."
},
"onSuccess": {
"items": {
"$ref": "#/$defs/ZarfComponentAction"
},
"type": "array",
"description": "Actions to run if all operations succeed."
},
"onFailure": {
"items": {
"$ref": "#/$defs/ZarfComponentAction"
},
"type": "array",
"description": "Actions to run if all operations fail."
}
},
"additionalProperties": false,
"type": "object",
"description": "ZarfComponentActionSet is a set of actions to run during a zarf package operation.",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentActionWait": {
"properties": {
"cluster": {
"$ref": "#/$defs/ZarfComponentActionWaitCluster",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$ref": "#/$defs/ZarfComponentActionWaitNetwork",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"additionalProperties": false,
"type": "object",
"description": "ZarfComponentActionWait specifies a condition to wait for before continuing",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentActionWaitCluster": {
"properties": {
"kind": {
"type": "string",
"description": "The kind of resource to wait for.",
"examples": [
"Pod",
"Deployment"
]
},
"name": {
"type": "string",
"description": "The name of the resource or selector to wait for.",
"examples": [
"podinfo",
"app=podinfo"
]
},
"namespace": {
"type": "string",
"description": "The namespace of the resource to wait for."
},
"condition": {
"type": "string",
"description": "The condition or jsonpath state to wait for; defaults to exist, a special condition that will wait for the resource to exist.",
"examples": [
"Ready",
"Available"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"kind",
"name"
],
"description": "ZarfComponentActionWaitCluster specifies a condition to wait for before continuing",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentActionWaitNetwork": {
"properties": {
"protocol": {
"type": "string",
"enum": [
"tcp",
"http",
"https"
],
"description": "The protocol to wait for."
},
"address": {
"type": "string",
"description": "The address to wait for.",
"examples": [
"localhost:8080",
"1.1.1.1"
]
},
"code": {
"type": "integer",
"description": "The HTTP status code to wait for if using http or https.",
"examples": [
200,
404
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"protocol",
"address"
],
"description": "ZarfComponentActionWaitNetwork specifies a condition to wait for before continuing",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentActions": {
"properties": {
"onCreate": {
"$ref": "#/$defs/ZarfComponentActionSet",
"description": "Actions to run during package creation."
},
"onDeploy": {
"$ref": "#/$defs/ZarfComponentActionSet",
"description": "Actions to run during package deployment."
},
"onRemove": {
"$ref": "#/$defs/ZarfComponentActionSet",
"description": "Actions to run during package removal."
}
},
"additionalProperties": false,
"type": "object",
"description": "ZarfComponentActions are ActionSets that map to different zarf package operations.",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentExtensions": {
"properties": {
"bigbang": {
"$ref": "#/$defs/BigBang",
"description": "Configurations for installing Big Bang and Flux in the cluster."
}
},
"additionalProperties": false,
"type": "object",
"description": "ZarfComponentExtensions is a struct that contains all the official extensions.",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentImport": {
"properties": {
"name": {
"type": "string",
"description": "The name of the component to import from the referenced zarf.yaml."
},
"path": {
"not": {
"pattern": "###ZARF_PKG_TMPL_"
},
"type": "string",
"description": "The path to the directory containing the zarf.yaml to import."
},
"url": {
"not": {
"pattern": "###ZARF_PKG_TMPL_"
},
"type": "string",
"pattern": "^oci://.*$",
"description": "[beta] The URL to a Zarf package to import via OCI."
}
},
"additionalProperties": false,
"type": "object",
"description": "ZarfComponentImport structure for including imported Zarf components.",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentOnlyCluster": {
"properties": {
"architecture": {
"type": "string",
"enum": [
"amd64",
"arm64"
],
"description": "Only create and deploy to clusters of the given architecture."
},
"distros": {
"items": {
"type": "string",
"examples": [
"k3s",
"eks"
]
},
"type": "array",
"description": "A list of kubernetes distros this package works with (Reserved for future use)."
}
},
"additionalProperties": false,
"type": "object",
"description": "ZarfComponentOnlyCluster represents the architecture and K8s cluster distribution to filter on.",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentOnlyTarget": {
"properties": {
"localOS": {
"type": "string",
"enum": [
"linux",
"darwin",
"windows"
],
"description": "Only deploy component to specified OS."
},
"cluster": {
"$ref": "#/$defs/ZarfComponentOnlyCluster",
"description": "Only deploy component to specified clusters."
},
"flavor": {
"type": "string",
"description": "Only include this component when a matching '--flavor' is specified on 'zarf package create'."
}
},
"additionalProperties": false,
"type": "object",
"description": "ZarfComponentOnlyTarget filters a component to only show it for a given local OS and cluster.",
"patternProperties": {
"^x-": {}
}
},
"ZarfContainerTarget": {
"properties": {
"namespace": {
"type": "string",
"description": "The namespace to target for data injection."
},
"selector": {
"type": "string",
"description": "The K8s selector to target for data injection.",
"examples": [
"app=data-injection"
]
},
"container": {
"type": "string",
"description": "The container name to target for data injection."
},
"path": {
"type": "string",
"description": "The path within the container to copy the data into."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"namespace",
"selector",
"container",
"path"
],
"description": "ZarfContainerTarget defines the destination info for a ZarfData target",
"patternProperties": {
"^x-": {}
}
},
"ZarfDataInjection": {
"properties": {
"source": {
"type": "string",
"description": "Either a path to a local folder/file or a remote URL of a file to inject into the given target pod + container."
},
"target": {
"$ref": "#/$defs/ZarfContainerTarget",
"description": "The target pod + container to inject the data into."
},
"compress": {
"type": "boolean",
"description": "Compress the data before transmitting using gzip. Note: this requires support for tar/gzip locally and in the target image."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"source",
"target"
],
"description": "ZarfDataInjection is a data-injection definition.",
"patternProperties": {
"^x-": {}
}
},
"ZarfFile": {
"properties": {
"source": {
"type": "string",
"description": "Local folder or file path or remote URL to pull into the package."
},
"shasum": {
"type": "string",
"description": "(files only) Optional SHA256 checksum of the file."
},
"target": {
"type": "string",
"description": "The absolute or relative path where the file or folder should be copied to during package deploy."
},
"executable": {
"type": "boolean",
"description": "(files only) Determines if the file should be made executable during package deploy."
},
"symlinks": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of symlinks to create during package deploy."
},
"extractPath": {
"type": "string",
"description": "Local folder or file to be extracted from a 'source' archive."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"source",
"target"
],
"description": "ZarfFile defines a file to deploy.",
"patternProperties": {
"^x-": {}
}
},
"ZarfManifest": {
"properties": {
"name": {
"type": "string",
"description": "A name to give this collection of manifests; this will become the name of the dynamically-created helm chart."
},
"namespace": {
"type": "string",
"description": "The namespace to deploy the manifests to."
},
"files": {
"items": {
"type": "string"