Devfile schema - Version 2.0.0

Devfile describes the structure of a cloud-native workspace and development environment.

commands: object[]

Predefined, ready-to-use, workspace-related commands

object
apply: object

Command that consists in applying a given component definition, typically bound to a workspace 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 workspace 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 workspace start by default.

component: string

Describes component that will be applied

group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

label: string

Optional label that provides a label for this command to be used in Editor UI menus for example

composite: object

Composite command that allows executing several sub-commands either sequentially or concurrently

commands: string[]

The commands that comprise this composite command

string
group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

label: string

Optional label that provides a label for this command to be used in Editor UI menus for example

parallel: boolean

Indicates if the sub-commands should be executed concurrently

exec: object

CLI Command executed in an existing component container

commandLine: string

The actual command-line string

Special variables that can be used:

  • $PROJECTS_ROOT: A path where projects sources are mounted as defined by container component's sourceMapping.

  • $PROJECT_SOURCE: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one.

component: string

Describes component to which given action relates

env: object[]

Optional list of environment variables that have to be set before running the command

object
name: string
value: string
group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

hotReloadCapable: boolean

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.

Default value is false

label: string

Optional label that provides a label for this command to be used in Editor UI menus for example

workingDir: string

Working directory where the command should be executed

Special variables that can be used:

  • $PROJECTS_ROOT: A path where projects sources are mounted as defined by container component's sourceMapping.

  • $PROJECT_SOURCE: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one.

vscodeLaunch: object

Command providing the definition of a VsCode launch action

inlined: string

Inlined content of the VsCode configuration

uri: string

Location as an absolute of relative URI the VsCode configuration will be fetched from

group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

vscodeTask: object

Command providing the definition of a VsCode Task

inlined: string

Inlined content of the VsCode configuration

uri: string

Location as an absolute of relative URI the VsCode configuration will be fetched from

group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

attributes: object

Map of implementation-dependant free-form YAML attributes.

id: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.

components: object[]

List of the workspace components, such as editor and plugins, user-provided containers, or other types of components

object
container: object

Allows adding and configuring workspace-related containers

args: string[]

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.

string
command: string[]

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.

string
dedicatedPod: boolean

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

endpoints: object[]
object
attributes: object

Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:

  • cookiesAuthEnabled: "true" / "false",
  • type: "terminal" / "ide" / "ide-dev",
exposure: string , x ∈ { public (default) , internal , none }

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 workspace 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 workspace POD, on a local address.

Default value is public

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
path: string

Path of the endpoint URL

protocol: string , x ∈ { http (default) , https , ws , wss , tcp , udp }

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

secure: boolean

Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https or wss.

targetPort: integer
env: object[]

Environment variables used in this container.

The following variables are reserved and cannot be overridden via env:

  • $PROJECTS_ROOT

  • $PROJECT_SOURCE

object
name: string
value: string
image: string
memoryLimit: string
mountSources: boolean

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.

sourceMapping: string /projects

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.

volumeMounts: object[]

List of volumes mounts that should be mounted is this container.

object

Volume that should be mounted to a component container

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

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.

path: string

The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is /<name>.

kubernetes: object

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.

inlined: string

Inlined manifest

uri: string

Location in a file fetched from a uri.

endpoints: object[]
object
attributes: object

Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:

  • cookiesAuthEnabled: "true" / "false",
  • type: "terminal" / "ide" / "ide-dev",
exposure: string , x ∈ { public (default) , internal , none }

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 workspace 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 workspace POD, on a local address.

Default value is public

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
path: string

Path of the endpoint URL

protocol: string , x ∈ { http (default) , https , ws , wss , tcp , udp }

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

secure: boolean

Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https or wss.

targetPort: integer
openshift: object

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.

inlined: string

Inlined manifest

uri: string

Location in a file fetched from a uri.

endpoints: object[]
object
attributes: object

Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:

  • cookiesAuthEnabled: "true" / "false",
  • type: "terminal" / "ide" / "ide-dev",
exposure: string , x ∈ { public (default) , internal , none }

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 workspace 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 workspace POD, on a local address.

Default value is public

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
path: string

Path of the endpoint URL

protocol: string , x ∈ { http (default) , https , ws , wss , tcp , udp }

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

secure: boolean

Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https or wss.

targetPort: integer
plugin: object

Allows importing a plugin.

Plugins 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

id: string

Id in a registry that contains a Devfile yaml file

kubernetes: object

Reference to a Kubernetes CRD of type DevWorkspaceTemplate

name: string
namespace: string
uri: string

Uri of a Devfile yaml file

commands: object[]

Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.

object
apply: object

Command that consists in applying a given component definition, typically bound to a workspace 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 workspace 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 workspace start by default.

component: string

Describes component that will be applied

group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

label: string

Optional label that provides a label for this command to be used in Editor UI menus for example

composite: object

Composite command that allows executing several sub-commands either sequentially or concurrently

commands: string[]

The commands that comprise this composite command

string
group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

label: string

Optional label that provides a label for this command to be used in Editor UI menus for example

parallel: boolean

Indicates if the sub-commands should be executed concurrently

exec: object

CLI Command executed in an existing component container

commandLine: string

The actual command-line string

Special variables that can be used:

  • $PROJECTS_ROOT: A path where projects sources are mounted as defined by container component's sourceMapping.

  • $PROJECT_SOURCE: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one.

component: string

Describes component to which given action relates

env: object[]

Optional list of environment variables that have to be set before running the command

object
name: string
value: string
group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

hotReloadCapable: boolean

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.

Default value is false

label: string

Optional label that provides a label for this command to be used in Editor UI menus for example

workingDir: string

Working directory where the command should be executed

Special variables that can be used:

  • $PROJECTS_ROOT: A path where projects sources are mounted as defined by container component's sourceMapping.

  • $PROJECT_SOURCE: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one.

vscodeLaunch: object

Command providing the definition of a VsCode launch action

inlined: string

Inlined content of the VsCode configuration

uri: string

Location as an absolute of relative URI the VsCode configuration will be fetched from

group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

vscodeTask: object

Command providing the definition of a VsCode Task

inlined: string

Inlined content of the VsCode configuration

uri: string

Location as an absolute of relative URI the VsCode configuration will be fetched from

group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

attributes: object

Map of implementation-dependant free-form YAML attributes.

id: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.

components: object[]

Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.

object
container: object

Allows adding and configuring workspace-related containers

args: string[]

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.

string
command: string[]

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.

string
dedicatedPod: boolean

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

endpoints: object[]
object
attributes: object

Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:

  • cookiesAuthEnabled: "true" / "false",
  • type: "terminal" / "ide" / "ide-dev",
exposure: string , x ∈ { public , internal , none }

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 workspace 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 workspace POD, on a local address.

Default value is public

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
path: string

Path of the endpoint URL

protocol: string , x ∈ { http , https , ws , wss , tcp , udp }

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

secure: boolean

Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https or wss.

targetPort: integer
env: object[]

Environment variables used in this container.

The following variables are reserved and cannot be overridden via env:

  • $PROJECTS_ROOT

  • $PROJECT_SOURCE

object
name: string
value: string
image: string
memoryLimit: string
mountSources: boolean

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.

sourceMapping: string

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.

volumeMounts: object[]

List of volumes mounts that should be mounted is this container.

object

Volume that should be mounted to a component container

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

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.

path: string

The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is /<name>.

kubernetes: object

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.

inlined: string

Inlined manifest

uri: string

Location in a file fetched from a uri.

endpoints: object[]
object
attributes: object

Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:

  • cookiesAuthEnabled: "true" / "false",
  • type: "terminal" / "ide" / "ide-dev",
exposure: string , x ∈ { public , internal , none }

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 workspace 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 workspace POD, on a local address.

Default value is public

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
path: string

Path of the endpoint URL

protocol: string , x ∈ { http , https , ws , wss , tcp , udp }

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

secure: boolean

Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https or wss.

targetPort: integer
openshift: object

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.

inlined: string

Inlined manifest

uri: string

Location in a file fetched from a uri.

endpoints: object[]
object
attributes: object

Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:

  • cookiesAuthEnabled: "true" / "false",
  • type: "terminal" / "ide" / "ide-dev",
exposure: string , x ∈ { public , internal , none }

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 workspace 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 workspace POD, on a local address.

Default value is public

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
path: string

Path of the endpoint URL

protocol: string , x ∈ { http , https , ws , wss , tcp , udp }

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

secure: boolean

Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https or wss.

targetPort: integer
volume: object

Allows specifying the definition of a volume shared by several other components

size: string

Size of the volume

attributes: object

Map of implementation-dependant free-form YAML attributes.

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

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.

registryUrl: string
volume: object

Allows specifying the definition of a volume shared by several other components

size: string

Size of the volume

attributes: object

Map of implementation-dependant free-form YAML attributes.

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

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.

events: object

Bindings of commands to events. Each command is referred-to by its name.

postStart: string[]

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.

string
postStop: string[]

IDs of commands that should be executed after stopping the workspace.

string
preStart: string[]

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.

string
preStop: string[]

IDs of commands that should be executed before stopping the workspace.

string
metadata: object

Optional metadata

attributes: object

Map of implementation-dependant free-form YAML attributes.

description: string

Optional devfile description

displayName: string

Optional devfile display name

globalMemoryLimit: string

Optional devfile global memory limit

icon: string

Optional devfile icon

name: string

Optional devfile name

tags: string[]

Optional devfile tags

string
version: string , must match ^([0-9]+)\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$

Optional semver-compatible version

parent: object

Parent workspace template

id: string

Id in a registry that contains a Devfile yaml file

kubernetes: object

Reference to a Kubernetes CRD of type DevWorkspaceTemplate

name: string
namespace: string
uri: string

Uri of a Devfile yaml file

commands: object[]

Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.

object
apply: object

Command that consists in applying a given component definition, typically bound to a workspace 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 workspace 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 workspace start by default.

component: string

Describes component that will be applied

group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

label: string

Optional label that provides a label for this command to be used in Editor UI menus for example

composite: object

Composite command that allows executing several sub-commands either sequentially or concurrently

commands: string[]

The commands that comprise this composite command

string
group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

label: string

Optional label that provides a label for this command to be used in Editor UI menus for example

parallel: boolean

Indicates if the sub-commands should be executed concurrently

exec: object

CLI Command executed in an existing component container

commandLine: string

The actual command-line string

Special variables that can be used:

  • $PROJECTS_ROOT: A path where projects sources are mounted as defined by container component's sourceMapping.

  • $PROJECT_SOURCE: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one.

component: string

Describes component to which given action relates

env: object[]

Optional list of environment variables that have to be set before running the command

object
name: string
value: string
group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

hotReloadCapable: boolean

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.

Default value is false

label: string

Optional label that provides a label for this command to be used in Editor UI menus for example

workingDir: string

Working directory where the command should be executed

Special variables that can be used:

  • $PROJECTS_ROOT: A path where projects sources are mounted as defined by container component's sourceMapping.

  • $PROJECT_SOURCE: A path to a project source ($PROJECTS_ROOT/). If there are multiple projects, this will point to the directory of the first one.

vscodeLaunch: object

Command providing the definition of a VsCode launch action

inlined: string

Inlined content of the VsCode configuration

uri: string

Location as an absolute of relative URI the VsCode configuration will be fetched from

group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

vscodeTask: object

Command providing the definition of a VsCode Task

inlined: string

Inlined content of the VsCode configuration

uri: string

Location as an absolute of relative URI the VsCode configuration will be fetched from

group: object

Defines the group this command is part of

isDefault: boolean

Identifies the default command for a given group kind

kind: string , x ∈ { build , run , test , debug }

Kind of group the command is part of

attributes: object

Map of implementation-dependant free-form YAML attributes.

id: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.

components: object[]

Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.

object
container: object

Allows adding and configuring workspace-related containers

args: string[]

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.

string
command: string[]

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.

string
dedicatedPod: boolean

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

endpoints: object[]
object
attributes: object

Map of implementation-dependant string-based free-form attributes.

Examples of Che-specific attributes:

  • cookiesAuthEnabled: "true" / "false",
  • type: "terminal" / "ide" / "ide-dev",
exposure: string , x ∈ { public , internal , none }

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 workspace 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 workspace POD, on a local address.

Default value is public

name: string (up to 63 chars) , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
path: string

Path of the endpoint URL

protocol: string , x ∈ { http , https , ws , wss , tcp , udp }

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

secure: boolean

Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https or wss.

targetPort: integer
env: object[]

Environment variables used in this container.

The following variables are reserved and cannot be overridden via env:

  • $PROJECTS_ROOT

  • $PROJECT_SOURCE

object
name: string
value: string
image: string
memoryLimit: string