Skip to content

added devfile component changes #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 4, 2022
Original file line number Diff line number Diff line change
Expand Up @@ -9,54 +9,69 @@ Each component in a single devfile must have a unique name and use one of the ob
|===
|Key |Type| Required| Description

|container
|componentObject
|`container`
|`componentObject`
|no
|The list of containers that you use.
|The list of containers.

|`kubernetes`
|`componentObject`
|no
|The Kubernetes cluster.

|`openshift`
|`componentObject`
|no
|The OpenShift container.

|`volume`
|`componentObject`
|no
|The list of volume components.
|===

.container object
[cols="1,1,1,1"]
|===
|Key |Type| Required| Description

|name
|string
|`name`
|`string`
|yes
|The name of your container.

|image
|string
|`image`
|`string`
|yes
|The image version.

|memoryLimit
|string
|`memoryLimit`
|`string`
|no
|The memory limit that you use with your container.

|mountSources
|boolean
|`mountSources`
|`boolean`
|no
|Choose to mount the source or not.

|sourceMapping
|string
|`sourceMapping`
|`string`
|no
|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`.

|endpoints
|endpointObject
|`endpoints`
|`endpointObject`
|no
|The list of endpoints to use.

|volumeMounts
|volumeMountsObject
|`volumeMounts`
|`volumeMountsObject`
|no
|The list of volumes to mount.

|environment
|envObject
|`environment`
|`envObject`
|no
|The list of environment variables to use.
|===
Expand All @@ -66,64 +81,69 @@ Each component in a single devfile must have a unique name and use one of the ob
|===
|Key |Type| Required| Description

|name
|string
|`name`
|`string`
|yes
|The name of your endpoint.

|targetPort
|integer
|`targetPort`
|`integer`
|yes
|The port number that you target.

|exposure
|string
|`exposure`
|`string`
|no
|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`.

|path
|string
|`path`
|`string`
|no
|The path to the endpoint URL.

|protocol
|string
|`protocol`
|`string`
|no
|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`.

|secure
|boolean
|`secure`
|`boolean`
|no
|Choose to define the endpoint as secure or not.
|Choose whether to define the endpoint as secure.
|===

.volume object
.volumeMount object
[cols="1,1,1,1"]
|===
|Key |Type| Required| Description

|name
|string
|`name`
|`string`
|yes
|The name of the volume components that you use.

|path
|string
|`path`
|`string`
|no
|The path in the component container where you mount the volume.
|===

|name
|string
.volume object
[cols="1,1,1,1"]
|===
|Key |Type| Required| Description

|`name`
|`string`
|yes
|The name of the volume component.

|size
|string
|`size`
|`string`
|no
|The size of the storage you create.
|===


.Prerequisites

* xref:adding-schema-version-to-a-devfile.adoc[]
Expand Down