forked from GoogleContainerTools/skaffold
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathv1beta6.json
executable file
·1614 lines (1614 loc) · 71.1 KB
/
v1beta6.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
{
"type": "object",
"anyOf": [
{
"$ref": "#/definitions/SkaffoldPipeline"
}
],
"$schema": "http://json-schema-org/draft-07/schema#",
"definitions": {
"Activation": {
"properties": {
"command": {
"type": "string",
"description": "a Skaffold command for which the profile is auto-activated.",
"x-intellij-html-description": "a Skaffold command for which the profile is auto-activated.",
"examples": [
"dev"
]
},
"env": {
"type": "string",
"description": "a `key=value` pair. The profile is auto-activated if an Environment Variable `key` has value `value`.",
"x-intellij-html-description": "a <code>key=value</code> pair. The profile is auto-activated if an Environment Variable <code>key</code> has value <code>value</code>.",
"examples": [
"ENV=production"
]
},
"kubeContext": {
"type": "string",
"description": "a Kubernetes context for which the profile is auto-activated.",
"x-intellij-html-description": "a Kubernetes context for which the profile is auto-activated.",
"examples": [
"minikube"
]
}
},
"preferredOrder": [
"env",
"kubeContext",
"command"
],
"additionalProperties": false,
"description": "criteria by which a profile is auto-activated.",
"x-intellij-html-description": "criteria by which a profile is auto-activated."
},
"Artifact": {
"required": [
"image"
],
"anyOf": [
{
"properties": {
"context": {
"type": "string",
"description": "directory containing the artifact's sources.",
"x-intellij-html-description": "directory containing the artifact's sources.",
"default": "."
},
"image": {
"type": "string",
"description": "name of the image to be built.",
"x-intellij-html-description": "name of the image to be built.",
"examples": [
"gcr.io/k8s-skaffold/example"
]
},
"plugin": {
"$ref": "#/definitions/BuilderPlugin",
"description": "plugin used to build this artifact.",
"x-intellij-html-description": "plugin used to build this artifact."
},
"sync": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "*alpha* local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"x-intellij-html-description": "<em>alpha</em> local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"default": "{}",
"examples": [
"{\"*.py\": \".\", \"css/**/*.css\": \"app/css\"}"
]
}
},
"preferredOrder": [
"image",
"context",
"sync",
"plugin"
],
"additionalProperties": false
},
{
"properties": {
"context": {
"type": "string",
"description": "directory containing the artifact's sources.",
"x-intellij-html-description": "directory containing the artifact's sources.",
"default": "."
},
"docker": {
"$ref": "#/definitions/DockerArtifact",
"description": "*beta* describes an artifact built from a Dockerfile.",
"x-intellij-html-description": "<em>beta</em> describes an artifact built from a Dockerfile."
},
"image": {
"type": "string",
"description": "name of the image to be built.",
"x-intellij-html-description": "name of the image to be built.",
"examples": [
"gcr.io/k8s-skaffold/example"
]
},
"plugin": {
"$ref": "#/definitions/BuilderPlugin",
"description": "plugin used to build this artifact.",
"x-intellij-html-description": "plugin used to build this artifact."
},
"sync": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "*alpha* local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"x-intellij-html-description": "<em>alpha</em> local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"default": "{}",
"examples": [
"{\"*.py\": \".\", \"css/**/*.css\": \"app/css\"}"
]
}
},
"preferredOrder": [
"image",
"context",
"sync",
"plugin",
"docker"
],
"additionalProperties": false
},
{
"properties": {
"bazel": {
"$ref": "#/definitions/BazelArtifact",
"description": "*beta* requires bazel CLI to be installed and the sources to contain [Bazel](https://bazel.build/) configuration files.",
"x-intellij-html-description": "<em>beta</em> requires bazel CLI to be installed and the sources to contain <a href=\"https://bazel.build/\">Bazel</a> configuration files."
},
"context": {
"type": "string",
"description": "directory containing the artifact's sources.",
"x-intellij-html-description": "directory containing the artifact's sources.",
"default": "."
},
"image": {
"type": "string",
"description": "name of the image to be built.",
"x-intellij-html-description": "name of the image to be built.",
"examples": [
"gcr.io/k8s-skaffold/example"
]
},
"plugin": {
"$ref": "#/definitions/BuilderPlugin",
"description": "plugin used to build this artifact.",
"x-intellij-html-description": "plugin used to build this artifact."
},
"sync": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "*alpha* local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"x-intellij-html-description": "<em>alpha</em> local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"default": "{}",
"examples": [
"{\"*.py\": \".\", \"css/**/*.css\": \"app/css\"}"
]
}
},
"preferredOrder": [
"image",
"context",
"sync",
"plugin",
"bazel"
],
"additionalProperties": false
},
{
"properties": {
"context": {
"type": "string",
"description": "directory containing the artifact's sources.",
"x-intellij-html-description": "directory containing the artifact's sources.",
"default": "."
},
"image": {
"type": "string",
"description": "name of the image to be built.",
"x-intellij-html-description": "name of the image to be built.",
"examples": [
"gcr.io/k8s-skaffold/example"
]
},
"jibMaven": {
"$ref": "#/definitions/JibMavenArtifact",
"description": "*alpha* builds images using the [Jib plugin for Maven](https://github.com/GoogleContainerTools/jib/tree/master/jib-maven-plugin).",
"x-intellij-html-description": "<em>alpha</em> builds images using the <a href=\"https://github.com/GoogleContainerTools/jib/tree/master/jib-maven-plugin\">Jib plugin for Maven</a>."
},
"plugin": {
"$ref": "#/definitions/BuilderPlugin",
"description": "plugin used to build this artifact.",
"x-intellij-html-description": "plugin used to build this artifact."
},
"sync": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "*alpha* local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"x-intellij-html-description": "<em>alpha</em> local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"default": "{}",
"examples": [
"{\"*.py\": \".\", \"css/**/*.css\": \"app/css\"}"
]
}
},
"preferredOrder": [
"image",
"context",
"sync",
"plugin",
"jibMaven"
],
"additionalProperties": false
},
{
"properties": {
"context": {
"type": "string",
"description": "directory containing the artifact's sources.",
"x-intellij-html-description": "directory containing the artifact's sources.",
"default": "."
},
"image": {
"type": "string",
"description": "name of the image to be built.",
"x-intellij-html-description": "name of the image to be built.",
"examples": [
"gcr.io/k8s-skaffold/example"
]
},
"jibGradle": {
"$ref": "#/definitions/JibGradleArtifact",
"description": "*alpha* builds images using the [Jib plugin for Gradle](https://github.com/GoogleContainerTools/jib/tree/master/jib-gradle-plugin).",
"x-intellij-html-description": "<em>alpha</em> builds images using the <a href=\"https://github.com/GoogleContainerTools/jib/tree/master/jib-gradle-plugin\">Jib plugin for Gradle</a>."
},
"plugin": {
"$ref": "#/definitions/BuilderPlugin",
"description": "plugin used to build this artifact.",
"x-intellij-html-description": "plugin used to build this artifact."
},
"sync": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "*alpha* local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"x-intellij-html-description": "<em>alpha</em> local files synced to pods instead of triggering an image build when modified. This is a mapping of local files to sync to remote folders.",
"default": "{}",
"examples": [
"{\"*.py\": \".\", \"css/**/*.css\": \"app/css\"}"
]
}
},
"preferredOrder": [
"image",
"context",
"sync",
"plugin",
"jibGradle"
],
"additionalProperties": false
}
],
"description": "items that need to be built, along with the context in which they should be built.",
"x-intellij-html-description": "items that need to be built, along with the context in which they should be built."
},
"ArtifactType": {
"properties": {
"bazel": {
"$ref": "#/definitions/BazelArtifact",
"description": "*beta* requires bazel CLI to be installed and the sources to contain [Bazel](https://bazel.build/) configuration files.",
"x-intellij-html-description": "<em>beta</em> requires bazel CLI to be installed and the sources to contain <a href=\"https://bazel.build/\">Bazel</a> configuration files."
},
"docker": {
"$ref": "#/definitions/DockerArtifact",
"description": "*beta* describes an artifact built from a Dockerfile.",
"x-intellij-html-description": "<em>beta</em> describes an artifact built from a Dockerfile."
},
"jibGradle": {
"$ref": "#/definitions/JibGradleArtifact",
"description": "*alpha* builds images using the [Jib plugin for Gradle](https://github.com/GoogleContainerTools/jib/tree/master/jib-gradle-plugin).",
"x-intellij-html-description": "<em>alpha</em> builds images using the <a href=\"https://github.com/GoogleContainerTools/jib/tree/master/jib-gradle-plugin\">Jib plugin for Gradle</a>."
},
"jibMaven": {
"$ref": "#/definitions/JibMavenArtifact",
"description": "*alpha* builds images using the [Jib plugin for Maven](https://github.com/GoogleContainerTools/jib/tree/master/jib-maven-plugin).",
"x-intellij-html-description": "<em>alpha</em> builds images using the <a href=\"https://github.com/GoogleContainerTools/jib/tree/master/jib-maven-plugin\">Jib plugin for Maven</a>."
}
},
"preferredOrder": [
"docker",
"bazel",
"jibMaven",
"jibGradle"
],
"additionalProperties": false,
"description": "describes how to build an artifact.",
"x-intellij-html-description": "describes how to build an artifact."
},
"BazelArtifact": {
"required": [
"target"
],
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "additional args to pass to `bazel build`.",
"x-intellij-html-description": "additional args to pass to <code>bazel build</code>.",
"default": "[]",
"examples": [
"[\"-flag\", \"--otherflag\"]"
]
},
"target": {
"type": "string",
"description": "`bazel build` target to run.",
"x-intellij-html-description": "<code>bazel build</code> target to run.",
"examples": [
"//:skaffold_example.tar"
]
}
},
"preferredOrder": [
"target",
"args"
],
"additionalProperties": false,
"description": "*beta* describes an artifact built with [Bazel](https://bazel.build/).",
"x-intellij-html-description": "<em>beta</em> describes an artifact built with <a href=\"https://bazel.build/\">Bazel</a>."
},
"BuildConfig": {
"anyOf": [
{
"properties": {
"artifacts": {
"items": {
"$ref": "#/definitions/Artifact"
},
"type": "array",
"description": "the images you're going to be building.",
"x-intellij-html-description": "the images you're going to be building."
},
"executionEnvironment": {
"$ref": "#/definitions/ExecutionEnvironment",
"description": "environment in which the build should run. Possible values: googleCloudBuild.",
"x-intellij-html-description": "environment in which the build should run. Possible values: googleCloudBuild."
},
"tagPolicy": {
"$ref": "#/definitions/TagPolicy",
"description": "*beta* determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to `gitCommit: {}`.",
"x-intellij-html-description": "<em>beta</em> determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to <code>gitCommit: {}</code>."
}
},
"preferredOrder": [
"artifacts",
"tagPolicy",
"executionEnvironment"
],
"additionalProperties": false
},
{
"properties": {
"artifacts": {
"items": {
"$ref": "#/definitions/Artifact"
},
"type": "array",
"description": "the images you're going to be building.",
"x-intellij-html-description": "the images you're going to be building."
},
"executionEnvironment": {
"$ref": "#/definitions/ExecutionEnvironment",
"description": "environment in which the build should run. Possible values: googleCloudBuild.",
"x-intellij-html-description": "environment in which the build should run. Possible values: googleCloudBuild."
},
"local": {
"$ref": "#/definitions/LocalBuild",
"description": "*beta* describes how to do a build on the local docker daemon and optionally push to a repository.",
"x-intellij-html-description": "<em>beta</em> describes how to do a build on the local docker daemon and optionally push to a repository."
},
"tagPolicy": {
"$ref": "#/definitions/TagPolicy",
"description": "*beta* determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to `gitCommit: {}`.",
"x-intellij-html-description": "<em>beta</em> determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to <code>gitCommit: {}</code>."
}
},
"preferredOrder": [
"artifacts",
"tagPolicy",
"executionEnvironment",
"local"
],
"additionalProperties": false
},
{
"properties": {
"artifacts": {
"items": {
"$ref": "#/definitions/Artifact"
},
"type": "array",
"description": "the images you're going to be building.",
"x-intellij-html-description": "the images you're going to be building."
},
"executionEnvironment": {
"$ref": "#/definitions/ExecutionEnvironment",
"description": "environment in which the build should run. Possible values: googleCloudBuild.",
"x-intellij-html-description": "environment in which the build should run. Possible values: googleCloudBuild."
},
"googleCloudBuild": {
"$ref": "#/definitions/GoogleCloudBuild",
"description": "*beta* describes how to do a remote build on [Google Cloud Build](https://cloud.google.com/cloud-build/).",
"x-intellij-html-description": "<em>beta</em> describes how to do a remote build on <a href=\"https://cloud.google.com/cloud-build/\">Google Cloud Build</a>."
},
"tagPolicy": {
"$ref": "#/definitions/TagPolicy",
"description": "*beta* determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to `gitCommit: {}`.",
"x-intellij-html-description": "<em>beta</em> determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to <code>gitCommit: {}</code>."
}
},
"preferredOrder": [
"artifacts",
"tagPolicy",
"executionEnvironment",
"googleCloudBuild"
],
"additionalProperties": false
},
{
"properties": {
"artifacts": {
"items": {
"$ref": "#/definitions/Artifact"
},
"type": "array",
"description": "the images you're going to be building.",
"x-intellij-html-description": "the images you're going to be building."
},
"executionEnvironment": {
"$ref": "#/definitions/ExecutionEnvironment",
"description": "environment in which the build should run. Possible values: googleCloudBuild.",
"x-intellij-html-description": "environment in which the build should run. Possible values: googleCloudBuild."
},
"kaniko": {
"$ref": "#/definitions/KanikoBuild",
"description": "*beta* describes how to do an on-cluster build using [Kaniko](https://github.com/GoogleContainerTools/kaniko).",
"x-intellij-html-description": "<em>beta</em> describes how to do an on-cluster build using <a href=\"https://github.com/GoogleContainerTools/kaniko\">Kaniko</a>."
},
"tagPolicy": {
"$ref": "#/definitions/TagPolicy",
"description": "*beta* determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to `gitCommit: {}`.",
"x-intellij-html-description": "<em>beta</em> determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to <code>gitCommit: {}</code>."
}
},
"preferredOrder": [
"artifacts",
"tagPolicy",
"executionEnvironment",
"kaniko"
],
"additionalProperties": false
}
],
"description": "contains all the configuration for the build steps.",
"x-intellij-html-description": "contains all the configuration for the build steps."
},
"BuildType": {
"properties": {
"googleCloudBuild": {
"$ref": "#/definitions/GoogleCloudBuild",
"description": "*beta* describes how to do a remote build on [Google Cloud Build](https://cloud.google.com/cloud-build/).",
"x-intellij-html-description": "<em>beta</em> describes how to do a remote build on <a href=\"https://cloud.google.com/cloud-build/\">Google Cloud Build</a>."
},
"kaniko": {
"$ref": "#/definitions/KanikoBuild",
"description": "*beta* describes how to do an on-cluster build using [Kaniko](https://github.com/GoogleContainerTools/kaniko).",
"x-intellij-html-description": "<em>beta</em> describes how to do an on-cluster build using <a href=\"https://github.com/GoogleContainerTools/kaniko\">Kaniko</a>."
},
"local": {
"$ref": "#/definitions/LocalBuild",
"description": "*beta* describes how to do a build on the local docker daemon and optionally push to a repository.",
"x-intellij-html-description": "<em>beta</em> describes how to do a build on the local docker daemon and optionally push to a repository."
}
},
"preferredOrder": [
"local",
"googleCloudBuild",
"kaniko"
],
"additionalProperties": false,
"description": "contains the specific implementation and parameters needed for the build step. Only one field should be populated.",
"x-intellij-html-description": "contains the specific implementation and parameters needed for the build step. Only one field should be populated."
},
"BuilderPlugin": {
"properties": {
"name": {
"type": "string",
"description": "name of the build plugin.",
"x-intellij-html-description": "name of the build plugin."
},
"properties": {
"additionalProperties": {},
"type": "object",
"description": "key-value pairs passed to the plugin.",
"x-intellij-html-description": "key-value pairs passed to the plugin.",
"default": "{}"
}
},
"preferredOrder": [
"name",
"properties"
],
"additionalProperties": false,
"description": "contains all fields necessary for specifying a build plugin.",
"x-intellij-html-description": "contains all fields necessary for specifying a build plugin."
},
"DateTimeTagger": {
"properties": {
"format": {
"type": "string",
"description": "formats the date and time. See [#Time.Format](https://golang.org/pkg/time/#Time.Format).",
"x-intellij-html-description": "formats the date and time. See <a href=\"https://golang.org/pkg/time/#Time.Format\">#Time.Format</a>.",
"default": "2006-01-02_15-04-05.999_MST"
},
"timezone": {
"type": "string",
"description": "sets the timezone for the date and time. See [Time.LoadLocation](https://golang.org/pkg/time/#Time.LoadLocation). Defaults to the local timezone.",
"x-intellij-html-description": "sets the timezone for the date and time. See <a href=\"https://golang.org/pkg/time/#Time.LoadLocation\">Time.LoadLocation</a>. Defaults to the local timezone."
}
},
"preferredOrder": [
"format",
"timezone"
],
"additionalProperties": false,
"description": "*beta* tags images with the build timestamp.",
"x-intellij-html-description": "<em>beta</em> tags images with the build timestamp."
},
"DeployConfig": {
"anyOf": [
{
"additionalProperties": false
},
{
"properties": {
"helm": {
"$ref": "#/definitions/HelmDeploy",
"description": "*beta* uses the `helm` CLI to apply the charts to the cluster.",
"x-intellij-html-description": "<em>beta</em> uses the <code>helm</code> CLI to apply the charts to the cluster."
}
},
"preferredOrder": [
"helm"
],
"additionalProperties": false
},
{
"properties": {
"kubectl": {
"$ref": "#/definitions/KubectlDeploy",
"description": "*beta* uses a client side `kubectl apply` to deploy manifests. You'll need a `kubectl` CLI version installed that's compatible with your cluster.",
"x-intellij-html-description": "<em>beta</em> uses a client side <code>kubectl apply</code> to deploy manifests. You'll need a <code>kubectl</code> CLI version installed that's compatible with your cluster."
}
},
"preferredOrder": [
"kubectl"
],
"additionalProperties": false
},
{
"properties": {
"kustomize": {
"$ref": "#/definitions/KustomizeDeploy",
"description": "*beta* uses the `kustomize` CLI to \"patch\" a deployment for a target environment.",
"x-intellij-html-description": "<em>beta</em> uses the <code>kustomize</code> CLI to "patch" a deployment for a target environment."
}
},
"preferredOrder": [
"kustomize"
],
"additionalProperties": false
}
],
"description": "contains all the configuration needed by the deploy steps.",
"x-intellij-html-description": "contains all the configuration needed by the deploy steps."
},
"DeployType": {
"properties": {
"helm": {
"$ref": "#/definitions/HelmDeploy",
"description": "*beta* uses the `helm` CLI to apply the charts to the cluster.",
"x-intellij-html-description": "<em>beta</em> uses the <code>helm</code> CLI to apply the charts to the cluster."
},
"kubectl": {
"$ref": "#/definitions/KubectlDeploy",
"description": "*beta* uses a client side `kubectl apply` to deploy manifests. You'll need a `kubectl` CLI version installed that's compatible with your cluster.",
"x-intellij-html-description": "<em>beta</em> uses a client side <code>kubectl apply</code> to deploy manifests. You'll need a <code>kubectl</code> CLI version installed that's compatible with your cluster."
},
"kustomize": {
"$ref": "#/definitions/KustomizeDeploy",
"description": "*beta* uses the `kustomize` CLI to \"patch\" a deployment for a target environment.",
"x-intellij-html-description": "<em>beta</em> uses the <code>kustomize</code> CLI to "patch" a deployment for a target environment."
}
},
"preferredOrder": [
"helm",
"kubectl",
"kustomize"
],
"additionalProperties": false,
"description": "contains the specific implementation and parameters needed for the deploy step. Only one field should be populated.",
"x-intellij-html-description": "contains the specific implementation and parameters needed for the deploy step. Only one field should be populated."
},
"DockerArtifact": {
"properties": {
"buildArgs": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"description": "arguments passed to the docker build.",
"x-intellij-html-description": "arguments passed to the docker build.",
"default": "{}",
"examples": [
"{\"key1\": \"value1\", \"key2\": \"value2\"}"
]
},
"cacheFrom": {
"items": {
"type": "string"
},
"type": "array",
"description": "the Docker images used as cache sources.",
"x-intellij-html-description": "the Docker images used as cache sources.",
"default": "[]",
"examples": [
"[\"golang:1.10.1-alpine3.7\", \"alpine:3.7\"]"
]
},
"dockerfile": {
"type": "string",
"description": "locates the Dockerfile relative to workspace.",
"x-intellij-html-description": "locates the Dockerfile relative to workspace.",
"default": "Dockerfile"
},
"target": {
"type": "string",
"description": "Dockerfile target name to build.",
"x-intellij-html-description": "Dockerfile target name to build."
}
},
"preferredOrder": [
"dockerfile",
"target",
"buildArgs",
"cacheFrom"
],
"additionalProperties": false,
"description": "*beta* describes an artifact built from a Dockerfile, usually using `docker build`.",
"x-intellij-html-description": "<em>beta</em> describes an artifact built from a Dockerfile, usually using <code>docker build</code>."
},
"DockerConfig": {
"properties": {
"path": {
"type": "string",
"description": "path to the docker `config.json`.",
"x-intellij-html-description": "path to the docker <code>config.json</code>."
},
"secretName": {
"type": "string",
"description": "Kubernetes secret that will hold the Docker configuration.",
"x-intellij-html-description": "Kubernetes secret that will hold the Docker configuration."
}
},
"preferredOrder": [
"path",
"secretName"
],
"additionalProperties": false,
"description": "contains information about the docker `config.json` to mount.",
"x-intellij-html-description": "contains information about the docker <code>config.json</code> to mount."
},
"EnvTemplateTagger": {
"required": [
"template"
],
"properties": {
"template": {
"type": "string",
"description": "used to produce the image name and tag. See golang [text/template](https://golang.org/pkg/text/template/). The template is executed against the current environment, with those variables injected: IMAGE_NAME | Name of the image being built, as supplied in the artifacts section.",
"x-intellij-html-description": "used to produce the image name and tag. See golang <a href=\"https://golang.org/pkg/text/template/\">text/template</a>. The template is executed against the current environment, with those variables injected: IMAGE_NAME | Name of the image being built, as supplied in the artifacts section.",
"examples": [
"{{.RELEASE}}-{{.IMAGE_NAME}}"
]
}
},
"preferredOrder": [
"template"
],
"additionalProperties": false,
"description": "*beta* tags images with a configurable template string.",
"x-intellij-html-description": "<em>beta</em> tags images with a configurable template string."
},
"ExecEnvironment": {
"type": "string",
"description": "name of an execution environment.",
"x-intellij-html-description": "name of an execution environment."
},
"ExecutionEnvironment": {
"properties": {
"name": {
"$ref": "#/definitions/ExecEnvironment",
"description": "name of the environment.",
"x-intellij-html-description": "name of the environment."
},
"properties": {
"additionalProperties": {},
"type": "object",
"description": "key-value pairs passed to the environment.",
"x-intellij-html-description": "key-value pairs passed to the environment.",
"default": "{}"
}
},
"preferredOrder": [
"name",
"properties"
],
"additionalProperties": false,
"description": "environment in which the build should run (ex. local or in-cluster, etc.).",
"x-intellij-html-description": "environment in which the build should run (ex. local or in-cluster, etc.)."
},
"GitTagger": {
"description": "*beta* tags images with the git tag or commit of the artifact's workspace.",
"x-intellij-html-description": "<em>beta</em> tags images with the git tag or commit of the artifact's workspace."
},
"GoogleCloudBuild": {
"properties": {
"diskSizeGb": {
"type": "number",
"description": "disk size of the VM that runs the build. See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions).",
"x-intellij-html-description": "disk size of the VM that runs the build. See <a href=\"https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions\">Cloud Build Reference</a>."
},
"dockerImage": {
"type": "string",
"description": "image that runs a Docker build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).",
"x-intellij-html-description": "image that runs a Docker build. See <a href=\"https://cloud.google.com/cloud-build/docs/cloud-builders\">Cloud Builders</a>.",
"default": "gcr.io/cloud-builders/docker"
},
"gradleImage": {
"type": "string",
"description": "image that runs a Gradle build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).",
"x-intellij-html-description": "image that runs a Gradle build. See <a href=\"https://cloud.google.com/cloud-build/docs/cloud-builders\">Cloud Builders</a>.",
"default": "gcr.io/cloud-builders/gradle"
},
"machineType": {
"type": "string",
"description": "type of the VM that runs the build. See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions).",
"x-intellij-html-description": "type of the VM that runs the build. See <a href=\"https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions\">Cloud Build Reference</a>."
},
"mavenImage": {
"type": "string",
"description": "image that runs a Maven build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).",
"x-intellij-html-description": "image that runs a Maven build. See <a href=\"https://cloud.google.com/cloud-build/docs/cloud-builders\">Cloud Builders</a>.",
"default": "gcr.io/cloud-builders/mvn"
},
"projectId": {
"type": "string",
"description": "ID of your Cloud Platform Project. If it is not provided, Skaffold will guess it from the image name. For example, given the artifact image name `gcr.io/myproject/image`, Skaffold will use the `myproject` GCP project.",
"x-intellij-html-description": "ID of your Cloud Platform Project. If it is not provided, Skaffold will guess it from the image name. For example, given the artifact image name <code>gcr.io/myproject/image</code>, Skaffold will use the <code>myproject</code> GCP project."
},
"timeout": {
"type": "string",
"description": "amount of time (in seconds) that this build should be allowed to run. See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#resource-build).",
"x-intellij-html-description": "amount of time (in seconds) that this build should be allowed to run. See <a href=\"https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#resource-build\">Cloud Build Reference</a>."
}
},
"preferredOrder": [
"projectId",
"diskSizeGb",
"machineType",
"timeout",
"dockerImage",
"mavenImage",
"gradleImage"
],
"additionalProperties": false,
"description": "*beta* describes how to do a remote build on [Google Cloud Build](https://cloud.google.com/cloud-build/docs/). Docker and Jib artifacts can be built on Cloud Build. The `projectId` needs to be provided and the currently logged in user should be given permissions to trigger new builds.",
"x-intellij-html-description": "<em>beta</em> describes how to do a remote build on <a href=\"https://cloud.google.com/cloud-build/docs/\">Google Cloud Build</a>. Docker and Jib artifacts can be built on Cloud Build. The <code>projectId</code> needs to be provided and the currently logged in user should be given permissions to trigger new builds."
},
"HelmConventionConfig": {
"description": "image config in the syntax of image.repository and image.tag.",
"x-intellij-html-description": "image config in the syntax of image.repository and image.tag."
},
"HelmDeploy": {
"required": [
"releases"
],
"properties": {
"flags": {
"$ref": "#/definitions/HelmDeployFlags",
"description": "additional option flags that are passed on the command line to `helm`.",
"x-intellij-html-description": "additional option flags that are passed on the command line to <code>helm</code>."
},
"releases": {
"items": {
"$ref": "#/definitions/HelmRelease"
},
"type": "array",
"description": "a list of Helm releases.",
"x-intellij-html-description": "a list of Helm releases."
}
},
"preferredOrder": [
"releases",
"flags"
],
"additionalProperties": false,
"description": "*beta* uses the `helm` CLI to apply the charts to the cluster.",
"x-intellij-html-description": "<em>beta</em> uses the <code>helm</code> CLI to apply the charts to the cluster."
},
"HelmDeployFlags": {
"properties": {
"global": {
"items": {
"type": "string"
},
"type": "array",
"description": "additional flags passed on every command.",
"x-intellij-html-description": "additional flags passed on every command.",
"default": "[]"
},
"install": {
"items": {
"type": "string"
},
"type": "array",
"description": "additional flags passed to (`helm install`).",
"x-intellij-html-description": "additional flags passed to (<code>helm install</code>).",
"default": "[]"
},
"upgrade": {
"items": {
"type": "string"
},
"type": "array",
"description": "additional flags passed to (`helm upgrade`).",
"x-intellij-html-description": "additional flags passed to (<code>helm upgrade</code>).",
"default": "[]"
}
},
"preferredOrder": [
"global",
"install",
"upgrade"
],
"additionalProperties": false,
"description": "additional option flags that are passed on the command line to `helm`.",
"x-intellij-html-description": "additional option flags that are passed on the command line to <code>helm</code>."
},
"HelmFQNConfig": {
"properties": {
"property": {
"type": "string",
"description": "defines the image config.",
"x-intellij-html-description": "defines the image config."
}
},
"preferredOrder": [
"property"
],
"additionalProperties": false,
"description": "image config to use the FullyQualifiedImageName as param to set.",
"x-intellij-html-description": "image config to use the FullyQualifiedImageName as param to set."
},
"HelmImageConfig": {
"properties": {
"fqn": {
"$ref": "#/definitions/HelmFQNConfig",
"description": "image configuration uses the syntax `IMAGE-NAME=IMAGE-REPOSITORY:IMAGE-TAG`.",
"x-intellij-html-description": "image configuration uses the syntax <code>IMAGE-NAME=IMAGE-REPOSITORY:IMAGE-TAG</code>."
},
"helm": {
"$ref": "#/definitions/HelmConventionConfig",
"description": "image configuration uses the syntax `IMAGE-NAME.repository=IMAGE-REPOSITORY, IMAGE-NAME.tag=IMAGE-TAG`.",
"x-intellij-html-description": "image configuration uses the syntax <code>IMAGE-NAME.repository=IMAGE-REPOSITORY, IMAGE-NAME.tag=IMAGE-TAG</code>."
}
},
"preferredOrder": [
"fqn",
"helm"
],
"additionalProperties": false,
"description": "describes an image configuration.",
"x-intellij-html-description": "describes an image configuration."
},
"HelmImageStrategy": {
"anyOf": [
{
"additionalProperties": false
},
{
"properties": {
"fqn": {
"$ref": "#/definitions/HelmFQNConfig",
"description": "image configuration uses the syntax `IMAGE-NAME=IMAGE-REPOSITORY:IMAGE-TAG`.",
"x-intellij-html-description": "image configuration uses the syntax <code>IMAGE-NAME=IMAGE-REPOSITORY:IMAGE-TAG</code>."
}
},
"preferredOrder": [
"fqn"
],
"additionalProperties": false
},
{
"properties": {
"helm": {
"$ref": "#/definitions/HelmConventionConfig",
"description": "image configuration uses the syntax `IMAGE-NAME.repository=IMAGE-REPOSITORY, IMAGE-NAME.tag=IMAGE-TAG`.",
"x-intellij-html-description": "image configuration uses the syntax <code>IMAGE-NAME.repository=IMAGE-REPOSITORY, IMAGE-NAME.tag=IMAGE-TAG</code>."
}
},
"preferredOrder": [
"helm"
],
"additionalProperties": false
}
],
"description": "adds image configurations to the Helm `values` file.",
"x-intellij-html-description": "adds image configurations to the Helm <code>values</code> file."
},
"HelmPackaged": {
"properties": {
"appVersion": {
"type": "string",
"description": "sets the `appVersion` on the chart to this version.",
"x-intellij-html-description": "sets the <code>appVersion</code> on the chart to this version."
},
"version": {
"type": "string",
"description": "sets the `version` on the chart to this semver version.",
"x-intellij-html-description": "sets the <code>version</code> on the chart to this semver version."
}
},
"preferredOrder": [
"version",
"appVersion"
],
"additionalProperties": false,
"description": "parameters for packaging helm chart (`helm package`).",
"x-intellij-html-description": "parameters for packaging helm chart (<code>helm package</code>)."
},
"HelmRelease": {
"required": [
"name",
"chartPath"
],
"properties": {
"chartPath": {
"type": "string",
"description": "path to the Helm chart.",
"x-intellij-html-description": "path to the Helm chart."
},
"imageStrategy": {
"$ref": "#/definitions/HelmImageStrategy",
"description": "adds image configurations to the Helm `values` file.",
"x-intellij-html-description": "adds image configurations to the Helm <code>values</code> file."
},
"name": {
"type": "string",
"description": "name of the Helm release.",
"x-intellij-html-description": "name of the Helm release."
},
"namespace": {
"type": "string",
"description": "Kubernetes namespace.",