Devfile describes the structure of a cloud-native devworkspace and development environment.
Map of implementation-dependant free-form YAML attributes.
Predefined, ready-to-use, devworkspace-related commands
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.
Describes component that will be applied
Defines the group this command is part of
Identifies the default command for a given group kind
Kind of group the command is part of
Optional label that provides a label for this command to be used in Editor UI menus for example
Composite command that allows executing several sub-commands either sequentially or concurrently
The commands that comprise this composite command
Defines the group this command is part of
Identifies the default command for a given group kind
Kind of group the command is part of
Optional label that provides a label for this command to be used in Editor UI menus for example
Indicates if the sub-commands should be executed concurrently
CLI Command executed in an existing component container
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/
Describes component to which given action relates
Optional list of environment variables that have to be set before running the command
Defines the group this command is part of
Identifies the default command for a given group kind
Kind of group the command is part of
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
Optional label that provides a label for this command to be used in Editor UI menus for example
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/
Map of implementation-dependant free-form YAML attributes.
Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.
List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components
Allows adding and configuring devworkspace-related containers
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.
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.
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
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
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
Path of the endpoint URL
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
Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https
or wss
.
Environment variables used in this container.
The following variables are reserved and cannot be overridden via env:
$PROJECTS_ROOT
$PROJECT_SOURCE
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.
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.
List of volumes mounts that should be mounted is this container.
Volume that should be mounted to a component container
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.
The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is /<name>
.
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.
Inlined manifest
Location in a file fetched from a uri.
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
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
Path of the endpoint URL
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
Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https
or wss
.
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.
Inlined manifest
Location in a file fetched from a uri.
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
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
Path of the endpoint URL
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
Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https
or wss
.
Allows specifying the definition of a volume shared by several other components
Ephemeral volumes are not stored persistently across restarts. Defaults to false
Size of the volume
Map of implementation-dependant free-form YAML attributes.
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.
Bindings of commands to events. Each command is referred-to by its name.
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.
IDs of commands that should be executed after stopping the devworkspace.
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.
IDs of commands that should be executed before stopping the devworkspace.
Optional metadata
Map of implementation-dependant free-form YAML attributes. Deprecated, use the top-level attributes field instead.
Optional devfile description
Optional devfile display name
Optional devfile global memory limit
Optional devfile icon, can be a URI or a relative path in the project
Optional devfile language
Optional devfile name
Optional devfile project type
Optional devfile tags
Optional semver-compatible version
Optional devfile website
Parent devworkspace template
Id in a registry that contains a Devfile yaml file
Reference to a Kubernetes CRD of type DevWorkspaceTemplate
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.
Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.
Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.
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.
Describes component that will be applied
Defines the group this command is part of
Identifies the default command for a given group kind
Kind of group the command is part of
Optional label that provides a label for this command to be used in Editor UI menus for example
Composite command that allows executing several sub-commands either sequentially or concurrently
The commands that comprise this composite command
Defines the group this command is part of
Identifies the default command for a given group kind
Kind of group the command is part of
Optional label that provides a label for this command to be used in Editor UI menus for example
Indicates if the sub-commands should be executed concurrently
CLI Command executed in an existing component container
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/
Describes component to which given action relates
Optional list of environment variables that have to be set before running the command
Defines the group this command is part of
Identifies the default command for a given group kind
Kind of group the command is part of
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
Optional label that provides a label for this command to be used in Editor UI menus for example
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/
Map of implementation-dependant free-form YAML attributes.
Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.
Overrides of components encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules.
Allows adding and configuring devworkspace-related containers
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.
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.
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
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
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
Path of the endpoint URL
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
Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https
or wss
.
Environment variables used in this container.
The following variables are reserved and cannot be overridden via env:
$PROJECTS_ROOT
$PROJECT_SOURCE
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.
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.
List of volumes mounts that should be mounted is this container.
Volume that should be mounted to a component container
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.
The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is /<name>
.
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.
Inlined manifest
Location in a file fetched from a uri.
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
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
Path of the endpoint URL
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
Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https
or wss
.
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.
Inlined manifest
Location in a file fetched from a uri.
Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
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
Path of the endpoint URL
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
Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of https
or wss
.
Allows specifying the definition of a volume shared by several other components
Ephemeral volumes are not stored persistently across restarts. Defaults to false
Size of the volume
Map of implementation-dependant free-form YAML attributes.
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.
Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.
Project's Git source
Defines from what the project should be checked out. Required if there are more than one remote configured
The remote name should be used as init. Required if there are more than one remote configured
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.
The remotes map which should be initialized in the git project. Must have at least one remote configured
Project's Zip source
Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH
Map of implementation-dependant free-form YAML attributes.
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.
Project name
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 regsitryURL
when Id
is used.
Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.
Project's Git source
Defines from what the project should be checked out. Required if there are more than one remote configured
The remote name should be used as init. Required if there are more than one remote configured
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.
The remotes map which should be initialized in the git project. Must have at least one remote configured
Project's Zip source
Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH
Map of implementation-dependant free-form YAML attributes.
Description of a starter project
Project name
Sub-directory from a starter project to be used as root for starter project.
Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.
Projects worked on in the devworkspace, containing names and sources locations
Project's Git source
Defines from what the project should be checked out. Required if there are more than one remote configured
The remote name should be used as init. Required if there are more than one remote configured
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.
The remotes map which should be initialized in the git project. Must have at least one remote configured
Project's Zip source
Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH
Map of implementation-dependant free-form YAML attributes.
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.
Project name
Devfile schema version
StarterProjects is a project that can be used as a starting point when bootstrapping new projects
Project's Git source
Defines from what the project should be checked out. Required if there are more than one remote configured
The remote name should be used as init. Required if there are more than one remote configured
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.
The remotes map which should be initialized in the git project. Must have at least one remote configured
Project's Zip source
Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH
Map of implementation-dependant free-form YAML attributes.
Description of a starter project
Project name
Sub-directory from a starter project to be used as root for starter project.
Map of key-value variables used for string replacement in the devfile. Values can can be referenced via {{variable-key}} to replace the corresponding value in string fields in the devfile. Replacement cannot be used for