-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
8711 lines (8388 loc) · 377 KB
/
openapi.yaml
File metadata and controls
8711 lines (8388 loc) · 377 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Kubernetes
version: ""
servers:
- url: /
paths: {}
components:
schemas:
v2.2.0.Devfile:
description: Devfile describes the structure of a cloud-native devworkspace
and development environment.
properties:
attributes:
description: Map of implementation-dependant free-form YAML attributes.
properties: {}
type: object
commands:
description: Predefined, ready-to-use, devworkspace-related commands
items:
$ref: '#/components/schemas/v2.2.0.Devfile.commands'
type: array
components:
description: List of the devworkspace components, such as editor and plugins,
user-provided containers, or other types of components
items:
$ref: '#/components/schemas/v2.2.0.Devfile.components'
type: array
events:
$ref: '#/components/schemas/v2.2.0.Devfile.events'
metadata:
$ref: '#/components/schemas/v2.2.0.Devfile.metadata'
parent:
$ref: '#/components/schemas/v2.2.0.Devfile.parent'
projects:
description: Projects worked on in the devworkspace, containing names and
sources locations
items:
$ref: '#/components/schemas/v2.2.0.Devfile.projects'
type: array
schemaVersion:
description: Devfile schema version
pattern: ^([2-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$
type: string
starterProjects:
description: StarterProjects is a project that can be used as a starting
point when bootstrapping new projects
items:
$ref: '#/components/schemas/v2.2.0.Devfile.starterProjects'
type: array
variables:
additionalProperties:
type: string
description: |-
Map of key-value variables used for string replacement in the devfile. Values can be referenced via {{variable-key}} to replace the corresponding value in string fields in the devfile. Replacement cannot be used for
- schemaVersion, metadata, parent source
- element identifiers, e.g. command id, component name, endpoint name, project name
- references to identifiers, e.g. in events, a command's component, container's volume mount name
- string enums, e.g. command group kind, endpoint exposure
type: object
required:
- schemaVersion
title: Devfile schema - Version 2.2.0-alpha
type: object
v2.2.0.Devfile.events:
description: Bindings of commands to events. Each command is referred-to by
its name.
properties:
postStart:
description: IDs of commands that should be executed after the devworkspace
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.
items:
type: string
type: array
postStop:
description: IDs of commands that should be executed after stopping the
devworkspace.
items:
type: string
type: array
preStart:
description: IDs of commands that should be executed before the devworkspace
start. Kubernetes-wise, these commands would typically be executed in
init containers of the devworkspace POD.
items:
type: string
type: array
preStop:
description: IDs of commands that should be executed before stopping the
devworkspace.
items:
type: string
type: array
type: object
v2.2.0.Devfile.metadata:
description: Optional metadata
properties:
architectures:
description: Optional list of processor architectures that the devfile supports,
empty list suggests that the devfile can be used on any architecture
items:
description: Architecture describes the architecture type
enum:
- amd64
- arm64
- ppc64le
- s390x
type: string
type: array
uniqueItems: true
attributes:
description: Map of implementation-dependant free-form YAML attributes.
Deprecated, use the top-level attributes field instead.
properties: {}
type: object
description:
description: Optional devfile description
type: string
displayName:
description: Optional devfile display name
type: string
globalMemoryLimit:
description: Optional devfile global memory limit
type: string
icon:
description: Optional devfile icon, can be a URI or a relative path in the
project
type: string
language:
description: Optional devfile language
type: string
name:
description: Optional devfile name
type: string
projectType:
description: Optional devfile project type
type: string
provider:
description: Optional devfile provider information
type: string
supportUrl:
description: Optional link to a page that provides support information
type: string
tags:
description: Optional devfile tags
items:
type: string
type: array
version:
description: Optional semver-compatible version
pattern: ^([0-9]+)\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$
type: string
website:
description: Optional devfile website
type: string
type: object
v2.2.0.Devfile.parent:
description: Parent devworkspace template
properties:
attributes:
description: Overrides of attributes encapsulated in a parent devfile. Overriding
is done according to K8S strategic merge patch standard rules.
properties: {}
type: object
commands:
description: Overrides of commands encapsulated in a parent devfile or a
plugin. Overriding is done according to K8S strategic merge patch standard
rules.
items:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.commands'
type: array
components:
description: Overrides of components encapsulated in a parent devfile or
a plugin. Overriding is done according to K8S strategic merge patch standard
rules.
items:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components'
type: array
id:
description: Id in a registry that contains a Devfile yaml file
type: string
kubernetes:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.kubernetes'
projects:
description: Overrides of projects encapsulated in a parent devfile. Overriding
is done according to K8S strategic merge patch standard rules.
items:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.projects'
type: array
registryUrl:
description: Registry URL to pull the parent devfile from when using id
in the parent reference. To ensure the parent devfile gets resolved consistently
in different environments, it is recommended to always specify the `registryUrl`
when `id` is used.
type: string
starterProjects:
description: Overrides of starterProjects encapsulated in a parent devfile.
Overriding is done according to K8S strategic merge patch standard rules.
items:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.starterProjects'
type: array
uri:
description: URI Reference of a parent devfile YAML file. It can be a full
URL or a relative URI with the current devfile as the base URI.
type: string
variables:
additionalProperties:
type: string
description: Overrides of variables encapsulated in a parent devfile. Overriding
is done according to K8S strategic merge patch standard rules.
type: object
version:
description: Specific stack/sample version to pull the parent devfile from,
when using id in the parent reference. To specify `version`, `id` must
be defined and used as the import reference source. `version` can be either
a specific stack version, or `latest`. If no `version` specified, default
version will be used.
pattern: ^(latest)|(([1-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?)$
type: string
type: object
v2.2.0.Devfile.starterProjects.items.git:
description: Project's Git source
properties:
checkoutFrom:
$ref: '#/components/schemas/v2.2.0.Devfile.starterProjects.items.git.checkoutFrom'
remotes:
additionalProperties:
type: string
description: The remotes map which should be initialized in the git project.
Projects must have at least one remote configured while StarterProjects
& Image Component's Git source can only have at most one remote configured.
type: object
required:
- remotes
type: object
v2.2.0.Devfile.starterProjects.items.zip:
description: Project's Zip source
properties:
location:
description: Zip project's source location address. Should be file path
of the archive, e.g. file://$FILE_PATH
type: string
type: object
v2.2.0.Devfile.starterProjects:
properties:
attributes:
description: Map of implementation-dependant free-form YAML attributes.
properties: {}
type: object
description:
description: Description of a starter project
type: string
git:
$ref: '#/components/schemas/v2.2.0.Devfile.starterProjects.items.git'
name:
description: Project name
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
subDir:
description: Sub-directory from a starter project to be used as root for
starter project.
type: string
zip:
$ref: '#/components/schemas/v2.2.0.Devfile.starterProjects.items.zip'
required:
- name
type: object
v2.2.0.Devfile.starterProjects.items.git.checkoutFrom:
description: Defines from what the project should be checked out. Required if
there are more than one remote configured
properties:
remote:
description: The remote name should be used as init. Required if there are
more than one remote configured
type: string
revision:
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.
type: string
type: object
v2.2.0.Devfile.projects.items.git:
description: Project's Git source
properties:
checkoutFrom:
$ref: '#/components/schemas/v2.2.0.Devfile.projects.items.git.checkoutFrom'
remotes:
additionalProperties:
type: string
description: The remotes map which should be initialized in the git project.
Projects must have at least one remote configured while StarterProjects
& Image Component's Git source can only have at most one remote configured.
type: object
required:
- remotes
type: object
v2.2.0.Devfile.projects.items.zip:
description: Project's Zip source
properties:
location:
description: Zip project's source location address. Should be file path
of the archive, e.g. file://$FILE_PATH
type: string
type: object
v2.2.0.Devfile.projects:
properties:
attributes:
description: Map of implementation-dependant free-form YAML attributes.
properties: {}
type: object
clonePath:
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.
type: string
git:
$ref: '#/components/schemas/v2.2.0.Devfile.projects.items.git'
name:
description: Project name
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
zip:
$ref: '#/components/schemas/v2.2.0.Devfile.projects.items.zip'
required:
- name
type: object
v2.2.0.Devfile.projects.items.git.checkoutFrom:
description: Defines from what the project should be checked out. Required if
there are more than one remote configured
properties:
remote:
description: The remote name should be used as init. Required if there are
more than one remote configured
type: string
revision:
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.
type: string
type: object
v2.2.0.Devfile.parent.commands:
properties:
apply:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.commands.items.apply'
attributes:
description: Map of implementation-dependant free-form YAML attributes.
properties: {}
type: object
composite:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.commands.items.composite'
exec:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.commands.items.exec'
id:
description: Mandatory identifier that allows referencing this command in
composite commands, from a parent, or in events.
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
required:
- id
type: object
v2.2.0.Devfile.parent.components:
properties:
attributes:
description: Map of implementation-dependant free-form YAML attributes.
properties: {}
type: object
container:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.container'
image:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.image'
kubernetes:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.kubernetes'
name:
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.
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
openshift:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.openshift'
volume:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.volume'
required:
- name
type: object
v2.2.0.Devfile.parent.kubernetes:
description: Reference to a Kubernetes CRD of type DevWorkspaceTemplate
properties:
name:
type: string
namespace:
type: string
required:
- name
type: object
v2.2.0.Devfile.parent.projects:
properties:
attributes:
description: Map of implementation-dependant free-form YAML attributes.
properties: {}
type: object
clonePath:
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.
type: string
git:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.projects.items.git'
name:
description: Project name
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
zip:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.projects.items.zip'
required:
- name
type: object
v2.2.0.Devfile.parent.starterProjects:
properties:
attributes:
description: Map of implementation-dependant free-form YAML attributes.
properties: {}
type: object
description:
description: Description of a starter project
type: string
git:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.starterProjects.items.git'
name:
description: Project name
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
subDir:
description: Sub-directory from a starter project to be used as root for
starter project.
type: string
zip:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.starterProjects.items.zip'
required:
- name
type: object
v2.2.0.Devfile.parent.starterProjects.items.git:
description: Project's Git source
properties:
checkoutFrom:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.starterProjects.items.git.checkoutFrom'
remotes:
additionalProperties:
type: string
description: The remotes map which should be initialized in the git project.
Projects must have at least one remote configured while StarterProjects
& Image Component's Git source can only have at most one remote configured.
type: object
type: object
v2.2.0.Devfile.parent.starterProjects.items.zip:
description: Project's Zip source
properties:
location:
description: Zip project's source location address. Should be file path
of the archive, e.g. file://$FILE_PATH
type: string
type: object
v2.2.0.Devfile.parent.starterProjects.items.git.checkoutFrom:
description: Defines from what the project should be checked out. Required if
there are more than one remote configured
properties:
remote:
description: The remote name should be used as init. Required if there are
more than one remote configured
type: string
revision:
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.
type: string
type: object
v2.2.0.Devfile.parent.projects.items.git:
description: Project's Git source
properties:
checkoutFrom:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.projects.items.git.checkoutFrom'
remotes:
additionalProperties:
type: string
description: The remotes map which should be initialized in the git project.
Projects must have at least one remote configured while StarterProjects
& Image Component's Git source can only have at most one remote configured.
type: object
type: object
v2.2.0.Devfile.parent.projects.items.zip:
description: Project's Zip source
properties:
location:
description: Zip project's source location address. Should be file path
of the archive, e.g. file://$FILE_PATH
type: string
type: object
v2.2.0.Devfile.parent.projects.items.git.checkoutFrom:
description: Defines from what the project should be checked out. Required if
there are more than one remote configured
properties:
remote:
description: The remote name should be used as init. Required if there are
more than one remote configured
type: string
revision:
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.
type: string
type: object
v2.2.0.Devfile.parent.components.items.container:
description: Allows adding and configuring devworkspace-related containers
properties:
annotation:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.container.annotation'
args:
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.
Defaults to an empty array, meaning use whatever is defined in the image.
items:
type: string
type: array
command:
description: |-
The command to run in the dockerimage component instead of the default one provided in the image.
Defaults to an empty array, meaning use whatever is defined in the image.
items:
type: string
type: array
cpuLimit:
type: string
cpuRequest:
type: string
dedicatedPod:
description: |-
Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.
Default value is `false`
type: boolean
endpoints:
items:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.container.endpoints'
type: array
env:
description: |-
Environment variables used in this container.
The following variables are reserved and cannot be overridden via env:
- `$PROJECTS_ROOT`
- `$PROJECT_SOURCE`
items:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.container.env'
type: array
image:
type: string
memoryLimit:
type: string
memoryRequest:
type: string
mountSources:
description: |-
Toggles whether or not the project source code should be mounted in the component.
Defaults to true for all component types except plugins and components that set `dedicatedPod` to true.
type: boolean
sourceMapping:
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.
type: string
volumeMounts:
description: List of volumes mounts that should be mounted is this container.
items:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.container.volumeMounts'
type: array
type: object
v2.2.0.Devfile.parent.components.items.image:
description: Allows specifying the definition of an image for outer loop builds
properties:
autoBuild:
description: |-
Defines if the image should be built during startup.
Default value is `false`
type: boolean
dockerfile:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.image.dockerfile'
imageName:
description: Name of the image for the resulting outerloop build
type: string
type: object
v2.2.0.Devfile.parent.components.items.kubernetes:
description: Allows importing into the devworkspace the Kubernetes resources
defined in a given manifest. For example this allows reusing the Kubernetes
definitions used to deploy some runtime components in production.
properties:
deployByDefault:
description: |-
Defines if the component should be deployed during startup.
Default value is `false`
type: boolean
endpoints:
items:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.kubernetes.endpoints'
type: array
inlined:
description: Inlined manifest
type: string
uri:
description: Location in a file fetched from a uri.
type: string
type: object
v2.2.0.Devfile.parent.components.items.openshift:
description: Allows importing into the devworkspace the OpenShift resources
defined in a given manifest. For example this allows reusing the OpenShift
definitions used to deploy some runtime components in production.
properties:
deployByDefault:
description: |-
Defines if the component should be deployed during startup.
Default value is `false`
type: boolean
endpoints:
items:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.openshift.endpoints'
type: array
inlined:
description: Inlined manifest
type: string
uri:
description: Location in a file fetched from a uri.
type: string
type: object
v2.2.0.Devfile.parent.components.items.volume:
description: Allows specifying the definition of a volume shared by several
other components
properties:
ephemeral:
description: Ephemeral volumes are not stored persistently across restarts.
Defaults to false
type: boolean
size:
description: Size of the volume
type: string
type: object
v2.2.0.Devfile.parent.components.items.openshift.endpoints:
properties:
annotation:
additionalProperties:
type: string
description: Annotations to be added to Kubernetes Ingress or Openshift
Route
type: object
attributes:
description: |-
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev",
properties: {}
type: object
exposure:
description: |-
Describes how the endpoint should be exposed on the network.
- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.
- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.
- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.
Default value is `public`
enum:
- public
- internal
- none
type: string
name:
maxLength: 15
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
path:
description: Path of the endpoint URL
type: string
protocol:
description: |-
Describes the application and transport protocols of the traffic that will go through this endpoint.
- `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`.
- `https`: Endpoint will have `https` traffic, typically on a TCP connection.
- `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`.
- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.
- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.
- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.
Default value is `http`
enum:
- http
- https
- ws
- wss
- tcp
- udp
type: string
secure:
description: Describes whether the endpoint should be secured and protected
by some authentication process. This requires a protocol of `https` or
`wss`.
type: boolean
targetPort:
description: Port number to be used within the container component. The
same port cannot be used by two different container components.
type: integer
required:
- name
type: object
v2.2.0.Devfile.parent.components.items.kubernetes.endpoints:
properties:
annotation:
additionalProperties:
type: string
description: Annotations to be added to Kubernetes Ingress or Openshift
Route
type: object
attributes:
description: |-
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev",
properties: {}
type: object
exposure:
description: |-
Describes how the endpoint should be exposed on the network.
- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.
- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.
- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.
Default value is `public`
enum:
- public
- internal
- none
type: string
name:
maxLength: 15
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
path:
description: Path of the endpoint URL
type: string
protocol:
description: |-
Describes the application and transport protocols of the traffic that will go through this endpoint.
- `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`.
- `https`: Endpoint will have `https` traffic, typically on a TCP connection.
- `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`.
- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.
- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.
- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.
Default value is `http`
enum:
- http
- https
- ws
- wss
- tcp
- udp
type: string
secure:
description: Describes whether the endpoint should be secured and protected
by some authentication process. This requires a protocol of `https` or
`wss`.
type: boolean
targetPort:
description: Port number to be used within the container component. The
same port cannot be used by two different container components.
type: integer
required:
- name
type: object
v2.2.0.Devfile.parent.components.items.image.dockerfile:
description: Allows specifying dockerfile type build
properties:
args:
description: The arguments to supply to the dockerfile build.
items:
type: string
type: array
buildContext:
description: Path of source directory to establish build context. Defaults
to ${PROJECT_SOURCE} in the container
type: string
devfileRegistry:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.image.dockerfile.devfileRegistry'
git:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.image.dockerfile.git'
rootRequired:
description: |-
Specify if a privileged builder pod is required.
Default value is `false`
type: boolean
uri:
description: URI Reference of a Dockerfile. It can be a full URL or a relative
URI from the current devfile as the base URI.
type: string
type: object
v2.2.0.Devfile.parent.components.items.image.dockerfile.devfileRegistry:
description: Dockerfile's Devfile Registry source
properties:
id:
description: Id in a devfile registry that contains a Dockerfile. The src
in the OCI registry required for the Dockerfile build will be downloaded
for building the image.
type: string
registryUrl:
description: Devfile Registry URL to pull the Dockerfile from when using
the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets
resolved consistently in different environments, it is recommended to
always specify the `devfileRegistryUrl` when `Id` is used.
type: string
type: object
v2.2.0.Devfile.parent.components.items.image.dockerfile.git:
description: Dockerfile's Git source
properties:
checkoutFrom:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.components.items.image.dockerfile.git.checkoutFrom'
fileLocation:
description: Location of the Dockerfile in the Git repository when using
git as Dockerfile src. Defaults to Dockerfile.
type: string
remotes:
additionalProperties:
type: string
description: The remotes map which should be initialized in the git project.
Projects must have at least one remote configured while StarterProjects
& Image Component's Git source can only have at most one remote configured.
type: object
type: object
v2.2.0.Devfile.parent.components.items.image.dockerfile.git.checkoutFrom:
description: Defines from what the project should be checked out. Required if
there are more than one remote configured
properties:
remote:
description: The remote name should be used as init. Required if there are
more than one remote configured
type: string
revision:
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.
type: string
type: object
v2.2.0.Devfile.parent.components.items.container.annotation:
description: Annotations that should be added to specific resources for this
container
properties:
deployment:
additionalProperties:
type: string
description: Annotations to be added to deployment
type: object
service:
additionalProperties:
type: string
description: Annotations to be added to service
type: object
type: object
v2.2.0.Devfile.parent.components.items.container.endpoints:
properties:
annotation:
additionalProperties:
type: string
description: Annotations to be added to Kubernetes Ingress or Openshift
Route
type: object
attributes:
description: |-
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev",
properties: {}
type: object
exposure:
description: |-
Describes how the endpoint should be exposed on the network.
- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.
- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.
- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.
Default value is `public`
enum:
- public
- internal
- none
type: string
name:
maxLength: 15
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
path:
description: Path of the endpoint URL
type: string
protocol:
description: |-
Describes the application and transport protocols of the traffic that will go through this endpoint.
- `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`.
- `https`: Endpoint will have `https` traffic, typically on a TCP connection.
- `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`.
- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.
- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.
- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.
Default value is `http`
enum:
- http
- https
- ws
- wss
- tcp
- udp
type: string
secure:
description: Describes whether the endpoint should be secured and protected
by some authentication process. This requires a protocol of `https` or
`wss`.
type: boolean
targetPort:
description: Port number to be used within the container component. The
same port cannot be used by two different container components.
type: integer
required:
- name
type: object
v2.2.0.Devfile.parent.components.items.container.env:
properties:
name:
type: string
value:
type: string
required:
- name
type: object
v2.2.0.Devfile.parent.components.items.container.volumeMounts:
description: Volume that should be mounted to a component container
properties:
name:
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.
maxLength: 63
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
path:
description: The path in the component container where the volume should
be mounted. If not path is mentioned, default path is the is `/<name>`.
type: string
required:
- name
type: object
v2.2.0.Devfile.parent.commands.items.apply:
description: |-
Command that consists in applying a given component definition, typically bound to a devworkspace event.
For 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 devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.
When no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.
properties:
component:
description: Describes component that will be applied
type: string
group:
$ref: '#/components/schemas/v2.2.0.Devfile.parent.commands.items.apply.group'