-
Notifications
You must be signed in to change notification settings - Fork 26
/
oam.schema.json
440 lines (440 loc) · 13.7 KB
/
oam.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
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "wasmCloud Application Deployment Manager (wadm) Manifest",
"description": "Manifest file based on the Open Application Model (OAM) specification for declaratively managing wasmCloud applications",
"type": "object",
"required": ["apiVersion", "kind", "metadata", "spec"],
"properties": {
"apiVersion": {
"description": "The OAM version of the manifest",
"type": "string"
},
"kind": {
"description": "The kind or type of manifest described by the spec",
"type": "string"
},
"metadata": {
"description": "Metadata describing the manifest",
"allOf": [
{
"$ref": "#/definitions/Metadata"
}
]
},
"spec": {
"description": "The specification for this manifest",
"allOf": [
{
"$ref": "#/definitions/Specification"
}
]
}
},
"additionalProperties": false,
"definitions": {
"CapabilityProperties": {
"type": "object",
"required": ["image"],
"properties": {
"config": {
"description": "Named configuration to pass to the provider. The merged set of configuration will be passed to the provider at runtime using the provider SDK's `init()` function.",
"type": "array",
"items": {
"$ref": "#/definitions/ConfigProperty"
}
},
"id": {
"description": "The component ID to use for this provider. If not supplied, it will be generated as a combination of the [Metadata::name] and the image reference.",
"type": ["string", "null"]
},
"image": {
"description": "The image reference to use",
"type": "string"
},
"secrets": {
"description": "Named secret references to pass to the t. The provider will be able to retrieve these values at runtime using `wasmcloud:secrets/store`.",
"type": "array",
"items": {
"$ref": "#/definitions/SecretProperty"
}
}
},
"additionalProperties": false
},
"Component": {
"description": "A component definition",
"type": "object",
"oneOf": [
{
"type": "object",
"required": ["properties", "type"],
"properties": {
"properties": {
"$ref": "#/definitions/ComponentProperties"
},
"type": {
"type": "string",
"enum": ["component"]
}
}
},
{
"type": "object",
"required": ["properties", "type"],
"properties": {
"properties": {
"$ref": "#/definitions/CapabilityProperties"
},
"type": {
"type": "string",
"enum": ["capability"]
}
}
}
],
"required": ["name"],
"properties": {
"name": {
"description": "The name of this component",
"type": "string"
},
"traits": {
"description": "A list of various traits assigned to this component",
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/Trait"
}
}
}
},
"ComponentProperties": {
"type": "object",
"required": ["image"],
"properties": {
"config": {
"description": "Named configuration to pass to the component. The component will be able to retrieve these values at runtime using `wasi:runtime/config.`",
"type": "array",
"items": {
"$ref": "#/definitions/ConfigProperty"
}
},
"id": {
"description": "The component ID to use for this component. If not supplied, it will be generated as a combination of the [Metadata::name] and the image reference.",
"type": ["string", "null"]
},
"image": {
"description": "The image reference to use",
"type": "string"
},
"secrets": {
"description": "Named secret references to pass to the component. The component will be able to retrieve these values at runtime using `wasmcloud:secrets/store`.",
"type": "array",
"items": {
"$ref": "#/definitions/SecretProperty"
}
}
},
"additionalProperties": false
},
"ConfigDefinition": {
"type": "object",
"properties": {
"config": {
"type": "array",
"items": {
"$ref": "#/definitions/ConfigProperty"
}
},
"secrets": {
"type": "array",
"items": {
"$ref": "#/definitions/SecretProperty"
}
}
}
},
"ConfigProperty": {
"description": "Properties for the config list associated with components, providers, and links\n\n## Usage Defining a config block, like so: ```yaml source_config: - name: \"external-secret-kv\" - name: \"default-port\" properties: port: \"8080\" ```\n\nWill result in two config scalers being created, one with the name `basic-kv` and one with the name `default-port`. Wadm will not resolve collisions with configuration names between manifests.",
"type": "object",
"required": ["name"],
"properties": {
"name": {
"description": "Name of the config to ensure exists",
"type": "string"
},
"properties": {
"description": "Optional properties to put with the configuration. If the properties are omitted in the manifest, wadm will assume that the configuration is externally managed and will not attempt to create it, only reporting the status as failed if not found.",
"type": ["object", "null"],
"additionalProperties": {
"type": "string"
}
}
},
"additionalProperties": false
},
"LinkProperty": {
"description": "Properties for links",
"type": "object",
"required": ["interfaces", "namespace", "package", "target"],
"properties": {
"interfaces": {
"description": "WIT interfaces for the link",
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"description": "The name of this link",
"type": ["string", "null"]
},
"namespace": {
"description": "WIT namespace for the link",
"type": "string"
},
"package": {
"description": "WIT package for the link",
"type": "string"
},
"source": {
"description": "Configuration to apply to the source of the link",
"anyOf": [
{
"$ref": "#/definitions/ConfigDefinition"
},
{
"type": "null"
}
]
},
"source_config": {
"deprecated": true,
"writeOnly": true,
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/ConfigProperty"
}
},
"target": {
"description": "Configuration to apply to the target of the link",
"allOf": [
{
"$ref": "#/definitions/TargetConfig"
}
]
},
"target_config": {
"deprecated": true,
"writeOnly": true,
"type": ["array", "null"],
"items": {
"$ref": "#/definitions/ConfigProperty"
}
}
}
},
"Metadata": {
"description": "The metadata describing the manifest",
"type": "object",
"required": ["annotations", "name"],
"properties": {
"annotations": {
"description": "Optional data for annotating this manifest see <https://github.com/oam-dev/spec/blob/master/metadata.md#annotations-format>",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"labels": {
"description": "Optional data for labeling this manifest, see <https://github.com/oam-dev/spec/blob/master/metadata.md#label-format>",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"name": {
"description": "The name of the manifest. This must be unique per lattice",
"type": "string"
}
}
},
"Policy": {
"description": "A policy definition",
"type": "object",
"required": ["name", "properties", "type"],
"properties": {
"name": {
"description": "The name of this policy",
"type": "string"
},
"properties": {
"description": "The properties for this policy",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"type": {
"description": "The type of the policy",
"type": "string"
}
}
},
"SecretProperty": {
"type": "object",
"required": ["name", "properties"],
"properties": {
"name": {
"description": "The name of the secret. This is used by a reference by the component or capability to get the secret value as a resource.",
"type": "string"
},
"properties": {
"description": "The of the secret. This indicates how to retrieve the secret value from a secrets backend and which backend to actually query.",
"allOf": [
{
"$ref": "#/definitions/SecretSourceProperty"
}
]
}
}
},
"SecretSourceProperty": {
"type": "object",
"required": ["key", "policy"],
"properties": {
"key": {
"description": "The key to use for retrieving the secret from the backend.",
"type": "string"
},
"policy": {
"description": "The policy to use for retrieving the secret.",
"type": "string"
},
"version": {
"description": "The version of the secret to retrieve. If not supplied, the latest version will be used.",
"type": ["string", "null"]
}
}
},
"Specification": {
"description": "A representation of an OAM specification",
"type": "object",
"required": ["components"],
"properties": {
"components": {
"description": "The list of components for describing an application",
"type": "array",
"items": {
"$ref": "#/definitions/Component"
}
},
"policies": {
"description": "The list of policies describing an application. This is for providing application-wide setting such as configuration for a secrets backend, how to render Kubernetes services, etc. It can be omitted if no policies are needed for an application.",
"type": "array",
"items": {
"$ref": "#/definitions/Policy"
}
}
}
},
"Spread": {
"description": "Configuration for various spreading requirements",
"type": "object",
"required": ["name", "requirements"],
"properties": {
"name": {
"description": "The name of this spread requirement",
"type": "string"
},
"requirements": {
"description": "An arbitrary map of labels to match on for scaling requirements",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"weight": {
"description": "An optional weight for this spread. Higher weights are given more precedence",
"type": ["integer", "null"],
"format": "uint",
"minimum": 0.0
}
},
"additionalProperties": false
},
"SpreadScalerProperty": {
"description": "Properties for spread scalers",
"type": "object",
"required": ["instances"],
"properties": {
"instances": {
"description": "Number of instances to spread across matching requirements",
"type": "integer",
"format": "uint",
"minimum": 0.0
},
"spread": {
"description": "Requirements for spreading those instances",
"type": "array",
"items": {
"$ref": "#/definitions/Spread"
}
}
},
"additionalProperties": false
},
"TargetConfig": {
"type": "object",
"required": ["name"],
"properties": {
"config": {
"type": "array",
"items": {
"$ref": "#/definitions/ConfigProperty"
}
},
"name": {
"description": "The target this link applies to. This should be the name of a component in the manifest",
"type": "string"
},
"secrets": {
"type": "array",
"items": {
"$ref": "#/definitions/SecretProperty"
}
}
}
},
"Trait": {
"type": "object",
"required": ["properties", "type"],
"properties": {
"properties": {
"description": "The properties of this trait",
"allOf": [
{
"$ref": "#/definitions/TraitProperty"
}
]
},
"type": {
"description": "The type of trait specified. This should be a unique string for the type of scaler. As we plan on supporting custom scalers, these traits are not enumerated",
"type": "string"
}
},
"additionalProperties": false
},
"TraitProperty": {
"description": "Properties for defining traits",
"anyOf": [
{
"$ref": "#/definitions/LinkProperty"
},
{
"$ref": "#/definitions/SpreadScalerProperty"
},
true
]
}
}
}