-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
aspire-8.0.json
629 lines (629 loc) · 22 KB
/
aspire-8.0.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
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://json.schemastore.org/aspire-8.0.json",
"type": "object",
"description": "Defines the .NET Aspire 8.0 deployment manifest JSON schema.",
"required": ["resources"],
"properties": {
"resources": {
"type": "object",
"description": "Contains the set of resources deployable as part of this manifest. Each property is a distinct resource.",
"additionalProperties": {
"type": "object",
"required": ["type"],
"properties": {
"type": {
"type": "string"
}
},
"oneOf": [
{
"type": "object",
"description": "A resource that represents a Dockerfile that will be built into a container during deployment.",
"required": ["type", "path", "context"],
"properties": {
"type": {
"const": "dockerfile.v0"
},
"path": {
"type": "string",
"description": "The file path to the Dockerfile to be built into a container image."
},
"context": {
"type": "string",
"description": "A directory path used as the context for building the Dockerfile into a container image."
},
"env": {
"$ref": "#/definitions/env"
},
"bindings": {
"$ref": "#/definitions/bindings"
},
"buildArgs": {
"$ref": "#/definitions/buildArgs"
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "A generic container resource.",
"required": ["type", "image"],
"properties": {
"type": {
"const": "container.v0"
},
"image": {
"type": "string",
"description": "A string representing the container image to be used."
},
"entrypoint": {
"type": "string",
"description": "The entrypoint to use for the container image when executed."
},
"args": {
"$ref": "#/definitions/args"
},
"connectionString": {
"$ref": "#/definitions/connectionString"
},
"env": {
"$ref": "#/definitions/env"
},
"bindings": {
"$ref": "#/definitions/bindings"
},
"bindMounts": {
"$ref": "#/definitions/bindMounts"
},
"volumes": {
"$ref": "#/definitions/volumes"
},
"build": false
},
"additionalProperties": false
},
{
"type": "object",
"description": "A generic container resource.",
"oneOf": [
{
"required": ["type", "build"]
},
{
"required": ["type", "image"]
}
],
"properties": {
"type": {
"const": "container.v1"
},
"image": {
"type": "string",
"description": "A string representing the container image to be used."
},
"entrypoint": {
"type": "string",
"description": "The entrypoint to use for the container image when executed."
},
"args": {
"$ref": "#/definitions/args"
},
"build": {
"$ref": "#/definitions/build"
},
"connectionString": {
"$ref": "#/definitions/connectionString"
},
"env": {
"$ref": "#/definitions/env"
},
"bindings": {
"$ref": "#/definitions/bindings"
},
"bindMounts": {
"$ref": "#/definitions/bindMounts"
},
"volumes": {
"$ref": "#/definitions/volumes"
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Represents a .NET project resource.",
"required": ["type", "path"],
"properties": {
"type": {
"const": "project.v0"
},
"path": {
"type": "string",
"description": "The path to the project file. Relative paths are interpreted as being relative to the location of the manifest file."
},
"args": {
"$ref": "#/definitions/args"
},
"env": {
"$ref": "#/definitions/env"
},
"bindings": {
"$ref": "#/definitions/bindings"
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Represents an executable resource.",
"required": ["type", "command", "workingDirectory"],
"properties": {
"type": {
"const": "executable.v0"
},
"workingDirectory": {
"type": "string",
"description": "The path to the working directory. Should be interpreted as being relative to the AppHost directory."
},
"command": {
"type": "string",
"description": "The path to the command. Should be interpreted as being relative to the AppHost directory."
},
"args": {
"$ref": "#/definitions/args"
},
"env": {
"$ref": "#/definitions/env"
},
"bindings": {
"$ref": "#/definitions/bindings"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": ["connectionString"],
"description": "Represents a value resource. Typically used to perform string concatenation (e.g. for connection strings).",
"properties": {
"type": {
"const": "value.v0"
},
"connectionString": {
"$ref": "#/definitions/connectionString"
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Represents a parameter resource. Parameter resources are used to represent external configuration values that should be provided at deployment time.",
"required": ["value", "inputs"],
"properties": {
"type": {
"const": "parameter.v0"
},
"value": {
"$ref": "#/definitions/value"
},
"connectionString": {
"$ref": "#/definitions/connectionString"
},
"inputs": {
"type": "object",
"description": "Defines a set of input values which need to be either generated or prompted by the deployment tool. This is typically used for environment specific configuration values or secrets.",
"additionalProperties": {
"type": "object",
"required": ["type"],
"properties": {
"type": {
"type": "string",
"description": "The type of the value to be prompted or generated. Currently only 'string'' is supported.",
"enum": ["string"]
},
"secret": {
"type": "boolean",
"description": "Flag indicating whether the value should be treated as a secret. Deployment tools should note this value to take appropriate precautions when prompting, storing, and transmitting this value."
},
"default": {
"type": "object",
"required": ["generate"],
"properties": {
"generate": {
"type": "object",
"required": ["minLength"],
"properties": {
"minLength": {
"type": "number",
"description": "The minimum length of the generated value."
},
"lower": {
"type": "boolean",
"description": "Indicates whether lower case characters are allowed in the generated value."
},
"upper": {
"type": "boolean",
"description": "Indicates whether upper case characters are allowed in the generated value."
},
"numeric": {
"type": "boolean",
"description": "Indicates whether numeric characters are allowed in the generated value."
},
"special": {
"type": "boolean",
"description": "Indicates whether special characters are allowed in the generated value."
},
"minLower": {
"type": "number",
"description": "Specifies the minimum number of lower case characters that must appear in the generated value."
},
"minUpper": {
"type": "number",
"description": "Specifies the minimum number of upper case characters that must appear in the generated value."
},
"minNumeric": {
"type": "number",
"description": "Specifies the minimum number of numeric characters that must appear in the generated value."
},
"minSpecial": {
"type": "number",
"description": "Specifies the minimum number of special characters that must appear in the generated value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Represents a Dapr resource in the manifest.",
"required": ["dapr"],
"properties": {
"type": {
"const": "dapr.v0"
},
"dapr": {
"type": "object",
"description": "Dapr specific configuration.",
"required": ["application", "appId", "components"],
"properties": {
"application": {
"type": "string"
},
"appId": {
"type": "string"
},
"components": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": ["daprComponent"],
"properties": {
"type": {
"const": "dapr.component.v0"
},
"daprComponent": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"default": "Represents a resource that is deployed using Azure Bicep.",
"required": ["path"],
"properties": {
"type": {
"const": "azure.bicep.v0"
},
"path": {
"type": "string",
"description": "Path to the Bicep file to be used for deployment."
},
"connectionString": {
"$ref": "#/definitions/connectionString"
},
"params": {
"type": "object",
"description": "A list of parameters which are passed to Azure deployment.",
"additionalProperties": {
"oneOf": [
{ "type": "array" },
{ "type": "boolean" },
{ "type": "number" },
{ "type": "object" },
{ "type": "string" }
]
}
}
},
"additionalProperties": false
},
{
"type": "object",
"required": ["type", "stack-name"],
"properties": {
"type": {
"const": "aws.cloudformation.stack.v0"
},
"stack-name": {
"type": "string"
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target-resource": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "object",
"required": ["type", "stack-name", "template-path"],
"properties": {
"type": {
"const": "aws.cloudformation.template.v0"
},
"stack-name": {
"type": "string"
},
"template-path": {
"type": "string"
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"target-resource": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "object",
"description": "Represents extensions. Any object with a 'type' field that is not captured above will pass.",
"required": ["type"],
"not": {
"properties": {
"type": {
"type": "string",
"enum": [
"parameter.v0",
"container.v0",
"container.v1",
"dockerfile.v0",
"project.v0",
"value.v0",
"executable.v0",
"azure.bicep.v0",
"aws.cloudformation.template.v0",
"aws.cloudformation.stack.v0",
"dapr.component.v0",
"dapr.v0"
]
}
}
},
"properties": {
"type": {
"type": "string"
}
}
}
]
}
}
},
"definitions": {
"connectionString": {
"type": "string",
"description": "A connection string that can be used to connect to this resource."
},
"value": {
"type": "string",
"description": "A value that can be referenced via an expression in the manifest"
},
"args": {
"type": "array",
"description": "List of arguments to used when launched.",
"items": {
"type": "string"
}
},
"build": {
"type": "object",
"description": "An object that captures properties that control the building of a container image.",
"required": ["context", "dockerfile"],
"properties": {
"context": {
"type": "string",
"description": "The path to the context directory for the container build. Can be relative of absolute. If relative it is relative to the location of the manifest file."
},
"dockerfile": {
"type": "string",
"description": "The path to the Dockerfile. Can be relative or absolute. If relative it is relative to the manifest file."
},
"args": {
"type": "object",
"description": "A list of build arguments which are used during container build.",
"additionalProperties": {
"type": "string"
}
},
"secrets": {
"type": "object",
"description": "A list of build arguments which are used during container build.",
"additionalProperties": {
"type": "object",
"required": ["type"],
"oneOf": [
{
"required": ["type", "value"],
"properties": {
"type": {
"type": "string",
"const": "env"
},
"value": {
"type": "string",
"description": "If provided use as the value for the environment variable when docker build is run."
}
}
},
{
"required": ["type", "source"],
"properties": {
"type": {
"type": "string",
"const": "file"
},
"source": {
"type": "string",
"description": "Path to secret file. If relative, the path is relative to the manifest file."
}
}
}
]
}
}
},
"additionalProperties": false
},
"buildArgs": {
"type": "object",
"description": "A list of build arguments which are used during container build (for dockerfile.v0 resource type).",
"additionalProperties": {
"type": "string"
}
},
"bindings": {
"type": "object",
"description": "A list of port bindings for the resource when it is deployed.",
"additionalProperties": {
"type": "object",
"required": ["scheme", "protocol", "transport"],
"properties": {
"scheme": {
"type": "string",
"description": "The scheme used in URIs for this binding.",
"enum": ["http", "https", "tcp", "udp"]
},
"protocol": {
"type": "string",
"description": "The protocol used for this binding (only 'tcp' or 'udp' are valid).",
"enum": ["tcp", "udp"]
},
"transport": {
"type": "string",
"description": "Additional information describing the transport (e.g. HTTP/2).",
"enum": ["http", "http2", "tcp"]
},
"external": {
"type": "boolean",
"description": "A flag indicating whether this binding is exposed externally when deployed."
},
"targetPort": {
"type": "number",
"description": "The port that the workload (e.g. container) is listening on."
},
"port": {
"type": "number",
"description": "The port that the workload (e.g. container) is exposed as to other resources and externally."
}
},
"additionalProperties": false
}
},
"env": {
"type": "object",
"description": "A list of environment variables which are inserted into the resource at runtime.",
"additionalProperties": {
"type": "string"
}
},
"volumes": {
"type": "array",
"description": "A list of volumes associated with this resource when deployed.",
"items": {
"type": "object",
"required": ["name", "target", "readOnly"],
"properties": {
"name": {
"type": "string",
"description": "The name of the volume."
},
"target": {
"type": "string",
"description": "The target within the container where the volume is mounted."
},
"readOnly": {
"type": "boolean",
"description": "Flag indicating whether the mount is read-only."
}
},
"additionalProperties": false
}
},
"bindMounts": {
"type": "array",
"description": "A list of bind mounts associated with this resource when deployed.",
"items": {
"type": "object",
"required": ["source", "target", "readOnly"],
"properties": {
"source": {
"type": "string",
"description": "The source path on the host which is mounted into the container."
},
"target": {
"type": "string",
"description": "The target within the container where the volume is mounted."
},
"readOnly": {
"type": "boolean",
"description": "Flag indicating whether the mount is read-only."
}
},
"additionalProperties": false
}
}
}
}