-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.json
1399 lines (1399 loc) · 154 KB
/
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
{
"$ref": "#/definitions/pipeline",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": true,
"definitions": {
"across_var": {
"additionalProperties": false,
"properties": {
"fail_fast": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . When enabled, the `across` step will fail fast by returning as soon as any sub-step fails. This means that running steps will be interrupted and pending steps will no longer be scheduled."
},
"max_in_flight": {
"description": "Default `1` . If set to `all` , the substep will run with all combinations of the current var in parallel. If set to a schema.number , only that number of substeps may run in parallel. \n@example Multiple vars \n If multiple schema.across_var vars are configured, the effective `max_in_flight` is multiplicative. For instance: \n\n \n plan:\n - across:\n - var: var1\n values: [a, b, c]\n max_in_flight: all\n - var: var2\n values: [1, 2]\n - var: var3\n values: [foo, bar]\n max_in_flight: 2\n \n\n Here, ** 6 substeps ** will run in parallel, since all 3 of `var1` 's values can run in parallel, and 2 of `var3` 's values can run in parallel.",
"oneOf": [
{
"enum": [
"all"
],
"type": "string"
},
{
"$ref": "#/definitions/number"
}
]
},
"values": {
"description": "The list of values that the schema.across_var.var var will iterate over when running the substep. If multiple schema.across_var vars are configured, all combinations of values across all vars will run. The list of values may also be interpolated. For instance, you may use the load-var-step to first load a list of schema.value into a local-vars local var , and then iterate across that dynamic list of values. \n@example Value combinations \n The following schema.across will run the task `foo/build.yml` for each package defined in `foo/packages-to-build.json` with Go 1.15 and 1.16. \n\n \n plan:\n - get: foo\n - load_var: packages\n file: foo/packages-to-build.json\n - across:\n - var: package\n values: ((.:packages))\n - var: go_version\n values: ['1.15', '1.16']\n task: build\n file: foo/build.yml\n vars:\n go_version: ((.:go_version))\n package: ((.:package))\n \n\n Supposing `foo/packages-to-build.json` had the following content: \n\n \n [\"./cmd/first\", \"./cmd/second\", \"./cmd/third\"]\n \n\n ...then the task `foo/build.yml` would be run with the following var combinations: `{package: \"./cmd/first\", go_version: \"1.15\"}` `{package: \"./cmd/first\", go_version: \"1.16\"}` `{package: \"./cmd/second\", go_version: \"1.15\"}` `{package: \"./cmd/second\", go_version: \"1.16\"}` `{package: \"./cmd/third\", go_version: \"1.15\"}` `{package: \"./cmd/third\", go_version: \"1.16\"}`",
"items": {
"$ref": "#/definitions/value"
},
"type": "array"
},
"var": {
"$ref": "#/definitions/identifier",
"description": "The name of the variable that will be added to the local-vars \" `.` \" var source . This variable will only be accessible in the scope of the step - each iteration of the step gets its own scope. If a variable of the same name already exists in the parent scope, a warning will be printed."
}
},
"required": [
"values",
"var"
],
"type": "object"
},
"anonymous_resource": {
"additionalProperties": false,
"properties": {
"params": {
"$ref": "#/definitions/config",
"description": "A map of arbitrary configuration to forward to the resource. Refer to the resource type's documentation to see what it supports."
},
"source": {
"$ref": "#/definitions/config",
"description": "The configuration for the resource; see schema.resource.source ."
},
"type": {
"$ref": "#/definitions/string",
"description": "The type of the resource. Usually `registry-image` . You can use any resource type that returns a filesystem in the correct format: a `/rootfs` directory containing a full filesystem, and a `metadata.json` file containing."
},
"version": {
"$ref": "#/definitions/version",
"description": "A specific version of the resource to fetch. This should be a map with string keys and values. If not specified, the latest version will be fetched."
}
},
"required": [
"source",
"type"
],
"type": "object"
},
"boolean": {
"type": "boolean"
},
"build_log_retention_policy": {
"additionalProperties": false,
"properties": {
"builds": {
"$ref": "#/definitions/number",
"description": "Keep logs for the last specified number of builds."
},
"days": {
"$ref": "#/definitions/number",
"description": "Keep logs for builds which have finished within the specified number of days."
},
"minimum_succeeded_builds": {
"$ref": "#/definitions/number",
"description": "Keep a minimum number of successful build logs that would normally be reaped. Requires schema.build_log_retention_policy.builds `builds` to be set to an integer higher than 0 in order to work. For example, if schema.build_log_retention_policy.builds `builds` is set to 5, and this attribute to 1, say a job has the following build history: 7(f), 6(f), 5(f), 4(f), 3(f), 2(f), 1(s), where f means failed and s means succeeded, then builds 2 and 3 will be reaped, because it retains 5 build logs, and at least 1 succeeded build log. Default is 0."
}
},
"required": [],
"type": "object"
},
"cache": {},
"command": {
"additionalProperties": false,
"properties": {
"args": {
"description": "Arguments to pass to the command. Note that when executed with fly-cli Fly , any arguments passed to fly-execute are appended to this array.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"dir": {
"$ref": "#/definitions/dir_path",
"description": "A directory, relative to the initial working directory, to set as the working directory when running the script."
},
"path": {
"$ref": "#/definitions/file_path",
"description": "The name of or path to the executable to run. `path` is relative to the working directory. If `dir` is specified to set the working directory, then `path` is relative to it. This is commonly a path to a script provided by one of the task's inputs, e.g. `my-resource/scripts/test` . It could also be a command like `bash` (respecting standard `$PATH` lookup rules), or an absolute path to a file to execute, e.g. `/bin/bash` ."
},
"user": {
"$ref": "#/definitions/string",
"description": "Explicitly set the user to run as. If not specified, this defaults to the user configured by the task's image. If not specified there, it's up to the Garden backend, and may be e.g. `root` on Linux."
}
},
"required": [
"path"
],
"type": "object"
},
"config": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"container_limits": {
"additionalProperties": false,
"properties": {
"cpu": {
"$ref": "#/definitions/number",
"description": "The maximum amount of CPU available to the task container, measured in shares. 0 means unlimited. CPU shares are relative to the CPU shares of other containers on a worker. For example, if you have two containers both with a CPU limit of 2 shares then each container will get 50% of the CPU's time. \n\n \n Container A: 2 shares - 50% CPU\n Container B: 2 shares - 50% CPU\n Total CPU shares declared: 4\n \n\n If you introduce another container then the number of CPU time per container changes. CPU shares are relative to each other. \n\n \n Container A: 2 shares - 25% CPU\n Container B: 2 shares - 25% CPU\n Container C: 4 shares - 50% CPU\n Total CPU shares declared: 8"
},
"memory": {
"$ref": "#/definitions/number",
"description": "The maximum amount of memory available to the task container, measured in bytes. 0 means unlimited."
}
},
"required": [],
"type": "object"
},
"dir_path": {
"type": "string"
},
"display_config": {},
"do_step": {
"additionalProperties": false,
"properties": {
"across": {
"description": "Contains a list of schema.across_var . across_var var identifier The name of the variable that will be added to the local-vars \" `.` \" var source . This variable will only be accessible in the scope of the step - each iteration of the step gets its own scope. If a variable of the same name already exists in the parent scope, a warning will be printed. values [value] The list of values that the schema.across_var.var var will iterate over when running the substep. If multiple schema.across_var vars are configured, all combinations of values across all vars will run. The list of values may also be interpolated. For instance, you may use the load-var-step to first load a list of schema.value into a local-vars local var , and then iterate across that dynamic list of values. \n@example Value combinations \n The following schema.across will run the task `foo/build.yml` for each package defined in `foo/packages-to-build.json` with Go 1.15 and 1.16. \n\n \n plan:\n - get: foo\n - load_var: packages\n file: foo/packages-to-build.json\n - across:\n - var: package\n values: ((.:packages))\n - var: go_version\n values: ['1.15', '1.16']\n task: build\n file: foo/build.yml\n vars:\n go_version: ((.:go_version))\n package: ((.:package))\n \n\n Supposing `foo/packages-to-build.json` had the following content: \n\n \n [\"./cmd/first\", \"./cmd/second\", \"./cmd/third\"]\n \n\n ...then the task `foo/build.yml` would be run with the following var combinations: `{package: \"./cmd/first\", go_version: \"1.15\"}` `{package: \"./cmd/first\", go_version: \"1.16\"}` `{package: \"./cmd/second\", go_version: \"1.15\"}` `{package: \"./cmd/second\", go_version: \"1.16\"}` `{package: \"./cmd/third\", go_version: \"1.15\"}` `{package: \"./cmd/third\", go_version: \"1.16\"}` max_in_flight `all` | number Default `1` . If set to `all` , the substep will run with all combinations of the current var in parallel. If set to a schema.number , only that number of substeps may run in parallel. \n@example Multiple vars \n If multiple schema.across_var vars are configured, the effective `max_in_flight` is multiplicative. For instance: \n\n \n plan:\n - across:\n - var: var1\n values: [a, b, c]\n max_in_flight: all\n - var: var2\n values: [1, 2]\n - var: var3\n values: [foo, bar]\n max_in_flight: 2\n \n\n Here, ** 6 substeps ** will run in parallel, since all 3 of `var1` 's values can run in parallel, and 2 of `var3` 's values can run in parallel. fail_fast boolean Default `false` . When enabled, the `across` step will fail fast by returning as soon as any sub-step fails. This means that running steps will be interrupted and pending steps will no longer be scheduled.",
"items": {
"$ref": "#/definitions/across_var"
},
"type": "array"
},
"attempts": {
"$ref": "#/definitions/number",
"description": "@example Retrying a task \n The following will run the task and retry it up to 9 times (for a total of 10 attempts) if it fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n attempts: 10\n \n\n \n@example Retrying with a timeout \n When used in combination with `timeout` , the timeout applies to each step. This semi-arbitary decision was made because often things either succeed in a reasonable amount of time or fail due to hanging/flakiness. In this case it seems more useful to allow each attempt the allotted timeout rather than have one very long attempt prevent more attempts. \n\n \n plan:\n - get: flake\n - task: flaky-tests\n file: flake/integration.yml\n timeout: 10m\n attempts: 3"
},
"do": {
"description": "@example Running multiple steps in a try \n This can be used to perform multiple steps serially in a try-step : \n\n \n jobs:\n - name: with-do\n plan:\n - try:\n do:\n - get: black-ice\n - get: control-node\n - get: cyberdeck\n \n resources:\n - name: black-ice\n type: mock\n - name: control-node\n type: mock\n - name: cyberdeck\n type: mock",
"items": {
"$ref": "#/definitions/step"
},
"type": "array"
},
"ensure": {
"$ref": "#/definitions/step",
"description": "@example Releasing a lock \n The following build plan acquires a lock and then `ensure` s that the lock is released. \n\n \n plan:\n - put: some-lock\n params: {acquire: true}\n - task: integration\n file: foo/integration.yml\n ensure:\n put: some-lock\n params: {release: some-lock}"
},
"on_abort": {
"$ref": "#/definitions/step",
"description": "@example Cleaning up `on_abort`\n The following will perform the `cleanup` task only if the build is aborted while the `unit` task was running: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_abort:\n task: cleanup\n file: foo/cleanup.yml"
},
"on_error": {
"$ref": "#/definitions/step",
"description": "@example Sending a notification \n Until notifications become first-class ( RFC #28 https://github.com/concourse/rfcs/pull/28 , this step can be used to notify folks if their builds errored out: \n\n \n plan:\n - do:\n - get: ci\n - task: unit\n file: ci/unit.yml\n on_error:\n put: slack"
},
"on_failure": {
"$ref": "#/definitions/step",
"description": "@example Alerting on failure \n The following will perform the `alert` task only if the `unit` task fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_failure:\n task: alert\n file: foo/alert.yml"
},
"on_success": {
"$ref": "#/definitions/step",
"description": "@example Running on success \n The following will perform the second task only if the first one succeeds: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_success:\n task: alert\n file: foo/alert.yml\n \n\n Note that this is semantically equivalent to the following: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n - task: alert\n file: foo/alert.yml\n \n\n The `on_success` hook is provided mainly for cases where there is an equivalent schema.on_failure , and having them next to each other is more clear."
},
"tags": {
"description": "Default `[]` . \n@example Running in a private network \n You may have a private cluster only reachable by special workers running on-premises. To run steps against those workers, just provide a matching tag: \n\n \n plan:\n - get: my-repo\n - put: my-site\n tags: [private]\n params: {path: my-repo}\n - task: acceptance-tests\n tags: [private]\n file: my-repo/ci/acceptance.yml",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"timeout": {
"$ref": "#/definitions/duration",
"description": "@example Giving up \n The following will run the `unit` task and cancel it if it takes longer than 1 hour and 30 minutes: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n timeout: 1h30m"
}
},
"required": [
"do"
],
"type": "object"
},
"dummy_config": {},
"dummy_var_source": {
"additionalProperties": false,
"properties": {
"config": {
"$ref": "#/definitions/dummy_config",
"description": "dummy_config vars vars A mapping of var name to var value."
},
"name": {
"$ref": "#/definitions/string",
"description": "The name of the `((var))` source. This should be short and simple. This name will be referenced var-syntax throughout the config."
},
"type": {
"description": "The `dummy` type supports configuring a static map of vars to values. This is really only useful if you have no better alternative for credential management but still have sensitive values that you would like to creds-redacting redact them from build output.",
"enum": [
"dummy"
],
"type": "string"
}
},
"required": [
"config",
"name",
"type"
],
"type": "object"
},
"duration": {
"type": "string"
},
"env_vars": {
"patternProperties": {
".*": {
"additionalProperties": true
}
},
"type": "object"
},
"file_path": {
"type": "string"
},
"get_step": {
"additionalProperties": false,
"properties": {
"across": {
"description": "Contains a list of schema.across_var . across_var var identifier The name of the variable that will be added to the local-vars \" `.` \" var source . This variable will only be accessible in the scope of the step - each iteration of the step gets its own scope. If a variable of the same name already exists in the parent scope, a warning will be printed. values [value] The list of values that the schema.across_var.var var will iterate over when running the substep. If multiple schema.across_var vars are configured, all combinations of values across all vars will run. The list of values may also be interpolated. For instance, you may use the load-var-step to first load a list of schema.value into a local-vars local var , and then iterate across that dynamic list of values. \n@example Value combinations \n The following schema.across will run the task `foo/build.yml` for each package defined in `foo/packages-to-build.json` with Go 1.15 and 1.16. \n\n \n plan:\n - get: foo\n - load_var: packages\n file: foo/packages-to-build.json\n - across:\n - var: package\n values: ((.:packages))\n - var: go_version\n values: ['1.15', '1.16']\n task: build\n file: foo/build.yml\n vars:\n go_version: ((.:go_version))\n package: ((.:package))\n \n\n Supposing `foo/packages-to-build.json` had the following content: \n\n \n [\"./cmd/first\", \"./cmd/second\", \"./cmd/third\"]\n \n\n ...then the task `foo/build.yml` would be run with the following var combinations: `{package: \"./cmd/first\", go_version: \"1.15\"}` `{package: \"./cmd/first\", go_version: \"1.16\"}` `{package: \"./cmd/second\", go_version: \"1.15\"}` `{package: \"./cmd/second\", go_version: \"1.16\"}` `{package: \"./cmd/third\", go_version: \"1.15\"}` `{package: \"./cmd/third\", go_version: \"1.16\"}` max_in_flight `all` | number Default `1` . If set to `all` , the substep will run with all combinations of the current var in parallel. If set to a schema.number , only that number of substeps may run in parallel. \n@example Multiple vars \n If multiple schema.across_var vars are configured, the effective `max_in_flight` is multiplicative. For instance: \n\n \n plan:\n - across:\n - var: var1\n values: [a, b, c]\n max_in_flight: all\n - var: var2\n values: [1, 2]\n - var: var3\n values: [foo, bar]\n max_in_flight: 2\n \n\n Here, ** 6 substeps ** will run in parallel, since all 3 of `var1` 's values can run in parallel, and 2 of `var3` 's values can run in parallel. fail_fast boolean Default `false` . When enabled, the `across` step will fail fast by returning as soon as any sub-step fails. This means that running steps will be interrupted and pending steps will no longer be scheduled.",
"items": {
"$ref": "#/definitions/across_var"
},
"type": "array"
},
"attempts": {
"$ref": "#/definitions/number",
"description": "@example Retrying a task \n The following will run the task and retry it up to 9 times (for a total of 10 attempts) if it fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n attempts: 10\n \n\n \n@example Retrying with a timeout \n When used in combination with `timeout` , the timeout applies to each step. This semi-arbitary decision was made because often things either succeed in a reasonable amount of time or fail due to hanging/flakiness. In this case it seems more useful to allow each attempt the allotted timeout rather than have one very long attempt prevent more attempts. \n\n \n plan:\n - get: flake\n - task: flaky-tests\n file: flake/integration.yml\n timeout: 10m\n attempts: 3"
},
"ensure": {
"$ref": "#/definitions/step",
"description": "@example Releasing a lock \n The following build plan acquires a lock and then `ensure` s that the lock is released. \n\n \n plan:\n - put: some-lock\n params: {acquire: true}\n - task: integration\n file: foo/integration.yml\n ensure:\n put: some-lock\n params: {release: some-lock}"
},
"get": {
"description": "The fetched bits will be registered in the build's artifact namespace under the given identifier. Subsequent task-step and put-step which list the identifier as an input will have a copy of the bits in their working directory. \n@example Fetching a repo and passing it to a task \n Almost every simple job will look something like this: fetch my code with a get-step and do something (run tests) with it in a task-step . \n\n \n jobs:\n - name: fetch-repo\n plan:\n - get: repo # fetches repo under artifact name \"repo\"\n - task: ls-repo\n config:\n platform: linux\n image_resource:\n type: mock\n source: {mirror_self: true}\n # pass the \"repo\" artifact into the task\n inputs:\n - name: repo\n run:\n path: ls\n args: [\"-lah\",\"repo\"]\n \n resources:\n - name: repo\n type: git\n source:\n uri: https://github.com/concourse/examples.git",
"oneOf": [
{
"$ref": "#/definitions/string"
},
{
"$ref": "#/definitions/identifier"
}
]
},
"on_abort": {
"$ref": "#/definitions/step",
"description": "@example Cleaning up `on_abort`\n The following will perform the `cleanup` task only if the build is aborted while the `unit` task was running: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_abort:\n task: cleanup\n file: foo/cleanup.yml"
},
"on_error": {
"$ref": "#/definitions/step",
"description": "@example Sending a notification \n Until notifications become first-class ( RFC #28 https://github.com/concourse/rfcs/pull/28 , this step can be used to notify folks if their builds errored out: \n\n \n plan:\n - do:\n - get: ci\n - task: unit\n file: ci/unit.yml\n on_error:\n put: slack"
},
"on_failure": {
"$ref": "#/definitions/step",
"description": "@example Alerting on failure \n The following will perform the `alert` task only if the `unit` task fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_failure:\n task: alert\n file: foo/alert.yml"
},
"on_success": {
"$ref": "#/definitions/step",
"description": "@example Running on success \n The following will perform the second task only if the first one succeeds: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_success:\n task: alert\n file: foo/alert.yml\n \n\n Note that this is semantically equivalent to the following: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n - task: alert\n file: foo/alert.yml\n \n\n The `on_success` hook is provided mainly for cases where there is an equivalent schema.on_failure , and having them next to each other is more clear."
},
"params": {
"$ref": "#/definitions/config",
"description": "Arbitrary configuration to pass to the resource. Refer to the resource type's documentation to see what it supports. \n@example Fetching with `params`\n \n\n \n jobs:\n - name: resource-params\n plan:\n - get: cyberdeck\n params:\n create_files_via_params:\n version_to_put.txt: \"made-via-params\"\n - put: cyberdeck\n params:\n file: cyberdeck/version_to_put.txt\n \n \n resources:\n - name: cyberdeck\n type: mock"
},
"passed": {
"description": "When specified, only the versions of the resource that made it through the given list of jobs (AND-ed together) will be considered when triggering and fetching. \n@example Fanning out and in \n If multiple `get` s are configured with `passed` constraints, all of the mentioned jobs are correlated. \n\n \n jobs:\n - name: lvl-1-firewall\n plan:\n - in_parallel:\n - get: black-ice\n - get: control-node\n - get: cyberdeck\n \n - name: lvl-2-unit\n plan:\n - in_parallel:\n - get: black-ice\n passed: [lvl-1-firewall]\n - get: control-node\n passed: [lvl-1-firewall]\n - get: cyberdeck\n passed: [lvl-1-firewall]\n \n - name: lvl-2-integration\n plan:\n - in_parallel:\n - get: black-ice\n passed: [lvl-1-firewall]\n - get: control-node\n passed: [lvl-1-firewall]\n - get: cyberdeck\n passed: [lvl-1-firewall]\n \n - name: lvl-3-production\n plan:\n - in_parallel:\n - get: black-ice\n passed: [lvl-2-unit,lvl-2-integration]\n - get: control-node\n passed: [lvl-2-unit,lvl-2-integration]\n - get: cyberdeck\n passed: [lvl-2-unit,lvl-2-integration]\n \n resources:\n - name: black-ice\n type: mock\n source:\n initial_version: lvl4\n - name: control-node\n type: mock\n source:\n initial_version: tower\n - name: cyberdeck\n type: mock\n source:\n initial_version: mk3\n \n\n For the final job, `lvl-3-production` , only versions that have passed the previous two jobs ( `lvl-2-unit` and `lvl-2-integration` ) will be passed to `lvl-3-production` . This is crucial to being able to implement safe \"fan-in\" semantics as things progress through a pipeline.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"resource": {
"$ref": "#/definitions/string",
"description": "Defaults to the value of `get` . The resource to fetch, as configured in schema.pipeline.resources . Use this attribute to rename a resource from the overall pipeline context into the job-specific context. \n@example Re-labelling artifact \n \n\n \n jobs:\n - name: fetch-repo\n plan:\n - get: thecode # fetches \"repo\" under artifact name \"thecode\"\n resource: repo\n - task: ls-repo\n config:\n platform: linux\n image_resource:\n type: mock\n source: {mirror_self: true}\n # pass the \"thecode\" artifact into the task\n inputs:\n - name: thecode\n run:\n path: ls\n args: [\"-lah\",\"thecode\"]\n \n resources:\n - name: repo\n type: git\n source:\n uri: https://github.com/concourse/examples.git"
},
"tags": {
"description": "Default `[]` . \n@example Running in a private network \n You may have a private cluster only reachable by special workers running on-premises. To run steps against those workers, just provide a matching tag: \n\n \n plan:\n - get: my-repo\n - put: my-site\n tags: [private]\n params: {path: my-repo}\n - task: acceptance-tests\n tags: [private]\n file: my-repo/ci/acceptance.yml",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"timeout": {
"$ref": "#/definitions/duration",
"description": "@example Giving up \n The following will run the `unit` task and cancel it if it takes longer than 1 hour and 30 minutes: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n timeout: 1h30m"
},
"trigger": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . If set to `true` , new builds of the job will be automatically created when a new version for this input becomes available. Note: if none of a job's `get` steps are set to `true` , the job can only be manually triggered. \n@example Automatically trigger job on new versions \n \n\n \n jobs:\n - name: fetch-repo\n plan:\n - get: repo\n trigger: true # automatically runs the job\n - task: ls-repo\n config:\n platform: linux\n image_resource:\n type: mock\n source: {mirror_self: true}\n inputs:\n - name: repo\n run:\n path: ls\n args: [\"-lah\",\"repo\"]\n \n resources:\n - name: repo\n type: git\n source:\n uri: https://github.com/concourse/examples.git"
},
"version": {
"description": "Default `latest` . The version of the resource to fetch. If set to `latest` , scheduling will just find the latest available version of a resource and use it, allowing versions to be skipped. This is usually what you want, e.g. if someone pushes 100 git commits. If set to `every` , builds will walk through all available versions of the resource. Note that if `passed` is also configured, it will only step through the versions satisfying the constraints. If set to a specific version (e.g. `{ref: abcdef123}` ), only that version will be used. Note that the version must be available and detected by the resource, otherwise the input will never be satisfied. You may want to use fly-check-resource to force detection of resource versions, if you need to use an older one that was never detected (as all newly configured resources start from the latest version).",
"oneOf": [
{
"enum": [
"latest"
],
"type": "string"
},
{
"enum": [
"every"
],
"type": "string"
},
{
"$ref": "#/definitions/version"
}
]
}
},
"required": [
"get"
],
"type": "object"
},
"group_config": {
"additionalProperties": false,
"properties": {
"jobs": {
"description": "A list of jobs that should appear in this group. A job may appear in multiple groups. Neighbours of jobs in the current group will also appear on the same page in order to give context of the location of the group in the pipeline. You may also use any valid glob https://www.man7.org/linux/man-pages/man7/glob.7.html to represent several jobs, e.g.: \n\n \n groups:\n - name: develop\n jobs:\n - terraform-*\n - test\n - deploy-{dev,staging}\n - name: ship\n jobs:\n - deploy-prod\n - name: all\n jobs:\n - \"*\"\n \n\n In this example, the `develop` group will match `terraform-apply` , `terraform-destroy` , `test` , `deploy-dev` , `deploy-staging` . The `ship` group will only match `deploy-prod` . The `all` group will match all jobs in the pipeline. Note that depending on how it's used, `*` , `{` , and `}` have special meaning in YAML, and may need to be quoted (as was done in the `all` job above)",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"name": {
"$ref": "#/definitions/identifier",
"description": "A unique name for the group. This should be short and simple as it will be used as the tab name for navigation."
}
},
"required": [
"name"
],
"type": "object"
},
"identifier": {
"type": "string"
},
"in_parallel_config": {
"additionalProperties": false,
"properties": {
"fail_fast": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . When enabled the parallel step will fail fast by returning as soon as any sub-step fails. This means that running steps will be interrupted and pending steps will no longer be scheduled."
},
"limit": {
"$ref": "#/definitions/number",
"description": "Default unlimited. A sempahore which limits the parallelism when executing the steps in a `in_parallel` step. When set, the number of running steps will not exceed the limit. When not specified, `in_parallel` will execute all steps immediately. \n@example Limiting parallelism \n Using `limit` is useful for performing parallel execution of a growing number of tasks without overloading your workers. In the example below, two tasks will be run in parallel and in order until all steps have been executed: \n\n \n jobs:\n - name: limit-in-parallel\n plan:\n - get: examples\n - in_parallel:\n limit: 2\n steps:\n - task: print-date\n file: examples/tasks/print-date.yml\n - task: hello-world\n file: examples/tasks/hello-world.yml\n - task: print-var\n file: examples/tasks/print-var.yml\n vars:\n my-var: hello\n second-var: good-bye\n \n \n resources:\n - name: examples\n type: git\n source:\n uri: https://github.com/concourse/examples.git"
},
"steps": {
"description": "The steps to perform in parallel. \n@example Fetching artifacts in parallel \n Using the `in_parallel` step where possible is the easiest way to speeding up a builds. It is often used to fetch all dependent resources together at the start of a build plan: \n\n \n jobs:\n - name: get-in-parallel\n plan:\n - in_parallel:\n limit: 2\n fail_fast: false\n steps:\n - get: ci\n - get: repo\n - get: code\n \n \n resources:\n - name: repo\n type: mock\n - name: code\n type: mock\n - name: ci\n type: mock",
"items": {
"$ref": "#/definitions/step"
},
"type": "array"
}
},
"required": [
"steps"
],
"type": "object"
},
"in_parallel_step": {
"additionalProperties": false,
"properties": {
"across": {
"description": "Contains a list of schema.across_var . across_var var identifier The name of the variable that will be added to the local-vars \" `.` \" var source . This variable will only be accessible in the scope of the step - each iteration of the step gets its own scope. If a variable of the same name already exists in the parent scope, a warning will be printed. values [value] The list of values that the schema.across_var.var var will iterate over when running the substep. If multiple schema.across_var vars are configured, all combinations of values across all vars will run. The list of values may also be interpolated. For instance, you may use the load-var-step to first load a list of schema.value into a local-vars local var , and then iterate across that dynamic list of values. \n@example Value combinations \n The following schema.across will run the task `foo/build.yml` for each package defined in `foo/packages-to-build.json` with Go 1.15 and 1.16. \n\n \n plan:\n - get: foo\n - load_var: packages\n file: foo/packages-to-build.json\n - across:\n - var: package\n values: ((.:packages))\n - var: go_version\n values: ['1.15', '1.16']\n task: build\n file: foo/build.yml\n vars:\n go_version: ((.:go_version))\n package: ((.:package))\n \n\n Supposing `foo/packages-to-build.json` had the following content: \n\n \n [\"./cmd/first\", \"./cmd/second\", \"./cmd/third\"]\n \n\n ...then the task `foo/build.yml` would be run with the following var combinations: `{package: \"./cmd/first\", go_version: \"1.15\"}` `{package: \"./cmd/first\", go_version: \"1.16\"}` `{package: \"./cmd/second\", go_version: \"1.15\"}` `{package: \"./cmd/second\", go_version: \"1.16\"}` `{package: \"./cmd/third\", go_version: \"1.15\"}` `{package: \"./cmd/third\", go_version: \"1.16\"}` max_in_flight `all` | number Default `1` . If set to `all` , the substep will run with all combinations of the current var in parallel. If set to a schema.number , only that number of substeps may run in parallel. \n@example Multiple vars \n If multiple schema.across_var vars are configured, the effective `max_in_flight` is multiplicative. For instance: \n\n \n plan:\n - across:\n - var: var1\n values: [a, b, c]\n max_in_flight: all\n - var: var2\n values: [1, 2]\n - var: var3\n values: [foo, bar]\n max_in_flight: 2\n \n\n Here, ** 6 substeps ** will run in parallel, since all 3 of `var1` 's values can run in parallel, and 2 of `var3` 's values can run in parallel. fail_fast boolean Default `false` . When enabled, the `across` step will fail fast by returning as soon as any sub-step fails. This means that running steps will be interrupted and pending steps will no longer be scheduled.",
"items": {
"$ref": "#/definitions/across_var"
},
"type": "array"
},
"attempts": {
"$ref": "#/definitions/number",
"description": "@example Retrying a task \n The following will run the task and retry it up to 9 times (for a total of 10 attempts) if it fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n attempts: 10\n \n\n \n@example Retrying with a timeout \n When used in combination with `timeout` , the timeout applies to each step. This semi-arbitary decision was made because often things either succeed in a reasonable amount of time or fail due to hanging/flakiness. In this case it seems more useful to allow each attempt the allotted timeout rather than have one very long attempt prevent more attempts. \n\n \n plan:\n - get: flake\n - task: flaky-tests\n file: flake/integration.yml\n timeout: 10m\n attempts: 3"
},
"ensure": {
"$ref": "#/definitions/step",
"description": "@example Releasing a lock \n The following build plan acquires a lock and then `ensure` s that the lock is released. \n\n \n plan:\n - put: some-lock\n params: {acquire: true}\n - task: integration\n file: foo/integration.yml\n ensure:\n put: some-lock\n params: {release: some-lock}"
},
"in_parallel": {
"description": "Steps are either configured as a array or within an schema.in_parallel_config . \n@example Fetching artifacts in parallel \n Using the `in_parallel` step where possible is the easiest way to speeding up a builds. It is often used to fetch all dependent resources together at the start of a build plan: \n\n \n jobs:\n - name: get-in-parallel\n plan:\n - in_parallel:\n - get: ci\n - get: repo\n - get: code\n \n \n resources:\n - name: repo\n type: mock\n - name: code\n type: mock\n - name: ci\n type: mock\n \n\n \n@example Running a build matrix \n If any step in the `in_parallel` fails, the build will fail, making it useful for build matrices: \n\n \n plan:\n - get: some-repo\n - in_parallel:\n - task: unit-windows\n file: some-repo/ci/windows.yml\n - task: unit-linux\n file: some-repo/ci/linux.yml\n - task: unit-darwin\n file: some-repo/ci/darwin.yml",
"oneOf": [
{
"items": {
"$ref": "#/definitions/step"
},
"type": "array"
},
{
"$ref": "#/definitions/in_parallel_config"
}
]
},
"on_abort": {
"$ref": "#/definitions/step",
"description": "@example Cleaning up `on_abort`\n The following will perform the `cleanup` task only if the build is aborted while the `unit` task was running: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_abort:\n task: cleanup\n file: foo/cleanup.yml"
},
"on_error": {
"$ref": "#/definitions/step",
"description": "@example Sending a notification \n Until notifications become first-class ( RFC #28 https://github.com/concourse/rfcs/pull/28 , this step can be used to notify folks if their builds errored out: \n\n \n plan:\n - do:\n - get: ci\n - task: unit\n file: ci/unit.yml\n on_error:\n put: slack"
},
"on_failure": {
"$ref": "#/definitions/step",
"description": "@example Alerting on failure \n The following will perform the `alert` task only if the `unit` task fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_failure:\n task: alert\n file: foo/alert.yml"
},
"on_success": {
"$ref": "#/definitions/step",
"description": "@example Running on success \n The following will perform the second task only if the first one succeeds: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_success:\n task: alert\n file: foo/alert.yml\n \n\n Note that this is semantically equivalent to the following: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n - task: alert\n file: foo/alert.yml\n \n\n The `on_success` hook is provided mainly for cases where there is an equivalent schema.on_failure , and having them next to each other is more clear."
},
"tags": {
"description": "Default `[]` . \n@example Running in a private network \n You may have a private cluster only reachable by special workers running on-premises. To run steps against those workers, just provide a matching tag: \n\n \n plan:\n - get: my-repo\n - put: my-site\n tags: [private]\n params: {path: my-repo}\n - task: acceptance-tests\n tags: [private]\n file: my-repo/ci/acceptance.yml",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"timeout": {
"$ref": "#/definitions/duration",
"description": "@example Giving up \n The following will run the `unit` task and cancel it if it takes longer than 1 hour and 30 minutes: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n timeout: 1h30m"
}
},
"required": [
"in_parallel"
],
"type": "object"
},
"input": {
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/definitions/identifier",
"description": "The name of the input."
},
"optional": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . If `true` , then the input is not required by the task. The task may run even if this input is missing. An `optional` input that is missing will not appear in the current directory of the running task."
},
"path": {
"$ref": "#/definitions/dir_path",
"description": "The path where the input will be placed. If not specified, the input's `name` is used. Paths are relative to the working directory of the task. Absolute paths are not respected."
}
},
"required": [
"name"
],
"type": "object"
},
"job": {
"additionalProperties": false,
"properties": {
"build_log_retention": {
"$ref": "#/definitions/build_log_retention_policy",
"description": "Configures the retention policy for build logs. This is useful if you have a job that runs often but after some amount of time the logs aren't worth keeping around. Builds which are not retained by the configured policy will have their logs reaped. If this configuration is omitted, logs are kept forever (unless build-log-retention is configured globally). \n@example A complicated example \n The following example will keep logs for any builds that have completed in the last 2 days, while also keeping the last 1000 builds and at least 1 succeeded build. \n\n \n jobs:\n - name: smoke-tests\n build_log_retention:\n days: 2\n builds: 1000\n minimum_succeeded_builds: 1\n plan:\n - get: 10m\n - task: smoke-tests\n # ...\n \n\n If more than 1000 builds finish in the past 2 days, all of them will be retained thanks to the schema.build_log_retention_policy.days `days` configuration. Similarly, if there are 1000 builds spanning more than 2 days, they will also be kept thanks to the schema.build_log_retention_policy.builds `builds` configuration. And if they all happened to have failed, the schema.build_log_retention_policy.minimum_succeeded_builds `minimum_succeeded_builds` will keep around at least one successful build. All policies operate independently. build_log_retention_policy days number Keep logs for builds which have finished within the specified number of days. builds number Keep logs for the last specified number of builds. minimum_succeeded_builds number Keep a minimum number of successful build logs that would normally be reaped. Requires schema.build_log_retention_policy.builds `builds` to be set to an integer higher than 0 in order to work. For example, if schema.build_log_retention_policy.builds `builds` is set to 5, and this attribute to 1, say a job has the following build history: 7(f), 6(f), 5(f), 4(f), 3(f), 2(f), 1(s), where f means failed and s means succeeded, then builds 2 and 3 will be reaped, because it retains 5 build logs, and at least 1 succeeded build log. Default is 0."
},
"build_logs_to_retain": {
"$ref": "#/definitions/number",
"description": "Deprecated. Equivalent to setting schema.build_log_retention_policy.builds `job.build_log_retention.builds` ."
},
"disable_manual_trigger": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . If set to `true` , manual triggering of the job (via the web UI or fly-trigger-job ) will be disabled."
},
"ensure": {
"$ref": "#/definitions/step",
"description": "Step to execute regardless of whether the job succeeds, fails, errors, or aborts. Equivalent to the schema.ensure hook."
},
"interruptible": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . Normally, when a worker is shutting down it will wait for builds with containers running on that worker to finish before exiting. If this value is set to `true` , the worker will not wait on the builds of this job. You may want this if e.g. you have a self-deploying Concourse or long-running-but-low-importance jobs."
},
"max_in_flight": {
"$ref": "#/definitions/number",
"description": "If set, specifies a maximum number of builds to run at a time. If `serial` or `serial_groups` are set, they take precedence and force this value to be `1` ."
},
"name": {
"$ref": "#/definitions/identifier",
"description": "The name of the job. This should be short; it will show up in URLs."
},
"old_name": {
"$ref": "#/definitions/identifier",
"description": "The old name of the job. If configured, the history of old job will be inherited to the new one. Once the pipeline is set, this field can be removed as the builds have been transfered. \n@example Renaming a job \n This can be used to rename a job without losing its history, like so: \n\n \n jobs:\n - name: new-name\n old_name: current-name\n plan: [{get: 10m}]\n \n\n After the pipeline is set, because the builds have been inherited, the job can have the field removed: \n\n \n jobs:\n - name: new-name\n plan: [{get: 10m}]"
},
"on_abort": {
"$ref": "#/definitions/step",
"description": "Step to execute when the job aborts. Equivalent to the schema.on_abort hook."
},
"on_error": {
"$ref": "#/definitions/step",
"description": "Step to execute when the job errors. Equivalent to the schema.on_error hook."
},
"on_failure": {
"$ref": "#/definitions/step",
"description": "Step to execute when the job fails. Equivalent to the schema.on_failure hook."
},
"on_success": {
"$ref": "#/definitions/step",
"description": "Step to execute when the job succeeds. Equivalent to the schema.on_success hook."
},
"plan": {
"description": "The sequence of steps steps to execute.",
"items": {
"$ref": "#/definitions/step"
},
"type": "array"
},
"public": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . If set to `true` , the build log of this job will be viewable by unauthenticated users. Unauthenticated users will always be able to see the inputs, outputs, and build status history of a job. This is useful if you would like to expose your pipeline publicly without showing sensitive information in the build log. Note: when this is set to `true` , any get-step and put-step s will show the metadata for their resource version, regardless of whether the resource itself has set schema.resource.public to `true` ."
},
"serial": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . If set to `true` , builds will queue up and execute one-by-one, rather than executing in parallel."
},
"serial_groups": {
"description": "Default `[]` . When set to an array of arbitrary tag-like strings, builds of this job and other jobs referencing the same tags will be serialized. \n@example Limiting parallelism \n This can be used to ensure that certain jobs do not run at the same time, like so: \n\n \n jobs:\n - name: job-a\n serial_groups: [some-tag]\n - name: job-b\n serial_groups: [some-tag, some-other-tag]\n - name: job-c\n serial_groups: [some-other-tag]\n \n\n In this example, `job-a` and `job-c` can run concurrently, but neither job can run builds at the same time as `job-b` . The builds are executed in their order of creation, across all jobs with common tags.",
"items": {
"$ref": "#/definitions/identifier"
},
"type": "array"
}
},
"required": [
"name",
"plan"
],
"type": "object"
},
"load_var_step": {
"additionalProperties": false,
"properties": {
"across": {
"description": "Contains a list of schema.across_var . across_var var identifier The name of the variable that will be added to the local-vars \" `.` \" var source . This variable will only be accessible in the scope of the step - each iteration of the step gets its own scope. If a variable of the same name already exists in the parent scope, a warning will be printed. values [value] The list of values that the schema.across_var.var var will iterate over when running the substep. If multiple schema.across_var vars are configured, all combinations of values across all vars will run. The list of values may also be interpolated. For instance, you may use the load-var-step to first load a list of schema.value into a local-vars local var , and then iterate across that dynamic list of values. \n@example Value combinations \n The following schema.across will run the task `foo/build.yml` for each package defined in `foo/packages-to-build.json` with Go 1.15 and 1.16. \n\n \n plan:\n - get: foo\n - load_var: packages\n file: foo/packages-to-build.json\n - across:\n - var: package\n values: ((.:packages))\n - var: go_version\n values: ['1.15', '1.16']\n task: build\n file: foo/build.yml\n vars:\n go_version: ((.:go_version))\n package: ((.:package))\n \n\n Supposing `foo/packages-to-build.json` had the following content: \n\n \n [\"./cmd/first\", \"./cmd/second\", \"./cmd/third\"]\n \n\n ...then the task `foo/build.yml` would be run with the following var combinations: `{package: \"./cmd/first\", go_version: \"1.15\"}` `{package: \"./cmd/first\", go_version: \"1.16\"}` `{package: \"./cmd/second\", go_version: \"1.15\"}` `{package: \"./cmd/second\", go_version: \"1.16\"}` `{package: \"./cmd/third\", go_version: \"1.15\"}` `{package: \"./cmd/third\", go_version: \"1.16\"}` max_in_flight `all` | number Default `1` . If set to `all` , the substep will run with all combinations of the current var in parallel. If set to a schema.number , only that number of substeps may run in parallel. \n@example Multiple vars \n If multiple schema.across_var vars are configured, the effective `max_in_flight` is multiplicative. For instance: \n\n \n plan:\n - across:\n - var: var1\n values: [a, b, c]\n max_in_flight: all\n - var: var2\n values: [1, 2]\n - var: var3\n values: [foo, bar]\n max_in_flight: 2\n \n\n Here, ** 6 substeps ** will run in parallel, since all 3 of `var1` 's values can run in parallel, and 2 of `var3` 's values can run in parallel. fail_fast boolean Default `false` . When enabled, the `across` step will fail fast by returning as soon as any sub-step fails. This means that running steps will be interrupted and pending steps will no longer be scheduled.",
"items": {
"$ref": "#/definitions/across_var"
},
"type": "array"
},
"attempts": {
"$ref": "#/definitions/number",
"description": "@example Retrying a task \n The following will run the task and retry it up to 9 times (for a total of 10 attempts) if it fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n attempts: 10\n \n\n \n@example Retrying with a timeout \n When used in combination with `timeout` , the timeout applies to each step. This semi-arbitary decision was made because often things either succeed in a reasonable amount of time or fail due to hanging/flakiness. In this case it seems more useful to allow each attempt the allotted timeout rather than have one very long attempt prevent more attempts. \n\n \n plan:\n - get: flake\n - task: flaky-tests\n file: flake/integration.yml\n timeout: 10m\n attempts: 3"
},
"ensure": {
"$ref": "#/definitions/step",
"description": "@example Releasing a lock \n The following build plan acquires a lock and then `ensure` s that the lock is released. \n\n \n plan:\n - put: some-lock\n params: {acquire: true}\n - task: integration\n file: foo/integration.yml\n ensure:\n put: some-lock\n params: {release: some-lock}"
},
"file": {
"$ref": "#/definitions/file_path",
"description": "The path to a file whose content shall be read and used as the var's value."
},
"format": {
"description": "The format of the file's content. If unset, Concourse will try to detect the format from the file extension. If the file format cannot be determined, Concourse will fallback to `trim` . If set to `json` , `yaml` , or `yml` , the file content will be parsed accordingly and the resulting structure will be the value of the var. If set to `trim` , the var will be set to the content of the file with any trailing and leading whitespace removed. If set to `raw` , the var will be set to the content of the file without modification (i.e. with any existing whitespace). \n@example Loading a var with multiple fields \n Let's say we have a file with multiple fields, like this yaml file: yaml https://raw.githubusercontent.com/concourse/examples/master/pipelines/vars-file.yml We could pass these values to subsequent steps by loading it into a var with `load_var` , which will detect that it is in YAML format based on the file extension: \n\n \n jobs:\n - name: loading-vars\n plan:\n - get: examples\n - load_var: version\n file: examples/pipelines/vars-file.yml\n - put: img\n params:\n version: \"((.:version.hello))-((.:version.number))\"\n \n \n resources:\n - name: examples\n type: git\n icon: github\n source:\n uri: https://github.com/concourse/examples.git\n - name: img\n type: mock\n \n\n If the file `vars-file.yml` was generated in a task and printed these values, they would be automatically redacted unless schema.load-var.reveal `reveal: true` is set.",
"enum": [
"json",
"yaml",
"yml",
"trim",
"raw"
],
"type": "string"
},
"load_var": {
"$ref": "#/definitions/identifier",
"description": "The identifier will be the name of var, available to subsequent steps as a local-vars local build var . \n@example Loading a simple value as a var \n The following pipeline loads vars from a text file whose contents are used as a version number to put-step `put` . \n\n \n jobs:\n - name: loading-vars\n plan:\n - get: examples\n - load_var: version\n file: examples/misc/simple-value.txt\n - put: img\n params:\n version: ((.:version))\n \n \n resources:\n - name: examples\n type: git\n icon: github\n source:\n uri: https://github.com/concourse/examples.git\n - name: img\n type: mock\n \n\n `simple-value.txt` looks like this: https://raw.githubusercontent.com/concourse/examples/master/misc/simple-value.txt"
},
"on_abort": {
"$ref": "#/definitions/step",
"description": "@example Cleaning up `on_abort`\n The following will perform the `cleanup` task only if the build is aborted while the `unit` task was running: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_abort:\n task: cleanup\n file: foo/cleanup.yml"
},
"on_error": {
"$ref": "#/definitions/step",
"description": "@example Sending a notification \n Until notifications become first-class ( RFC #28 https://github.com/concourse/rfcs/pull/28 , this step can be used to notify folks if their builds errored out: \n\n \n plan:\n - do:\n - get: ci\n - task: unit\n file: ci/unit.yml\n on_error:\n put: slack"
},
"on_failure": {
"$ref": "#/definitions/step",
"description": "@example Alerting on failure \n The following will perform the `alert` task only if the `unit` task fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_failure:\n task: alert\n file: foo/alert.yml"
},
"on_success": {
"$ref": "#/definitions/step",
"description": "@example Running on success \n The following will perform the second task only if the first one succeeds: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_success:\n task: alert\n file: foo/alert.yml\n \n\n Note that this is semantically equivalent to the following: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n - task: alert\n file: foo/alert.yml\n \n\n The `on_success` hook is provided mainly for cases where there is an equivalent schema.on_failure , and having them next to each other is more clear."
},
"reveal": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . If set to `true` , allow the var's content to be printed in the build output even with secret redaction enabled."
},
"tags": {
"description": "Default `[]` . \n@example Running in a private network \n You may have a private cluster only reachable by special workers running on-premises. To run steps against those workers, just provide a matching tag: \n\n \n plan:\n - get: my-repo\n - put: my-site\n tags: [private]\n params: {path: my-repo}\n - task: acceptance-tests\n tags: [private]\n file: my-repo/ci/acceptance.yml",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"timeout": {
"$ref": "#/definitions/duration",
"description": "@example Giving up \n The following will run the `unit` task and cancel it if it takes longer than 1 hour and 30 minutes: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n timeout: 1h30m"
}
},
"required": [
"file",
"load_var"
],
"type": "object"
},
"number": {
"type": "number"
},
"output": {
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/definitions/identifier",
"description": "The name of the output. The contents under `path` will be made available to the rest of the plan under this name."
},
"path": {
"$ref": "#/definitions/dir_path",
"description": "The path to a directory where the output will be taken from. If not specified, the output's `name` is used. Paths are relative to the working directory of the task. Absolute paths are not respected."
}
},
"required": [
"name"
],
"type": "object"
},
"pipeline": {
"additionalProperties": false,
"properties": {
"display": {
"$ref": "#/definitions/display_config",
"description": "`display` was introduced in Concourse v6.6.0. It is considered an ** experimental ** feature. Visual configurations for personalizing your pipeline. \n@example Background image \n The following example will display an image in the background of the pipeline it is configured on. \n\n \n display:\n background_image: https://avatars1.githubusercontent.com/u/7809479?s=400&v=4\n \n\n display_config background_image string Allow users to specify a custom background image which is put at 30% opacity, grayscaled and blended into existing background. Must be an http, https, or relative URL."
},
"groups": {
"description": "A list of job groups to use for organizing jobs in the web UI. Groups have no functional effect on your pipeline. They are purely for making it easier to grok large pipelines in the web UI. Note: once you have added groups to your pipeline, all jobs must be in a group. \n@example Grouping jobs \n The following example will make the \"tests\" group the default view (since it's listed first), separating the later jobs into a \"publish\" group: \n\n \n groups:\n - name: test\n jobs:\n - unit\n - integration\n - name: publish\n jobs:\n - deploy\n - shipit\n \n\n This would display two tabs at the top of the home page: \"test\" and \"publish\". For a real world example of how groups can be used to simplify navigation and provide logical grouping, see the groups used at the top of the page in the Concourse pipeline https://ci.concourse-ci.org . group_config name identifier A unique name for the group. This should be short and simple as it will be used as the tab name for navigation. jobs [job.name] A list of jobs that should appear in this group. A job may appear in multiple groups. Neighbours of jobs in the current group will also appear on the same page in order to give context of the location of the group in the pipeline. You may also use any valid glob https://www.man7.org/linux/man-pages/man7/glob.7.html to represent several jobs, e.g.: \n\n \n groups:\n - name: develop\n jobs:\n - terraform-*\n - test\n - deploy-{dev,staging}\n - name: ship\n jobs:\n - deploy-prod\n - name: all\n jobs:\n - \"*\"\n \n\n In this example, the `develop` group will match `terraform-apply` , `terraform-destroy` , `test` , `deploy-dev` , `deploy-staging` . The `ship` group will only match `deploy-prod` . The `all` group will match all jobs in the pipeline. Note that depending on how it's used, `*` , `{` , and `}` have special meaning in YAML, and may need to be quoted (as was done in the `all` job above)",
"items": {
"$ref": "#/definitions/group_config"
},
"type": "array"
},
"jobs": {
"description": "A set of jobs jobs for the pipeline to continuously schedule. At least one job is required for a pipeline to be valid.",
"items": {
"$ref": "#/definitions/job"
},
"type": "array"
},
"resource_types": {
"description": "A set of resource-types resource types for resources within the pipeline to use.",
"items": {
"$ref": "#/definitions/resource_type"
},
"type": "array"
},
"resources": {
"description": "A set of resources resources for the pipeline to continuously check.",
"items": {
"$ref": "#/definitions/resource"
},
"type": "array"
},
"var_sources": {
"description": "A set of var-sources for the pipeline to use.",
"items": {
"$ref": "#/definitions/var_source"
},
"type": "array"
}
},
"required": [
"jobs"
],
"type": "object"
},
"put_step": {
"additionalProperties": false,
"properties": {
"across": {
"description": "Contains a list of schema.across_var . across_var var identifier The name of the variable that will be added to the local-vars \" `.` \" var source . This variable will only be accessible in the scope of the step - each iteration of the step gets its own scope. If a variable of the same name already exists in the parent scope, a warning will be printed. values [value] The list of values that the schema.across_var.var var will iterate over when running the substep. If multiple schema.across_var vars are configured, all combinations of values across all vars will run. The list of values may also be interpolated. For instance, you may use the load-var-step to first load a list of schema.value into a local-vars local var , and then iterate across that dynamic list of values. \n@example Value combinations \n The following schema.across will run the task `foo/build.yml` for each package defined in `foo/packages-to-build.json` with Go 1.15 and 1.16. \n\n \n plan:\n - get: foo\n - load_var: packages\n file: foo/packages-to-build.json\n - across:\n - var: package\n values: ((.:packages))\n - var: go_version\n values: ['1.15', '1.16']\n task: build\n file: foo/build.yml\n vars:\n go_version: ((.:go_version))\n package: ((.:package))\n \n\n Supposing `foo/packages-to-build.json` had the following content: \n\n \n [\"./cmd/first\", \"./cmd/second\", \"./cmd/third\"]\n \n\n ...then the task `foo/build.yml` would be run with the following var combinations: `{package: \"./cmd/first\", go_version: \"1.15\"}` `{package: \"./cmd/first\", go_version: \"1.16\"}` `{package: \"./cmd/second\", go_version: \"1.15\"}` `{package: \"./cmd/second\", go_version: \"1.16\"}` `{package: \"./cmd/third\", go_version: \"1.15\"}` `{package: \"./cmd/third\", go_version: \"1.16\"}` max_in_flight `all` | number Default `1` . If set to `all` , the substep will run with all combinations of the current var in parallel. If set to a schema.number , only that number of substeps may run in parallel. \n@example Multiple vars \n If multiple schema.across_var vars are configured, the effective `max_in_flight` is multiplicative. For instance: \n\n \n plan:\n - across:\n - var: var1\n values: [a, b, c]\n max_in_flight: all\n - var: var2\n values: [1, 2]\n - var: var3\n values: [foo, bar]\n max_in_flight: 2\n \n\n Here, ** 6 substeps ** will run in parallel, since all 3 of `var1` 's values can run in parallel, and 2 of `var3` 's values can run in parallel. fail_fast boolean Default `false` . When enabled, the `across` step will fail fast by returning as soon as any sub-step fails. This means that running steps will be interrupted and pending steps will no longer be scheduled.",
"items": {
"$ref": "#/definitions/across_var"
},
"type": "array"
},
"attempts": {
"$ref": "#/definitions/number",
"description": "@example Retrying a task \n The following will run the task and retry it up to 9 times (for a total of 10 attempts) if it fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n attempts: 10\n \n\n \n@example Retrying with a timeout \n When used in combination with `timeout` , the timeout applies to each step. This semi-arbitary decision was made because often things either succeed in a reasonable amount of time or fail due to hanging/flakiness. In this case it seems more useful to allow each attempt the allotted timeout rather than have one very long attempt prevent more attempts. \n\n \n plan:\n - get: flake\n - task: flaky-tests\n file: flake/integration.yml\n timeout: 10m\n attempts: 3"
},
"ensure": {
"$ref": "#/definitions/step",
"description": "@example Releasing a lock \n The following build plan acquires a lock and then `ensure` s that the lock is released. \n\n \n plan:\n - put: some-lock\n params: {acquire: true}\n - task: integration\n file: foo/integration.yml\n ensure:\n put: some-lock\n params: {release: some-lock}"
},
"get_params": {
"$ref": "#/definitions/config",
"description": "Arbitrary configuration to pass to the resource during the implicit `get` step. Refer to the resource type's documentation to see what it supports. \n@example Parameterizing the implicit `get`\n You can control the settings of the implicit `get` step by setting `get_params` . For example, if you did not want a `put` step utilizing the `registry-image` resource type https://github.com/concourse/registry-image-resource to download the image, you would implement your `put` step as such: \n\n \n plan:\n - put: app-image\n params:\n build: git-resource\n get_params:\n skip_download: true"
},
"inputs": {
"description": "Default `all` . When not set, or set to `all` , all artifacts will be provided. This can result in slow performance if the prior steps in the build plan register a bunch of large artifacts before this step, so you may want to consider being explicit. If configured as a list of identifiers, only the listed artifacts will be provided to the container. If set to `detect` , the artifacts are detected based on the configured schema.put.params by looking for all string values and using the first path segment as an identifier. (This may become the default in the future.) \n@example Put Input Methods \n \n\n \n jobs:\n - name: put-input-methods\n plan:\n - in_parallel:\n - get: repo-dev\n - get: repo-master\n - get: app-image\n - get: ci\n - put: all-inputs\n resource: repo\n inputs: all # default option\n params:\n file: ci/version.txt\n - put: detect-inputs\n resource: repo\n inputs: detect # will only stream the \"ci\" artifact\n params:\n file: ci/version.txt\n - put: explicit-inputs\n resource: repo\n inputs: # explicitly list artifacts to stream to put step\n - ci\n params:\n file: ci/version.txt\n \n resources:\n - name: repo\n type: mock\n - name: repo-dev\n type: mock\n - name: repo-master\n type: mock\n - name: app-image\n type: mock\n - name: ci\n type: mock\n source:\n create_files:\n version.txt: \"42\"",
"oneOf": [
{
"enum": [
"all"
],
"type": "string"
},
{
"enum": [
"detect"
],
"type": "string"
},
{
"items": {
"$ref": "#/definitions/identifier"
},
"type": "array"
}
]
},
"on_abort": {
"$ref": "#/definitions/step",
"description": "@example Cleaning up `on_abort`\n The following will perform the `cleanup` task only if the build is aborted while the `unit` task was running: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_abort:\n task: cleanup\n file: foo/cleanup.yml"
},
"on_error": {
"$ref": "#/definitions/step",
"description": "@example Sending a notification \n Until notifications become first-class ( RFC #28 https://github.com/concourse/rfcs/pull/28 , this step can be used to notify folks if their builds errored out: \n\n \n plan:\n - do:\n - get: ci\n - task: unit\n file: ci/unit.yml\n on_error:\n put: slack"
},
"on_failure": {
"$ref": "#/definitions/step",
"description": "@example Alerting on failure \n The following will perform the `alert` task only if the `unit` task fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_failure:\n task: alert\n file: foo/alert.yml"
},
"on_success": {
"$ref": "#/definitions/step",
"description": "@example Running on success \n The following will perform the second task only if the first one succeeds: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_success:\n task: alert\n file: foo/alert.yml\n \n\n Note that this is semantically equivalent to the following: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n - task: alert\n file: foo/alert.yml\n \n\n The `on_success` hook is provided mainly for cases where there is an equivalent schema.on_failure , and having them next to each other is more clear."
},
"params": {
"$ref": "#/definitions/config",
"description": "Arbitrary configuration to pass to the resource. Refer to the resource type's documentation to see what it supports. \n@example Putting with params \n \n\n \n jobs:\n - name: resource-params\n plan:\n - put: cyberdeck\n params:\n version: \"made-via-params\"\n \n resources:\n - name: cyberdeck\n type: mock"
},
"put": {
"description": "When the step succeeds, the version by the step will be immediately fetched via an additional implicit get-step . This is so that later steps in your plan can use the artifact that was produced. The artifact will be available under the identifier `put` specifies. \n@example Getting and Putting \n The following plan fetches a version using get-step `get` and pushes it to another resource using put-step `put` : \n\n \n jobs:\n - name: get-and-pull\n plan:\n - get: the-ice\n - put: cyberdeck\n params:\n file: the-ice/version.txt\n \n resources:\n - name: the-ice\n type: mock\n source:\n create_files:\n version.txt: \"made-via-source\"\n - name: cyberdeck\n type: mock",
"oneOf": [
{
"$ref": "#/definitions/string"
},
{
"$ref": "#/definitions/identifier"
}
]
},
"resource": {
"$ref": "#/definitions/string",
"description": "Defaults to the value of `put` . The resource to update, as configured in schema.pipeline.resources . \n@example Re-label Put Resource \n \n\n \n jobs:\n - name: fetch-repo\n plan:\n # puts to \"repo\" and fetches new version under artifact name \"thecode\"\n - put: thecode\n resource: repo\n params:\n version: put-only\n - task: ls-repo\n config:\n platform: linux\n image_resource:\n type: mock\n source: {mirror_self: true}\n # pass the \"thecode\" artifact into the task\n inputs:\n - name: thecode\n run:\n path: ls\n args: [\"-lah\",\"thecode\"]\n \n resources:\n - name: repo\n type: mock"
},
"tags": {
"description": "Default `[]` . \n@example Running in a private network \n You may have a private cluster only reachable by special workers running on-premises. To run steps against those workers, just provide a matching tag: \n\n \n plan:\n - get: my-repo\n - put: my-site\n tags: [private]\n params: {path: my-repo}\n - task: acceptance-tests\n tags: [private]\n file: my-repo/ci/acceptance.yml",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"timeout": {
"$ref": "#/definitions/duration",
"description": "@example Giving up \n The following will run the `unit` task and cancel it if it takes longer than 1 hour and 30 minutes: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n timeout: 1h30m"
}
},
"required": [
"put"
],
"type": "object"
},
"resource": {
"additionalProperties": false,
"properties": {
"check_every": {
"description": "Default `1m` . The interval on which to check for new versions of the resource. Acceptable interval options are defined by the time.ParseDuration function https://golang.org/pkg/time/#ParseDuration . If set to `never` the resource will not be automatically checked. The resource can still be checked manually via the web UI, fly, or webhooks.",
"oneOf": [
{
"$ref": "#/definitions/duration"
},
{
"enum": [
"never"
],
"type": "string"
}
]
},
"check_timeout": {
"$ref": "#/definitions/duration",
"description": "Default `1h` . The time limit on checking new versions of resources. Acceptable interval options are defined by the time.ParseDuration function https://golang.org/pkg/time/#ParseDuration ."
},
"expose_build_created_by": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . If set to `true` , environment variable resource-metadata `BUILD_CREATED_BY` will be available in the metadata of a get-step get step or put-step put step ."
},
"icon": {
"$ref": "#/definitions/string",
"description": "The name of a Material Design icon https://materialdesignicons.com/ to show next to the resource name in the web UI. For example, `github` ."
},
"name": {
"$ref": "#/definitions/identifier",
"description": "The name of the resource. This should be short and simple. This name will be referenced by build-plans build plans of jobs in the pipeline."
},
"old_name": {
"$ref": "#/definitions/identifier",
"description": "The old name of the resource. If configured, the history of the old resource will be inherited to the new one. Once the pipeline is set, this field can be removed as the history has been transferred. \n@example Renaming a resource \n This can be used to rename a resource without losing its history, like so: \n\n \n resources:\n - name: new-name\n old_name: current-name\n type: git\n source: {uri: \"https://github.com/vito/booklit\"}\n \n\n After the pipeline is set, the resource was successfully renamed, so the `old_name` field can be removed from the resource: \n\n \n resources:\n - name: new-name\n type: git\n source: {uri: \"https://github.com/vito/booklit\"}"
},
"public": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . If set to `true` , the metadata for each version of the resource will be viewable by unauthenticated users (assuming the pipeline has been exposing exposed ). Resource metadata should never contain credentials or secret information, but this is off by default just to be safe in case users don't want to show things like commit messages and authors to the public. Note: even when set to `false` , the versions identifiers will be visible. In addition, if a resource is fetched in a build whose job is marked schema.job.public , metadata will be visible in the build output."
},
"source": {
"$ref": "#/definitions/config",
"description": "The configuration for the resource. This varies by resource type, and is a black box to Concourse; it is blindly passed to the resource at runtime. To use `git` as an example, the source may contain the repo URI, the branch of the repo to track, and a private key to use when pushing/pulling. By convention, documentation for each resource type's configuration is in each implementation's `README` . You can find the source for the resource types provided with Concourse at the Concourse GitHub organization https://github.com/concourse?q=-resource ."
},
"tags": {
"description": "Default `[]` . A list of tags to determine which workers the checks will be performed on. You'll want to specify this if the source is internal to a worker's network, for example. This does not apply tags to all get-step get steps or put-step put steps that use the resource. If you want these steps to use tags, you must set schema.tags for each step.",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"type": {
"$ref": "#/definitions/string",
"description": "The resource-types resource type implementing the resource."
},
"version": {
"$ref": "#/definitions/version",
"description": "A version to pin the resource to across the pipeline. This has the same effect as setting schema.get.version on every get-step referencing the resource. Resources can also be temporarily pinned to a version via the API and web UI. However this functionality is disabled if the resource is pinned via configuration, and if a pipeline is configured to have a version pinned while also pinned in the web UI, the configuration takes precedence and will clear out the temporary pin."
},
"webhook_token": {
"$ref": "#/definitions/string",
"description": "If specified, web hooks can be sent to trigger an immediate check of the resource, specifying this value as a primitive form of authentication via query params. After configuring this value, you would then configure your hook sender with the following painfully long path appended to your external URL: `\n /api/v1/teams/TEAM_NAME/pipelines/PIPELINE_NAME/resources/RESOURCE_NAME/check/webhook?webhook_token=WEBHOOK_TOKEN\n ` For managing-instanced-pipelines instance pipelines you will need to include the pipeline vars for a single pipeline instance. Currently you can not have webhooks for all instances of a pipeline. The pipeline vars should be added to the webhook URL as URL parameters https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_is_a_URL#parameters with the format `vars.MY-VAR=\"SOME-VALUE\"` . A webhook URL for a pipeline instance may look like this: `\n /api/v1/teams/TEAM_NAME/pipelines/PIPELINE_NAME/resources/RESOURCE_NAME/check/webhook?webhook_token=WEBHOOK_TOKEN&vars.my-var=\"some-value\"&vars.second-var=\"two\"\n ` Note that the request payload sent to this API endpoint is entirely ignored. You should configure the resource as if you're not using web hooks, as the resource schema.resource.source config is still the \"source of truth.\""
}
},
"required": [
"name",
"source",
"type"
],
"type": "object"
},
"resource_type": {
"additionalProperties": false,
"properties": {
"check_every": {
"$ref": "#/definitions/duration",
"description": "Default `1m` . The interval on which to check for new versions of the resource type. Acceptable interval options are defined by the time.ParseDuration function https://golang.org/pkg/time/#ParseDuration ."
},
"defaults": {
"$ref": "#/definitions/config",
"description": "The default configuration for the resource type. This varies by resource type, and is a black box to Concourse; it is merged with (duplicate fields are overwritten by) schema.resource.source and passed to the resource at runtime. \n@example Setting default configuration for resources \n \n\n \n resource_types:\n - name: gcs\n type: registry-image\n source:\n repository: frodenas/gcs-resource\n defaults:\n json_key: ((default_key))\n \n resources:\n - name: bucket-a\n type: gcs\n source:\n bucket: a\n \n - name: bucket-b\n type: gcs\n source:\n bucket: b\n \n - name: bucket-c\n type: gcs\n source:\n bucket: c\n json_key: ((different_key))\n \n\n \n@example Overriding default resource types \n Since it's possible to overwrite the base resource types, it can be used to give defaults to resources at the pipeline level. \n\n \n resource_types:\n - name: registry-image\n type: registry-image\n source:\n repository: concourse/registry-image-resource\n defaults:\n registry_mirror:\n host: https://registry.mirror.example.com\n \n resources:\n - name: mirrored-image\n type: registry-image\n source:\n repository: busybox\n \n\n Alternatively, the web node can be configured to use resource-defaults defaults for base resource types"
},
"name": {
"$ref": "#/definitions/identifier",
"description": "The name of the resource type. This should be short and simple. This name will be referenced by schema.pipeline.resources defined within the same pipeline, and schema.task-config.image_resource s used by tasks running in the pipeline. Pipeline-provided resource types can override the core resource types by specifying the same name."
},
"params": {
"$ref": "#/definitions/config",
"description": "Arbitrary config to pass when running the `get` to fetch the resource type's image."
},
"privileged": {
"$ref": "#/definitions/boolean",
"description": "Default `false` . If set to `true` , the resource's containers will be run with full capabilities, as determined by the worker backend the task runs on. For Linux-based backends it typically determines whether or not the container will run in a separate user namespace, and whether the `root` user is \"actual\" `root` (if set to `true` ) or a user namespaced `root` (if set to `false` , the default). This is a gaping security hole; only configure it if the resource type needs it (which should be called out in its documentation). This is not up to the resource type to decide dynamically, so as to prevent privilege escalation via third-party resource type exploits."
},
"source": {
"$ref": "#/definitions/config",
"description": "The configuration for the resource type's resource. This varies by resource type, and is a black box to Concourse; it is blindly passed to the resource at runtime. To use `registry-image` as an example, the source would contain something like `repository: username/reponame` . See the Registry Image resource https://github.com/concourse/registry-image-resource (or whatever resource type your resource type uses) for more information."
},
"tags": {
"description": "Default `[]` . A list of tags to determine which workers the checks will be performed on. You'll want to specify this if the source is internal to a worker's network, for example. See also schema.tags .",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"type": {
"description": "The type of the resource used to provide the resource type's container image. This is a bit meta. Usually this value will be `registry-image` as the resource type must result in a container image. A resource type's type can refer to other resource types, and can also use the core type that it's overriding. This is useful for bringing in a newer or forked `registry-image` resource.",
"oneOf": [
{
"$ref": "#/definitions/string"
},
{
"$ref": "#/definitions/identifier"
}
]
}
},
"required": [
"name",
"source",
"type"
],
"type": "object"
},
"set_pipeline_step": {
"additionalProperties": false,
"properties": {
"across": {
"description": "Contains a list of schema.across_var . across_var var identifier The name of the variable that will be added to the local-vars \" `.` \" var source . This variable will only be accessible in the scope of the step - each iteration of the step gets its own scope. If a variable of the same name already exists in the parent scope, a warning will be printed. values [value] The list of values that the schema.across_var.var var will iterate over when running the substep. If multiple schema.across_var vars are configured, all combinations of values across all vars will run. The list of values may also be interpolated. For instance, you may use the load-var-step to first load a list of schema.value into a local-vars local var , and then iterate across that dynamic list of values. \n@example Value combinations \n The following schema.across will run the task `foo/build.yml` for each package defined in `foo/packages-to-build.json` with Go 1.15 and 1.16. \n\n \n plan:\n - get: foo\n - load_var: packages\n file: foo/packages-to-build.json\n - across:\n - var: package\n values: ((.:packages))\n - var: go_version\n values: ['1.15', '1.16']\n task: build\n file: foo/build.yml\n vars:\n go_version: ((.:go_version))\n package: ((.:package))\n \n\n Supposing `foo/packages-to-build.json` had the following content: \n\n \n [\"./cmd/first\", \"./cmd/second\", \"./cmd/third\"]\n \n\n ...then the task `foo/build.yml` would be run with the following var combinations: `{package: \"./cmd/first\", go_version: \"1.15\"}` `{package: \"./cmd/first\", go_version: \"1.16\"}` `{package: \"./cmd/second\", go_version: \"1.15\"}` `{package: \"./cmd/second\", go_version: \"1.16\"}` `{package: \"./cmd/third\", go_version: \"1.15\"}` `{package: \"./cmd/third\", go_version: \"1.16\"}` max_in_flight `all` | number Default `1` . If set to `all` , the substep will run with all combinations of the current var in parallel. If set to a schema.number , only that number of substeps may run in parallel. \n@example Multiple vars \n If multiple schema.across_var vars are configured, the effective `max_in_flight` is multiplicative. For instance: \n\n \n plan:\n - across:\n - var: var1\n values: [a, b, c]\n max_in_flight: all\n - var: var2\n values: [1, 2]\n - var: var3\n values: [foo, bar]\n max_in_flight: 2\n \n\n Here, ** 6 substeps ** will run in parallel, since all 3 of `var1` 's values can run in parallel, and 2 of `var3` 's values can run in parallel. fail_fast boolean Default `false` . When enabled, the `across` step will fail fast by returning as soon as any sub-step fails. This means that running steps will be interrupted and pending steps will no longer be scheduled.",
"items": {
"$ref": "#/definitions/across_var"
},
"type": "array"
},
"attempts": {
"$ref": "#/definitions/number",
"description": "@example Retrying a task \n The following will run the task and retry it up to 9 times (for a total of 10 attempts) if it fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n attempts: 10\n \n\n \n@example Retrying with a timeout \n When used in combination with `timeout` , the timeout applies to each step. This semi-arbitary decision was made because often things either succeed in a reasonable amount of time or fail due to hanging/flakiness. In this case it seems more useful to allow each attempt the allotted timeout rather than have one very long attempt prevent more attempts. \n\n \n plan:\n - get: flake\n - task: flaky-tests\n file: flake/integration.yml\n timeout: 10m\n attempts: 3"
},
"ensure": {
"$ref": "#/definitions/step",
"description": "@example Releasing a lock \n The following build plan acquires a lock and then `ensure` s that the lock is released. \n\n \n plan:\n - put: some-lock\n params: {acquire: true}\n - task: integration\n file: foo/integration.yml\n ensure:\n put: some-lock\n params: {release: some-lock}"
},
"file": {
"$ref": "#/definitions/file_path",
"description": "The path to the pipeline's configuration file. `file` points at a `.yml` file containing the pipeline configuration, which allows this to be tracked with your resources or generated by a task-step . The first segment in the path should refer to another artifact from the plan, and the rest of the path is relative to that artifact. \n@example Fetching and configuring a pipeline \n The get-step can be used to fetch your configuration from a `git` repo and auto-configure it using a set-pipeline-step : \n\n \n jobs:\n - name: set-pipeline\n plan:\n - get: examples\n trigger: true\n - set_pipeline: hello-world # pipeline's name\n file: examples/pipelines/hello-world.yml # pipeline's config\n \n resources:\n - name: examples\n type: git\n icon: github\n source:\n uri: https://github.com/concourse/examples.git"
},
"instance_vars": {
"$ref": "#/definitions/vars",
"description": "A map of instance vars used to identify instanced-pipelines instanced pipelines . These vars will also be pipeline-static-vars interpolated into the pipeline config . Note that variables set with this field will not propagate to tasks configured via schema.task.file . If you want those variables to be determined at the time the pipeline is set, use schema.task.vars as well. instanced-pipelines Instance pipelines are experimental and need to be enabled by setting the `--enable-pipeline-instances` flag on the web-node . \n@example Configuring instance vars \n The following pipeline will create one instance group with three pipelines. The instance group is called `my-bots` and each pipeline has a different set of `instance_vars` making it distinct from the other pipelines in the instance group. \n\n \n jobs:\n - name: set-pipeline-instance-group\n plan:\n - get: examples\n - in_parallel:\n - set_pipeline: my-bots\n file: examples/pipelines/pipeline-vars.yml\n instance_vars:\n first: initial\n number: \"9000\"\n hello: HAL\n - set_pipeline: my-bots\n file: examples/pipelines/pipeline-vars.yml\n instance_vars:\n first: second\n number: \"3000\"\n hello: WALLY-E\n - set_pipeline: my-bots\n file: examples/pipelines/pipeline-vars.yml\n instance_vars:\n first: the-third\n number: \"6000\"\n hello: R2D2\n \n resources:\n - name: examples\n type: git\n icon: github\n source:\n uri: https://github.com/concourse/examples.git\n \n\n \n@example Configuring instance vars and vars \n Both `instance_vars` and `vars` may be statically. The difference between the two fields is that `instance_vars` are used to identify a pipeline and render the pipeline config. `vars` are only used for rendering the pipeline config: \n\n \n jobs:\n - name: set-pipeline-vars-and-instance-vars\n plan:\n - get: examples\n - set_pipeline: my-bots\n file: examples/pipelines/pipeline-vars.yml\n instance_vars:\n first: initial\n number: \"9000\"\n vars:\n hello: HAL\n \n resources:\n - name: examples\n type: git\n icon: github\n source:\n uri: https://github.com/concourse/examples.git"
},
"on_abort": {
"$ref": "#/definitions/step",
"description": "@example Cleaning up `on_abort`\n The following will perform the `cleanup` task only if the build is aborted while the `unit` task was running: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_abort:\n task: cleanup\n file: foo/cleanup.yml"
},
"on_error": {
"$ref": "#/definitions/step",
"description": "@example Sending a notification \n Until notifications become first-class ( RFC #28 https://github.com/concourse/rfcs/pull/28 , this step can be used to notify folks if their builds errored out: \n\n \n plan:\n - do:\n - get: ci\n - task: unit\n file: ci/unit.yml\n on_error:\n put: slack"
},
"on_failure": {
"$ref": "#/definitions/step",
"description": "@example Alerting on failure \n The following will perform the `alert` task only if the `unit` task fails: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_failure:\n task: alert\n file: foo/alert.yml"
},
"on_success": {
"$ref": "#/definitions/step",
"description": "@example Running on success \n The following will perform the second task only if the first one succeeds: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n on_success:\n task: alert\n file: foo/alert.yml\n \n\n Note that this is semantically equivalent to the following: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n - task: alert\n file: foo/alert.yml\n \n\n The `on_success` hook is provided mainly for cases where there is an equivalent schema.on_failure , and having them next to each other is more clear."
},
"set_pipeline": {
"description": "The identifier specifies the name of the pipeline to configure. Unless schema.set-pipeline.team is set, it will be configured within the current team and be created unpaused . If set to `self` , the current pipeline will update its own config. `set_pipeline: self` was introduced in Concourse v6.5.0. It is considered an ** experimental ** feature and may be removed at any time. Contribute to the associated discussion https://github.com/concourse/concourse/discussions/5732 with feedback. \n@example One pipeline configuring another \n This is a way to ensure a pipeline stays up to date with its definition in a source code repository, eliminating the need to manually run fly-set-pipeline . \n\n \n jobs:\n - name: set-pipeline\n plan:\n - get: examples\n trigger: true\n - set_pipeline: hello-world # pipeline's name\n file: examples/pipelines/hello-world.yml # pipeline's config\n \n resources:\n - name: examples\n type: git\n icon: github\n source:\n uri: https://github.com/concourse/examples.git",
"oneOf": [
{
"$ref": "#/definitions/identifier"
},
{
"enum": [
"self"
],
"type": "string"
}
]
},
"tags": {
"description": "Default `[]` . \n@example Running in a private network \n You may have a private cluster only reachable by special workers running on-premises. To run steps against those workers, just provide a matching tag: \n\n \n plan:\n - get: my-repo\n - put: my-site\n tags: [private]\n params: {path: my-repo}\n - task: acceptance-tests\n tags: [private]\n file: my-repo/ci/acceptance.yml",
"items": {
"$ref": "#/definitions/string"
},
"type": "array"
},
"team": {
"$ref": "#/definitions/identifier",
"description": "By default, the `set_pipeline` step sets the pipeline for the same teams team that is running the build. The `team` attribute can be used to specify another team. Only the main-team is allowed to set another team's pipeline. Any team other than the main-team using the `team` attribute will error, unless they reference their own team. The `team` attribute was introduced in Concourse v6.4.0. It is considered an ** experimental ** feature and may be removed at any time. Contribute to the associated discussion https://github.com/concourse/concourse/discussions/5731 with feedback. \n@example Setting a pipeline on another team \n \n\n \n jobs:\n - name: set-pipeline\n plan:\n - get: examples\n trigger: true\n - set_pipeline: hello-world\n file: examples/pipelines/hello-world.yml\n team: other-team # name of the team goes here\n \n resources:\n - name: examples\n type: git\n icon: github\n source:\n uri: https://github.com/concourse/examples.git"
},
"timeout": {
"$ref": "#/definitions/duration",
"description": "@example Giving up \n The following will run the `unit` task and cancel it if it takes longer than 1 hour and 30 minutes: \n\n \n plan:\n - get: foo\n - task: unit\n file: foo/unit.yml\n timeout: 1h30m"
},
"var_files": {
"description": "A list of paths to `.yml` files that will be passed to the pipeline config in the same manner as the `--load-vars-from` flag to fly-set-pipeline . This means that if a variable appears in multiple files, the value from a file that is passed later in the list will override the values from files earlier in the list. \n@example Configuring static vars with a vars file \n Where the vars file looks like: yaml https://raw.githubusercontent.com/concourse/examples/master/pipelines/vars-file.yml And the pipeline config is: \n\n \n jobs:\n - name: set-pipeline-vars-only\n plan:\n - get: examples\n - set_pipeline: pipeline-set-with-vars\n file: examples/pipelines/pipeline-vars.yml\n var_files:\n - examples/pipelines/vars-file.yml\n \n resources:\n - name: examples\n type: git\n icon: github\n source:\n uri: https://github.com/concourse/examples.git",
"items": {