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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
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])?$
+
+
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.
+
+
+
+
+
+
+
+
+
+
+
+ projects:
+
+ object[]
+
+
+
+
+
Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.
+
+
+
+
+
+ object
+
+
+
+
+
+
+
+
+ git:
+
+ object
+
+
+
+
+
Project's Git source
+
+
+
+
+
+
+ checkoutFrom:
+
+ object
+
+
+
+
+
Defines from what the project should be checked out. Required if there are more than one remote configured
+
+
+
+
+
+
+ remote:
+
+ string
+
+
+
+
+
The remote name should be used as init. Required if there are more than one remote configured
+
+
+
+
+
+
+ revision:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+
+
+
+
+ remotes:
+
+ object
+
+
+
+
+
The remotes map which should be initialized in the git project. Must have at least one remote configured
+
+
+
+
+
+
+
+
+
+
+
+ github:
+
+ object
+
+
+
+
+
Project's GitHub source
+
+
+
+
+
+
+ checkoutFrom:
+
+ object
+
+
+
+
+
Defines from what the project should be checked out. Required if there are more than one remote configured
+
+
+
+
+
+
+ remote:
+
+ string
+
+
+
+
+
The remote name should be used as init. Required if there are more than one remote configured
+
+
+
+
+
+
+ revision:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+
+
+
+
+ remotes:
+
+ object
+
+
+
+
+
The remotes map which should be initialized in the git project. Must have at least one remote configured
+
+
+
+
+
+
+
+
+
+
+
+ zip:
+
+ object
+
+
+
+
+
Project's Zip source
+
+
+
+
+
+
+ location:
+
+ string
+
+
+
+
+
Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attributes:
+
+ object
+
+
+
+
+
Map of implementation-dependant free-form YAML attributes.
+
+
+
+
+
+
+
+ clonePath:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+ name:
+
+ string
+
+
+
+ (up to 63 chars)
+
+ , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+
+
+
+
Project name
+
+
+
+
+
+
+ sparseCheckoutDirs:
+
+ string[]
+
+
+
+
+
Populate the project sparsely with selected directories.
+
+
+
+
+
+ string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ registryUrl:
+
+ string
+
+
+
+
+
+
+
+
+
+
+ starterProjects:
+
+ object[]
+
+
+
+
+
Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.
+
+
+
+
+
+ object
+
+
+
+
+
+
+
+
+ git:
+
+ object
+
+
+
+
+
Project's Git source
+
+
+
+
+
+
+ checkoutFrom:
+
+ object
+
+
+
+
+
Defines from what the project should be checked out. Required if there are more than one remote configured
+
+
+
+
+
+
+ remote:
+
+ string
+
+
+
+
+
The remote name should be used as init. Required if there are more than one remote configured
+
+
+
+
+
+
+ revision:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+
+
+
+
+ remotes:
+
+ object
+
+
+
+
+
The remotes map which should be initialized in the git project. Must have at least one remote configured
+
+
+
+
+
+
+
+
+
+
+
+ github:
+
+ object
+
+
+
+
+
Project's GitHub source
+
+
+
+
+
+
+ checkoutFrom:
+
+ object
+
+
+
+
+
Defines from what the project should be checked out. Required if there are more than one remote configured
+
+
+
+
+
+
+ remote:
+
+ string
+
+
+
+
+
The remote name should be used as init. Required if there are more than one remote configured
+
+
+
+
+
+
+ revision:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+
+
+
+
+ remotes:
+
+ object
+
+
+
+
+
The remotes map which should be initialized in the git project. Must have at least one remote configured
+
+
+
+
+
+
+
+
+
+
+
+ zip:
+
+ object
+
+
+
+
+
Project's Zip source
+
+
+
+
+
+
+ location:
+
+ string
+
+
+
+
+
Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attributes:
+
+ object
+
+
+
+
+
Map of implementation-dependant free-form YAML attributes.
+
+
+
+
+
+
+
+ description:
+
+ string
+
+
+
+
+
Description of a starter project
+
+
+
+
+
+
+ name:
+
+ string
+
+
+
+ (up to 63 chars)
+
+ , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+
+
+
+
Project name
+
+
+
+
+
+
+ subDir:
+
+ string
+
+
+
+
+
Sub-directory from a starter project to be used as root for starter project.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ projects:
+
+ object[]
+
+
+
+
+
Projects worked on in the workspace, containing names and sources locations
+
+
+
+
+
+ object
+
+
+
+
+
+
+
+
+ git:
+
+ object
+
+
+
+
+
Project's Git source
+
+
+
+
+
+
+ checkoutFrom:
+
+ object
+
+
+
+
+
Defines from what the project should be checked out. Required if there are more than one remote configured
+
+
+
+
+
+
+ remote:
+
+ string
+
+
+
+
+
The remote name should be used as init. Required if there are more than one remote configured
+
+
+
+
+
+
+ revision:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+
+
+
+
+ remotes:
+
+ object
+
+
+
+
+
+
The remotes map which should be initialized in the git project. Must have at least one remote configured
+
+
+
+
+
+
+
+
+
+
+
+ github:
+
+ object
+
+
+
+
+
Project's GitHub source
+
+
+
+
+
+
+ checkoutFrom:
+
+ object
+
+
+
+
+
Defines from what the project should be checked out. Required if there are more than one remote configured
+
+
+
+
+
+
+ remote:
+
+ string
+
+
+
+
+
The remote name should be used as init. Required if there are more than one remote configured
+
+
+
+
+
+
+ revision:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+
+
+
+
+ remotes:
+
+ object
+
+
+
+
+
+
The remotes map which should be initialized in the git project. Must have at least one remote configured
+
+
+
+
+
+
+
+
+
+
+
+ zip:
+
+ object
+
+
+
+
+
Project's Zip source
+
+
+
+
+
+
+ location:
+
+ string
+
+
+
+
+
Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attributes:
+
+ object
+
+
+
+
+
Map of implementation-dependant free-form YAML attributes.
+
+
+
+
+
+
+
+ clonePath:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+ name:
+
+ string
+
+
+
+ (up to 63 chars)
+
+ , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+
+
+
+
Project name
+
+
+
+
+
+
+ sparseCheckoutDirs:
+
+ string[]
+
+
+
+
+
Populate the project sparsely with selected directories.
+
+
+
+
+
+ string
+
+
+
+
+
+
+
+
+
+
+
+
+
+ schemaVersion:
+
+ string
+
+
+ , must match ^([2-9])\.([0-9]+)\.([0-9]+)(\-[0-9a-z-]+(\.[0-9a-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$
+
+
+
+
Devfile schema version
+
+
+
+
+
+
+ starterProjects:
+
+ object[]
+
+
+
+
+
StarterProjects is a project that can be used as a starting point when bootstrapping new projects
+
+
+
+
+
+ object
+
+
+
+
+
+
+
+
+ git:
+
+ object
+
+
+
+
+
Project's Git source
+
+
+
+
+
+
+ checkoutFrom:
+
+ object
+
+
+
+
+
Defines from what the project should be checked out. Required if there are more than one remote configured
+
+
+
+
+
+
+ remote:
+
+ string
+
+
+
+
+
The remote name should be used as init. Required if there are more than one remote configured
+
+
+
+
+
+
+ revision:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+
+
+
+
+ remotes:
+
+ object
+
+
+
+
+
+
The remotes map which should be initialized in the git project. Must have at least one remote configured
+
+
+
+
+
+
+
+
+
+
+
+ github:
+
+ object
+
+
+
+
+
Project's GitHub source
+
+
+
+
+
+
+ checkoutFrom:
+
+ object
+
+
+
+
+
Defines from what the project should be checked out. Required if there are more than one remote configured
+
+
+
+
+
+
+ remote:
+
+ string
+
+
+
+
+
The remote name should be used as init. Required if there are more than one remote configured
+
+
+
+
+
+
+ revision:
+
+ string
+
+
+
+
+
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.
+
+
+
+
+
+
+
+
+
+
+ remotes:
+
+ object
+
+
+
+
+
+
The remotes map which should be initialized in the git project. Must have at least one remote configured
+
+
+
+
+
+
+
+
+
+
+
+ zip:
+
+ object
+
+
+
+
+
Project's Zip source
+
+
+
+
+
+
+ location:
+
+ string
+
+
+
+
+
Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attributes:
+
+ object
+
+
+
+
+
Map of implementation-dependant free-form YAML attributes.
+
+
+
+
+
+
+
+ description:
+
+ string
+
+
+
+
+
Description of a starter project
+
+
+
+
+
+
+ name:
+
+ string
+
+
+
+ (up to 63 chars)
+
+ , must match ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
+
+
+
+
Project name
+
+
+
+
+
+
+ subDir:
+
+ string
+
+
+
+
+
Sub-directory from a starter project to be used as root for starter project.
`.\n@font-family-monospace: Menlo, Monaco, Consolas, \"Courier New\", monospace;\n@font-family-base: @font-family-sans-serif;\n\n@font-size-base: 14px;\n@font-size-large: ceil((@font-size-base * 1.25)); // ~18px\n@font-size-small: ceil((@font-size-base * .85)); // ~12px\n\n@font-size-h1: floor((@font-size-base * 2.6)); // ~36px\n@font-size-h2: floor((@font-size-base * 2.15)); // ~30px\n@font-size-h3: ceil((@font-size-base * 1.7)); // ~24px\n@font-size-h4: ceil((@font-size-base * 1.25)); // ~18px\n@font-size-h5: @font-size-base;\n@font-size-h6: ceil((@font-size-base * .85)); // ~12px\n\n//** Unit-less `line-height` for use in components like buttons.\n@line-height-base: 1.428571429; // 20/14\n//** Computed \"line-height\" (`font-size` * `line-height`) for use with `margin`, `padding`, etc.\n@line-height-computed: floor((@font-size-base * @line-height-base)); // ~20px\n\n//** By default, this inherits from the ``.\n@headings-font-family: inherit;\n@headings-font-weight: 500;\n@headings-line-height: 1.1;\n@headings-color: inherit;\n\n\n//== Iconography\n//\n//## Specify custom location and filename of the included Glyphicons icon font. Useful for those including Bootstrap via Bower.\n\n//** Load fonts from this directory.\n@icon-font-path: \"../fonts/\";\n//** File name for all font files.\n@icon-font-name: \"glyphicons-halflings-regular\";\n//** Element ID within SVG icon file.\n@icon-font-svg-id: \"glyphicons_halflingsregular\";\n\n\n//== Components\n//\n//## Define common padding and border radius sizes and more. Values based on 14px text and 1.428 line-height (~20px to start).\n\n@padding-base-vertical: 6px;\n@padding-base-horizontal: 12px;\n\n@padding-large-vertical: 10px;\n@padding-large-horizontal: 16px;\n\n@padding-small-vertical: 5px;\n@padding-small-horizontal: 10px;\n\n@padding-xs-vertical: 1px;\n@padding-xs-horizontal: 5px;\n\n@line-height-large: 1.3333333; // extra decimals for Win 8.1 Chrome\n@line-height-small: 1.5;\n\n@border-radius-base: 4px;\n@border-radius-large: 6px;\n@border-radius-small: 3px;\n\n//** Global color for active items (e.g., navs or dropdowns).\n@component-active-color: #fff;\n//** Global background color for active items (e.g., navs or dropdowns).\n@component-active-bg: @brand-primary;\n\n//** Width of the `border` for generating carets that indicate dropdowns.\n@caret-width-base: 4px;\n//** Carets increase slightly in size for larger components.\n@caret-width-large: 5px;\n\n\n//== Tables\n//\n//## Customizes the `.table` component with basic values, each used across all table variations.\n\n//** Padding for `
`s and `
`s.\n@table-cell-padding: 8px;\n//** Padding for cells in `.table-condensed`.\n@table-condensed-cell-padding: 5px;\n\n//** Default background color used for all tables.\n@table-bg: transparent;\n//** Background color used for `.table-striped`.\n@table-bg-accent: #f9f9f9;\n//** Background color used for `.table-hover`.\n@table-bg-hover: #f5f5f5;\n@table-bg-active: @table-bg-hover;\n\n//** Border color for table and cell borders.\n@table-border-color: #ddd;\n\n\n//== Buttons\n//\n//## For each of Bootstrap's buttons, define text, background and border color.\n\n@btn-font-weight: normal;\n\n@btn-default-color: #333;\n@btn-default-bg: #fff;\n@btn-default-border: #ccc;\n\n@btn-primary-color: #fff;\n@btn-primary-bg: @brand-primary;\n@btn-primary-border: darken(@btn-primary-bg, 5%);\n\n@btn-success-color: #fff;\n@btn-success-bg: @brand-success;\n@btn-success-border: darken(@btn-success-bg, 5%);\n\n@btn-info-color: #fff;\n@btn-info-bg: @brand-info;\n@btn-info-border: darken(@btn-info-bg, 5%);\n\n@btn-warning-color: #fff;\n@btn-warning-bg: @brand-warning;\n@btn-warning-border: darken(@btn-warning-bg, 5%);\n\n@btn-danger-color: #fff;\n@btn-danger-bg: @brand-danger;\n@btn-danger-border: darken(@btn-danger-bg, 5%);\n\n@btn-link-disabled-color: @gray-light;\n\n// Allows for customizing button radius independently from global border radius\n@btn-border-radius-base: @border-radius-base;\n@btn-border-radius-large: @border-radius-large;\n@btn-border-radius-small: @border-radius-small;\n\n\n//== Forms\n//\n//##\n\n//** `` background color\n@input-bg: #fff;\n//** `` background color\n@input-bg-disabled: @gray-lighter;\n\n//** Text color for ``s\n@input-color: @gray;\n//** `` border color\n@input-border: #ccc;\n\n// TODO: Rename `@input-border-radius` to `@input-border-radius-base` in v4\n//** Default `.form-control` border radius\n// This has no effect on `