@eclipse-che/che-devworkspace-generator 7.78.0-next-5aa7ed4 → 7.78.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/api/devfile-context.d.ts +10 -0
- package/lib/api/devfile-context.js +12 -0
- package/lib/api/devfile-context.js.map +1 -1
- package/lib/devfile-schema/2.0.0/devfile.json +2852 -0
- package/lib/devfile-schema/2.1.0/devfile.json +1430 -0
- package/lib/devfile-schema/2.2.0/devfile.json +2037 -0
- package/lib/devfile-schema/2.2.1/devfile.json +2048 -0
- package/lib/devfile-schema/2.2.2/devfile.json +2211 -0
- package/lib/devfile-schema/devfile-schema-module.d.ts +12 -0
- package/lib/devfile-schema/devfile-schema-module.js +19 -0
- package/lib/devfile-schema/devfile-schema-module.js.map +1 -0
- package/lib/devfile-schema/devfile-schema-validator.d.ts +5878 -0
- package/lib/devfile-schema/devfile-schema-validator.js +77 -0
- package/lib/devfile-schema/devfile-schema-validator.js.map +1 -0
- package/lib/generate.js +1 -1
- package/lib/generate.js.map +1 -1
- package/lib/inversify/inversify-binding.js +2 -0
- package/lib/inversify/inversify-binding.js.map +1 -1
- package/lib/main.js +14 -1
- package/lib/main.js.map +1 -1
- package/package.json +2 -1
- package/src/api/devfile-context.ts +11 -0
- package/src/devfile-schema/2.0.0/devfile.json +2852 -0
- package/src/devfile-schema/2.1.0/devfile.json +1430 -0
- package/src/devfile-schema/2.2.0/devfile.json +2037 -0
- package/src/devfile-schema/2.2.1/devfile.json +2048 -0
- package/src/devfile-schema/2.2.2/devfile.json +2211 -0
- package/src/devfile-schema/devfile-schema-module.ts +18 -0
- package/src/devfile-schema/devfile-schema-validator.ts +46 -0
- package/src/generate.ts +1 -2
- package/src/inversify/inversify-binding.ts +2 -0
- package/src/main.ts +20 -0
|
@@ -0,0 +1,2852 @@
|
|
|
1
|
+
{
|
|
2
|
+
"description": "Devfile describes the structure of a cloud-native workspace and development environment.",
|
|
3
|
+
"type": "object",
|
|
4
|
+
"title": "Devfile schema - Version 2.0.0",
|
|
5
|
+
"required": ["schemaVersion"],
|
|
6
|
+
"properties": {
|
|
7
|
+
"commands": {
|
|
8
|
+
"description": "Predefined, ready-to-use, workspace-related commands",
|
|
9
|
+
"type": "array",
|
|
10
|
+
"items": {
|
|
11
|
+
"type": "object",
|
|
12
|
+
"required": ["id"],
|
|
13
|
+
"oneOf": [
|
|
14
|
+
{
|
|
15
|
+
"required": ["exec"]
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"required": ["apply"]
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
"required": ["vscodeTask"]
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"required": ["vscodeLaunch"]
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"required": ["composite"]
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"properties": {
|
|
31
|
+
"apply": {
|
|
32
|
+
"description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.",
|
|
33
|
+
"type": "object",
|
|
34
|
+
"required": ["component"],
|
|
35
|
+
"properties": {
|
|
36
|
+
"component": {
|
|
37
|
+
"description": "Describes component that will be applied",
|
|
38
|
+
"type": "string"
|
|
39
|
+
},
|
|
40
|
+
"group": {
|
|
41
|
+
"description": "Defines the group this command is part of",
|
|
42
|
+
"type": "object",
|
|
43
|
+
"required": ["kind"],
|
|
44
|
+
"properties": {
|
|
45
|
+
"isDefault": {
|
|
46
|
+
"description": "Identifies the default command for a given group kind",
|
|
47
|
+
"type": "boolean"
|
|
48
|
+
},
|
|
49
|
+
"kind": {
|
|
50
|
+
"description": "Kind of group the command is part of",
|
|
51
|
+
"type": "string",
|
|
52
|
+
"enum": ["build", "run", "test", "debug"]
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
"additionalProperties": false
|
|
56
|
+
},
|
|
57
|
+
"label": {
|
|
58
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
59
|
+
"type": "string"
|
|
60
|
+
}
|
|
61
|
+
},
|
|
62
|
+
"additionalProperties": false
|
|
63
|
+
},
|
|
64
|
+
"attributes": {
|
|
65
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
66
|
+
"type": "object",
|
|
67
|
+
"additionalProperties": true
|
|
68
|
+
},
|
|
69
|
+
"composite": {
|
|
70
|
+
"description": "Composite command that allows executing several sub-commands either sequentially or concurrently",
|
|
71
|
+
"type": "object",
|
|
72
|
+
"properties": {
|
|
73
|
+
"commands": {
|
|
74
|
+
"description": "The commands that comprise this composite command",
|
|
75
|
+
"type": "array",
|
|
76
|
+
"items": {
|
|
77
|
+
"type": "string"
|
|
78
|
+
}
|
|
79
|
+
},
|
|
80
|
+
"group": {
|
|
81
|
+
"description": "Defines the group this command is part of",
|
|
82
|
+
"type": "object",
|
|
83
|
+
"required": ["kind"],
|
|
84
|
+
"properties": {
|
|
85
|
+
"isDefault": {
|
|
86
|
+
"description": "Identifies the default command for a given group kind",
|
|
87
|
+
"type": "boolean"
|
|
88
|
+
},
|
|
89
|
+
"kind": {
|
|
90
|
+
"description": "Kind of group the command is part of",
|
|
91
|
+
"type": "string",
|
|
92
|
+
"enum": ["build", "run", "test", "debug"]
|
|
93
|
+
}
|
|
94
|
+
},
|
|
95
|
+
"additionalProperties": false
|
|
96
|
+
},
|
|
97
|
+
"label": {
|
|
98
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
99
|
+
"type": "string"
|
|
100
|
+
},
|
|
101
|
+
"parallel": {
|
|
102
|
+
"description": "Indicates if the sub-commands should be executed concurrently",
|
|
103
|
+
"type": "boolean"
|
|
104
|
+
}
|
|
105
|
+
},
|
|
106
|
+
"additionalProperties": false
|
|
107
|
+
},
|
|
108
|
+
"exec": {
|
|
109
|
+
"description": "CLI Command executed in an existing component container",
|
|
110
|
+
"type": "object",
|
|
111
|
+
"required": ["commandLine", "component"],
|
|
112
|
+
"properties": {
|
|
113
|
+
"commandLine": {
|
|
114
|
+
"description": "The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.",
|
|
115
|
+
"type": "string"
|
|
116
|
+
},
|
|
117
|
+
"component": {
|
|
118
|
+
"description": "Describes component to which given action relates",
|
|
119
|
+
"type": "string"
|
|
120
|
+
},
|
|
121
|
+
"env": {
|
|
122
|
+
"description": "Optional list of environment variables that have to be set before running the command",
|
|
123
|
+
"type": "array",
|
|
124
|
+
"items": {
|
|
125
|
+
"type": "object",
|
|
126
|
+
"required": ["name", "value"],
|
|
127
|
+
"properties": {
|
|
128
|
+
"name": {
|
|
129
|
+
"type": "string"
|
|
130
|
+
},
|
|
131
|
+
"value": {
|
|
132
|
+
"type": "string"
|
|
133
|
+
}
|
|
134
|
+
},
|
|
135
|
+
"additionalProperties": false
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
"group": {
|
|
139
|
+
"description": "Defines the group this command is part of",
|
|
140
|
+
"type": "object",
|
|
141
|
+
"required": ["kind"],
|
|
142
|
+
"properties": {
|
|
143
|
+
"isDefault": {
|
|
144
|
+
"description": "Identifies the default command for a given group kind",
|
|
145
|
+
"type": "boolean"
|
|
146
|
+
},
|
|
147
|
+
"kind": {
|
|
148
|
+
"description": "Kind of group the command is part of",
|
|
149
|
+
"type": "string",
|
|
150
|
+
"enum": ["build", "run", "test", "debug"]
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
"additionalProperties": false
|
|
154
|
+
},
|
|
155
|
+
"hotReloadCapable": {
|
|
156
|
+
"description": "Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\n\nDefault value is `false`",
|
|
157
|
+
"type": "boolean"
|
|
158
|
+
},
|
|
159
|
+
"label": {
|
|
160
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
161
|
+
"type": "string"
|
|
162
|
+
},
|
|
163
|
+
"workingDir": {
|
|
164
|
+
"description": "Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.",
|
|
165
|
+
"type": "string"
|
|
166
|
+
}
|
|
167
|
+
},
|
|
168
|
+
"additionalProperties": false
|
|
169
|
+
},
|
|
170
|
+
"id": {
|
|
171
|
+
"description": "Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.",
|
|
172
|
+
"type": "string",
|
|
173
|
+
"maxLength": 63,
|
|
174
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
175
|
+
},
|
|
176
|
+
"vscodeLaunch": {
|
|
177
|
+
"description": "Command providing the definition of a VsCode launch action",
|
|
178
|
+
"type": "object",
|
|
179
|
+
"oneOf": [
|
|
180
|
+
{
|
|
181
|
+
"required": ["uri"]
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"required": ["inlined"]
|
|
185
|
+
}
|
|
186
|
+
],
|
|
187
|
+
"properties": {
|
|
188
|
+
"group": {
|
|
189
|
+
"description": "Defines the group this command is part of",
|
|
190
|
+
"type": "object",
|
|
191
|
+
"required": ["kind"],
|
|
192
|
+
"properties": {
|
|
193
|
+
"isDefault": {
|
|
194
|
+
"description": "Identifies the default command for a given group kind",
|
|
195
|
+
"type": "boolean"
|
|
196
|
+
},
|
|
197
|
+
"kind": {
|
|
198
|
+
"description": "Kind of group the command is part of",
|
|
199
|
+
"type": "string",
|
|
200
|
+
"enum": ["build", "run", "test", "debug"]
|
|
201
|
+
}
|
|
202
|
+
},
|
|
203
|
+
"additionalProperties": false
|
|
204
|
+
},
|
|
205
|
+
"inlined": {
|
|
206
|
+
"description": "Inlined content of the VsCode configuration",
|
|
207
|
+
"type": "string"
|
|
208
|
+
},
|
|
209
|
+
"uri": {
|
|
210
|
+
"description": "Location as an absolute of relative URI the VsCode configuration will be fetched from",
|
|
211
|
+
"type": "string"
|
|
212
|
+
}
|
|
213
|
+
},
|
|
214
|
+
"additionalProperties": false
|
|
215
|
+
},
|
|
216
|
+
"vscodeTask": {
|
|
217
|
+
"description": "Command providing the definition of a VsCode Task",
|
|
218
|
+
"type": "object",
|
|
219
|
+
"oneOf": [
|
|
220
|
+
{
|
|
221
|
+
"required": ["uri"]
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"required": ["inlined"]
|
|
225
|
+
}
|
|
226
|
+
],
|
|
227
|
+
"properties": {
|
|
228
|
+
"group": {
|
|
229
|
+
"description": "Defines the group this command is part of",
|
|
230
|
+
"type": "object",
|
|
231
|
+
"required": ["kind"],
|
|
232
|
+
"properties": {
|
|
233
|
+
"isDefault": {
|
|
234
|
+
"description": "Identifies the default command for a given group kind",
|
|
235
|
+
"type": "boolean"
|
|
236
|
+
},
|
|
237
|
+
"kind": {
|
|
238
|
+
"description": "Kind of group the command is part of",
|
|
239
|
+
"type": "string",
|
|
240
|
+
"enum": ["build", "run", "test", "debug"]
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
"additionalProperties": false
|
|
244
|
+
},
|
|
245
|
+
"inlined": {
|
|
246
|
+
"description": "Inlined content of the VsCode configuration",
|
|
247
|
+
"type": "string"
|
|
248
|
+
},
|
|
249
|
+
"uri": {
|
|
250
|
+
"description": "Location as an absolute of relative URI the VsCode configuration will be fetched from",
|
|
251
|
+
"type": "string"
|
|
252
|
+
}
|
|
253
|
+
},
|
|
254
|
+
"additionalProperties": false
|
|
255
|
+
}
|
|
256
|
+
},
|
|
257
|
+
"additionalProperties": false
|
|
258
|
+
}
|
|
259
|
+
},
|
|
260
|
+
"components": {
|
|
261
|
+
"description": "List of the workspace components, such as editor and plugins, user-provided containers, or other types of components",
|
|
262
|
+
"type": "array",
|
|
263
|
+
"items": {
|
|
264
|
+
"type": "object",
|
|
265
|
+
"required": ["name"],
|
|
266
|
+
"oneOf": [
|
|
267
|
+
{
|
|
268
|
+
"required": ["container"]
|
|
269
|
+
},
|
|
270
|
+
{
|
|
271
|
+
"required": ["kubernetes"]
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"required": ["openshift"]
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
"required": ["volume"]
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"required": ["plugin"]
|
|
281
|
+
}
|
|
282
|
+
],
|
|
283
|
+
"properties": {
|
|
284
|
+
"attributes": {
|
|
285
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
286
|
+
"type": "object",
|
|
287
|
+
"additionalProperties": true
|
|
288
|
+
},
|
|
289
|
+
"container": {
|
|
290
|
+
"description": "Allows adding and configuring workspace-related containers",
|
|
291
|
+
"type": "object",
|
|
292
|
+
"required": ["image"],
|
|
293
|
+
"properties": {
|
|
294
|
+
"args": {
|
|
295
|
+
"description": "The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\n\nDefaults to an empty array, meaning use whatever is defined in the image.",
|
|
296
|
+
"type": "array",
|
|
297
|
+
"items": {
|
|
298
|
+
"type": "string"
|
|
299
|
+
}
|
|
300
|
+
},
|
|
301
|
+
"command": {
|
|
302
|
+
"description": "The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.",
|
|
303
|
+
"type": "array",
|
|
304
|
+
"items": {
|
|
305
|
+
"type": "string"
|
|
306
|
+
}
|
|
307
|
+
},
|
|
308
|
+
"dedicatedPod": {
|
|
309
|
+
"description": "Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`",
|
|
310
|
+
"type": "boolean"
|
|
311
|
+
},
|
|
312
|
+
"endpoints": {
|
|
313
|
+
"type": "array",
|
|
314
|
+
"items": {
|
|
315
|
+
"type": "object",
|
|
316
|
+
"required": ["name", "targetPort"],
|
|
317
|
+
"properties": {
|
|
318
|
+
"attributes": {
|
|
319
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
320
|
+
"type": "object",
|
|
321
|
+
"additionalProperties": true
|
|
322
|
+
},
|
|
323
|
+
"exposure": {
|
|
324
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
325
|
+
"type": "string",
|
|
326
|
+
"default": "public",
|
|
327
|
+
"enum": ["public", "internal", "none"]
|
|
328
|
+
},
|
|
329
|
+
"name": {
|
|
330
|
+
"type": "string",
|
|
331
|
+
"maxLength": 63,
|
|
332
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
333
|
+
},
|
|
334
|
+
"path": {
|
|
335
|
+
"description": "Path of the endpoint URL",
|
|
336
|
+
"type": "string"
|
|
337
|
+
},
|
|
338
|
+
"protocol": {
|
|
339
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
340
|
+
"type": "string",
|
|
341
|
+
"default": "http",
|
|
342
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
343
|
+
},
|
|
344
|
+
"secure": {
|
|
345
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
346
|
+
"type": "boolean"
|
|
347
|
+
},
|
|
348
|
+
"targetPort": {
|
|
349
|
+
"type": "integer"
|
|
350
|
+
}
|
|
351
|
+
},
|
|
352
|
+
"additionalProperties": false
|
|
353
|
+
}
|
|
354
|
+
},
|
|
355
|
+
"env": {
|
|
356
|
+
"description": "Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`",
|
|
357
|
+
"type": "array",
|
|
358
|
+
"items": {
|
|
359
|
+
"type": "object",
|
|
360
|
+
"required": ["name", "value"],
|
|
361
|
+
"properties": {
|
|
362
|
+
"name": {
|
|
363
|
+
"type": "string"
|
|
364
|
+
},
|
|
365
|
+
"value": {
|
|
366
|
+
"type": "string"
|
|
367
|
+
}
|
|
368
|
+
},
|
|
369
|
+
"additionalProperties": false
|
|
370
|
+
}
|
|
371
|
+
},
|
|
372
|
+
"image": {
|
|
373
|
+
"type": "string"
|
|
374
|
+
},
|
|
375
|
+
"memoryLimit": {
|
|
376
|
+
"type": "string"
|
|
377
|
+
},
|
|
378
|
+
"mountSources": {
|
|
379
|
+
"description": "Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.",
|
|
380
|
+
"type": "boolean"
|
|
381
|
+
},
|
|
382
|
+
"sourceMapping": {
|
|
383
|
+
"description": "Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.",
|
|
384
|
+
"type": "string",
|
|
385
|
+
"default": "/projects"
|
|
386
|
+
},
|
|
387
|
+
"volumeMounts": {
|
|
388
|
+
"description": "List of volumes mounts that should be mounted is this container.",
|
|
389
|
+
"type": "array",
|
|
390
|
+
"items": {
|
|
391
|
+
"description": "Volume that should be mounted to a component container",
|
|
392
|
+
"type": "object",
|
|
393
|
+
"required": ["name"],
|
|
394
|
+
"properties": {
|
|
395
|
+
"name": {
|
|
396
|
+
"description": "The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.",
|
|
397
|
+
"type": "string",
|
|
398
|
+
"maxLength": 63,
|
|
399
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
400
|
+
},
|
|
401
|
+
"path": {
|
|
402
|
+
"description": "The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/\u003cname\u003e`.",
|
|
403
|
+
"type": "string"
|
|
404
|
+
}
|
|
405
|
+
},
|
|
406
|
+
"additionalProperties": false
|
|
407
|
+
}
|
|
408
|
+
}
|
|
409
|
+
},
|
|
410
|
+
"additionalProperties": false
|
|
411
|
+
},
|
|
412
|
+
"kubernetes": {
|
|
413
|
+
"description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.",
|
|
414
|
+
"type": "object",
|
|
415
|
+
"oneOf": [
|
|
416
|
+
{
|
|
417
|
+
"required": ["uri"]
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"required": ["inlined"]
|
|
421
|
+
}
|
|
422
|
+
],
|
|
423
|
+
"properties": {
|
|
424
|
+
"endpoints": {
|
|
425
|
+
"type": "array",
|
|
426
|
+
"items": {
|
|
427
|
+
"type": "object",
|
|
428
|
+
"required": ["name", "targetPort"],
|
|
429
|
+
"properties": {
|
|
430
|
+
"attributes": {
|
|
431
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
432
|
+
"type": "object",
|
|
433
|
+
"additionalProperties": true
|
|
434
|
+
},
|
|
435
|
+
"exposure": {
|
|
436
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
437
|
+
"type": "string",
|
|
438
|
+
"default": "public",
|
|
439
|
+
"enum": ["public", "internal", "none"]
|
|
440
|
+
},
|
|
441
|
+
"name": {
|
|
442
|
+
"type": "string",
|
|
443
|
+
"maxLength": 63,
|
|
444
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
445
|
+
},
|
|
446
|
+
"path": {
|
|
447
|
+
"description": "Path of the endpoint URL",
|
|
448
|
+
"type": "string"
|
|
449
|
+
},
|
|
450
|
+
"protocol": {
|
|
451
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
452
|
+
"type": "string",
|
|
453
|
+
"default": "http",
|
|
454
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
455
|
+
},
|
|
456
|
+
"secure": {
|
|
457
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
458
|
+
"type": "boolean"
|
|
459
|
+
},
|
|
460
|
+
"targetPort": {
|
|
461
|
+
"type": "integer"
|
|
462
|
+
}
|
|
463
|
+
},
|
|
464
|
+
"additionalProperties": false
|
|
465
|
+
}
|
|
466
|
+
},
|
|
467
|
+
"inlined": {
|
|
468
|
+
"description": "Inlined manifest",
|
|
469
|
+
"type": "string"
|
|
470
|
+
},
|
|
471
|
+
"uri": {
|
|
472
|
+
"description": "Location in a file fetched from a uri.",
|
|
473
|
+
"type": "string"
|
|
474
|
+
}
|
|
475
|
+
},
|
|
476
|
+
"additionalProperties": false
|
|
477
|
+
},
|
|
478
|
+
"name": {
|
|
479
|
+
"description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.",
|
|
480
|
+
"type": "string",
|
|
481
|
+
"maxLength": 63,
|
|
482
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
483
|
+
},
|
|
484
|
+
"openshift": {
|
|
485
|
+
"description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.",
|
|
486
|
+
"type": "object",
|
|
487
|
+
"oneOf": [
|
|
488
|
+
{
|
|
489
|
+
"required": ["uri"]
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
"required": ["inlined"]
|
|
493
|
+
}
|
|
494
|
+
],
|
|
495
|
+
"properties": {
|
|
496
|
+
"endpoints": {
|
|
497
|
+
"type": "array",
|
|
498
|
+
"items": {
|
|
499
|
+
"type": "object",
|
|
500
|
+
"required": ["name", "targetPort"],
|
|
501
|
+
"properties": {
|
|
502
|
+
"attributes": {
|
|
503
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
504
|
+
"type": "object",
|
|
505
|
+
"additionalProperties": true
|
|
506
|
+
},
|
|
507
|
+
"exposure": {
|
|
508
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
509
|
+
"type": "string",
|
|
510
|
+
"default": "public",
|
|
511
|
+
"enum": ["public", "internal", "none"]
|
|
512
|
+
},
|
|
513
|
+
"name": {
|
|
514
|
+
"type": "string",
|
|
515
|
+
"maxLength": 63,
|
|
516
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
517
|
+
},
|
|
518
|
+
"path": {
|
|
519
|
+
"description": "Path of the endpoint URL",
|
|
520
|
+
"type": "string"
|
|
521
|
+
},
|
|
522
|
+
"protocol": {
|
|
523
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
524
|
+
"type": "string",
|
|
525
|
+
"default": "http",
|
|
526
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
527
|
+
},
|
|
528
|
+
"secure": {
|
|
529
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
530
|
+
"type": "boolean"
|
|
531
|
+
},
|
|
532
|
+
"targetPort": {
|
|
533
|
+
"type": "integer"
|
|
534
|
+
}
|
|
535
|
+
},
|
|
536
|
+
"additionalProperties": false
|
|
537
|
+
}
|
|
538
|
+
},
|
|
539
|
+
"inlined": {
|
|
540
|
+
"description": "Inlined manifest",
|
|
541
|
+
"type": "string"
|
|
542
|
+
},
|
|
543
|
+
"uri": {
|
|
544
|
+
"description": "Location in a file fetched from a uri.",
|
|
545
|
+
"type": "string"
|
|
546
|
+
}
|
|
547
|
+
},
|
|
548
|
+
"additionalProperties": false
|
|
549
|
+
},
|
|
550
|
+
"plugin": {
|
|
551
|
+
"description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources",
|
|
552
|
+
"type": "object",
|
|
553
|
+
"oneOf": [
|
|
554
|
+
{
|
|
555
|
+
"required": ["uri"]
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
"required": ["id"]
|
|
559
|
+
},
|
|
560
|
+
{
|
|
561
|
+
"required": ["kubernetes"]
|
|
562
|
+
}
|
|
563
|
+
],
|
|
564
|
+
"properties": {
|
|
565
|
+
"commands": {
|
|
566
|
+
"description": "Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
|
|
567
|
+
"type": "array",
|
|
568
|
+
"items": {
|
|
569
|
+
"type": "object",
|
|
570
|
+
"required": ["id"],
|
|
571
|
+
"oneOf": [
|
|
572
|
+
{
|
|
573
|
+
"required": ["exec"]
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
"required": ["apply"]
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
"required": ["vscodeTask"]
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"required": ["vscodeLaunch"]
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"required": ["composite"]
|
|
586
|
+
}
|
|
587
|
+
],
|
|
588
|
+
"properties": {
|
|
589
|
+
"apply": {
|
|
590
|
+
"description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.",
|
|
591
|
+
"type": "object",
|
|
592
|
+
"properties": {
|
|
593
|
+
"component": {
|
|
594
|
+
"description": "Describes component that will be applied",
|
|
595
|
+
"type": "string"
|
|
596
|
+
},
|
|
597
|
+
"group": {
|
|
598
|
+
"description": "Defines the group this command is part of",
|
|
599
|
+
"type": "object",
|
|
600
|
+
"properties": {
|
|
601
|
+
"isDefault": {
|
|
602
|
+
"description": "Identifies the default command for a given group kind",
|
|
603
|
+
"type": "boolean"
|
|
604
|
+
},
|
|
605
|
+
"kind": {
|
|
606
|
+
"description": "Kind of group the command is part of",
|
|
607
|
+
"type": "string",
|
|
608
|
+
"enum": ["build", "run", "test", "debug"]
|
|
609
|
+
}
|
|
610
|
+
},
|
|
611
|
+
"additionalProperties": false
|
|
612
|
+
},
|
|
613
|
+
"label": {
|
|
614
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
615
|
+
"type": "string"
|
|
616
|
+
}
|
|
617
|
+
},
|
|
618
|
+
"additionalProperties": false
|
|
619
|
+
},
|
|
620
|
+
"attributes": {
|
|
621
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
622
|
+
"type": "object",
|
|
623
|
+
"additionalProperties": true
|
|
624
|
+
},
|
|
625
|
+
"composite": {
|
|
626
|
+
"description": "Composite command that allows executing several sub-commands either sequentially or concurrently",
|
|
627
|
+
"type": "object",
|
|
628
|
+
"properties": {
|
|
629
|
+
"commands": {
|
|
630
|
+
"description": "The commands that comprise this composite command",
|
|
631
|
+
"type": "array",
|
|
632
|
+
"items": {
|
|
633
|
+
"type": "string"
|
|
634
|
+
}
|
|
635
|
+
},
|
|
636
|
+
"group": {
|
|
637
|
+
"description": "Defines the group this command is part of",
|
|
638
|
+
"type": "object",
|
|
639
|
+
"properties": {
|
|
640
|
+
"isDefault": {
|
|
641
|
+
"description": "Identifies the default command for a given group kind",
|
|
642
|
+
"type": "boolean"
|
|
643
|
+
},
|
|
644
|
+
"kind": {
|
|
645
|
+
"description": "Kind of group the command is part of",
|
|
646
|
+
"type": "string",
|
|
647
|
+
"enum": ["build", "run", "test", "debug"]
|
|
648
|
+
}
|
|
649
|
+
},
|
|
650
|
+
"additionalProperties": false
|
|
651
|
+
},
|
|
652
|
+
"label": {
|
|
653
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
654
|
+
"type": "string"
|
|
655
|
+
},
|
|
656
|
+
"parallel": {
|
|
657
|
+
"description": "Indicates if the sub-commands should be executed concurrently",
|
|
658
|
+
"type": "boolean"
|
|
659
|
+
}
|
|
660
|
+
},
|
|
661
|
+
"additionalProperties": false
|
|
662
|
+
},
|
|
663
|
+
"exec": {
|
|
664
|
+
"description": "CLI Command executed in an existing component container",
|
|
665
|
+
"type": "object",
|
|
666
|
+
"properties": {
|
|
667
|
+
"commandLine": {
|
|
668
|
+
"description": "The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.",
|
|
669
|
+
"type": "string"
|
|
670
|
+
},
|
|
671
|
+
"component": {
|
|
672
|
+
"description": "Describes component to which given action relates",
|
|
673
|
+
"type": "string"
|
|
674
|
+
},
|
|
675
|
+
"env": {
|
|
676
|
+
"description": "Optional list of environment variables that have to be set before running the command",
|
|
677
|
+
"type": "array",
|
|
678
|
+
"items": {
|
|
679
|
+
"type": "object",
|
|
680
|
+
"required": ["name"],
|
|
681
|
+
"properties": {
|
|
682
|
+
"name": {
|
|
683
|
+
"type": "string"
|
|
684
|
+
},
|
|
685
|
+
"value": {
|
|
686
|
+
"type": "string"
|
|
687
|
+
}
|
|
688
|
+
},
|
|
689
|
+
"additionalProperties": false
|
|
690
|
+
}
|
|
691
|
+
},
|
|
692
|
+
"group": {
|
|
693
|
+
"description": "Defines the group this command is part of",
|
|
694
|
+
"type": "object",
|
|
695
|
+
"properties": {
|
|
696
|
+
"isDefault": {
|
|
697
|
+
"description": "Identifies the default command for a given group kind",
|
|
698
|
+
"type": "boolean"
|
|
699
|
+
},
|
|
700
|
+
"kind": {
|
|
701
|
+
"description": "Kind of group the command is part of",
|
|
702
|
+
"type": "string",
|
|
703
|
+
"enum": ["build", "run", "test", "debug"]
|
|
704
|
+
}
|
|
705
|
+
},
|
|
706
|
+
"additionalProperties": false
|
|
707
|
+
},
|
|
708
|
+
"hotReloadCapable": {
|
|
709
|
+
"description": "Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\n\nDefault value is `false`",
|
|
710
|
+
"type": "boolean"
|
|
711
|
+
},
|
|
712
|
+
"label": {
|
|
713
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
714
|
+
"type": "string"
|
|
715
|
+
},
|
|
716
|
+
"workingDir": {
|
|
717
|
+
"description": "Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.",
|
|
718
|
+
"type": "string"
|
|
719
|
+
}
|
|
720
|
+
},
|
|
721
|
+
"additionalProperties": false
|
|
722
|
+
},
|
|
723
|
+
"id": {
|
|
724
|
+
"description": "Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.",
|
|
725
|
+
"type": "string",
|
|
726
|
+
"maxLength": 63,
|
|
727
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
728
|
+
},
|
|
729
|
+
"vscodeLaunch": {
|
|
730
|
+
"description": "Command providing the definition of a VsCode launch action",
|
|
731
|
+
"type": "object",
|
|
732
|
+
"oneOf": [
|
|
733
|
+
{
|
|
734
|
+
"required": ["uri"]
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
"required": ["inlined"]
|
|
738
|
+
}
|
|
739
|
+
],
|
|
740
|
+
"properties": {
|
|
741
|
+
"group": {
|
|
742
|
+
"description": "Defines the group this command is part of",
|
|
743
|
+
"type": "object",
|
|
744
|
+
"properties": {
|
|
745
|
+
"isDefault": {
|
|
746
|
+
"description": "Identifies the default command for a given group kind",
|
|
747
|
+
"type": "boolean"
|
|
748
|
+
},
|
|
749
|
+
"kind": {
|
|
750
|
+
"description": "Kind of group the command is part of",
|
|
751
|
+
"type": "string",
|
|
752
|
+
"enum": ["build", "run", "test", "debug"]
|
|
753
|
+
}
|
|
754
|
+
},
|
|
755
|
+
"additionalProperties": false
|
|
756
|
+
},
|
|
757
|
+
"inlined": {
|
|
758
|
+
"description": "Inlined content of the VsCode configuration",
|
|
759
|
+
"type": "string"
|
|
760
|
+
},
|
|
761
|
+
"uri": {
|
|
762
|
+
"description": "Location as an absolute of relative URI the VsCode configuration will be fetched from",
|
|
763
|
+
"type": "string"
|
|
764
|
+
}
|
|
765
|
+
},
|
|
766
|
+
"additionalProperties": false
|
|
767
|
+
},
|
|
768
|
+
"vscodeTask": {
|
|
769
|
+
"description": "Command providing the definition of a VsCode Task",
|
|
770
|
+
"type": "object",
|
|
771
|
+
"oneOf": [
|
|
772
|
+
{
|
|
773
|
+
"required": ["uri"]
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"required": ["inlined"]
|
|
777
|
+
}
|
|
778
|
+
],
|
|
779
|
+
"properties": {
|
|
780
|
+
"group": {
|
|
781
|
+
"description": "Defines the group this command is part of",
|
|
782
|
+
"type": "object",
|
|
783
|
+
"properties": {
|
|
784
|
+
"isDefault": {
|
|
785
|
+
"description": "Identifies the default command for a given group kind",
|
|
786
|
+
"type": "boolean"
|
|
787
|
+
},
|
|
788
|
+
"kind": {
|
|
789
|
+
"description": "Kind of group the command is part of",
|
|
790
|
+
"type": "string",
|
|
791
|
+
"enum": ["build", "run", "test", "debug"]
|
|
792
|
+
}
|
|
793
|
+
},
|
|
794
|
+
"additionalProperties": false
|
|
795
|
+
},
|
|
796
|
+
"inlined": {
|
|
797
|
+
"description": "Inlined content of the VsCode configuration",
|
|
798
|
+
"type": "string"
|
|
799
|
+
},
|
|
800
|
+
"uri": {
|
|
801
|
+
"description": "Location as an absolute of relative URI the VsCode configuration will be fetched from",
|
|
802
|
+
"type": "string"
|
|
803
|
+
}
|
|
804
|
+
},
|
|
805
|
+
"additionalProperties": false
|
|
806
|
+
}
|
|
807
|
+
},
|
|
808
|
+
"additionalProperties": false
|
|
809
|
+
}
|
|
810
|
+
},
|
|
811
|
+
"components": {
|
|
812
|
+
"description": "Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
|
|
813
|
+
"type": "array",
|
|
814
|
+
"items": {
|
|
815
|
+
"type": "object",
|
|
816
|
+
"required": ["name"],
|
|
817
|
+
"oneOf": [
|
|
818
|
+
{
|
|
819
|
+
"required": ["container"]
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"required": ["kubernetes"]
|
|
823
|
+
},
|
|
824
|
+
{
|
|
825
|
+
"required": ["openshift"]
|
|
826
|
+
},
|
|
827
|
+
{
|
|
828
|
+
"required": ["volume"]
|
|
829
|
+
}
|
|
830
|
+
],
|
|
831
|
+
"properties": {
|
|
832
|
+
"attributes": {
|
|
833
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
834
|
+
"type": "object",
|
|
835
|
+
"additionalProperties": true
|
|
836
|
+
},
|
|
837
|
+
"container": {
|
|
838
|
+
"description": "Allows adding and configuring workspace-related containers",
|
|
839
|
+
"type": "object",
|
|
840
|
+
"properties": {
|
|
841
|
+
"args": {
|
|
842
|
+
"description": "The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\n\nDefaults to an empty array, meaning use whatever is defined in the image.",
|
|
843
|
+
"type": "array",
|
|
844
|
+
"items": {
|
|
845
|
+
"type": "string"
|
|
846
|
+
}
|
|
847
|
+
},
|
|
848
|
+
"command": {
|
|
849
|
+
"description": "The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.",
|
|
850
|
+
"type": "array",
|
|
851
|
+
"items": {
|
|
852
|
+
"type": "string"
|
|
853
|
+
}
|
|
854
|
+
},
|
|
855
|
+
"dedicatedPod": {
|
|
856
|
+
"description": "Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`",
|
|
857
|
+
"type": "boolean"
|
|
858
|
+
},
|
|
859
|
+
"endpoints": {
|
|
860
|
+
"type": "array",
|
|
861
|
+
"items": {
|
|
862
|
+
"type": "object",
|
|
863
|
+
"required": ["name"],
|
|
864
|
+
"properties": {
|
|
865
|
+
"attributes": {
|
|
866
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
867
|
+
"type": "object",
|
|
868
|
+
"additionalProperties": true
|
|
869
|
+
},
|
|
870
|
+
"exposure": {
|
|
871
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
872
|
+
"type": "string",
|
|
873
|
+
"enum": ["public", "internal", "none"]
|
|
874
|
+
},
|
|
875
|
+
"name": {
|
|
876
|
+
"type": "string",
|
|
877
|
+
"maxLength": 63,
|
|
878
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
879
|
+
},
|
|
880
|
+
"path": {
|
|
881
|
+
"description": "Path of the endpoint URL",
|
|
882
|
+
"type": "string"
|
|
883
|
+
},
|
|
884
|
+
"protocol": {
|
|
885
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
886
|
+
"type": "string",
|
|
887
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
888
|
+
},
|
|
889
|
+
"secure": {
|
|
890
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
891
|
+
"type": "boolean"
|
|
892
|
+
},
|
|
893
|
+
"targetPort": {
|
|
894
|
+
"type": "integer"
|
|
895
|
+
}
|
|
896
|
+
},
|
|
897
|
+
"additionalProperties": false
|
|
898
|
+
}
|
|
899
|
+
},
|
|
900
|
+
"env": {
|
|
901
|
+
"description": "Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`",
|
|
902
|
+
"type": "array",
|
|
903
|
+
"items": {
|
|
904
|
+
"type": "object",
|
|
905
|
+
"required": ["name"],
|
|
906
|
+
"properties": {
|
|
907
|
+
"name": {
|
|
908
|
+
"type": "string"
|
|
909
|
+
},
|
|
910
|
+
"value": {
|
|
911
|
+
"type": "string"
|
|
912
|
+
}
|
|
913
|
+
},
|
|
914
|
+
"additionalProperties": false
|
|
915
|
+
}
|
|
916
|
+
},
|
|
917
|
+
"image": {
|
|
918
|
+
"type": "string"
|
|
919
|
+
},
|
|
920
|
+
"memoryLimit": {
|
|
921
|
+
"type": "string"
|
|
922
|
+
},
|
|
923
|
+
"mountSources": {
|
|
924
|
+
"description": "Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.",
|
|
925
|
+
"type": "boolean"
|
|
926
|
+
},
|
|
927
|
+
"sourceMapping": {
|
|
928
|
+
"description": "Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.",
|
|
929
|
+
"type": "string"
|
|
930
|
+
},
|
|
931
|
+
"volumeMounts": {
|
|
932
|
+
"description": "List of volumes mounts that should be mounted is this container.",
|
|
933
|
+
"type": "array",
|
|
934
|
+
"items": {
|
|
935
|
+
"description": "Volume that should be mounted to a component container",
|
|
936
|
+
"type": "object",
|
|
937
|
+
"required": ["name"],
|
|
938
|
+
"properties": {
|
|
939
|
+
"name": {
|
|
940
|
+
"description": "The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.",
|
|
941
|
+
"type": "string",
|
|
942
|
+
"maxLength": 63,
|
|
943
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
944
|
+
},
|
|
945
|
+
"path": {
|
|
946
|
+
"description": "The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/\u003cname\u003e`.",
|
|
947
|
+
"type": "string"
|
|
948
|
+
}
|
|
949
|
+
},
|
|
950
|
+
"additionalProperties": false
|
|
951
|
+
}
|
|
952
|
+
}
|
|
953
|
+
},
|
|
954
|
+
"additionalProperties": false
|
|
955
|
+
},
|
|
956
|
+
"kubernetes": {
|
|
957
|
+
"description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.",
|
|
958
|
+
"type": "object",
|
|
959
|
+
"oneOf": [
|
|
960
|
+
{
|
|
961
|
+
"required": ["uri"]
|
|
962
|
+
},
|
|
963
|
+
{
|
|
964
|
+
"required": ["inlined"]
|
|
965
|
+
}
|
|
966
|
+
],
|
|
967
|
+
"properties": {
|
|
968
|
+
"endpoints": {
|
|
969
|
+
"type": "array",
|
|
970
|
+
"items": {
|
|
971
|
+
"type": "object",
|
|
972
|
+
"required": ["name"],
|
|
973
|
+
"properties": {
|
|
974
|
+
"attributes": {
|
|
975
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
976
|
+
"type": "object",
|
|
977
|
+
"additionalProperties": true
|
|
978
|
+
},
|
|
979
|
+
"exposure": {
|
|
980
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
981
|
+
"type": "string",
|
|
982
|
+
"enum": ["public", "internal", "none"]
|
|
983
|
+
},
|
|
984
|
+
"name": {
|
|
985
|
+
"type": "string",
|
|
986
|
+
"maxLength": 63,
|
|
987
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
988
|
+
},
|
|
989
|
+
"path": {
|
|
990
|
+
"description": "Path of the endpoint URL",
|
|
991
|
+
"type": "string"
|
|
992
|
+
},
|
|
993
|
+
"protocol": {
|
|
994
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
995
|
+
"type": "string",
|
|
996
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
997
|
+
},
|
|
998
|
+
"secure": {
|
|
999
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
1000
|
+
"type": "boolean"
|
|
1001
|
+
},
|
|
1002
|
+
"targetPort": {
|
|
1003
|
+
"type": "integer"
|
|
1004
|
+
}
|
|
1005
|
+
},
|
|
1006
|
+
"additionalProperties": false
|
|
1007
|
+
}
|
|
1008
|
+
},
|
|
1009
|
+
"inlined": {
|
|
1010
|
+
"description": "Inlined manifest",
|
|
1011
|
+
"type": "string"
|
|
1012
|
+
},
|
|
1013
|
+
"uri": {
|
|
1014
|
+
"description": "Location in a file fetched from a uri.",
|
|
1015
|
+
"type": "string"
|
|
1016
|
+
}
|
|
1017
|
+
},
|
|
1018
|
+
"additionalProperties": false
|
|
1019
|
+
},
|
|
1020
|
+
"name": {
|
|
1021
|
+
"description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.",
|
|
1022
|
+
"type": "string",
|
|
1023
|
+
"maxLength": 63,
|
|
1024
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
1025
|
+
},
|
|
1026
|
+
"openshift": {
|
|
1027
|
+
"description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.",
|
|
1028
|
+
"type": "object",
|
|
1029
|
+
"oneOf": [
|
|
1030
|
+
{
|
|
1031
|
+
"required": ["uri"]
|
|
1032
|
+
},
|
|
1033
|
+
{
|
|
1034
|
+
"required": ["inlined"]
|
|
1035
|
+
}
|
|
1036
|
+
],
|
|
1037
|
+
"properties": {
|
|
1038
|
+
"endpoints": {
|
|
1039
|
+
"type": "array",
|
|
1040
|
+
"items": {
|
|
1041
|
+
"type": "object",
|
|
1042
|
+
"required": ["name"],
|
|
1043
|
+
"properties": {
|
|
1044
|
+
"attributes": {
|
|
1045
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
1046
|
+
"type": "object",
|
|
1047
|
+
"additionalProperties": true
|
|
1048
|
+
},
|
|
1049
|
+
"exposure": {
|
|
1050
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
1051
|
+
"type": "string",
|
|
1052
|
+
"enum": ["public", "internal", "none"]
|
|
1053
|
+
},
|
|
1054
|
+
"name": {
|
|
1055
|
+
"type": "string",
|
|
1056
|
+
"maxLength": 63,
|
|
1057
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
1058
|
+
},
|
|
1059
|
+
"path": {
|
|
1060
|
+
"description": "Path of the endpoint URL",
|
|
1061
|
+
"type": "string"
|
|
1062
|
+
},
|
|
1063
|
+
"protocol": {
|
|
1064
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
1065
|
+
"type": "string",
|
|
1066
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
1067
|
+
},
|
|
1068
|
+
"secure": {
|
|
1069
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
1070
|
+
"type": "boolean"
|
|
1071
|
+
},
|
|
1072
|
+
"targetPort": {
|
|
1073
|
+
"type": "integer"
|
|
1074
|
+
}
|
|
1075
|
+
},
|
|
1076
|
+
"additionalProperties": false
|
|
1077
|
+
}
|
|
1078
|
+
},
|
|
1079
|
+
"inlined": {
|
|
1080
|
+
"description": "Inlined manifest",
|
|
1081
|
+
"type": "string"
|
|
1082
|
+
},
|
|
1083
|
+
"uri": {
|
|
1084
|
+
"description": "Location in a file fetched from a uri.",
|
|
1085
|
+
"type": "string"
|
|
1086
|
+
}
|
|
1087
|
+
},
|
|
1088
|
+
"additionalProperties": false
|
|
1089
|
+
},
|
|
1090
|
+
"volume": {
|
|
1091
|
+
"description": "Allows specifying the definition of a volume shared by several other components",
|
|
1092
|
+
"type": "object",
|
|
1093
|
+
"properties": {
|
|
1094
|
+
"size": {
|
|
1095
|
+
"description": "Size of the volume",
|
|
1096
|
+
"type": "string"
|
|
1097
|
+
}
|
|
1098
|
+
},
|
|
1099
|
+
"additionalProperties": false
|
|
1100
|
+
}
|
|
1101
|
+
},
|
|
1102
|
+
"additionalProperties": false
|
|
1103
|
+
}
|
|
1104
|
+
},
|
|
1105
|
+
"id": {
|
|
1106
|
+
"description": "Id in a registry that contains a Devfile yaml file",
|
|
1107
|
+
"type": "string"
|
|
1108
|
+
},
|
|
1109
|
+
"kubernetes": {
|
|
1110
|
+
"description": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate",
|
|
1111
|
+
"type": "object",
|
|
1112
|
+
"required": ["name"],
|
|
1113
|
+
"properties": {
|
|
1114
|
+
"name": {
|
|
1115
|
+
"type": "string"
|
|
1116
|
+
},
|
|
1117
|
+
"namespace": {
|
|
1118
|
+
"type": "string"
|
|
1119
|
+
}
|
|
1120
|
+
},
|
|
1121
|
+
"additionalProperties": false
|
|
1122
|
+
},
|
|
1123
|
+
"registryUrl": {
|
|
1124
|
+
"type": "string"
|
|
1125
|
+
},
|
|
1126
|
+
"uri": {
|
|
1127
|
+
"description": "Uri of a Devfile yaml file",
|
|
1128
|
+
"type": "string"
|
|
1129
|
+
}
|
|
1130
|
+
},
|
|
1131
|
+
"additionalProperties": false
|
|
1132
|
+
},
|
|
1133
|
+
"volume": {
|
|
1134
|
+
"description": "Allows specifying the definition of a volume shared by several other components",
|
|
1135
|
+
"type": "object",
|
|
1136
|
+
"properties": {
|
|
1137
|
+
"size": {
|
|
1138
|
+
"description": "Size of the volume",
|
|
1139
|
+
"type": "string"
|
|
1140
|
+
}
|
|
1141
|
+
},
|
|
1142
|
+
"additionalProperties": false
|
|
1143
|
+
}
|
|
1144
|
+
},
|
|
1145
|
+
"additionalProperties": false
|
|
1146
|
+
}
|
|
1147
|
+
},
|
|
1148
|
+
"events": {
|
|
1149
|
+
"description": "Bindings of commands to events. Each command is referred-to by its name.",
|
|
1150
|
+
"type": "object",
|
|
1151
|
+
"properties": {
|
|
1152
|
+
"postStart": {
|
|
1153
|
+
"description": "IDs of commands that should be executed after the workspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.",
|
|
1154
|
+
"type": "array",
|
|
1155
|
+
"items": {
|
|
1156
|
+
"type": "string"
|
|
1157
|
+
}
|
|
1158
|
+
},
|
|
1159
|
+
"postStop": {
|
|
1160
|
+
"description": "IDs of commands that should be executed after stopping the workspace.",
|
|
1161
|
+
"type": "array",
|
|
1162
|
+
"items": {
|
|
1163
|
+
"type": "string"
|
|
1164
|
+
}
|
|
1165
|
+
},
|
|
1166
|
+
"preStart": {
|
|
1167
|
+
"description": "IDs of commands that should be executed before the workspace start. Kubernetes-wise, these commands would typically be executed in init containers of the workspace POD.",
|
|
1168
|
+
"type": "array",
|
|
1169
|
+
"items": {
|
|
1170
|
+
"type": "string"
|
|
1171
|
+
}
|
|
1172
|
+
},
|
|
1173
|
+
"preStop": {
|
|
1174
|
+
"description": "IDs of commands that should be executed before stopping the workspace.",
|
|
1175
|
+
"type": "array",
|
|
1176
|
+
"items": {
|
|
1177
|
+
"type": "string"
|
|
1178
|
+
}
|
|
1179
|
+
}
|
|
1180
|
+
},
|
|
1181
|
+
"additionalProperties": false
|
|
1182
|
+
},
|
|
1183
|
+
"metadata": {
|
|
1184
|
+
"description": "Optional metadata",
|
|
1185
|
+
"type": "object",
|
|
1186
|
+
"properties": {
|
|
1187
|
+
"attributes": {
|
|
1188
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
1189
|
+
"type": "object",
|
|
1190
|
+
"additionalProperties": true
|
|
1191
|
+
},
|
|
1192
|
+
"description": {
|
|
1193
|
+
"description": "Optional devfile description",
|
|
1194
|
+
"type": "string"
|
|
1195
|
+
},
|
|
1196
|
+
"displayName": {
|
|
1197
|
+
"description": "Optional devfile display name",
|
|
1198
|
+
"type": "string"
|
|
1199
|
+
},
|
|
1200
|
+
"globalMemoryLimit": {
|
|
1201
|
+
"description": "Optional devfile global memory limit",
|
|
1202
|
+
"type": "string"
|
|
1203
|
+
},
|
|
1204
|
+
"icon": {
|
|
1205
|
+
"description": "Optional devfile icon",
|
|
1206
|
+
"type": "string"
|
|
1207
|
+
},
|
|
1208
|
+
"name": {
|
|
1209
|
+
"description": "Optional devfile name",
|
|
1210
|
+
"type": "string"
|
|
1211
|
+
},
|
|
1212
|
+
"tags": {
|
|
1213
|
+
"description": "Optional devfile tags",
|
|
1214
|
+
"type": "array",
|
|
1215
|
+
"items": {
|
|
1216
|
+
"type": "string"
|
|
1217
|
+
}
|
|
1218
|
+
},
|
|
1219
|
+
"version": {
|
|
1220
|
+
"description": "Optional semver-compatible version",
|
|
1221
|
+
"type": "string",
|
|
1222
|
+
"pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"
|
|
1223
|
+
}
|
|
1224
|
+
},
|
|
1225
|
+
"additionalProperties": true
|
|
1226
|
+
},
|
|
1227
|
+
"parent": {
|
|
1228
|
+
"description": "Parent workspace template",
|
|
1229
|
+
"type": "object",
|
|
1230
|
+
"oneOf": [
|
|
1231
|
+
{
|
|
1232
|
+
"required": ["uri"]
|
|
1233
|
+
},
|
|
1234
|
+
{
|
|
1235
|
+
"required": ["id"]
|
|
1236
|
+
},
|
|
1237
|
+
{
|
|
1238
|
+
"required": ["kubernetes"]
|
|
1239
|
+
}
|
|
1240
|
+
],
|
|
1241
|
+
"properties": {
|
|
1242
|
+
"commands": {
|
|
1243
|
+
"description": "Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
|
|
1244
|
+
"type": "array",
|
|
1245
|
+
"items": {
|
|
1246
|
+
"type": "object",
|
|
1247
|
+
"required": ["id"],
|
|
1248
|
+
"oneOf": [
|
|
1249
|
+
{
|
|
1250
|
+
"required": ["exec"]
|
|
1251
|
+
},
|
|
1252
|
+
{
|
|
1253
|
+
"required": ["apply"]
|
|
1254
|
+
},
|
|
1255
|
+
{
|
|
1256
|
+
"required": ["vscodeTask"]
|
|
1257
|
+
},
|
|
1258
|
+
{
|
|
1259
|
+
"required": ["vscodeLaunch"]
|
|
1260
|
+
},
|
|
1261
|
+
{
|
|
1262
|
+
"required": ["composite"]
|
|
1263
|
+
}
|
|
1264
|
+
],
|
|
1265
|
+
"properties": {
|
|
1266
|
+
"apply": {
|
|
1267
|
+
"description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.",
|
|
1268
|
+
"type": "object",
|
|
1269
|
+
"properties": {
|
|
1270
|
+
"component": {
|
|
1271
|
+
"description": "Describes component that will be applied",
|
|
1272
|
+
"type": "string"
|
|
1273
|
+
},
|
|
1274
|
+
"group": {
|
|
1275
|
+
"description": "Defines the group this command is part of",
|
|
1276
|
+
"type": "object",
|
|
1277
|
+
"properties": {
|
|
1278
|
+
"isDefault": {
|
|
1279
|
+
"description": "Identifies the default command for a given group kind",
|
|
1280
|
+
"type": "boolean"
|
|
1281
|
+
},
|
|
1282
|
+
"kind": {
|
|
1283
|
+
"description": "Kind of group the command is part of",
|
|
1284
|
+
"type": "string",
|
|
1285
|
+
"enum": ["build", "run", "test", "debug"]
|
|
1286
|
+
}
|
|
1287
|
+
},
|
|
1288
|
+
"additionalProperties": false
|
|
1289
|
+
},
|
|
1290
|
+
"label": {
|
|
1291
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
1292
|
+
"type": "string"
|
|
1293
|
+
}
|
|
1294
|
+
},
|
|
1295
|
+
"additionalProperties": false
|
|
1296
|
+
},
|
|
1297
|
+
"attributes": {
|
|
1298
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
1299
|
+
"type": "object",
|
|
1300
|
+
"additionalProperties": true
|
|
1301
|
+
},
|
|
1302
|
+
"composite": {
|
|
1303
|
+
"description": "Composite command that allows executing several sub-commands either sequentially or concurrently",
|
|
1304
|
+
"type": "object",
|
|
1305
|
+
"properties": {
|
|
1306
|
+
"commands": {
|
|
1307
|
+
"description": "The commands that comprise this composite command",
|
|
1308
|
+
"type": "array",
|
|
1309
|
+
"items": {
|
|
1310
|
+
"type": "string"
|
|
1311
|
+
}
|
|
1312
|
+
},
|
|
1313
|
+
"group": {
|
|
1314
|
+
"description": "Defines the group this command is part of",
|
|
1315
|
+
"type": "object",
|
|
1316
|
+
"properties": {
|
|
1317
|
+
"isDefault": {
|
|
1318
|
+
"description": "Identifies the default command for a given group kind",
|
|
1319
|
+
"type": "boolean"
|
|
1320
|
+
},
|
|
1321
|
+
"kind": {
|
|
1322
|
+
"description": "Kind of group the command is part of",
|
|
1323
|
+
"type": "string",
|
|
1324
|
+
"enum": ["build", "run", "test", "debug"]
|
|
1325
|
+
}
|
|
1326
|
+
},
|
|
1327
|
+
"additionalProperties": false
|
|
1328
|
+
},
|
|
1329
|
+
"label": {
|
|
1330
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
1331
|
+
"type": "string"
|
|
1332
|
+
},
|
|
1333
|
+
"parallel": {
|
|
1334
|
+
"description": "Indicates if the sub-commands should be executed concurrently",
|
|
1335
|
+
"type": "boolean"
|
|
1336
|
+
}
|
|
1337
|
+
},
|
|
1338
|
+
"additionalProperties": false
|
|
1339
|
+
},
|
|
1340
|
+
"exec": {
|
|
1341
|
+
"description": "CLI Command executed in an existing component container",
|
|
1342
|
+
"type": "object",
|
|
1343
|
+
"properties": {
|
|
1344
|
+
"commandLine": {
|
|
1345
|
+
"description": "The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.",
|
|
1346
|
+
"type": "string"
|
|
1347
|
+
},
|
|
1348
|
+
"component": {
|
|
1349
|
+
"description": "Describes component to which given action relates",
|
|
1350
|
+
"type": "string"
|
|
1351
|
+
},
|
|
1352
|
+
"env": {
|
|
1353
|
+
"description": "Optional list of environment variables that have to be set before running the command",
|
|
1354
|
+
"type": "array",
|
|
1355
|
+
"items": {
|
|
1356
|
+
"type": "object",
|
|
1357
|
+
"required": ["name"],
|
|
1358
|
+
"properties": {
|
|
1359
|
+
"name": {
|
|
1360
|
+
"type": "string"
|
|
1361
|
+
},
|
|
1362
|
+
"value": {
|
|
1363
|
+
"type": "string"
|
|
1364
|
+
}
|
|
1365
|
+
},
|
|
1366
|
+
"additionalProperties": false
|
|
1367
|
+
}
|
|
1368
|
+
},
|
|
1369
|
+
"group": {
|
|
1370
|
+
"description": "Defines the group this command is part of",
|
|
1371
|
+
"type": "object",
|
|
1372
|
+
"properties": {
|
|
1373
|
+
"isDefault": {
|
|
1374
|
+
"description": "Identifies the default command for a given group kind",
|
|
1375
|
+
"type": "boolean"
|
|
1376
|
+
},
|
|
1377
|
+
"kind": {
|
|
1378
|
+
"description": "Kind of group the command is part of",
|
|
1379
|
+
"type": "string",
|
|
1380
|
+
"enum": ["build", "run", "test", "debug"]
|
|
1381
|
+
}
|
|
1382
|
+
},
|
|
1383
|
+
"additionalProperties": false
|
|
1384
|
+
},
|
|
1385
|
+
"hotReloadCapable": {
|
|
1386
|
+
"description": "Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\n\nDefault value is `false`",
|
|
1387
|
+
"type": "boolean"
|
|
1388
|
+
},
|
|
1389
|
+
"label": {
|
|
1390
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
1391
|
+
"type": "string"
|
|
1392
|
+
},
|
|
1393
|
+
"workingDir": {
|
|
1394
|
+
"description": "Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.",
|
|
1395
|
+
"type": "string"
|
|
1396
|
+
}
|
|
1397
|
+
},
|
|
1398
|
+
"additionalProperties": false
|
|
1399
|
+
},
|
|
1400
|
+
"id": {
|
|
1401
|
+
"description": "Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.",
|
|
1402
|
+
"type": "string",
|
|
1403
|
+
"maxLength": 63,
|
|
1404
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
1405
|
+
},
|
|
1406
|
+
"vscodeLaunch": {
|
|
1407
|
+
"description": "Command providing the definition of a VsCode launch action",
|
|
1408
|
+
"type": "object",
|
|
1409
|
+
"oneOf": [
|
|
1410
|
+
{
|
|
1411
|
+
"required": ["uri"]
|
|
1412
|
+
},
|
|
1413
|
+
{
|
|
1414
|
+
"required": ["inlined"]
|
|
1415
|
+
}
|
|
1416
|
+
],
|
|
1417
|
+
"properties": {
|
|
1418
|
+
"group": {
|
|
1419
|
+
"description": "Defines the group this command is part of",
|
|
1420
|
+
"type": "object",
|
|
1421
|
+
"properties": {
|
|
1422
|
+
"isDefault": {
|
|
1423
|
+
"description": "Identifies the default command for a given group kind",
|
|
1424
|
+
"type": "boolean"
|
|
1425
|
+
},
|
|
1426
|
+
"kind": {
|
|
1427
|
+
"description": "Kind of group the command is part of",
|
|
1428
|
+
"type": "string",
|
|
1429
|
+
"enum": ["build", "run", "test", "debug"]
|
|
1430
|
+
}
|
|
1431
|
+
},
|
|
1432
|
+
"additionalProperties": false
|
|
1433
|
+
},
|
|
1434
|
+
"inlined": {
|
|
1435
|
+
"description": "Inlined content of the VsCode configuration",
|
|
1436
|
+
"type": "string"
|
|
1437
|
+
},
|
|
1438
|
+
"uri": {
|
|
1439
|
+
"description": "Location as an absolute of relative URI the VsCode configuration will be fetched from",
|
|
1440
|
+
"type": "string"
|
|
1441
|
+
}
|
|
1442
|
+
},
|
|
1443
|
+
"additionalProperties": false
|
|
1444
|
+
},
|
|
1445
|
+
"vscodeTask": {
|
|
1446
|
+
"description": "Command providing the definition of a VsCode Task",
|
|
1447
|
+
"type": "object",
|
|
1448
|
+
"oneOf": [
|
|
1449
|
+
{
|
|
1450
|
+
"required": ["uri"]
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
"required": ["inlined"]
|
|
1454
|
+
}
|
|
1455
|
+
],
|
|
1456
|
+
"properties": {
|
|
1457
|
+
"group": {
|
|
1458
|
+
"description": "Defines the group this command is part of",
|
|
1459
|
+
"type": "object",
|
|
1460
|
+
"properties": {
|
|
1461
|
+
"isDefault": {
|
|
1462
|
+
"description": "Identifies the default command for a given group kind",
|
|
1463
|
+
"type": "boolean"
|
|
1464
|
+
},
|
|
1465
|
+
"kind": {
|
|
1466
|
+
"description": "Kind of group the command is part of",
|
|
1467
|
+
"type": "string",
|
|
1468
|
+
"enum": ["build", "run", "test", "debug"]
|
|
1469
|
+
}
|
|
1470
|
+
},
|
|
1471
|
+
"additionalProperties": false
|
|
1472
|
+
},
|
|
1473
|
+
"inlined": {
|
|
1474
|
+
"description": "Inlined content of the VsCode configuration",
|
|
1475
|
+
"type": "string"
|
|
1476
|
+
},
|
|
1477
|
+
"uri": {
|
|
1478
|
+
"description": "Location as an absolute of relative URI the VsCode configuration will be fetched from",
|
|
1479
|
+
"type": "string"
|
|
1480
|
+
}
|
|
1481
|
+
},
|
|
1482
|
+
"additionalProperties": false
|
|
1483
|
+
}
|
|
1484
|
+
},
|
|
1485
|
+
"additionalProperties": false
|
|
1486
|
+
}
|
|
1487
|
+
},
|
|
1488
|
+
"components": {
|
|
1489
|
+
"description": "Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
|
|
1490
|
+
"type": "array",
|
|
1491
|
+
"items": {
|
|
1492
|
+
"type": "object",
|
|
1493
|
+
"required": ["name"],
|
|
1494
|
+
"oneOf": [
|
|
1495
|
+
{
|
|
1496
|
+
"required": ["container"]
|
|
1497
|
+
},
|
|
1498
|
+
{
|
|
1499
|
+
"required": ["kubernetes"]
|
|
1500
|
+
},
|
|
1501
|
+
{
|
|
1502
|
+
"required": ["openshift"]
|
|
1503
|
+
},
|
|
1504
|
+
{
|
|
1505
|
+
"required": ["volume"]
|
|
1506
|
+
},
|
|
1507
|
+
{
|
|
1508
|
+
"required": ["plugin"]
|
|
1509
|
+
}
|
|
1510
|
+
],
|
|
1511
|
+
"properties": {
|
|
1512
|
+
"attributes": {
|
|
1513
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
1514
|
+
"type": "object",
|
|
1515
|
+
"additionalProperties": true
|
|
1516
|
+
},
|
|
1517
|
+
"container": {
|
|
1518
|
+
"description": "Allows adding and configuring workspace-related containers",
|
|
1519
|
+
"type": "object",
|
|
1520
|
+
"properties": {
|
|
1521
|
+
"args": {
|
|
1522
|
+
"description": "The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\n\nDefaults to an empty array, meaning use whatever is defined in the image.",
|
|
1523
|
+
"type": "array",
|
|
1524
|
+
"items": {
|
|
1525
|
+
"type": "string"
|
|
1526
|
+
}
|
|
1527
|
+
},
|
|
1528
|
+
"command": {
|
|
1529
|
+
"description": "The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.",
|
|
1530
|
+
"type": "array",
|
|
1531
|
+
"items": {
|
|
1532
|
+
"type": "string"
|
|
1533
|
+
}
|
|
1534
|
+
},
|
|
1535
|
+
"dedicatedPod": {
|
|
1536
|
+
"description": "Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`",
|
|
1537
|
+
"type": "boolean"
|
|
1538
|
+
},
|
|
1539
|
+
"endpoints": {
|
|
1540
|
+
"type": "array",
|
|
1541
|
+
"items": {
|
|
1542
|
+
"type": "object",
|
|
1543
|
+
"required": ["name"],
|
|
1544
|
+
"properties": {
|
|
1545
|
+
"attributes": {
|
|
1546
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
1547
|
+
"type": "object",
|
|
1548
|
+
"additionalProperties": true
|
|
1549
|
+
},
|
|
1550
|
+
"exposure": {
|
|
1551
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
1552
|
+
"type": "string",
|
|
1553
|
+
"enum": ["public", "internal", "none"]
|
|
1554
|
+
},
|
|
1555
|
+
"name": {
|
|
1556
|
+
"type": "string",
|
|
1557
|
+
"maxLength": 63,
|
|
1558
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
1559
|
+
},
|
|
1560
|
+
"path": {
|
|
1561
|
+
"description": "Path of the endpoint URL",
|
|
1562
|
+
"type": "string"
|
|
1563
|
+
},
|
|
1564
|
+
"protocol": {
|
|
1565
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
1566
|
+
"type": "string",
|
|
1567
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
1568
|
+
},
|
|
1569
|
+
"secure": {
|
|
1570
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
1571
|
+
"type": "boolean"
|
|
1572
|
+
},
|
|
1573
|
+
"targetPort": {
|
|
1574
|
+
"type": "integer"
|
|
1575
|
+
}
|
|
1576
|
+
},
|
|
1577
|
+
"additionalProperties": false
|
|
1578
|
+
}
|
|
1579
|
+
},
|
|
1580
|
+
"env": {
|
|
1581
|
+
"description": "Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`",
|
|
1582
|
+
"type": "array",
|
|
1583
|
+
"items": {
|
|
1584
|
+
"type": "object",
|
|
1585
|
+
"required": ["name"],
|
|
1586
|
+
"properties": {
|
|
1587
|
+
"name": {
|
|
1588
|
+
"type": "string"
|
|
1589
|
+
},
|
|
1590
|
+
"value": {
|
|
1591
|
+
"type": "string"
|
|
1592
|
+
}
|
|
1593
|
+
},
|
|
1594
|
+
"additionalProperties": false
|
|
1595
|
+
}
|
|
1596
|
+
},
|
|
1597
|
+
"image": {
|
|
1598
|
+
"type": "string"
|
|
1599
|
+
},
|
|
1600
|
+
"memoryLimit": {
|
|
1601
|
+
"type": "string"
|
|
1602
|
+
},
|
|
1603
|
+
"mountSources": {
|
|
1604
|
+
"description": "Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.",
|
|
1605
|
+
"type": "boolean"
|
|
1606
|
+
},
|
|
1607
|
+
"sourceMapping": {
|
|
1608
|
+
"description": "Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.",
|
|
1609
|
+
"type": "string"
|
|
1610
|
+
},
|
|
1611
|
+
"volumeMounts": {
|
|
1612
|
+
"description": "List of volumes mounts that should be mounted is this container.",
|
|
1613
|
+
"type": "array",
|
|
1614
|
+
"items": {
|
|
1615
|
+
"description": "Volume that should be mounted to a component container",
|
|
1616
|
+
"type": "object",
|
|
1617
|
+
"required": ["name"],
|
|
1618
|
+
"properties": {
|
|
1619
|
+
"name": {
|
|
1620
|
+
"description": "The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.",
|
|
1621
|
+
"type": "string",
|
|
1622
|
+
"maxLength": 63,
|
|
1623
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
1624
|
+
},
|
|
1625
|
+
"path": {
|
|
1626
|
+
"description": "The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/\u003cname\u003e`.",
|
|
1627
|
+
"type": "string"
|
|
1628
|
+
}
|
|
1629
|
+
},
|
|
1630
|
+
"additionalProperties": false
|
|
1631
|
+
}
|
|
1632
|
+
}
|
|
1633
|
+
},
|
|
1634
|
+
"additionalProperties": false
|
|
1635
|
+
},
|
|
1636
|
+
"kubernetes": {
|
|
1637
|
+
"description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.",
|
|
1638
|
+
"type": "object",
|
|
1639
|
+
"oneOf": [
|
|
1640
|
+
{
|
|
1641
|
+
"required": ["uri"]
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
"required": ["inlined"]
|
|
1645
|
+
}
|
|
1646
|
+
],
|
|
1647
|
+
"properties": {
|
|
1648
|
+
"endpoints": {
|
|
1649
|
+
"type": "array",
|
|
1650
|
+
"items": {
|
|
1651
|
+
"type": "object",
|
|
1652
|
+
"required": ["name"],
|
|
1653
|
+
"properties": {
|
|
1654
|
+
"attributes": {
|
|
1655
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
1656
|
+
"type": "object",
|
|
1657
|
+
"additionalProperties": true
|
|
1658
|
+
},
|
|
1659
|
+
"exposure": {
|
|
1660
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
1661
|
+
"type": "string",
|
|
1662
|
+
"enum": ["public", "internal", "none"]
|
|
1663
|
+
},
|
|
1664
|
+
"name": {
|
|
1665
|
+
"type": "string",
|
|
1666
|
+
"maxLength": 63,
|
|
1667
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
1668
|
+
},
|
|
1669
|
+
"path": {
|
|
1670
|
+
"description": "Path of the endpoint URL",
|
|
1671
|
+
"type": "string"
|
|
1672
|
+
},
|
|
1673
|
+
"protocol": {
|
|
1674
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
1675
|
+
"type": "string",
|
|
1676
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
1677
|
+
},
|
|
1678
|
+
"secure": {
|
|
1679
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
1680
|
+
"type": "boolean"
|
|
1681
|
+
},
|
|
1682
|
+
"targetPort": {
|
|
1683
|
+
"type": "integer"
|
|
1684
|
+
}
|
|
1685
|
+
},
|
|
1686
|
+
"additionalProperties": false
|
|
1687
|
+
}
|
|
1688
|
+
},
|
|
1689
|
+
"inlined": {
|
|
1690
|
+
"description": "Inlined manifest",
|
|
1691
|
+
"type": "string"
|
|
1692
|
+
},
|
|
1693
|
+
"uri": {
|
|
1694
|
+
"description": "Location in a file fetched from a uri.",
|
|
1695
|
+
"type": "string"
|
|
1696
|
+
}
|
|
1697
|
+
},
|
|
1698
|
+
"additionalProperties": false
|
|
1699
|
+
},
|
|
1700
|
+
"name": {
|
|
1701
|
+
"description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.",
|
|
1702
|
+
"type": "string",
|
|
1703
|
+
"maxLength": 63,
|
|
1704
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
1705
|
+
},
|
|
1706
|
+
"openshift": {
|
|
1707
|
+
"description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.",
|
|
1708
|
+
"type": "object",
|
|
1709
|
+
"oneOf": [
|
|
1710
|
+
{
|
|
1711
|
+
"required": ["uri"]
|
|
1712
|
+
},
|
|
1713
|
+
{
|
|
1714
|
+
"required": ["inlined"]
|
|
1715
|
+
}
|
|
1716
|
+
],
|
|
1717
|
+
"properties": {
|
|
1718
|
+
"endpoints": {
|
|
1719
|
+
"type": "array",
|
|
1720
|
+
"items": {
|
|
1721
|
+
"type": "object",
|
|
1722
|
+
"required": ["name"],
|
|
1723
|
+
"properties": {
|
|
1724
|
+
"attributes": {
|
|
1725
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
1726
|
+
"type": "object",
|
|
1727
|
+
"additionalProperties": true
|
|
1728
|
+
},
|
|
1729
|
+
"exposure": {
|
|
1730
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
1731
|
+
"type": "string",
|
|
1732
|
+
"enum": ["public", "internal", "none"]
|
|
1733
|
+
},
|
|
1734
|
+
"name": {
|
|
1735
|
+
"type": "string",
|
|
1736
|
+
"maxLength": 63,
|
|
1737
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
1738
|
+
},
|
|
1739
|
+
"path": {
|
|
1740
|
+
"description": "Path of the endpoint URL",
|
|
1741
|
+
"type": "string"
|
|
1742
|
+
},
|
|
1743
|
+
"protocol": {
|
|
1744
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
1745
|
+
"type": "string",
|
|
1746
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
1747
|
+
},
|
|
1748
|
+
"secure": {
|
|
1749
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
1750
|
+
"type": "boolean"
|
|
1751
|
+
},
|
|
1752
|
+
"targetPort": {
|
|
1753
|
+
"type": "integer"
|
|
1754
|
+
}
|
|
1755
|
+
},
|
|
1756
|
+
"additionalProperties": false
|
|
1757
|
+
}
|
|
1758
|
+
},
|
|
1759
|
+
"inlined": {
|
|
1760
|
+
"description": "Inlined manifest",
|
|
1761
|
+
"type": "string"
|
|
1762
|
+
},
|
|
1763
|
+
"uri": {
|
|
1764
|
+
"description": "Location in a file fetched from a uri.",
|
|
1765
|
+
"type": "string"
|
|
1766
|
+
}
|
|
1767
|
+
},
|
|
1768
|
+
"additionalProperties": false
|
|
1769
|
+
},
|
|
1770
|
+
"plugin": {
|
|
1771
|
+
"description": "Allows importing a plugin.\n\nPlugins are mainly imported devfiles that contribute components, commands and events as a consistent single unit. They are defined in either YAML files following the devfile syntax, or as `DevWorkspaceTemplate` Kubernetes Custom Resources",
|
|
1772
|
+
"type": "object",
|
|
1773
|
+
"oneOf": [
|
|
1774
|
+
{
|
|
1775
|
+
"required": ["uri"]
|
|
1776
|
+
},
|
|
1777
|
+
{
|
|
1778
|
+
"required": ["id"]
|
|
1779
|
+
},
|
|
1780
|
+
{
|
|
1781
|
+
"required": ["kubernetes"]
|
|
1782
|
+
}
|
|
1783
|
+
],
|
|
1784
|
+
"properties": {
|
|
1785
|
+
"commands": {
|
|
1786
|
+
"description": "Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
|
|
1787
|
+
"type": "array",
|
|
1788
|
+
"items": {
|
|
1789
|
+
"type": "object",
|
|
1790
|
+
"required": ["id"],
|
|
1791
|
+
"oneOf": [
|
|
1792
|
+
{
|
|
1793
|
+
"required": ["exec"]
|
|
1794
|
+
},
|
|
1795
|
+
{
|
|
1796
|
+
"required": ["apply"]
|
|
1797
|
+
},
|
|
1798
|
+
{
|
|
1799
|
+
"required": ["vscodeTask"]
|
|
1800
|
+
},
|
|
1801
|
+
{
|
|
1802
|
+
"required": ["vscodeLaunch"]
|
|
1803
|
+
},
|
|
1804
|
+
{
|
|
1805
|
+
"required": ["composite"]
|
|
1806
|
+
}
|
|
1807
|
+
],
|
|
1808
|
+
"properties": {
|
|
1809
|
+
"apply": {
|
|
1810
|
+
"description": "Command that consists in applying a given component definition, typically bound to a workspace event.\n\nFor example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the workspace POD, unless the component has its `dedicatedPod` field set to `true`.\n\nWhen no `apply` command exist for a given component, it is assumed the component will be applied at workspace start by default.",
|
|
1811
|
+
"type": "object",
|
|
1812
|
+
"properties": {
|
|
1813
|
+
"component": {
|
|
1814
|
+
"description": "Describes component that will be applied",
|
|
1815
|
+
"type": "string"
|
|
1816
|
+
},
|
|
1817
|
+
"group": {
|
|
1818
|
+
"description": "Defines the group this command is part of",
|
|
1819
|
+
"type": "object",
|
|
1820
|
+
"properties": {
|
|
1821
|
+
"isDefault": {
|
|
1822
|
+
"description": "Identifies the default command for a given group kind",
|
|
1823
|
+
"type": "boolean"
|
|
1824
|
+
},
|
|
1825
|
+
"kind": {
|
|
1826
|
+
"description": "Kind of group the command is part of",
|
|
1827
|
+
"type": "string",
|
|
1828
|
+
"enum": ["build", "run", "test", "debug"]
|
|
1829
|
+
}
|
|
1830
|
+
},
|
|
1831
|
+
"additionalProperties": false
|
|
1832
|
+
},
|
|
1833
|
+
"label": {
|
|
1834
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
1835
|
+
"type": "string"
|
|
1836
|
+
}
|
|
1837
|
+
},
|
|
1838
|
+
"additionalProperties": false
|
|
1839
|
+
},
|
|
1840
|
+
"attributes": {
|
|
1841
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
1842
|
+
"type": "object",
|
|
1843
|
+
"additionalProperties": true
|
|
1844
|
+
},
|
|
1845
|
+
"composite": {
|
|
1846
|
+
"description": "Composite command that allows executing several sub-commands either sequentially or concurrently",
|
|
1847
|
+
"type": "object",
|
|
1848
|
+
"properties": {
|
|
1849
|
+
"commands": {
|
|
1850
|
+
"description": "The commands that comprise this composite command",
|
|
1851
|
+
"type": "array",
|
|
1852
|
+
"items": {
|
|
1853
|
+
"type": "string"
|
|
1854
|
+
}
|
|
1855
|
+
},
|
|
1856
|
+
"group": {
|
|
1857
|
+
"description": "Defines the group this command is part of",
|
|
1858
|
+
"type": "object",
|
|
1859
|
+
"properties": {
|
|
1860
|
+
"isDefault": {
|
|
1861
|
+
"description": "Identifies the default command for a given group kind",
|
|
1862
|
+
"type": "boolean"
|
|
1863
|
+
},
|
|
1864
|
+
"kind": {
|
|
1865
|
+
"description": "Kind of group the command is part of",
|
|
1866
|
+
"type": "string",
|
|
1867
|
+
"enum": ["build", "run", "test", "debug"]
|
|
1868
|
+
}
|
|
1869
|
+
},
|
|
1870
|
+
"additionalProperties": false
|
|
1871
|
+
},
|
|
1872
|
+
"label": {
|
|
1873
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
1874
|
+
"type": "string"
|
|
1875
|
+
},
|
|
1876
|
+
"parallel": {
|
|
1877
|
+
"description": "Indicates if the sub-commands should be executed concurrently",
|
|
1878
|
+
"type": "boolean"
|
|
1879
|
+
}
|
|
1880
|
+
},
|
|
1881
|
+
"additionalProperties": false
|
|
1882
|
+
},
|
|
1883
|
+
"exec": {
|
|
1884
|
+
"description": "CLI Command executed in an existing component container",
|
|
1885
|
+
"type": "object",
|
|
1886
|
+
"properties": {
|
|
1887
|
+
"commandLine": {
|
|
1888
|
+
"description": "The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.",
|
|
1889
|
+
"type": "string"
|
|
1890
|
+
},
|
|
1891
|
+
"component": {
|
|
1892
|
+
"description": "Describes component to which given action relates",
|
|
1893
|
+
"type": "string"
|
|
1894
|
+
},
|
|
1895
|
+
"env": {
|
|
1896
|
+
"description": "Optional list of environment variables that have to be set before running the command",
|
|
1897
|
+
"type": "array",
|
|
1898
|
+
"items": {
|
|
1899
|
+
"type": "object",
|
|
1900
|
+
"required": ["name"],
|
|
1901
|
+
"properties": {
|
|
1902
|
+
"name": {
|
|
1903
|
+
"type": "string"
|
|
1904
|
+
},
|
|
1905
|
+
"value": {
|
|
1906
|
+
"type": "string"
|
|
1907
|
+
}
|
|
1908
|
+
},
|
|
1909
|
+
"additionalProperties": false
|
|
1910
|
+
}
|
|
1911
|
+
},
|
|
1912
|
+
"group": {
|
|
1913
|
+
"description": "Defines the group this command is part of",
|
|
1914
|
+
"type": "object",
|
|
1915
|
+
"properties": {
|
|
1916
|
+
"isDefault": {
|
|
1917
|
+
"description": "Identifies the default command for a given group kind",
|
|
1918
|
+
"type": "boolean"
|
|
1919
|
+
},
|
|
1920
|
+
"kind": {
|
|
1921
|
+
"description": "Kind of group the command is part of",
|
|
1922
|
+
"type": "string",
|
|
1923
|
+
"enum": ["build", "run", "test", "debug"]
|
|
1924
|
+
}
|
|
1925
|
+
},
|
|
1926
|
+
"additionalProperties": false
|
|
1927
|
+
},
|
|
1928
|
+
"hotReloadCapable": {
|
|
1929
|
+
"description": "Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.\n\nDefault value is `false`",
|
|
1930
|
+
"type": "boolean"
|
|
1931
|
+
},
|
|
1932
|
+
"label": {
|
|
1933
|
+
"description": "Optional label that provides a label for this command to be used in Editor UI menus for example",
|
|
1934
|
+
"type": "string"
|
|
1935
|
+
},
|
|
1936
|
+
"workingDir": {
|
|
1937
|
+
"description": "Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/\u003cproject-name\u003e). If there are multiple projects, this will point to the directory of the first one.",
|
|
1938
|
+
"type": "string"
|
|
1939
|
+
}
|
|
1940
|
+
},
|
|
1941
|
+
"additionalProperties": false
|
|
1942
|
+
},
|
|
1943
|
+
"id": {
|
|
1944
|
+
"description": "Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.",
|
|
1945
|
+
"type": "string",
|
|
1946
|
+
"maxLength": 63,
|
|
1947
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
1948
|
+
},
|
|
1949
|
+
"vscodeLaunch": {
|
|
1950
|
+
"description": "Command providing the definition of a VsCode launch action",
|
|
1951
|
+
"type": "object",
|
|
1952
|
+
"oneOf": [
|
|
1953
|
+
{
|
|
1954
|
+
"required": ["uri"]
|
|
1955
|
+
},
|
|
1956
|
+
{
|
|
1957
|
+
"required": ["inlined"]
|
|
1958
|
+
}
|
|
1959
|
+
],
|
|
1960
|
+
"properties": {
|
|
1961
|
+
"group": {
|
|
1962
|
+
"description": "Defines the group this command is part of",
|
|
1963
|
+
"type": "object",
|
|
1964
|
+
"properties": {
|
|
1965
|
+
"isDefault": {
|
|
1966
|
+
"description": "Identifies the default command for a given group kind",
|
|
1967
|
+
"type": "boolean"
|
|
1968
|
+
},
|
|
1969
|
+
"kind": {
|
|
1970
|
+
"description": "Kind of group the command is part of",
|
|
1971
|
+
"type": "string",
|
|
1972
|
+
"enum": ["build", "run", "test", "debug"]
|
|
1973
|
+
}
|
|
1974
|
+
},
|
|
1975
|
+
"additionalProperties": false
|
|
1976
|
+
},
|
|
1977
|
+
"inlined": {
|
|
1978
|
+
"description": "Inlined content of the VsCode configuration",
|
|
1979
|
+
"type": "string"
|
|
1980
|
+
},
|
|
1981
|
+
"uri": {
|
|
1982
|
+
"description": "Location as an absolute of relative URI the VsCode configuration will be fetched from",
|
|
1983
|
+
"type": "string"
|
|
1984
|
+
}
|
|
1985
|
+
},
|
|
1986
|
+
"additionalProperties": false
|
|
1987
|
+
},
|
|
1988
|
+
"vscodeTask": {
|
|
1989
|
+
"description": "Command providing the definition of a VsCode Task",
|
|
1990
|
+
"type": "object",
|
|
1991
|
+
"oneOf": [
|
|
1992
|
+
{
|
|
1993
|
+
"required": ["uri"]
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
"required": ["inlined"]
|
|
1997
|
+
}
|
|
1998
|
+
],
|
|
1999
|
+
"properties": {
|
|
2000
|
+
"group": {
|
|
2001
|
+
"description": "Defines the group this command is part of",
|
|
2002
|
+
"type": "object",
|
|
2003
|
+
"properties": {
|
|
2004
|
+
"isDefault": {
|
|
2005
|
+
"description": "Identifies the default command for a given group kind",
|
|
2006
|
+
"type": "boolean"
|
|
2007
|
+
},
|
|
2008
|
+
"kind": {
|
|
2009
|
+
"description": "Kind of group the command is part of",
|
|
2010
|
+
"type": "string",
|
|
2011
|
+
"enum": ["build", "run", "test", "debug"]
|
|
2012
|
+
}
|
|
2013
|
+
},
|
|
2014
|
+
"additionalProperties": false
|
|
2015
|
+
},
|
|
2016
|
+
"inlined": {
|
|
2017
|
+
"description": "Inlined content of the VsCode configuration",
|
|
2018
|
+
"type": "string"
|
|
2019
|
+
},
|
|
2020
|
+
"uri": {
|
|
2021
|
+
"description": "Location as an absolute of relative URI the VsCode configuration will be fetched from",
|
|
2022
|
+
"type": "string"
|
|
2023
|
+
}
|
|
2024
|
+
},
|
|
2025
|
+
"additionalProperties": false
|
|
2026
|
+
}
|
|
2027
|
+
},
|
|
2028
|
+
"additionalProperties": false
|
|
2029
|
+
}
|
|
2030
|
+
},
|
|
2031
|
+
"components": {
|
|
2032
|
+
"description": "Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.",
|
|
2033
|
+
"type": "array",
|
|
2034
|
+
"items": {
|
|
2035
|
+
"type": "object",
|
|
2036
|
+
"required": ["name"],
|
|
2037
|
+
"oneOf": [
|
|
2038
|
+
{
|
|
2039
|
+
"required": ["container"]
|
|
2040
|
+
},
|
|
2041
|
+
{
|
|
2042
|
+
"required": ["kubernetes"]
|
|
2043
|
+
},
|
|
2044
|
+
{
|
|
2045
|
+
"required": ["openshift"]
|
|
2046
|
+
},
|
|
2047
|
+
{
|
|
2048
|
+
"required": ["volume"]
|
|
2049
|
+
}
|
|
2050
|
+
],
|
|
2051
|
+
"properties": {
|
|
2052
|
+
"attributes": {
|
|
2053
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
2054
|
+
"type": "object",
|
|
2055
|
+
"additionalProperties": true
|
|
2056
|
+
},
|
|
2057
|
+
"container": {
|
|
2058
|
+
"description": "Allows adding and configuring workspace-related containers",
|
|
2059
|
+
"type": "object",
|
|
2060
|
+
"properties": {
|
|
2061
|
+
"args": {
|
|
2062
|
+
"description": "The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.\n\nDefaults to an empty array, meaning use whatever is defined in the image.",
|
|
2063
|
+
"type": "array",
|
|
2064
|
+
"items": {
|
|
2065
|
+
"type": "string"
|
|
2066
|
+
}
|
|
2067
|
+
},
|
|
2068
|
+
"command": {
|
|
2069
|
+
"description": "The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.",
|
|
2070
|
+
"type": "array",
|
|
2071
|
+
"items": {
|
|
2072
|
+
"type": "string"
|
|
2073
|
+
}
|
|
2074
|
+
},
|
|
2075
|
+
"dedicatedPod": {
|
|
2076
|
+
"description": "Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`",
|
|
2077
|
+
"type": "boolean"
|
|
2078
|
+
},
|
|
2079
|
+
"endpoints": {
|
|
2080
|
+
"type": "array",
|
|
2081
|
+
"items": {
|
|
2082
|
+
"type": "object",
|
|
2083
|
+
"required": ["name"],
|
|
2084
|
+
"properties": {
|
|
2085
|
+
"attributes": {
|
|
2086
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
2087
|
+
"type": "object",
|
|
2088
|
+
"additionalProperties": true
|
|
2089
|
+
},
|
|
2090
|
+
"exposure": {
|
|
2091
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
2092
|
+
"type": "string",
|
|
2093
|
+
"enum": ["public", "internal", "none"]
|
|
2094
|
+
},
|
|
2095
|
+
"name": {
|
|
2096
|
+
"type": "string",
|
|
2097
|
+
"maxLength": 63,
|
|
2098
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
2099
|
+
},
|
|
2100
|
+
"path": {
|
|
2101
|
+
"description": "Path of the endpoint URL",
|
|
2102
|
+
"type": "string"
|
|
2103
|
+
},
|
|
2104
|
+
"protocol": {
|
|
2105
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
2106
|
+
"type": "string",
|
|
2107
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
2108
|
+
},
|
|
2109
|
+
"secure": {
|
|
2110
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
2111
|
+
"type": "boolean"
|
|
2112
|
+
},
|
|
2113
|
+
"targetPort": {
|
|
2114
|
+
"type": "integer"
|
|
2115
|
+
}
|
|
2116
|
+
},
|
|
2117
|
+
"additionalProperties": false
|
|
2118
|
+
}
|
|
2119
|
+
},
|
|
2120
|
+
"env": {
|
|
2121
|
+
"description": "Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`",
|
|
2122
|
+
"type": "array",
|
|
2123
|
+
"items": {
|
|
2124
|
+
"type": "object",
|
|
2125
|
+
"required": ["name"],
|
|
2126
|
+
"properties": {
|
|
2127
|
+
"name": {
|
|
2128
|
+
"type": "string"
|
|
2129
|
+
},
|
|
2130
|
+
"value": {
|
|
2131
|
+
"type": "string"
|
|
2132
|
+
}
|
|
2133
|
+
},
|
|
2134
|
+
"additionalProperties": false
|
|
2135
|
+
}
|
|
2136
|
+
},
|
|
2137
|
+
"image": {
|
|
2138
|
+
"type": "string"
|
|
2139
|
+
},
|
|
2140
|
+
"memoryLimit": {
|
|
2141
|
+
"type": "string"
|
|
2142
|
+
},
|
|
2143
|
+
"mountSources": {
|
|
2144
|
+
"description": "Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.",
|
|
2145
|
+
"type": "boolean"
|
|
2146
|
+
},
|
|
2147
|
+
"sourceMapping": {
|
|
2148
|
+
"description": "Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.",
|
|
2149
|
+
"type": "string"
|
|
2150
|
+
},
|
|
2151
|
+
"volumeMounts": {
|
|
2152
|
+
"description": "List of volumes mounts that should be mounted is this container.",
|
|
2153
|
+
"type": "array",
|
|
2154
|
+
"items": {
|
|
2155
|
+
"description": "Volume that should be mounted to a component container",
|
|
2156
|
+
"type": "object",
|
|
2157
|
+
"required": ["name"],
|
|
2158
|
+
"properties": {
|
|
2159
|
+
"name": {
|
|
2160
|
+
"description": "The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.",
|
|
2161
|
+
"type": "string",
|
|
2162
|
+
"maxLength": 63,
|
|
2163
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
2164
|
+
},
|
|
2165
|
+
"path": {
|
|
2166
|
+
"description": "The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/\u003cname\u003e`.",
|
|
2167
|
+
"type": "string"
|
|
2168
|
+
}
|
|
2169
|
+
},
|
|
2170
|
+
"additionalProperties": false
|
|
2171
|
+
}
|
|
2172
|
+
}
|
|
2173
|
+
},
|
|
2174
|
+
"additionalProperties": false
|
|
2175
|
+
},
|
|
2176
|
+
"kubernetes": {
|
|
2177
|
+
"description": "Allows importing into the workspace the Kubernetes resources defined in a given manifest. For example this allows reusing the Kubernetes definitions used to deploy some runtime components in production.",
|
|
2178
|
+
"type": "object",
|
|
2179
|
+
"oneOf": [
|
|
2180
|
+
{
|
|
2181
|
+
"required": ["uri"]
|
|
2182
|
+
},
|
|
2183
|
+
{
|
|
2184
|
+
"required": ["inlined"]
|
|
2185
|
+
}
|
|
2186
|
+
],
|
|
2187
|
+
"properties": {
|
|
2188
|
+
"endpoints": {
|
|
2189
|
+
"type": "array",
|
|
2190
|
+
"items": {
|
|
2191
|
+
"type": "object",
|
|
2192
|
+
"required": ["name"],
|
|
2193
|
+
"properties": {
|
|
2194
|
+
"attributes": {
|
|
2195
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
2196
|
+
"type": "object",
|
|
2197
|
+
"additionalProperties": true
|
|
2198
|
+
},
|
|
2199
|
+
"exposure": {
|
|
2200
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
2201
|
+
"type": "string",
|
|
2202
|
+
"enum": ["public", "internal", "none"]
|
|
2203
|
+
},
|
|
2204
|
+
"name": {
|
|
2205
|
+
"type": "string",
|
|
2206
|
+
"maxLength": 63,
|
|
2207
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
2208
|
+
},
|
|
2209
|
+
"path": {
|
|
2210
|
+
"description": "Path of the endpoint URL",
|
|
2211
|
+
"type": "string"
|
|
2212
|
+
},
|
|
2213
|
+
"protocol": {
|
|
2214
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
2215
|
+
"type": "string",
|
|
2216
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
2217
|
+
},
|
|
2218
|
+
"secure": {
|
|
2219
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
2220
|
+
"type": "boolean"
|
|
2221
|
+
},
|
|
2222
|
+
"targetPort": {
|
|
2223
|
+
"type": "integer"
|
|
2224
|
+
}
|
|
2225
|
+
},
|
|
2226
|
+
"additionalProperties": false
|
|
2227
|
+
}
|
|
2228
|
+
},
|
|
2229
|
+
"inlined": {
|
|
2230
|
+
"description": "Inlined manifest",
|
|
2231
|
+
"type": "string"
|
|
2232
|
+
},
|
|
2233
|
+
"uri": {
|
|
2234
|
+
"description": "Location in a file fetched from a uri.",
|
|
2235
|
+
"type": "string"
|
|
2236
|
+
}
|
|
2237
|
+
},
|
|
2238
|
+
"additionalProperties": false
|
|
2239
|
+
},
|
|
2240
|
+
"name": {
|
|
2241
|
+
"description": "Mandatory name that allows referencing the component from other elements (such as commands) or from an external devfile that may reference this component through a parent or a plugin.",
|
|
2242
|
+
"type": "string",
|
|
2243
|
+
"maxLength": 63,
|
|
2244
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
2245
|
+
},
|
|
2246
|
+
"openshift": {
|
|
2247
|
+
"description": "Allows importing into the workspace the OpenShift resources defined in a given manifest. For example this allows reusing the OpenShift definitions used to deploy some runtime components in production.",
|
|
2248
|
+
"type": "object",
|
|
2249
|
+
"oneOf": [
|
|
2250
|
+
{
|
|
2251
|
+
"required": ["uri"]
|
|
2252
|
+
},
|
|
2253
|
+
{
|
|
2254
|
+
"required": ["inlined"]
|
|
2255
|
+
}
|
|
2256
|
+
],
|
|
2257
|
+
"properties": {
|
|
2258
|
+
"endpoints": {
|
|
2259
|
+
"type": "array",
|
|
2260
|
+
"items": {
|
|
2261
|
+
"type": "object",
|
|
2262
|
+
"required": ["name"],
|
|
2263
|
+
"properties": {
|
|
2264
|
+
"attributes": {
|
|
2265
|
+
"description": "Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",",
|
|
2266
|
+
"type": "object",
|
|
2267
|
+
"additionalProperties": true
|
|
2268
|
+
},
|
|
2269
|
+
"exposure": {
|
|
2270
|
+
"description": "Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `internal` means that the endpoint will be exposed internally outside of the main workspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main workspace POD, on a local address.\n\nDefault value is `public`",
|
|
2271
|
+
"type": "string",
|
|
2272
|
+
"enum": ["public", "internal", "none"]
|
|
2273
|
+
},
|
|
2274
|
+
"name": {
|
|
2275
|
+
"type": "string",
|
|
2276
|
+
"maxLength": 63,
|
|
2277
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
2278
|
+
},
|
|
2279
|
+
"path": {
|
|
2280
|
+
"description": "Path of the endpoint URL",
|
|
2281
|
+
"type": "string"
|
|
2282
|
+
},
|
|
2283
|
+
"protocol": {
|
|
2284
|
+
"description": "Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`",
|
|
2285
|
+
"type": "string",
|
|
2286
|
+
"enum": ["http", "https", "ws", "wss", "tcp", "udp"]
|
|
2287
|
+
},
|
|
2288
|
+
"secure": {
|
|
2289
|
+
"description": "Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.",
|
|
2290
|
+
"type": "boolean"
|
|
2291
|
+
},
|
|
2292
|
+
"targetPort": {
|
|
2293
|
+
"type": "integer"
|
|
2294
|
+
}
|
|
2295
|
+
},
|
|
2296
|
+
"additionalProperties": false
|
|
2297
|
+
}
|
|
2298
|
+
},
|
|
2299
|
+
"inlined": {
|
|
2300
|
+
"description": "Inlined manifest",
|
|
2301
|
+
"type": "string"
|
|
2302
|
+
},
|
|
2303
|
+
"uri": {
|
|
2304
|
+
"description": "Location in a file fetched from a uri.",
|
|
2305
|
+
"type": "string"
|
|
2306
|
+
}
|
|
2307
|
+
},
|
|
2308
|
+
"additionalProperties": false
|
|
2309
|
+
},
|
|
2310
|
+
"volume": {
|
|
2311
|
+
"description": "Allows specifying the definition of a volume shared by several other components",
|
|
2312
|
+
"type": "object",
|
|
2313
|
+
"properties": {
|
|
2314
|
+
"size": {
|
|
2315
|
+
"description": "Size of the volume",
|
|
2316
|
+
"type": "string"
|
|
2317
|
+
}
|
|
2318
|
+
},
|
|
2319
|
+
"additionalProperties": false
|
|
2320
|
+
}
|
|
2321
|
+
},
|
|
2322
|
+
"additionalProperties": false
|
|
2323
|
+
}
|
|
2324
|
+
},
|
|
2325
|
+
"id": {
|
|
2326
|
+
"description": "Id in a registry that contains a Devfile yaml file",
|
|
2327
|
+
"type": "string"
|
|
2328
|
+
},
|
|
2329
|
+
"kubernetes": {
|
|
2330
|
+
"description": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate",
|
|
2331
|
+
"type": "object",
|
|
2332
|
+
"properties": {
|
|
2333
|
+
"name": {
|
|
2334
|
+
"type": "string"
|
|
2335
|
+
},
|
|
2336
|
+
"namespace": {
|
|
2337
|
+
"type": "string"
|
|
2338
|
+
}
|
|
2339
|
+
},
|
|
2340
|
+
"additionalProperties": false
|
|
2341
|
+
},
|
|
2342
|
+
"registryUrl": {
|
|
2343
|
+
"type": "string"
|
|
2344
|
+
},
|
|
2345
|
+
"uri": {
|
|
2346
|
+
"description": "Uri of a Devfile yaml file",
|
|
2347
|
+
"type": "string"
|
|
2348
|
+
}
|
|
2349
|
+
},
|
|
2350
|
+
"additionalProperties": false
|
|
2351
|
+
},
|
|
2352
|
+
"volume": {
|
|
2353
|
+
"description": "Allows specifying the definition of a volume shared by several other components",
|
|
2354
|
+
"type": "object",
|
|
2355
|
+
"properties": {
|
|
2356
|
+
"size": {
|
|
2357
|
+
"description": "Size of the volume",
|
|
2358
|
+
"type": "string"
|
|
2359
|
+
}
|
|
2360
|
+
},
|
|
2361
|
+
"additionalProperties": false
|
|
2362
|
+
}
|
|
2363
|
+
},
|
|
2364
|
+
"additionalProperties": false
|
|
2365
|
+
}
|
|
2366
|
+
},
|
|
2367
|
+
"id": {
|
|
2368
|
+
"description": "Id in a registry that contains a Devfile yaml file",
|
|
2369
|
+
"type": "string"
|
|
2370
|
+
},
|
|
2371
|
+
"kubernetes": {
|
|
2372
|
+
"description": "Reference to a Kubernetes CRD of type DevWorkspaceTemplate",
|
|
2373
|
+
"type": "object",
|
|
2374
|
+
"required": ["name"],
|
|
2375
|
+
"properties": {
|
|
2376
|
+
"name": {
|
|
2377
|
+
"type": "string"
|
|
2378
|
+
},
|
|
2379
|
+
"namespace": {
|
|
2380
|
+
"type": "string"
|
|
2381
|
+
}
|
|
2382
|
+
},
|
|
2383
|
+
"additionalProperties": false
|
|
2384
|
+
},
|
|
2385
|
+
"projects": {
|
|
2386
|
+
"description": "Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.",
|
|
2387
|
+
"type": "array",
|
|
2388
|
+
"items": {
|
|
2389
|
+
"type": "object",
|
|
2390
|
+
"required": ["name"],
|
|
2391
|
+
"oneOf": [
|
|
2392
|
+
{
|
|
2393
|
+
"required": ["git"]
|
|
2394
|
+
},
|
|
2395
|
+
{
|
|
2396
|
+
"required": ["github"]
|
|
2397
|
+
},
|
|
2398
|
+
{
|
|
2399
|
+
"required": ["zip"]
|
|
2400
|
+
}
|
|
2401
|
+
],
|
|
2402
|
+
"properties": {
|
|
2403
|
+
"attributes": {
|
|
2404
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
2405
|
+
"type": "object",
|
|
2406
|
+
"additionalProperties": true
|
|
2407
|
+
},
|
|
2408
|
+
"clonePath": {
|
|
2409
|
+
"description": "Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.",
|
|
2410
|
+
"type": "string"
|
|
2411
|
+
},
|
|
2412
|
+
"git": {
|
|
2413
|
+
"description": "Project's Git source",
|
|
2414
|
+
"type": "object",
|
|
2415
|
+
"properties": {
|
|
2416
|
+
"checkoutFrom": {
|
|
2417
|
+
"description": "Defines from what the project should be checked out. Required if there are more than one remote configured",
|
|
2418
|
+
"type": "object",
|
|
2419
|
+
"properties": {
|
|
2420
|
+
"remote": {
|
|
2421
|
+
"description": "The remote name should be used as init. Required if there are more than one remote configured",
|
|
2422
|
+
"type": "string"
|
|
2423
|
+
},
|
|
2424
|
+
"revision": {
|
|
2425
|
+
"description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.",
|
|
2426
|
+
"type": "string"
|
|
2427
|
+
}
|
|
2428
|
+
},
|
|
2429
|
+
"additionalProperties": false
|
|
2430
|
+
},
|
|
2431
|
+
"remotes": {
|
|
2432
|
+
"description": "The remotes map which should be initialized in the git project. Must have at least one remote configured",
|
|
2433
|
+
"type": "object",
|
|
2434
|
+
"additionalProperties": {
|
|
2435
|
+
"type": "string"
|
|
2436
|
+
}
|
|
2437
|
+
}
|
|
2438
|
+
},
|
|
2439
|
+
"additionalProperties": false
|
|
2440
|
+
},
|
|
2441
|
+
"github": {
|
|
2442
|
+
"description": "Project's GitHub source",
|
|
2443
|
+
"type": "object",
|
|
2444
|
+
"properties": {
|
|
2445
|
+
"checkoutFrom": {
|
|
2446
|
+
"description": "Defines from what the project should be checked out. Required if there are more than one remote configured",
|
|
2447
|
+
"type": "object",
|
|
2448
|
+
"properties": {
|
|
2449
|
+
"remote": {
|
|
2450
|
+
"description": "The remote name should be used as init. Required if there are more than one remote configured",
|
|
2451
|
+
"type": "string"
|
|
2452
|
+
},
|
|
2453
|
+
"revision": {
|
|
2454
|
+
"description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.",
|
|
2455
|
+
"type": "string"
|
|
2456
|
+
}
|
|
2457
|
+
},
|
|
2458
|
+
"additionalProperties": false
|
|
2459
|
+
},
|
|
2460
|
+
"remotes": {
|
|
2461
|
+
"description": "The remotes map which should be initialized in the git project. Must have at least one remote configured",
|
|
2462
|
+
"type": "object",
|
|
2463
|
+
"additionalProperties": {
|
|
2464
|
+
"type": "string"
|
|
2465
|
+
}
|
|
2466
|
+
}
|
|
2467
|
+
},
|
|
2468
|
+
"additionalProperties": false
|
|
2469
|
+
},
|
|
2470
|
+
"name": {
|
|
2471
|
+
"description": "Project name",
|
|
2472
|
+
"type": "string",
|
|
2473
|
+
"maxLength": 63,
|
|
2474
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
2475
|
+
},
|
|
2476
|
+
"sparseCheckoutDirs": {
|
|
2477
|
+
"description": "Populate the project sparsely with selected directories.",
|
|
2478
|
+
"type": "array",
|
|
2479
|
+
"items": {
|
|
2480
|
+
"type": "string"
|
|
2481
|
+
}
|
|
2482
|
+
},
|
|
2483
|
+
"zip": {
|
|
2484
|
+
"description": "Project's Zip source",
|
|
2485
|
+
"type": "object",
|
|
2486
|
+
"properties": {
|
|
2487
|
+
"location": {
|
|
2488
|
+
"description": "Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH",
|
|
2489
|
+
"type": "string"
|
|
2490
|
+
}
|
|
2491
|
+
},
|
|
2492
|
+
"additionalProperties": false
|
|
2493
|
+
}
|
|
2494
|
+
},
|
|
2495
|
+
"additionalProperties": false
|
|
2496
|
+
}
|
|
2497
|
+
},
|
|
2498
|
+
"registryUrl": {
|
|
2499
|
+
"type": "string"
|
|
2500
|
+
},
|
|
2501
|
+
"starterProjects": {
|
|
2502
|
+
"description": "Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.",
|
|
2503
|
+
"type": "array",
|
|
2504
|
+
"items": {
|
|
2505
|
+
"type": "object",
|
|
2506
|
+
"required": ["name"],
|
|
2507
|
+
"oneOf": [
|
|
2508
|
+
{
|
|
2509
|
+
"required": ["git"]
|
|
2510
|
+
},
|
|
2511
|
+
{
|
|
2512
|
+
"required": ["github"]
|
|
2513
|
+
},
|
|
2514
|
+
{
|
|
2515
|
+
"required": ["zip"]
|
|
2516
|
+
}
|
|
2517
|
+
],
|
|
2518
|
+
"properties": {
|
|
2519
|
+
"attributes": {
|
|
2520
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
2521
|
+
"type": "object",
|
|
2522
|
+
"additionalProperties": true
|
|
2523
|
+
},
|
|
2524
|
+
"description": {
|
|
2525
|
+
"description": "Description of a starter project",
|
|
2526
|
+
"type": "string"
|
|
2527
|
+
},
|
|
2528
|
+
"git": {
|
|
2529
|
+
"description": "Project's Git source",
|
|
2530
|
+
"type": "object",
|
|
2531
|
+
"properties": {
|
|
2532
|
+
"checkoutFrom": {
|
|
2533
|
+
"description": "Defines from what the project should be checked out. Required if there are more than one remote configured",
|
|
2534
|
+
"type": "object",
|
|
2535
|
+
"properties": {
|
|
2536
|
+
"remote": {
|
|
2537
|
+
"description": "The remote name should be used as init. Required if there are more than one remote configured",
|
|
2538
|
+
"type": "string"
|
|
2539
|
+
},
|
|
2540
|
+
"revision": {
|
|
2541
|
+
"description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.",
|
|
2542
|
+
"type": "string"
|
|
2543
|
+
}
|
|
2544
|
+
},
|
|
2545
|
+
"additionalProperties": false
|
|
2546
|
+
},
|
|
2547
|
+
"remotes": {
|
|
2548
|
+
"description": "The remotes map which should be initialized in the git project. Must have at least one remote configured",
|
|
2549
|
+
"type": "object",
|
|
2550
|
+
"additionalProperties": {
|
|
2551
|
+
"type": "string"
|
|
2552
|
+
}
|
|
2553
|
+
}
|
|
2554
|
+
},
|
|
2555
|
+
"additionalProperties": false
|
|
2556
|
+
},
|
|
2557
|
+
"github": {
|
|
2558
|
+
"description": "Project's GitHub source",
|
|
2559
|
+
"type": "object",
|
|
2560
|
+
"properties": {
|
|
2561
|
+
"checkoutFrom": {
|
|
2562
|
+
"description": "Defines from what the project should be checked out. Required if there are more than one remote configured",
|
|
2563
|
+
"type": "object",
|
|
2564
|
+
"properties": {
|
|
2565
|
+
"remote": {
|
|
2566
|
+
"description": "The remote name should be used as init. Required if there are more than one remote configured",
|
|
2567
|
+
"type": "string"
|
|
2568
|
+
},
|
|
2569
|
+
"revision": {
|
|
2570
|
+
"description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.",
|
|
2571
|
+
"type": "string"
|
|
2572
|
+
}
|
|
2573
|
+
},
|
|
2574
|
+
"additionalProperties": false
|
|
2575
|
+
},
|
|
2576
|
+
"remotes": {
|
|
2577
|
+
"description": "The remotes map which should be initialized in the git project. Must have at least one remote configured",
|
|
2578
|
+
"type": "object",
|
|
2579
|
+
"additionalProperties": {
|
|
2580
|
+
"type": "string"
|
|
2581
|
+
}
|
|
2582
|
+
}
|
|
2583
|
+
},
|
|
2584
|
+
"additionalProperties": false
|
|
2585
|
+
},
|
|
2586
|
+
"name": {
|
|
2587
|
+
"description": "Project name",
|
|
2588
|
+
"type": "string",
|
|
2589
|
+
"maxLength": 63,
|
|
2590
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
2591
|
+
},
|
|
2592
|
+
"subDir": {
|
|
2593
|
+
"description": "Sub-directory from a starter project to be used as root for starter project.",
|
|
2594
|
+
"type": "string"
|
|
2595
|
+
},
|
|
2596
|
+
"zip": {
|
|
2597
|
+
"description": "Project's Zip source",
|
|
2598
|
+
"type": "object",
|
|
2599
|
+
"properties": {
|
|
2600
|
+
"location": {
|
|
2601
|
+
"description": "Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH",
|
|
2602
|
+
"type": "string"
|
|
2603
|
+
}
|
|
2604
|
+
},
|
|
2605
|
+
"additionalProperties": false
|
|
2606
|
+
}
|
|
2607
|
+
},
|
|
2608
|
+
"additionalProperties": false
|
|
2609
|
+
}
|
|
2610
|
+
},
|
|
2611
|
+
"uri": {
|
|
2612
|
+
"description": "Uri of a Devfile yaml file",
|
|
2613
|
+
"type": "string"
|
|
2614
|
+
}
|
|
2615
|
+
},
|
|
2616
|
+
"additionalProperties": false
|
|
2617
|
+
},
|
|
2618
|
+
"projects": {
|
|
2619
|
+
"description": "Projects worked on in the workspace, containing names and sources locations",
|
|
2620
|
+
"type": "array",
|
|
2621
|
+
"items": {
|
|
2622
|
+
"type": "object",
|
|
2623
|
+
"required": ["name"],
|
|
2624
|
+
"oneOf": [
|
|
2625
|
+
{
|
|
2626
|
+
"required": ["git"]
|
|
2627
|
+
},
|
|
2628
|
+
{
|
|
2629
|
+
"required": ["github"]
|
|
2630
|
+
},
|
|
2631
|
+
{
|
|
2632
|
+
"required": ["zip"]
|
|
2633
|
+
}
|
|
2634
|
+
],
|
|
2635
|
+
"properties": {
|
|
2636
|
+
"attributes": {
|
|
2637
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
2638
|
+
"type": "object",
|
|
2639
|
+
"additionalProperties": true
|
|
2640
|
+
},
|
|
2641
|
+
"clonePath": {
|
|
2642
|
+
"description": "Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.",
|
|
2643
|
+
"type": "string"
|
|
2644
|
+
},
|
|
2645
|
+
"git": {
|
|
2646
|
+
"description": "Project's Git source",
|
|
2647
|
+
"type": "object",
|
|
2648
|
+
"required": ["remotes"],
|
|
2649
|
+
"properties": {
|
|
2650
|
+
"checkoutFrom": {
|
|
2651
|
+
"description": "Defines from what the project should be checked out. Required if there are more than one remote configured",
|
|
2652
|
+
"type": "object",
|
|
2653
|
+
"properties": {
|
|
2654
|
+
"remote": {
|
|
2655
|
+
"description": "The remote name should be used as init. Required if there are more than one remote configured",
|
|
2656
|
+
"type": "string"
|
|
2657
|
+
},
|
|
2658
|
+
"revision": {
|
|
2659
|
+
"description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.",
|
|
2660
|
+
"type": "string"
|
|
2661
|
+
}
|
|
2662
|
+
},
|
|
2663
|
+
"additionalProperties": false
|
|
2664
|
+
},
|
|
2665
|
+
"remotes": {
|
|
2666
|
+
"description": "The remotes map which should be initialized in the git project. Must have at least one remote configured",
|
|
2667
|
+
"type": "object",
|
|
2668
|
+
"additionalProperties": {
|
|
2669
|
+
"type": "string"
|
|
2670
|
+
}
|
|
2671
|
+
}
|
|
2672
|
+
},
|
|
2673
|
+
"additionalProperties": false
|
|
2674
|
+
},
|
|
2675
|
+
"github": {
|
|
2676
|
+
"description": "Project's GitHub source",
|
|
2677
|
+
"type": "object",
|
|
2678
|
+
"required": ["remotes"],
|
|
2679
|
+
"properties": {
|
|
2680
|
+
"checkoutFrom": {
|
|
2681
|
+
"description": "Defines from what the project should be checked out. Required if there are more than one remote configured",
|
|
2682
|
+
"type": "object",
|
|
2683
|
+
"properties": {
|
|
2684
|
+
"remote": {
|
|
2685
|
+
"description": "The remote name should be used as init. Required if there are more than one remote configured",
|
|
2686
|
+
"type": "string"
|
|
2687
|
+
},
|
|
2688
|
+
"revision": {
|
|
2689
|
+
"description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.",
|
|
2690
|
+
"type": "string"
|
|
2691
|
+
}
|
|
2692
|
+
},
|
|
2693
|
+
"additionalProperties": false
|
|
2694
|
+
},
|
|
2695
|
+
"remotes": {
|
|
2696
|
+
"description": "The remotes map which should be initialized in the git project. Must have at least one remote configured",
|
|
2697
|
+
"type": "object",
|
|
2698
|
+
"additionalProperties": {
|
|
2699
|
+
"type": "string"
|
|
2700
|
+
}
|
|
2701
|
+
}
|
|
2702
|
+
},
|
|
2703
|
+
"additionalProperties": false
|
|
2704
|
+
},
|
|
2705
|
+
"name": {
|
|
2706
|
+
"description": "Project name",
|
|
2707
|
+
"type": "string",
|
|
2708
|
+
"maxLength": 63,
|
|
2709
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
2710
|
+
},
|
|
2711
|
+
"sparseCheckoutDirs": {
|
|
2712
|
+
"description": "Populate the project sparsely with selected directories.",
|
|
2713
|
+
"type": "array",
|
|
2714
|
+
"items": {
|
|
2715
|
+
"type": "string"
|
|
2716
|
+
}
|
|
2717
|
+
},
|
|
2718
|
+
"zip": {
|
|
2719
|
+
"description": "Project's Zip source",
|
|
2720
|
+
"type": "object",
|
|
2721
|
+
"properties": {
|
|
2722
|
+
"location": {
|
|
2723
|
+
"description": "Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH",
|
|
2724
|
+
"type": "string"
|
|
2725
|
+
}
|
|
2726
|
+
},
|
|
2727
|
+
"additionalProperties": false
|
|
2728
|
+
}
|
|
2729
|
+
},
|
|
2730
|
+
"additionalProperties": false
|
|
2731
|
+
}
|
|
2732
|
+
},
|
|
2733
|
+
"schemaVersion": {
|
|
2734
|
+
"description": "Devfile schema version",
|
|
2735
|
+
"type": "string",
|
|
2736
|
+
"pattern": "^2\\.0\\.0$"
|
|
2737
|
+
},
|
|
2738
|
+
"starterProjects": {
|
|
2739
|
+
"description": "StarterProjects is a project that can be used as a starting point when bootstrapping new projects",
|
|
2740
|
+
"type": "array",
|
|
2741
|
+
"items": {
|
|
2742
|
+
"type": "object",
|
|
2743
|
+
"required": ["name"],
|
|
2744
|
+
"oneOf": [
|
|
2745
|
+
{
|
|
2746
|
+
"required": ["git"]
|
|
2747
|
+
},
|
|
2748
|
+
{
|
|
2749
|
+
"required": ["github"]
|
|
2750
|
+
},
|
|
2751
|
+
{
|
|
2752
|
+
"required": ["zip"]
|
|
2753
|
+
}
|
|
2754
|
+
],
|
|
2755
|
+
"properties": {
|
|
2756
|
+
"attributes": {
|
|
2757
|
+
"description": "Map of implementation-dependant free-form YAML attributes.",
|
|
2758
|
+
"type": "object",
|
|
2759
|
+
"additionalProperties": true
|
|
2760
|
+
},
|
|
2761
|
+
"description": {
|
|
2762
|
+
"description": "Description of a starter project",
|
|
2763
|
+
"type": "string"
|
|
2764
|
+
},
|
|
2765
|
+
"git": {
|
|
2766
|
+
"description": "Project's Git source",
|
|
2767
|
+
"type": "object",
|
|
2768
|
+
"required": ["remotes"],
|
|
2769
|
+
"properties": {
|
|
2770
|
+
"checkoutFrom": {
|
|
2771
|
+
"description": "Defines from what the project should be checked out. Required if there are more than one remote configured",
|
|
2772
|
+
"type": "object",
|
|
2773
|
+
"properties": {
|
|
2774
|
+
"remote": {
|
|
2775
|
+
"description": "The remote name should be used as init. Required if there are more than one remote configured",
|
|
2776
|
+
"type": "string"
|
|
2777
|
+
},
|
|
2778
|
+
"revision": {
|
|
2779
|
+
"description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.",
|
|
2780
|
+
"type": "string"
|
|
2781
|
+
}
|
|
2782
|
+
},
|
|
2783
|
+
"additionalProperties": false
|
|
2784
|
+
},
|
|
2785
|
+
"remotes": {
|
|
2786
|
+
"description": "The remotes map which should be initialized in the git project. Must have at least one remote configured",
|
|
2787
|
+
"type": "object",
|
|
2788
|
+
"additionalProperties": {
|
|
2789
|
+
"type": "string"
|
|
2790
|
+
}
|
|
2791
|
+
}
|
|
2792
|
+
},
|
|
2793
|
+
"additionalProperties": false
|
|
2794
|
+
},
|
|
2795
|
+
"github": {
|
|
2796
|
+
"description": "Project's GitHub source",
|
|
2797
|
+
"type": "object",
|
|
2798
|
+
"required": ["remotes"],
|
|
2799
|
+
"properties": {
|
|
2800
|
+
"checkoutFrom": {
|
|
2801
|
+
"description": "Defines from what the project should be checked out. Required if there are more than one remote configured",
|
|
2802
|
+
"type": "object",
|
|
2803
|
+
"properties": {
|
|
2804
|
+
"remote": {
|
|
2805
|
+
"description": "The remote name should be used as init. Required if there are more than one remote configured",
|
|
2806
|
+
"type": "string"
|
|
2807
|
+
},
|
|
2808
|
+
"revision": {
|
|
2809
|
+
"description": "The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.",
|
|
2810
|
+
"type": "string"
|
|
2811
|
+
}
|
|
2812
|
+
},
|
|
2813
|
+
"additionalProperties": false
|
|
2814
|
+
},
|
|
2815
|
+
"remotes": {
|
|
2816
|
+
"description": "The remotes map which should be initialized in the git project. Must have at least one remote configured",
|
|
2817
|
+
"type": "object",
|
|
2818
|
+
"additionalProperties": {
|
|
2819
|
+
"type": "string"
|
|
2820
|
+
}
|
|
2821
|
+
}
|
|
2822
|
+
},
|
|
2823
|
+
"additionalProperties": false
|
|
2824
|
+
},
|
|
2825
|
+
"name": {
|
|
2826
|
+
"description": "Project name",
|
|
2827
|
+
"type": "string",
|
|
2828
|
+
"maxLength": 63,
|
|
2829
|
+
"pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"
|
|
2830
|
+
},
|
|
2831
|
+
"subDir": {
|
|
2832
|
+
"description": "Sub-directory from a starter project to be used as root for starter project.",
|
|
2833
|
+
"type": "string"
|
|
2834
|
+
},
|
|
2835
|
+
"zip": {
|
|
2836
|
+
"description": "Project's Zip source",
|
|
2837
|
+
"type": "object",
|
|
2838
|
+
"properties": {
|
|
2839
|
+
"location": {
|
|
2840
|
+
"description": "Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH",
|
|
2841
|
+
"type": "string"
|
|
2842
|
+
}
|
|
2843
|
+
},
|
|
2844
|
+
"additionalProperties": false
|
|
2845
|
+
}
|
|
2846
|
+
},
|
|
2847
|
+
"additionalProperties": false
|
|
2848
|
+
}
|
|
2849
|
+
}
|
|
2850
|
+
},
|
|
2851
|
+
"additionalProperties": false
|
|
2852
|
+
}
|