schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
devfile.json | args | 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. | {"type": "array", "items": {"type": "string"}} |
devfile.json | command | 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. | {"type": "array", "items": {"type": "string"}} |
devfile.json | dedicatedPod | 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` | {"type": "boolean"} |
devfile.json | annotation | Annotations to be added to Kubernetes Ingress or Openshift Route | {"type": "object", "additionalProperties": {"type": "string"}} |
devfile.json | attributes | Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev", | {"type": "object", "additionalProperties": true} |
devfile.json | exposure | 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` | {"type": "string", "default": "public", "enum": ["public", "internal", "none"]} |
devfile.json | path | Path of the endpoint URL | {"type": "string"} |
devfile.json | protocol | 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` | {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]} |
devfile.json | secure | Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`. | {"type": "boolean"} |
devfile.json | targetPort | Port number to be used within the container component. The same port cannot be used by two different container components. | {"type": "integer"} |
devfile.json | env | Environment variables used in this container.
The following variables are reserved and cannot be overridden via env:
- `$PROJECTS_ROOT`
- `$PROJECT_SOURCE` | {"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}} |
devfile.json | mountSources | 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. | {"type": "boolean"} |
devfile.json | sourceMapping | 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. | {"type": "string", "default": "/projects"} |
devfile.json | volumeMounts | List of volumes mounts that should be mounted is this container. | {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}}, "additionalProperties": false}} |
devfile.json | items | Volume that should be mounted to a component container | {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}}, "additionalProperties": false} |
devfile.json | name | 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. | {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"} |
devfile.json | path | The path in the component container where the volume should be mounted. If not path is mentioned, default path is the is `/<name>`. | {"type": "string"} |
devfile.json | image | Allows specifying the definition of an image for outer loop builds | {"type": "object", "required": ["imageName"], "oneOf": [{"required": ["dockerfile"]}], "properties": {"autoBuild": {"type": "boolean"}, "dockerfile": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["devfileRegistry"]}, {"required": ["git"]}], "properties": {"args": {"type": "array", "items": {"type": "string"}}, "buildContext": {"type": "string"}, "devfileRegistry": {"type": "object", "required": ["id"], "properties": {"id": {"type": "string"}, "registryUrl": {"type": "string"}}, "additionalProperties": false}, "git": {"type": "object", "required": ["remotes"], "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "fileLocation": {"type": "string"}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "rootRequired": {"type": "boolean"}, "uri": {"type": "string"}}, "additionalProperties": false}, "imageName": {"type": "string"}}, "additionalProperties": false} |
devfile.json | autoBuild | Defines if the image should be built during startup.
Default value is `false` | {"type": "boolean"} |
devfile.json | dockerfile | Allows specifying dockerfile type build | {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["devfileRegistry"]}, {"required": ["git"]}], "properties": {"args": {"type": "array", "items": {"type": "string"}}, "buildContext": {"type": "string"}, "devfileRegistry": {"type": "object", "required": ["id"], "properties": {"id": {"type": "string"}, "registryUrl": {"type": "string"}}, "additionalProperties": false}, "git": {"type": "object", "required": ["remotes"], "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "fileLocation": {"type": "string"}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "rootRequired": {"type": "boolean"}, "uri": {"type": "string"}}, "additionalProperties": false} |
devfile.json | args | The arguments to supply to the dockerfile build. | {"type": "array", "items": {"type": "string"}} |
devfile.json | buildContext | Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container | {"type": "string"} |
devfile.json | devfileRegistry | Dockerfile's Devfile Registry source | {"type": "object", "required": ["id"], "properties": {"id": {"type": "string"}, "registryUrl": {"type": "string"}}, "additionalProperties": false} |
devfile.json | id | Id in a devfile registry that contains a Dockerfile. The src in the OCI registry required for the Dockerfile build will be downloaded for building the image. | {"type": "string"} |
devfile.json | registryUrl | Devfile Registry URL to pull the Dockerfile from when using the Devfile Registry as Dockerfile src. To ensure the Dockerfile gets resolved consistently in different environments, it is recommended to always specify the `devfileRegistryUrl` when `Id` is used. | {"type": "string"} |
devfile.json | git | Dockerfile's Git source | {"type": "object", "required": ["remotes"], "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "fileLocation": {"type": "string"}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false} |
devfile.json | checkoutFrom | Defines from what the project should be checked out. Required if there are more than one remote configured | {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false} |
devfile.json | remote | The remote name should be used as init. Required if there are more than one remote configured | {"type": "string"} |
devfile.json | revision | 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. | {"type": "string"} |
devfile.json | fileLocation | Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile. | {"type": "string"} |
devfile.json | remotes | The remotes map which should be initialized in the git project. Projects must have at least one remote configured while StarterProjects & Image Component's Git source can only have at most one remote configured. | {"type": "object", "additionalProperties": {"type": "string"}} |
devfile.json | rootRequired | Specify if a privileged builder pod is required.
Default value is `false` | {"type": "boolean"} |
devfile.json | uri | URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI. | {"type": "string"} |
devfile.json | imageName | Name of the image for the resulting outerloop build | {"type": "string"} |
devfile.json | kubernetes | 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. | {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name", "targetPort"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "default": "public", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false} |
devfile.json | deployByDefault | Defines if the component should be deployed during startup.
Default value is `false` | {"type": "boolean"} |
devfile.json | annotation | Annotations to be added to Kubernetes Ingress or Openshift Route | {"type": "object", "additionalProperties": {"type": "string"}} |
devfile.json | attributes | Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev", | {"type": "object", "additionalProperties": true} |
devfile.json | exposure | 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` | {"type": "string", "default": "public", "enum": ["public", "internal", "none"]} |
devfile.json | path | Path of the endpoint URL | {"type": "string"} |
devfile.json | protocol | 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` | {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]} |
devfile.json | secure | Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`. | {"type": "boolean"} |
devfile.json | targetPort | Port number to be used within the container component. The same port cannot be used by two different container components. | {"type": "integer"} |
devfile.json | inlined | Inlined manifest | {"type": "string"} |
devfile.json | uri | Location in a file fetched from a uri. | {"type": "string"} |
devfile.json | name | 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. | {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"} |
devfile.json | openshift | 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. | {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name", "targetPort"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "default": "public", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false} |
devfile.json | deployByDefault | Defines if the component should be deployed during startup.
Default value is `false` | {"type": "boolean"} |
devfile.json | annotation | Annotations to be added to Kubernetes Ingress or Openshift Route | {"type": "object", "additionalProperties": {"type": "string"}} |
devfile.json | attributes | Map of implementation-dependant string-based free-form attributes.
Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev", | {"type": "object", "additionalProperties": true} |
devfile.json | exposure | 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` | {"type": "string", "default": "public", "enum": ["public", "internal", "none"]} |
devfile.json | path | Path of the endpoint URL | {"type": "string"} |
devfile.json | protocol | 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` | {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]} |
devfile.json | secure | Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`. | {"type": "boolean"} |
devfile.json | targetPort | Port number to be used within the container component. The same port cannot be used by two different container components. | {"type": "integer"} |
devfile.json | inlined | Inlined manifest | {"type": "string"} |
devfile.json | uri | Location in a file fetched from a uri. | {"type": "string"} |
devfile.json | volume | Allows specifying the definition of a volume shared by several other components | {"type": "object", "properties": {"ephemeral": {"type": "boolean"}, "size": {"type": "string"}}, "additionalProperties": false} |
devfile.json | ephemeral | Ephemeral volumes are not stored persistently across restarts. Defaults to false | {"type": "boolean"} |
devfile.json | size | Size of the volume | {"type": "string"} |
devfile.json | events | Bindings of commands to events. Each command is referred-to by its name. | {"type": "object", "properties": {"postStart": {"type": "array", "items": {"type": "string"}}, "postStop": {"type": "array", "items": {"type": "string"}}, "preStart": {"type": "array", "items": {"type": "string"}}, "preStop": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false} |
devfile.json | postStart | 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. | {"type": "array", "items": {"type": "string"}} |
devfile.json | postStop | IDs of commands that should be executed after stopping the devworkspace. | {"type": "array", "items": {"type": "string"}} |
devfile.json | preStart | 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. | {"type": "array", "items": {"type": "string"}} |
devfile.json | preStop | IDs of commands that should be executed before stopping the devworkspace. | {"type": "array", "items": {"type": "string"}} |
devfile.json | metadata | Optional metadata | {"type": "object", "properties": {"architectures": {"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["amd64", "arm64", "ppc64le", "s390x"]}}, "attributes": {"type": "object", "additionalProperties": true}, "displayName": {"type": "string"}, "globalMemoryLimit": {"type": "string"}, "icon": {"type": "string"}, "language": {"type": "string"}, "name": {"type": "string"}, "projectType": {"type": "string"}, "provider": {"type": "string"}, "supportUrl": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}, "version": {"type": "string", "pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"}, "website": {"type": "string"}}, "additionalProperties": true} |
devfile.json | architectures | Optional list of processor architectures that the devfile supports, empty list suggests that the devfile can be used on any architecture | {"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["amd64", "arm64", "ppc64le", "s390x"]}} |
devfile.json | items | Architecture describes the architecture type | {"type": "string", "enum": ["amd64", "arm64", "ppc64le", "s390x"]} |
devfile.json | attributes | Map of implementation-dependant free-form YAML attributes. Deprecated, use the top-level attributes field instead. | {"type": "object", "additionalProperties": true} |
devfile.json | description | Optional devfile description | {"type": "string"} |
devfile.json | displayName | Optional devfile display name | {"type": "string"} |
devfile.json | globalMemoryLimit | Optional devfile global memory limit | {"type": "string"} |
devfile.json | icon | Optional devfile icon, can be a URI or a relative path in the project | {"type": "string"} |
devfile.json | language | Optional devfile language | {"type": "string"} |
devfile.json | name | Optional devfile name | {"type": "string"} |
devfile.json | projectType | Optional devfile project type | {"type": "string"} |
devfile.json | provider | Optional devfile provider information | {"type": "string"} |
devfile.json | supportUrl | Optional link to a page that provides support information | {"type": "string"} |
devfile.json | tags | Optional devfile tags | {"type": "array", "items": {"type": "string"}} |
devfile.json | version | Optional semver-compatible version | {"type": "string", "pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"} |
devfile.json | website | Optional devfile website | {"type": "string"} |
devfile.json | parent | Parent devworkspace template | {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["id"]}, {"required": ["kubernetes"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "commands": {"type": "array", "items": {"type": "object", "required": ["id"], "oneOf": [{"required": ["exec"]}, {"required": ["apply"]}, {"required": ["composite"]}], "properties": {"apply": {"type": "object", "properties": {"component": {"type": "string"}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}}, "additionalProperties": false}, "attributes": {"type": "object", "additionalProperties": true}, "composite": {"type": "object", "properties": {"commands": {"type": "array", "items": {"type": "string"}}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}, "parallel": {"type": "boolean"}}, "additionalProperties": false}, "exec": {"type": "object", "properties": {"commandLine": {"type": "string"}, "component": {"type": "string"}, "env": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "hotReloadCapable": {"type": "boolean"}, "label": {"type": "string"}, "workingDir": {"type": "string"}}, "additionalProperties": false}, "id": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}}, "additionalProperties": false}}, "components": {"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["container"]}, {"required": ["kubernetes"]}, {"required": ["openshift"]}, {"required": ["volume"]}, {"required": ["image"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "container": {"type": "object", "properties": {"annotation": {"type": "object", "properties": {"deployment": {"type": "object", "additionalProperties": {"type": "string"}}, "service": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "args": {"type": "array", "items": {"type": "string"}}, "command": {"type": "array", "items": {"type": "string"}}, "cpuLimit": {"type": "string"}, "cpuRequest": {"type": "string"}, "dedicatedPod": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "env": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "image": {"type": "string"}, "memoryLimit": {"type": "string"}, "memoryRequest": {"type": "string"}, "mountSources": {"type": "boolean"}, "sourceMapping": {"type": "string"}, "volumeMounts": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}}, "additionalProperties": false}}}, "additionalProperties": false}, "image": {"type": "object", "oneOf": [{"required": ["dockerfile"]}, {"required": ["autoBuild"]}], "properties": {"autoBuild": {"type": "boolean"}, "dockerfile": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["devfileRegistry"]}, {"required": ["git"]}], "properties": {"args": {"type": "array", "items": {"type": "string"}}, "buildContext": {"type": "string"}, "devfileRegistry": {"type": "object", "properties": {"id": {"type": "string"}, "registryUrl": {"type": "string"}}, "additionalProperties": false}, "git": {"type": "object", "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "fileLocation": {"type": "string"}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "rootRequired": {"type": "boolean"}, "uri": {"type": "string"}}, "additionalProperties": false}, "imageName": {"type": "string"}}, "additionalProperties": false}, "kubernetes": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "openshift": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false}, "volume": {"type": "object", "properties": {"ephemeral": {"type": "boolean"}, "size": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "id": {"type": "string"}, "kubernetes": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "namespace": {"type": "string"}}, "additionalProperties": false}, "projects": {"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["git"]}, {"required": ["zip"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "clonePath": {"type": "string"}, "git": {"type": "object", "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "zip": {"type": "object", "properties": {"location": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "registryUrl": {"type": "string"}, "starterProjects": {"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["git"]}, {"required": ["zip"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "git": {"type": "object", "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "subDir": {"type": "string"}, "zip": {"type": "object", "properties": {"location": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "uri": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {"type": "string"}}, "version": {"type": "string", "pattern": "^(latest)|(([1-9])\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?)$"}}, "additionalProperties": false} |
devfile.json | attributes | Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules. | {"type": "object", "additionalProperties": true} |
devfile.json | commands | Overrides of commands encapsulated in a parent devfile or a plugin. Overriding is done according to K8S strategic merge patch standard rules. | {"type": "array", "items": {"type": "object", "required": ["id"], "oneOf": [{"required": ["exec"]}, {"required": ["apply"]}, {"required": ["composite"]}], "properties": {"apply": {"type": "object", "properties": {"component": {"type": "string"}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}}, "additionalProperties": false}, "attributes": {"type": "object", "additionalProperties": true}, "composite": {"type": "object", "properties": {"commands": {"type": "array", "items": {"type": "string"}}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}, "parallel": {"type": "boolean"}}, "additionalProperties": false}, "exec": {"type": "object", "properties": {"commandLine": {"type": "string"}, "component": {"type": "string"}, "env": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "hotReloadCapable": {"type": "boolean"}, "label": {"type": "string"}, "workingDir": {"type": "string"}}, "additionalProperties": false}, "id": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}}, "additionalProperties": false}} |
devfile.json | apply | 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, unless `deployByDefault` for that component is set to false. | {"type": "object", "properties": {"component": {"type": "string"}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}}, "additionalProperties": false} |
devfile.json | component | Describes component that will be applied | {"type": "string"} |
devfile.json | group | Defines the group this command is part of | {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false} |
devfile.json | isDefault | Identifies the default command for a given group kind | {"type": "boolean"} |
devfile.json | kind | Kind of group the command is part of | {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]} |
devfile.json | label | Optional label that provides a label for this command to be used in Editor UI menus for example | {"type": "string"} |
devfile.json | attributes | Map of implementation-dependant free-form YAML attributes. | {"type": "object", "additionalProperties": true} |
devfile.json | composite | Composite command that allows executing several sub-commands either sequentially or concurrently | {"type": "object", "properties": {"commands": {"type": "array", "items": {"type": "string"}}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}, "parallel": {"type": "boolean"}}, "additionalProperties": false} |
devfile.json | commands | The commands that comprise this composite command | {"type": "array", "items": {"type": "string"}} |
devfile.json | group | Defines the group this command is part of | {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false} |
devfile.json | isDefault | Identifies the default command for a given group kind | {"type": "boolean"} |
devfile.json | kind | Kind of group the command is part of | {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]} |
devfile.json | label | Optional label that provides a label for this command to be used in Editor UI menus for example | {"type": "string"} |
devfile.json | parallel | Indicates if the sub-commands should be executed concurrently | {"type": "boolean"} |
devfile.json | exec | CLI Command executed in an existing component container | {"type": "object", "properties": {"commandLine": {"type": "string"}, "component": {"type": "string"}, "env": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "hotReloadCapable": {"type": "boolean"}, "label": {"type": "string"}, "workingDir": {"type": "string"}}, "additionalProperties": false} |
devfile.json | commandLine | 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/<project-name>). If there are multiple projects, this will point to the directory of the first one. | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.