forked from argoproj/argo-workflows
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.json
806 lines (806 loc) · 36.2 KB
/
swagger.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
{
"swagger": "2.0",
"info": {
"title": "Argo",
"version": "v2.0.0"
},
"paths": {},
"definitions": {
"io.argoproj.workflow.v1alpha1.Arguments": {
"description": "Arguments to a template",
"properties": {
"artifacts": {
"description": "Artifacts is the list of artifacts to pass to the template or workflow",
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Artifact"
}
},
"parameters": {
"description": "Parameters is the list of parameters to pass to the template or workflow",
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Parameter"
}
}
}
},
"io.argoproj.workflow.v1alpha1.Artifact": {
"description": "Artifact indicates an artifact to place at a specified path",
"required": [
"name"
],
"properties": {
"artifactory": {
"description": "Artifactory contains artifactory artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ArtifactoryArtifact"
},
"from": {
"description": "From allows an artifact to reference an artifact from a previous step",
"type": "string"
},
"git": {
"description": "Git contains git artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.GitArtifact"
},
"http": {
"description": "HTTP contains HTTP artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.HTTPArtifact"
},
"mode": {
"description": "mode bits to use on this file, must be a value between 0 and 0777 set when loading input artifacts.",
"type": "integer",
"format": "int32"
},
"name": {
"description": "name of the artifact. must be unique within a template's inputs/outputs.",
"type": "string"
},
"path": {
"description": "Path is the container path to the artifact",
"type": "string"
},
"raw": {
"description": "Raw contains raw artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.RawArtifact"
},
"s3": {
"description": "S3 contains S3 artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.S3Artifact"
}
}
},
"io.argoproj.workflow.v1alpha1.ArtifactLocation": {
"description": "ArtifactLocation describes a location for a single or multiple artifacts. It is used as single artifact in the context of inputs/outputs (e.g. outputs.artifacts.artname). It is also used to describe the location of multiple artifacts such as the archive location of a single workflow step, which the executor will use as a default location to store its files.",
"properties": {
"artifactory": {
"description": "Artifactory contains artifactory artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ArtifactoryArtifact"
},
"git": {
"description": "Git contains git artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.GitArtifact"
},
"http": {
"description": "HTTP contains HTTP artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.HTTPArtifact"
},
"raw": {
"description": "Raw contains raw artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.RawArtifact"
},
"s3": {
"description": "S3 contains S3 artifact location details",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.S3Artifact"
}
}
},
"io.argoproj.workflow.v1alpha1.ArtifactoryArtifact": {
"description": "ArtifactoryArtifact is the location of an artifactory artifact",
"required": [
"url"
],
"properties": {
"passwordSecret": {
"description": "PasswordSecret is the secret selector to the repository password",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
},
"url": {
"description": "URL of the artifact",
"type": "string"
},
"usernameSecret": {
"description": "UsernameSecret is the secret selector to the repository username",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
}
}
},
"io.argoproj.workflow.v1alpha1.ArtifactoryAuth": {
"description": "ArtifactoryAuth describes the secret selectors required for authenticating to artifactory",
"properties": {
"passwordSecret": {
"description": "PasswordSecret is the secret selector to the repository password",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
},
"usernameSecret": {
"description": "UsernameSecret is the secret selector to the repository username",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
}
}
},
"io.argoproj.workflow.v1alpha1.DAG": {
"description": "DAG is a template subtype for directed acyclic graph templates",
"required": [
"tasks"
],
"properties": {
"target": {
"description": "Target are one or more names of targets to execute in a DAG",
"type": "string"
},
"tasks": {
"description": "Tasks are a list of DAG tasks",
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.DAGTask"
}
}
}
},
"io.argoproj.workflow.v1alpha1.DAGTask": {
"description": "DAGTask represents a node in the graph during DAG execution",
"required": [
"name",
"template"
],
"properties": {
"arguments": {
"description": "Arguments are the parameter and artifact arguments to the template",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Arguments"
},
"dependencies": {
"description": "Dependencies are name of other targets which this depends on",
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"description": "Name is the name of the target",
"type": "string"
},
"template": {
"description": "Name of template to execute",
"type": "string"
}
}
},
"io.argoproj.workflow.v1alpha1.GitArtifact": {
"description": "GitArtifact is the location of an git artifact",
"required": [
"repo"
],
"properties": {
"passwordSecret": {
"description": "PasswordSecret is the secret selector to the repository password",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
},
"repo": {
"description": "Repo is the git repository",
"type": "string"
},
"revision": {
"description": "Revision is the git commit, tag, branch to checkout",
"type": "string"
},
"usernameSecret": {
"description": "UsernameSecret is the secret selector to the repository username",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
}
}
},
"io.argoproj.workflow.v1alpha1.HTTPArtifact": {
"description": "HTTPArtifact allows an file served on HTTP to be placed as an input artifact in a container",
"required": [
"url"
],
"properties": {
"url": {
"description": "URL of the artifact",
"type": "string"
}
}
},
"io.argoproj.workflow.v1alpha1.Inputs": {
"description": "Inputs are the mechanism for passing parameters, artifacts, volumes from one template to another",
"properties": {
"artifacts": {
"description": "Artifact are a list of artifacts passed as inputs",
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Artifact"
}
},
"parameters": {
"description": "Parameters are a list of parameters passed as inputs",
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Parameter"
}
}
}
},
"io.argoproj.workflow.v1alpha1.Outputs": {
"description": "Outputs hold parameters, artifacts, and results from a step",
"properties": {
"artifacts": {
"description": "Artifacts holds the list of output artifacts produced by a step",
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Artifact"
}
},
"parameters": {
"description": "Parameters holds the list of output parameters produced by a step",
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Parameter"
}
},
"result": {
"description": "Result holds the result (stdout) of a script template",
"type": "string"
}
}
},
"io.argoproj.workflow.v1alpha1.Parameter": {
"description": "Parameter indicate a passed string parameter to a service template with an optional default value",
"required": [
"name"
],
"properties": {
"default": {
"description": "Default is the default value to use for an input parameter if a value was not supplied",
"type": "string"
},
"name": {
"description": "Name is the parameter name",
"type": "string"
},
"value": {
"description": "Value is the literal value to use for the parameter. If specified in the context of an input parameter, the value takes precedence over any passed values",
"type": "string"
},
"valueFrom": {
"description": "ValueFrom is the source for the output parameter's value",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ValueFrom"
}
}
},
"io.argoproj.workflow.v1alpha1.RawArtifact": {
"description": "RawArtifact allows raw string content to be placed as an artifact in a container",
"required": [
"data"
],
"properties": {
"data": {
"description": "Data is the string contents of the artifact",
"type": "string"
}
}
},
"io.argoproj.workflow.v1alpha1.ResourceTemplate": {
"description": "ResourceTemplate is a template subtype to manipulate kubernetes resources",
"required": [
"action",
"manifest"
],
"properties": {
"action": {
"description": "Action is the action to perform to the resource. Must be one of: get, create, apply, delete, replace",
"type": "string"
},
"failureCondition": {
"description": "FailureCondition is a label selector expression which describes the conditions of the k8s resource in which the step was considered failed",
"type": "string"
},
"manifest": {
"description": "Manifest contains the kubernetes manifest",
"type": "string"
},
"successCondition": {
"description": "SuccessCondition is a label selector expression which describes the conditions of the k8s resource in which it is acceptable to proceed to the following step",
"type": "string"
}
}
},
"io.argoproj.workflow.v1alpha1.RetryStrategy": {
"description": "RetryStrategy provides controls on how to retry a workflow step",
"properties": {
"limit": {
"description": "Limit is the maximum number of attempts when retrying a container",
"type": "integer",
"format": "int32"
}
}
},
"io.argoproj.workflow.v1alpha1.S3Artifact": {
"description": "S3Artifact is the location of an S3 artifact",
"required": [
"endpoint",
"bucket",
"accessKeySecret",
"secretKeySecret",
"key"
],
"properties": {
"accessKeySecret": {
"description": "AccessKeySecret is the secret selector to the bucket's access key",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
},
"bucket": {
"description": "Bucket is the name of the bucket",
"type": "string"
},
"endpoint": {
"description": "Endpoint is the hostname of the bucket endpoint",
"type": "string"
},
"insecure": {
"description": "Insecure will connect to the service with TLS",
"type": "boolean"
},
"key": {
"description": "Key is the key in the bucket where the artifact resides",
"type": "string"
},
"region": {
"description": "Region contains the optional bucket region",
"type": "string"
},
"secretKeySecret": {
"description": "SecretKeySecret is the secret selector to the bucket's secret key",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
}
}
},
"io.argoproj.workflow.v1alpha1.S3Bucket": {
"description": "S3Bucket contains the access information required for interfacing with an S3 bucket",
"required": [
"endpoint",
"bucket",
"accessKeySecret",
"secretKeySecret"
],
"properties": {
"accessKeySecret": {
"description": "AccessKeySecret is the secret selector to the bucket's access key",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
},
"bucket": {
"description": "Bucket is the name of the bucket",
"type": "string"
},
"endpoint": {
"description": "Endpoint is the hostname of the bucket endpoint",
"type": "string"
},
"insecure": {
"description": "Insecure will connect to the service with TLS",
"type": "boolean"
},
"region": {
"description": "Region contains the optional bucket region",
"type": "string"
},
"secretKeySecret": {
"description": "SecretKeySecret is the secret selector to the bucket's secret key",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
}
}
},
"io.argoproj.workflow.v1alpha1.Script": {
"description": "Script is a template subtype to enable scripting through code steps",
"required": [
"image",
"command",
"source"
],
"properties": {
"command": {
"description": "Command is the interpreter coommand to run (e.g. [python])",
"type": "array",
"items": {
"type": "string"
}
},
"image": {
"description": "Image is the container image to run",
"type": "string"
},
"source": {
"description": "Source contains the source code of the script to execute",
"type": "string"
}
}
},
"io.argoproj.workflow.v1alpha1.Sidecar": {
"description": "Sidecar is a container which runs alongside the main container",
"required": [
"name"
],
"properties": {
"args": {
"description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"type": "array",
"items": {
"type": "string"
}
},
"command": {
"description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell",
"type": "array",
"items": {
"type": "string"
}
},
"env": {
"description": "List of environment variables to set in the container. Cannot be updated.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvVar"
},
"x-kubernetes-patch-merge-key": "name",
"x-kubernetes-patch-strategy": "merge"
},
"envFrom": {
"description": "List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.EnvFromSource"
}
},
"image": {
"description": "Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.",
"type": "string"
},
"imagePullPolicy": {
"description": "Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images",
"type": "string"
},
"lifecycle": {
"description": "Actions that the management system should take in response to container lifecycle events. Cannot be updated.",
"$ref": "#/definitions/io.k8s.api.core.v1.Lifecycle"
},
"livenessProbe": {
"description": "Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"$ref": "#/definitions/io.k8s.api.core.v1.Probe"
},
"mirrorVolumeMounts": {
"description": "MirrorVolumeMounts will mount the same volumes specified in the main container to the sidecar (including artifacts), at the same mountPaths. This enables dind daemon to partially see the same filesystem as the main container in order to use features such as docker volume binding",
"type": "boolean"
},
"name": {
"description": "Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.",
"type": "string"
},
"ports": {
"description": "List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default \"0.0.0.0\" address inside a container will be accessible from the network. Cannot be updated.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.ContainerPort"
},
"x-kubernetes-patch-merge-key": "containerPort",
"x-kubernetes-patch-strategy": "merge"
},
"readinessProbe": {
"description": "Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes",
"$ref": "#/definitions/io.k8s.api.core.v1.Probe"
},
"resources": {
"description": "Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources",
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
},
"securityContext": {
"description": "Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/",
"$ref": "#/definitions/io.k8s.api.core.v1.SecurityContext"
},
"stdin": {
"description": "Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.",
"type": "boolean"
},
"stdinOnce": {
"description": "Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false",
"type": "boolean"
},
"terminationMessagePath": {
"description": "Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.",
"type": "string"
},
"terminationMessagePolicy": {
"description": "Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.",
"type": "string"
},
"tty": {
"description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.",
"type": "boolean"
},
"volumeDevices": {
"description": "volumeDevices is the list of block devices to be used by the container. This is an alpha feature and may change in the future.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeDevice"
},
"x-kubernetes-patch-merge-key": "devicePath",
"x-kubernetes-patch-strategy": "merge"
},
"volumeMounts": {
"description": "Pod volumes to mount into the container's filesystem. Cannot be updated.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.VolumeMount"
},
"x-kubernetes-patch-merge-key": "mountPath",
"x-kubernetes-patch-strategy": "merge"
},
"workingDir": {
"description": "Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.",
"type": "string"
}
}
},
"io.argoproj.workflow.v1alpha1.SidecarOptions": {
"description": "SidecarOptions provide a way to customize the behavior of a sidecar and how it affects the main container.",
"properties": {
"mirrorVolumeMounts": {
"description": "MirrorVolumeMounts will mount the same volumes specified in the main container to the sidecar (including artifacts), at the same mountPaths. This enables dind daemon to partially see the same filesystem as the main container in order to use features such as docker volume binding",
"type": "boolean"
}
}
},
"io.argoproj.workflow.v1alpha1.Template": {
"description": "Template is a reusable and composable unit of execution in a workflow",
"required": [
"name"
],
"properties": {
"activeDeadlineSeconds": {
"description": "Optional duration in seconds relative to the StartTime that the pod may be active on a node before the system actively tries to terminate the pod; value must be positive integer This field is only applicable to container and script templates.",
"type": "integer",
"format": "int64"
},
"affinity": {
"description": "Affinity sets the pod's scheduling constraints Overrides the affinity set at the workflow level (if any)",
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity"
},
"archiveLocation": {
"description": "Location in which all files related to the step will be stored (logs, artifacts, etc...). Can be overridden by individual items in Outputs. If omitted, will use the default artifact repository location configured in the controller, appended with the \u003cworkflowname\u003e/\u003cnodename\u003e in the key.",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ArtifactLocation"
},
"container": {
"description": "Container is the main container image to run in the pod",
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
},
"daemon": {
"description": "Deamon will allow a workflow to proceed to the next step so long as the container reaches readiness",
"type": "boolean"
},
"dag": {
"description": "DAG template subtype which runs a DAG",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.DAG"
},
"inputs": {
"description": "Inputs describe what inputs parameters and artifacts are supplied to this template",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Inputs"
},
"name": {
"description": "Name is the name of the template",
"type": "string"
},
"nodeSelector": {
"description": "NodeSelector is a selector to schedule this step of the workflow to be run on the selected node(s). Overrides the selector set at the workflow level.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"outputs": {
"description": "Outputs describe the parameters and artifacts that this template produces",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Outputs"
},
"resource": {
"description": "Resource template subtype which can run k8s resources",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.ResourceTemplate"
},
"retryStrategy": {
"description": "RetryStrategy describes how to retry a template when it fails",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.RetryStrategy"
},
"script": {
"description": "Script runs a portion of code against an interpreter",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Script"
},
"sidecars": {
"description": "Sidecars is a list of containers which run alongside the main container Sidecars are automatically killed when the main container completes",
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Sidecar"
}
},
"steps": {
"description": "Steps define a series of sequential/parallel workflow steps",
"type": "array",
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.WorkflowStep"
}
}
}
}
},
"io.argoproj.workflow.v1alpha1.ValueFrom": {
"description": "ValueFrom describes a location in which to obtain the value to a parameter",
"properties": {
"jqFilter": {
"description": "JQFilter expression against the resource object in resource templates",
"type": "string"
},
"jsonPath": {
"description": "JSONPath of a resource to retrieve an output parameter value from in resource templates",
"type": "string"
},
"parameter": {
"description": "Parameter reference to a step or dag task in which to retrieve an output parameter value from (e.g. '{{steps.mystep.outputs.myparam}}')",
"type": "string"
},
"path": {
"description": "Path in the container to retrieve an output parameter value from in container templates",
"type": "string"
}
}
},
"io.argoproj.workflow.v1alpha1.Workflow": {
"description": "Workflow is the definition of a workflow resource",
"required": [
"metadata",
"spec",
"status"
],
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.WorkflowSpec"
},
"status": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.WorkflowStatus"
}
}
},
"io.argoproj.workflow.v1alpha1.WorkflowList": {
"description": "WorkflowList is list of Workflow resources",
"required": [
"metadata",
"items"
],
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
"type": "string"
},
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Workflow"
}
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
}
},
"io.argoproj.workflow.v1alpha1.WorkflowSpec": {
"description": "WorkflowSpec is the specification of a Workflow.",
"required": [
"templates",
"entrypoint"
],
"properties": {
"affinity": {
"description": "Affinity sets the scheduling constraints for all pods in the workflow. Can be overridden by an affinity specified in the template",
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity"
},
"arguments": {
"description": "Arguments contain the parameters and artifacts sent to the workflow entrypoint Parameters are referencable globally using the 'workflow' variable prefix. e.g. {{workflow.parameters.myparam}}",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Arguments"
},
"entrypoint": {
"description": "Entrypoint is a template reference to the starting point of the workflow",
"type": "string"
},
"imagePullSecrets": {
"description": "ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
}
},
"nodeSelector": {
"description": "NodeSelector is a selector which will result in all pods of the workflow to be scheduled on the selected node(s). This is able to be overridden by a nodeSelector specified in the template.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"onExit": {
"description": "OnExit is a template reference which is invoked at the end of the workflow, irrespective of the success, failure, or error of the primary workflow.",
"type": "string"
},
"serviceAccountName": {
"description": "ServiceAccountName is the name of the ServiceAccount to run all pods of the workflow as.",
"type": "string"
},
"templates": {
"description": "Templates is a list of workflow templates used in a workflow",
"type": "array",
"items": {
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Template"
}
},
"volumeClaimTemplates": {
"description": "VolumeClaimTemplates is a list of claims that containers are allowed to reference. The Workflow controller will create the claims at the beginning of the workflow and delete the claims upon completion of the workflow",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.PersistentVolumeClaim"
}
},
"volumes": {
"description": "Volumes is a list of volumes that can be mounted by containers in a workflow.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Volume"
}
}
}
},
"io.argoproj.workflow.v1alpha1.WorkflowStep": {
"description": "WorkflowStep is a reference to a template to execute in a series of step",
"properties": {
"arguments": {
"description": "Arguments hold arguments to the template",
"$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Arguments"
},
"name": {
"description": "Name of the step",
"type": "string"
},
"template": {
"description": "Template is a reference to the template to execute as the step",
"type": "string"
},
"when": {
"description": "When is an expression in which the step should conditionally execute",
"type": "string"
},
"withParam": {
"description": "WithParam expands a step into from the value in the parameter",
"type": "string"
}
}
}
}
}