forked from defenseunicorns/uds-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tasks.schema.json
445 lines (445 loc) · 13.3 KB
/
tasks.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
{
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/TasksFile",
"definitions": {
"Action": {
"properties": {
"mute": {
"type": "boolean",
"description": "Hide the output of the command during package deployment (default false)"
},
"maxTotalSeconds": {
"type": "integer",
"description": "Timeout in seconds for the command (default to 0"
},
"maxRetries": {
"type": "integer",
"description": "Retry the command if it fails up to given number of times (default 0)"
},
"dir": {
"type": "string",
"description": "The working directory to run the command in (default is CWD)"
},
"env": {
"items": {
"type": "string"
},
"type": "array",
"description": "Additional environment variables to set for the command"
},
"cmd": {
"type": "string",
"description": "The command to run. Must specify either cmd or wait for the action to do anything."
},
"shell": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/Shell",
"description": "(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"
},
"setVariable": {
"pattern": "^[A-Z0-9_]+$",
"type": "string",
"description": "[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0"
},
"setVariables": {
"items": {
"$ref": "#/definitions/Variable"
},
"type": "array",
"description": "(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package."
},
"description": {
"type": "string",
"description": "Description of the action to be displayed during package execution instead of the command"
},
"wait": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/ZarfComponentActionWait",
"description": "Wait for a condition to be met before continuing. Must specify either cmd or wait for the action. See the 'zarf tools wait-for' command for more info."
},
"task": {
"type": "string",
"description": "The task to run"
},
"with": {
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"additionalProperties": true
}
},
"type": "object",
"description": "Input parameters to pass to the task"
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"InputParameter": {
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"description": "Description of the parameter"
},
"deprecatedMessage": {
"type": "string",
"description": "Message to display when the parameter is deprecated"
},
"required": {
"type": "boolean",
"description": "Whether the parameter is required"
},
"default": {
"type": "string",
"description": "Default value for the parameter"
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"InteractiveVariable": {
"required": [
"Variable"
],
"properties": {
"Variable": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/Variable"
},
"description": {
"type": "string",
"description": "A description of the variable to be used when prompting the user a value"
},
"default": {
"type": "string",
"description": "The default value to use for the variable"
},
"prompt": {
"type": "boolean",
"description": "Whether to prompt the user for input for this variable"
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"Shell": {
"properties": {
"windows": {
"type": "string",
"description": "(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item)",
"examples": [
"powershell",
"cmd",
"pwsh",
"sh",
"bash",
"gsh"
]
},
"linux": {
"type": "string",
"description": "(default 'sh') Indicates a preference for the shell to use on Linux systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
]
},
"darwin": {
"type": "string",
"description": "(default 'sh') Indicates a preference for the shell to use on macOS systems",
"examples": [
"sh",
"bash",
"fish",
"zsh",
"pwsh"
]
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"Task": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the task"
},
"description": {
"type": "string",
"description": "Description of the task"
},
"files": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/ZarfFile"
},
"type": "array",
"description": "Files or folders to download or copy"
},
"actions": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/Action"
},
"type": "array",
"description": "Actions to take when running the task"
},
"inputs": {
"patternProperties": {
"^[_a-zA-Z][a-zA-Z0-9_-]*$": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/InputParameter"
}
},
"type": "object",
"description": "Input parameters for the task"
},
"envPath": {
"type": "string",
"description": "Path to file containing environment variables"
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"TasksFile": {
"required": [
"tasks"
],
"properties": {
"includes": {
"items": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"type": "array",
"description": "List of local task files to include"
},
"variables": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/InteractiveVariable"
},
"type": "array",
"description": "Definitions and default values for variables used in run.yaml"
},
"tasks": {
"items": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/Task"
},
"type": "array",
"description": "The list of tasks that can be run"
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"Variable": {
"required": [
"name"
],
"properties": {
"name": {
"pattern": "^[A-Z0-9_]+$",
"type": "string",
"description": "The name to be used for the variable"
},
"sensitive": {
"type": "boolean",
"description": "Whether to mark this variable as sensitive to not print it in the log"
},
"autoIndent": {
"type": "boolean",
"description": "Whether to automatically indent the variable's value (if multiline) when templating. Based on the number of chars before the start of ###ZARF_VAR_."
},
"pattern": {
"type": "string",
"description": "An optional regex pattern that a variable value must match before a package deployment can continue."
},
"type": {
"enum": [
"raw",
"file"
],
"type": "string",
"description": "Changes the handling of a variable to load contents differently (i.e. from a file rather than as a raw variable - templated files should be kept below 1 MiB)"
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentActionWait": {
"properties": {
"cluster": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/ZarfComponentActionWaitCluster",
"description": "Wait for a condition to be met in the cluster before continuing. Only one of cluster or network can be specified."
},
"network": {
"$schema": "http://json-schema.org/draft-04/schema#",
"$ref": "#/definitions/ZarfComponentActionWaitNetwork",
"description": "Wait for a condition to be met on the network before continuing. Only one of cluster or network can be specified."
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentActionWaitCluster": {
"required": [
"kind",
"name"
],
"properties": {
"kind": {
"type": "string",
"description": "The kind of resource to wait for",
"examples": [
"Pod",
"Deployment)"
]
},
"name": {
"type": "string",
"description": "The name of the resource or selector to wait for",
"examples": [
"podinfo",
"app=podinfo"
]
},
"namespace": {
"type": "string",
"description": "The namespace of the resource to wait for"
},
"condition": {
"type": "string",
"description": "The condition or jsonpath state to wait for; defaults to exist",
"examples": [
"Ready",
"Available"
]
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"ZarfComponentActionWaitNetwork": {
"required": [
"protocol",
"address"
],
"properties": {
"protocol": {
"enum": [
"tcp",
"http",
"https"
],
"type": "string",
"description": "The protocol to wait for"
},
"address": {
"type": "string",
"description": "The address to wait for",
"examples": [
"localhost:8080",
"1.1.1.1"
]
},
"code": {
"type": "integer",
"description": "The HTTP status code to wait for if using http or https",
"examples": [
200,
404
]
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
},
"ZarfFile": {
"required": [
"source",
"target"
],
"properties": {
"source": {
"type": "string",
"description": "Local folder or file path or remote URL to pull into the package"
},
"shasum": {
"type": "string",
"description": "(files only) Optional SHA256 checksum of the file"
},
"target": {
"type": "string",
"description": "The absolute or relative path where the file or folder should be copied to during package deploy"
},
"executable": {
"type": "boolean",
"description": "(files only) Determines if the file should be made executable during package deploy"
},
"symlinks": {
"items": {
"type": "string"
},
"type": "array",
"description": "List of symlinks to create during package deploy"
},
"extractPath": {
"type": "string",
"description": "Local folder or file to be extracted from a 'source' archive"
}
},
"additionalProperties": false,
"type": "object",
"patternProperties": {
"^x-": {}
}
}
}
}