You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc
+62-42Lines changed: 62 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -9,54 +9,69 @@ Each component in a single devfile must have a unique name and use one of the ob
9
9
|===
10
10
|Key |Type| Required| Description
11
11
12
-
|container
13
-
|componentObject
12
+
|`container`
13
+
|`componentObject`
14
14
|no
15
-
|The list of containers that you use.
15
+
|The list of containers.
16
+
17
+
|`kubernetes`
18
+
|`componentObject`
19
+
|no
20
+
|The Kubernetes cluster.
21
+
22
+
|`openshift`
23
+
|`componentObject`
24
+
|no
25
+
|The OpenShift container.
26
+
27
+
|`volume`
28
+
|`componentObject`
29
+
|no
30
+
|The list of volume components.
16
31
|===
17
32
18
33
.container object
19
34
[cols="1,1,1,1"]
20
35
|===
21
36
|Key |Type| Required| Description
22
37
23
-
|name
24
-
|string
38
+
|`name`
39
+
|`string`
25
40
|yes
26
41
|The name of your container.
27
42
28
-
|image
29
-
|string
43
+
|`image`
44
+
|`string`
30
45
|yes
31
46
|The image version.
32
47
33
-
|memoryLimit
34
-
|string
48
+
|`memoryLimit`
49
+
|`string`
35
50
|no
36
51
|The memory limit that you use with your container.
37
52
38
-
|mountSources
39
-
|boolean
53
+
|`mountSources`
54
+
|`boolean`
40
55
|no
41
56
|Choose to mount the source or not.
42
57
43
-
|sourceMapping
44
-
|string
58
+
|`sourceMapping`
59
+
|`string`
45
60
|no
46
61
|The path in the container where you transfer and mount the project sources. This path is available in the container through the environment, `PROJECTS_ROOT`.
47
62
48
-
|endpoints
49
-
|endpointObject
63
+
|`endpoints`
64
+
|`endpointObject`
50
65
|no
51
66
|The list of endpoints to use.
52
67
53
-
|volumeMounts
54
-
|volumeMountsObject
68
+
|`volumeMounts`
69
+
|`volumeMountsObject`
55
70
|no
56
71
|The list of volumes to mount.
57
72
58
-
|environment
59
-
|envObject
73
+
|`environment`
74
+
|`envObject`
60
75
|no
61
76
|The list of environment variables to use.
62
77
|===
@@ -66,64 +81,69 @@ Each component in a single devfile must have a unique name and use one of the ob
66
81
|===
67
82
|Key |Type| Required| Description
68
83
69
-
|name
70
-
|string
84
+
|`name`
85
+
|`string`
71
86
|yes
72
87
|The name of your endpoint.
73
88
74
-
|targetPort
75
-
|integer
89
+
|`targetPort`
90
+
|`integer`
76
91
|yes
77
92
|The port number that you target.
78
93
79
-
|exposure
80
-
|string
94
+
|`exposure`
95
+
|`string`
81
96
|no
82
97
|Use the following attributes to describe how to expose the endpoints on the network: `public`, `internal`, `none`. If not specified, the default attribute is `public`.
83
98
84
-
|path
85
-
|string
99
+
|`path`
100
+
|`string`
86
101
|no
87
102
|The path to the endpoint URL.
88
103
89
-
|protocol
90
-
|string
104
+
|`protocol`
105
+
|`string`
91
106
|no
92
107
|Use the following attributes to describe the application and transport protocols of the traffic that goes through the endpoint: `http`, `https`, `ws`, `wss`, `tcp`, `udp`. If not specified, the default attribute is `http`.
93
108
94
-
|secure
95
-
|boolean
109
+
|`secure`
110
+
|`boolean`
96
111
|no
97
-
|Choose to define the endpoint as secure or not.
112
+
|Choose whether to define the endpoint as secure.
98
113
|===
99
114
100
-
.volume object
115
+
.volumeMount object
101
116
[cols="1,1,1,1"]
102
117
|===
103
118
|Key |Type| Required| Description
104
119
105
-
|name
106
-
|string
120
+
|`name`
121
+
|`string`
107
122
|yes
108
123
|The name of the volume components that you use.
109
124
110
-
|path
111
-
|string
125
+
|`path`
126
+
|`string`
112
127
|no
113
128
|The path in the component container where you mount the volume.
0 commit comments