[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"title":"dependencies","type":"object","$schema":"http://json-schema.org/draft-07/schema#","properties":{"packages":{"type":"array","items":{"anyOf":[{"type":"object","required":["package","version"],"properties":{"version":{"title":"Package version","description":"A semantic version string or range, such as [\">=1.0.0\", \"<2.0.0\"]","type":["array","number","string"]},"install-prerelease":{"title":"Install Prerelease","description":"Opt in to prerelease versions of a package","type":"boolean"},"package":{"title":"Package identifier","description":"Must be in format `org_name/package_name`. Refer to hub.getdbt.com for installation instructions","type":"string","examples":["dbt-labs/dbt_utils"],"pattern":"^[\\w\\-\\.]+/[\\w\\-\\.]+$"}},"additionalProperties":false},{"type":"object","required":["private"],"properties":{"private":{"title":"Package identifier","description":"Must be in format `org_name/package_name`. Refer to docs.getdbt.com for installation instructions","type":"string","examples":["dbt-labs/private_dbt_utils"],"pattern":"^[\\w\\-\\.]+/[\\w\\-\\.]+$"},"revision":{"title":"Revision","description":"Pin your package to a specific release by specifying a release name","type":"string"},"subdirectory":{"title":"Repo subdirectory","description":"Subdirectory of the repo where the dbt package is located","type":"string"}},"additionalProperties":false},{"type":"object","required":["git"],"properties":{"git":{"title":"Git URL","type":"string"},"revision":{"title":"Revision","description":"Pin your package to a specific release by specifying a release name","type":"string"},"subdirectory":{"title":"Subdirectory","description":"Only required if the package is nested in a subdirectory of the git project","type":"string"}},"additionalProperties":false},{"type":"object","required":["name","tarball"],"properties":{"name":{"description":"dbt will create a subdirectory in your `packages-install-path` with this name, and the tarball's source code will be installed here.","type":"string"},"tarball":{"title":"Internally-hosted tarball URL","type":"string"}},"additionalProperties":false},{"type":"object","properties":{"local":{"type":"string"}},"additionalProperties":false}]},"minItems":1},"projects":{"type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"}},"additionalProperties":false}}},"additionalProperties":false}
</schema>

[User] Provide a JSON object that satisfies the schema "dependencies". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

dependencies

Package version

A semantic version string or range, such as [">=1.0.0", "<2.0.0"]

Install Prerelease

Opt in to prerelease versions of a package

Package identifier

Must be in format `org_name/package_name`. Refer to hub.getdbt.com for installation instructions

Package identifier

Must be in format `org_name/package_name`. Refer to docs.getdbt.com for installation instructions

Revision

Pin your package to a specific release by specifying a release name

Repo subdirectory

Subdirectory of the repo where the dbt package is located

Git URL

Revision

Subdirectory

Only required if the package is nested in a subdirectory of the git project

dbt will create a subdirectory in your `packages-install-path` with this name, and the tarball's source code will be installed here.

Internally-hosted tarball URL

Provide a JSON object that satisfies the schema "dependencies". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"http://json-schema.org/draft-07/schema#","$id":"https://json.schemastore.org/deployed.json","additionalProperties":false,"definitions":{"privateKey":{"description":"Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format).","type":["string","object"]},"passphrase":{"description":"For an encrypted privateKey, this is the passphrase used to decrypt it.","type":"string","minLength":1},"script":{"description":"Execute script commands.","type":"string","minLength":1},"backupName":{"description":"Old version backup name.","type":"string","minLength":1},"removeLocalDir":{"description":"Delete localpath after deployment.","type":"boolean"},"clearRemoteDir":{"description":"Empty the old version before deploying the new version.","type":"boolean"}},"description":"JSON schema for the deployed cli config file. \n\nSee also: https://hyhello.github.io/deployed\n\n","properties":{"$schema":{"description":"JSON Schema for deployed.","type":"string","minLength":1},"projectName":{"description":"Name of project to be released.","type":"string","minLength":1},"cluster":{"type":"array","uniqueItems":true,"description":"Alias collection of environment to be deployed.","items":{"type":"string"}},"privateKey":{"$ref":"#/definitions/privateKey"},"passphrase":{"$ref":"#/definitions/passphrase"},"script":{"$ref":"#/definitions/script"},"backupName":{"$ref":"#/definitions/backupName"},"removeLocalDir":{"$ref":"#/definitions/removeLocalDir"},"clearRemoteDir":{"$ref":"#/definitions/clearRemoteDir"},"modeList":{"type":"array","minItems":1,"uniqueItems":true,"items":{"type":"object","required":["mode","name","host","port","username","localPath","remotePath"],"additionalProperties":false,"properties":{"mode":{"description":"Deployment environment alias.","type":"string","minLength":1},"name":{"description":"Deployment environment name.","type":"string","minLength":1},"host":{"description":"Hostname or IP address of the server.","type":"string","minLength":1},"port":{"description":"Port number of the server.","type":"integer","minimum":1},"username":{"description":"Username for authentication.","type":"string","minLength":1},"password":{"description":"Password for password-based user authentication.","type":"string","minLength":1},"remotePath":{"description":"Deployment path.","type":"string","minLength":2},"localPath":{"description":"Local upload path.","type":"string","minLength":1},"backupPath":{"description":"Backup path.","type":"string","minLength":2},"privateKey":{"$ref":"#/definitions/privateKey"},"passphrase":{"$ref":"#/definitions/passphrase"},"script":{"$ref":"#/definitions/script"},"backupName":{"$ref":"#/definitions/backupName"},"removeLocalDir":{"$ref":"#/definitions/removeLocalDir"},"clearRemoteDir":{"$ref":"#/definitions/clearRemoteDir"}}}},"plugin":{"description":"List of plugins to load and use.","type":"array","uniqueItems":true,"items":{"type":["string","array"],"items":[{"description":"The name of the plugin.","type":"string"},{"description":"The options of the plugin.","type":"object"}]}}},"required":["projectName","modeList"],"title":"deployed cli","type":"object"}
</schema>

[User] Provide a JSON object that satisfies the schema "deployed cli". Here are the required top‑level fields: projectName, modeList. Return only the valid JSON object.

Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format).

For an encrypted privateKey, this is the passphrase used to decrypt it.

Execute script commands.

Old version backup name.

Delete localpath after deployment.

Empty the old version before deploying the new version.

JSON schema for the deployed cli config file.

See also: https://hyhello.github.io/deployed

JSON Schema for deployed.

Name of project to be released.

Alias collection of environment to be deployed.

mode name host port username localPath remotePath

Deployment environment alias.

Deployment environment name.

Hostname or IP address of the server.

Port number of the server.

Username for authentication.

Password for password-based user authentication.

Deployment path.

Local upload path.

Backup path.

List of plugins to load and use.

The name of the plugin.

The options of the plugin.

deployed cli

Provide a JSON object that satisfies the schema "deployed cli". Here are the required top‑level fields: projectName, modeList. Return only the valid JSON object.


[User] Provide a JSON object that satisfies the schema "detekt-1.22.0". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

Provide a JSON object that satisfies the schema "detekt-1.22.0". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"allOf":[{"$ref":"./devContainer.base.schema.json"},{"$ref":"https://raw.githubusercontent.com/microsoft/vscode/main/extensions/configuration-editing/schemas/devContainer.codespaces.schema.json"},{"$ref":"https://raw.githubusercontent.com/microsoft/vscode/main/extensions/configuration-editing/schemas/devContainer.vscode.schema.json"}]}
</schema>

[User] Provide a JSON object that satisfies the schema "devContainer.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

Provide a JSON object that satisfies the schema "devContainer.schema". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"https://json-schema.org/draft-04/schema#","$id":"https://github.com/jetify-com/devbox/plugins","title":"Devbox Plugin Schema","description":"Defines fields and values for public devbox plugins","type":"object","properties":{"$schema":{"description":"The schema version of this plugin file.","type":"string"},"name":{"description":"The name of the plugin.","type":"string"},"version":{"description":"The version of the plugin.","type":"string"},"description":{"description":"A short description of the plugin and how it works. This will automatically display when the user first installs the plugin, or runs `devbox info`","type":"string"},"packages":{"description":"Collection of packages to install","oneOf":[{"type":"array","items":{"description":"Name and version of each package in name@version format.","type":"string"}},{"type":"object","description":"Name of each package in {\"name\": {\"version\": \"1.2.3\"}} format.","patternProperties":{".*":{"oneOf":[{"type":"object","description":"Version number of the specified package in {\"version\": \"1.2.3\"} format.","properties":{"version":{"type":"string","description":"Version of the package"},"platforms":{"type":"array","description":"Names of platforms to install the package on. This package will be skipped for any platforms not on this list","items":{"enum":["i686-linux","aarch64-linux","aarch64-darwin","x86_64-darwin","x86_64-linux","armv7l-linux"]}},"excluded_platforms":{"type":"array","description":"Names of platforms to exclude the package on","items":{"enum":["i686-linux","aarch64-linux","aarch64-darwin","x86_64-darwin","x86_64-linux","armv7l-linux"]}},"glibc_patch":{"type":"boolean","description":"Whether to patch glibc to the latest available version for this package"}}},{"type":"string","description":"Version of the package to install."}]}}}]},"env":{"type":"object","description":"List of additional environment variables to be set in the Devbox environment. These can be overridden by environment variables set in the user's devbox.json","patternProperties":{".*":{"type":"string","description":"Value of the environment variable."}}},"create_files":{"type":"object","description":"List of files to create in the user's project directory when the plugin is activated. The key points to the file path where the file will be created. The value points to the default file that should be copied to that location","patternProperties":{".*":{"type":"string","description":"Contents of the file."}}},"shell":{"type":"object","description":"Shell specific options and hooks for the plugin.","items":{"init_hook":{"type":["array","string"],"description":"Shell command to run right before initializing the user's shell, running a script, or starting a service"},"scripts":{"description":"List of command/script definitions to run with `devbox run <script_name>`.","type":"object","patternProperties":{".*":{"description":"Alias name for the script.","type":["array","string"],"items":{"type":"string","description":"The script's shell commands."}}}}}},"include":{"description":"List of additional plugins to activate within your devbox shell","type":"array","items":{"description":"Name of the plugin to activate.","type":"string"}}},"required":["name","version","description"]}
</schema>

[User] Provide a JSON object that satisfies the schema "Devbox Plugin Schema". Here are the required top‑level fields: name, version, description. Return only the valid JSON object.

Devbox Plugin Schema

Defines fields and values for public devbox plugins

The schema version of this plugin file.

The name of the plugin.

The version of the plugin.

A short description of the plugin and how it works. This will automatically display when the user first installs the plugin, or runs `devbox info`

Collection of packages to install

Name and version of each package in name@version format.

Name of each package in {"name": {"version": "1.2.3"}} format.

Version number of the specified package in {"version": "1.2.3"} format.

Version of the package

Names of platforms to install the package on. This package will be skipped for any platforms not on this list

Names of platforms to exclude the package on

Whether to patch glibc to the latest available version for this package

Version of the package to install.

List of additional environment variables to be set in the Devbox environment. These can be overridden by environment variables set in the user's devbox.json

Value of the environment variable.

List of files to create in the user's project directory when the plugin is activated. The key points to the file path where the file will be created. The value points to the default file that should be copied to that location

Contents of the file.

Shell specific options and hooks for the plugin.

Shell command to run right before initializing the user's shell, running a script, or starting a service

List of command/script definitions to run with `devbox run <script_name>`.

Alias name for the script.

The script's shell commands.

List of additional plugins to activate within your devbox shell

Name of the plugin to activate.

Provide a JSON object that satisfies the schema "Devbox Plugin Schema". Here are the required top‑level fields: name, version, description. Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"http://json-schema.org/draft-04/schema#","$id":"https://github.com/jetify-com/devbox","title":"Devbox json definition","description":"Defines fields and acceptable values of devbox.json","type":"object","properties":{"$schema":{"description":"The schema version of this devbox.json file.","type":"string"},"name":{"description":"The name of the Devbox development environment.","type":"string"},"description":{"description":"A description of the Devbox development environment.","type":"string"},"packages":{"description":"Collection of packages to install","oneOf":[{"type":"array","items":{"description":"Name and version of each package in name@version format.","type":"string"}},{"type":"object","description":"Name of each package in {\"name\": {\"version\": \"1.2.3\"}} format.","patternProperties":{".*":{"oneOf":[{"type":"object","description":"Version number of the specified package in {\"version\": \"1.2.3\"} format.","properties":{"version":{"type":"string","description":"Version of the package"},"platforms":{"type":"array","description":"Names of platforms to install the package on. This package will be skipped for any platforms not on this list","items":{"enum":["i686-linux","aarch64-linux","aarch64-darwin","x86_64-darwin","x86_64-linux","armv7l-linux"]}},"excluded_platforms":{"type":"array","description":"Names of platforms to exclude the package on","items":{"enum":["i686-linux","aarch64-linux","aarch64-darwin","x86_64-darwin","x86_64-linux","armv7l-linux"]}},"glibc_patch":{"type":"boolean","description":"Whether to patch glibc to the latest available version for this package"}}},{"type":"string","description":"Version of the package to install."}]}}}]},"env":{"description":"List of additional environment variables to be set in the Devbox environment. Values containing $PATH or $PWD will be expanded. No other variable expansion or command substitution will occur.","type":"object","patternProperties":{".*":{"type":"string","description":"Value of the environment variable."}}},"shell":{"description":"Definitions of scripts and actions to take when in devbox shell.","type":"object","properties":{"init_hook":{"type":["array","string"],"items":{"description":"List of shell commands/scripts to run right after devbox shell starts.","type":"string"}},"scripts":{"description":"List of command/script definitions to run with `devbox run <script_name>`.","type":"object","patternProperties":{".*":{"description":"Alias name for the script.","type":["array","string"],"items":{"type":"string","description":"The script's shell commands."}}}}},"additionalProperties":false},"include":{"description":"List of additional plugins to activate within your devbox shell","type":"array","items":{"description":"Name of the plugin to activate.","type":"string"}},"env_from":{"type":"string"},"nixpkgs":{"type":"object","properties":{"commit":{"type":"string","description":"The commit hash of the nixpkgs repository to use"}}}},"additionalProperties":false}
</schema>

[User] Provide a JSON object that satisfies the schema "Devbox json definition". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.

Devbox json definition

Defines fields and acceptable values of devbox.json

The schema version of this devbox.json file.

The name of the Devbox development environment.

A description of the Devbox development environment.

Collection of packages to install

Version of the package

Version of the package to install.

List of additional environment variables to be set in the Devbox environment. Values containing $PATH or $PWD will be expanded. No other variable expansion or command substitution will occur.

Value of the environment variable.

Definitions of scripts and actions to take when in devbox shell.

List of shell commands/scripts to run right after devbox shell starts.

Alias name for the script.

The script's shell commands.

Name of the plugin to activate.

The commit hash of the nixpkgs repository to use

Provide a JSON object that satisfies the schema "Devbox json definition". Here are the required top‑level fields: none (all optional). Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"description":"Devfile describes the structure of a cloud-native devworkspace and development environment.","type":"object","title":"Devfile schema - Version 2.2.0","required":["schemaVersion"],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"commands":{"description":"Predefined, ready-to-use, devworkspace-related commands","type":"array","items":{"type":"object","required":["id"],"oneOf":[{"required":["exec"]},{"required":["apply"]},{"required":["composite"]}],"properties":{"apply":{"description":"Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor 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`.\n\nWhen 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","required":["component"],"properties":{"component":{"description":"Describes component that will be applied","type":"string"},"group":{"description":"Defines the group this command is part of","type":"object","required":["kind"],"properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"}},"additionalProperties":false},"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"composite":{"description":"Composite command that allows executing several sub-commands either sequentially or concurrently","type":"object","properties":{"commands":{"description":"The commands that comprise this composite command","type":"array","items":{"type":"string"}},"group":{"description":"Defines the group this command is part of","type":"object","required":["kind"],"properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"},"parallel":{"description":"Indicates if the sub-commands should be executed concurrently","type":"boolean"}},"additionalProperties":false},"exec":{"description":"CLI Command executed in an existing component container","type":"object","required":["commandLine","component"],"properties":{"commandLine":{"description":"The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$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"},"component":{"description":"Describes component to which given action relates","type":"string"},"env":{"description":"Optional list of environment variables that have to be set before running the command","type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"group":{"description":"Defines the group this command is part of","type":"object","required":["kind"],"properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"hotReloadCapable":{"description":"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.\n\nDefault value is `false`","type":"boolean"},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"},"workingDir":{"description":"Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$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"}},"additionalProperties":false},"id":{"description":"Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}},"additionalProperties":false}},"components":{"description":"List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["container"]},{"required":["kubernetes"]},{"required":["openshift"]},{"required":["volume"]},{"required":["image"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"container":{"description":"Allows adding and configuring devworkspace-related containers","type":"object","required":["image"],"properties":{"annotation":{"description":"Annotations that should be added to specific resources for this container","type":"object","properties":{"deployment":{"description":"Annotations to be added to deployment","type":"object","additionalProperties":{"type":"string"}},"service":{"description":"Annotations to be added to service","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"args":{"description":"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.\n\nDefaults to an empty array, meaning use whatever is defined in the image.","type":"array","items":{"type":"string"}},"command":{"description":"The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.","type":"array","items":{"type":"string"}},"cpuLimit":{"type":"string"},"cpuRequest":{"type":"string"},"dedicatedPod":{"description":"Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name","targetPort"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `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.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","default":"public","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `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`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `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`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","default":"http","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"env":{"description":"Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`","type":"array","items":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"image":{"type":"string"},"memoryLimit":{"type":"string"},"memoryRequest":{"type":"string"},"mountSources":{"description":"Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.","type":"boolean"},"sourceMapping":{"description":"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"},"volumeMounts":{"description":"List of volumes mounts that should be mounted is this container.","type":"array","items":{"description":"Volume that should be mounted to a component container","type":"object","required":["name"],"properties":{"name":{"description":"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])?$"},"path":{"description":"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"}},"additionalProperties":false}}},"additionalProperties":false},"image":{"description":"Allows specifying the definition of an image for outer loop builds","type":"object","required":["imageName"],"oneOf":[{"required":["dockerfile"]}],"properties":{"autoBuild":{"description":"Defines if the image should be built during startup.\n\nDefault value is `false`","type":"boolean"},"dockerfile":{"description":"Allows specifying dockerfile type build","type":"object","oneOf":[{"required":["uri"]},{"required":["devfileRegistry"]},{"required":["git"]}],"properties":{"args":{"description":"The arguments to supply to the dockerfile build.","type":"array","items":{"type":"string"}},"buildContext":{"description":"Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container","type":"string"},"devfileRegistry":{"description":"Dockerfile's Devfile Registry source","type":"object","required":["id"],"properties":{"id":{"description":"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"},"registryUrl":{"description":"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"}},"additionalProperties":false},"git":{"description":"Dockerfile's Git source","type":"object","required":["remotes"],"properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"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"}},"additionalProperties":false},"fileLocation":{"description":"Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.","type":"string"},"remotes":{"description":"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"}}},"additionalProperties":false},"rootRequired":{"description":"Specify if a privileged builder pod is required.\n\nDefault value is `false`","type":"boolean"},"uri":{"description":"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"}},"additionalProperties":false},"imageName":{"description":"Name of the image for the resulting outerloop build","type":"string"}},"additionalProperties":false},"kubernetes":{"description":"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":{"description":"Defines if the component should be deployed during startup.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name","targetPort"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `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.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","default":"public","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `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`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `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`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","default":"http","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"inlined":{"description":"Inlined manifest","type":"string"},"uri":{"description":"Location in a file fetched from a uri.","type":"string"}},"additionalProperties":false},"name":{"description":"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])?$"},"openshift":{"description":"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":{"description":"Defines if the component should be deployed during startup.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name","targetPort"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `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.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","default":"public","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `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`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `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`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","default":"http","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"inlined":{"description":"Inlined manifest","type":"string"},"uri":{"description":"Location in a file fetched from a uri.","type":"string"}},"additionalProperties":false},"volume":{"description":"Allows specifying the definition of a volume shared by several other components","type":"object","properties":{"ephemeral":{"description":"Ephemeral volumes are not stored persistently across restarts. Defaults to false","type":"boolean"},"size":{"description":"Size of the volume","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"events":{"description":"Bindings of commands to events. Each command is referred-to by its name.","type":"object","properties":{"postStart":{"description":"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"}},"postStop":{"description":"IDs of commands that should be executed after stopping the devworkspace.","type":"array","items":{"type":"string"}},"preStart":{"description":"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"}},"preStop":{"description":"IDs of commands that should be executed before stopping the devworkspace.","type":"array","items":{"type":"string"}}},"additionalProperties":false},"metadata":{"description":"Optional metadata","type":"object","properties":{"architectures":{"description":"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":{"description":"Architecture describes the architecture type","type":"string","enum":["amd64","arm64","ppc64le","s390x"]}},"attributes":{"description":"Map of implementation-dependant free-form YAML attributes. Deprecated, use the top-level attributes field instead.","type":"object","additionalProperties":true},"description":{"description":"Optional devfile description","type":"string"},"displayName":{"description":"Optional devfile display name","type":"string"},"globalMemoryLimit":{"description":"Optional devfile global memory limit","type":"string"},"icon":{"description":"Optional devfile icon, can be a URI or a relative path in the project","type":"string"},"language":{"description":"Optional devfile language","type":"string"},"name":{"description":"Optional devfile name","type":"string"},"projectType":{"description":"Optional devfile project type","type":"string"},"provider":{"description":"Optional devfile provider information","type":"string"},"supportUrl":{"description":"Optional link to a page that provides support information","type":"string"},"tags":{"description":"Optional devfile tags","type":"array","items":{"type":"string"}},"version":{"description":"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-]+)*)?$"},"website":{"description":"Optional devfile website","type":"string"}},"additionalProperties":true},"parent":{"description":"Parent devworkspace template","type":"object","oneOf":[{"required":["uri"]},{"required":["id"]},{"required":["kubernetes"]}],"properties":{"attributes":{"description":"Overrides of attributes encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.","type":"object","additionalProperties":true},"commands":{"description":"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":{"description":"Command that consists in applying a given component definition, typically bound to a devworkspace event.\n\nFor 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`.\n\nWhen 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":{"description":"Describes component that will be applied","type":"string"},"group":{"description":"Defines the group this command is part of","type":"object","properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"}},"additionalProperties":false},"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"composite":{"description":"Composite command that allows executing several sub-commands either sequentially or concurrently","type":"object","properties":{"commands":{"description":"The commands that comprise this composite command","type":"array","items":{"type":"string"}},"group":{"description":"Defines the group this command is part of","type":"object","properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"},"parallel":{"description":"Indicates if the sub-commands should be executed concurrently","type":"boolean"}},"additionalProperties":false},"exec":{"description":"CLI Command executed in an existing component container","type":"object","properties":{"commandLine":{"description":"The actual command-line string\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$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"},"component":{"description":"Describes component to which given action relates","type":"string"},"env":{"description":"Optional list of environment variables that have to be set before running the command","type":"array","items":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"value":{"type":"string"}},"additionalProperties":false}},"group":{"description":"Defines the group this command is part of","type":"object","properties":{"isDefault":{"description":"Identifies the default command for a given group kind","type":"boolean"},"kind":{"description":"Kind of group the command is part of","type":"string","enum":["build","run","test","debug","deploy"]}},"additionalProperties":false},"hotReloadCapable":{"description":"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.\n\nDefault value is `false`","type":"boolean"},"label":{"description":"Optional label that provides a label for this command to be used in Editor UI menus for example","type":"string"},"workingDir":{"description":"Working directory where the command should be executed\n\nSpecial variables that can be used:\n\n - `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.\n\n - `$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"}},"additionalProperties":false},"id":{"description":"Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}},"additionalProperties":false}},"components":{"description":"Overrides of components 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":["name"],"oneOf":[{"required":["container"]},{"required":["kubernetes"]},{"required":["openshift"]},{"required":["volume"]},{"required":["image"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"container":{"description":"Allows adding and configuring devworkspace-related containers","type":"object","properties":{"annotation":{"description":"Annotations that should be added to specific resources for this container","type":"object","properties":{"deployment":{"description":"Annotations to be added to deployment","type":"object","additionalProperties":{"type":"string"}},"service":{"description":"Annotations to be added to service","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"args":{"description":"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.\n\nDefaults to an empty array, meaning use whatever is defined in the image.","type":"array","items":{"type":"string"}},"command":{"description":"The command to run in the dockerimage component instead of the default one provided in the image.\n\nDefaults to an empty array, meaning use whatever is defined in the image.","type":"array","items":{"type":"string"}},"cpuLimit":{"type":"string"},"cpuRequest":{"type":"string"},"dedicatedPod":{"description":"Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `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.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `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`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `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`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"env":{"description":"Environment variables used in this container.\n\nThe following variables are reserved and cannot be overridden via env:\n\n - `$PROJECTS_ROOT`\n\n - `$PROJECT_SOURCE`","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":{"description":"Toggles whether or not the project source code should be mounted in the component.\n\nDefaults to true for all component types except plugins and components that set `dedicatedPod` to true.","type":"boolean"},"sourceMapping":{"description":"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"},"volumeMounts":{"description":"List of volumes mounts that should be mounted is this container.","type":"array","items":{"description":"Volume that should be mounted to a component container","type":"object","required":["name"],"properties":{"name":{"description":"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])?$"},"path":{"description":"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"}},"additionalProperties":false}}},"additionalProperties":false},"image":{"description":"Allows specifying the definition of an image for outer loop builds","type":"object","oneOf":[{"required":["dockerfile"]},{"required":["autoBuild"]}],"properties":{"autoBuild":{"description":"Defines if the image should be built during startup.\n\nDefault value is `false`","type":"boolean"},"dockerfile":{"description":"Allows specifying dockerfile type build","type":"object","oneOf":[{"required":["uri"]},{"required":["devfileRegistry"]},{"required":["git"]}],"properties":{"args":{"description":"The arguments to supply to the dockerfile build.","type":"array","items":{"type":"string"}},"buildContext":{"description":"Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container","type":"string"},"devfileRegistry":{"description":"Dockerfile's Devfile Registry source","type":"object","properties":{"id":{"description":"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"},"registryUrl":{"description":"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"}},"additionalProperties":false},"git":{"description":"Dockerfile's Git source","type":"object","properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"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"}},"additionalProperties":false},"fileLocation":{"description":"Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.","type":"string"},"remotes":{"description":"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"}}},"additionalProperties":false},"rootRequired":{"description":"Specify if a privileged builder pod is required.\n\nDefault value is `false`","type":"boolean"},"uri":{"description":"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"}},"additionalProperties":false},"imageName":{"description":"Name of the image for the resulting outerloop build","type":"string"}},"additionalProperties":false},"kubernetes":{"description":"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":{"description":"Defines if the component should be deployed during startup.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `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.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `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`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `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`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"inlined":{"description":"Inlined manifest","type":"string"},"uri":{"description":"Location in a file fetched from a uri.","type":"string"}},"additionalProperties":false},"name":{"description":"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])?$"},"openshift":{"description":"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":{"description":"Defines if the component should be deployed during startup.\n\nDefault value is `false`","type":"boolean"},"endpoints":{"type":"array","items":{"type":"object","required":["name"],"properties":{"annotation":{"description":"Annotations to be added to Kubernetes Ingress or Openshift Route","type":"object","additionalProperties":{"type":"string"}},"attributes":{"description":"Map of implementation-dependant string-based free-form attributes.\n\nExamples of Che-specific attributes:\n- cookiesAuthEnabled: \"true\" / \"false\",\n- type: \"terminal\" / \"ide\" / \"ide-dev\",","type":"object","additionalProperties":true},"exposure":{"description":"Describes how the endpoint should be exposed on the network.\n- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.\n- `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.\n- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.\n\nDefault value is `public`","type":"string","enum":["public","internal","none"]},"name":{"type":"string","maxLength":15,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"path":{"description":"Path of the endpoint URL","type":"string"},"protocol":{"description":"Describes the application and transport protocols of the traffic that will go through this endpoint.\n- `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`.\n- `https`: Endpoint will have `https` traffic, typically on a TCP connection.\n- `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`.\n- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.\n- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.\n- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.\n\nDefault value is `http`","type":"string","enum":["http","https","ws","wss","tcp","udp"]},"secure":{"description":"Describes whether the endpoint should be secured and protected by some authentication process. This requires a protocol of `https` or `wss`.","type":"boolean"},"targetPort":{"description":"Port number to be used within the container component. The same port cannot be used by two different container components.","type":"integer"}},"additionalProperties":false}},"inlined":{"description":"Inlined manifest","type":"string"},"uri":{"description":"Location in a file fetched from a uri.","type":"string"}},"additionalProperties":false},"volume":{"description":"Allows specifying the definition of a volume shared by several other components","type":"object","properties":{"ephemeral":{"description":"Ephemeral volumes are not stored persistently across restarts. Defaults to false","type":"boolean"},"size":{"description":"Size of the volume","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"id":{"description":"Id in a registry that contains a Devfile yaml file","type":"string"},"kubernetes":{"description":"Reference to a Kubernetes CRD of type DevWorkspaceTemplate","type":"object","required":["name"],"properties":{"name":{"type":"string"},"namespace":{"type":"string"}},"additionalProperties":false},"projects":{"description":"Overrides of projects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["git"]},{"required":["zip"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"clonePath":{"description":"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.","type":"string"},"git":{"description":"Project's Git source","type":"object","properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"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"}},"additionalProperties":false},"remotes":{"description":"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"}}},"additionalProperties":false},"name":{"description":"Project name","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"zip":{"description":"Project's Zip source","type":"object","properties":{"location":{"description":"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"registryUrl":{"description":"Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `registryUrl` when `id` is used.","type":"string"},"starterProjects":{"description":"Overrides of starterProjects encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["git"]},{"required":["zip"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"description":{"description":"Description of a starter project","type":"string"},"git":{"description":"Project's Git source","type":"object","properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"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"}},"additionalProperties":false},"remotes":{"description":"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"}}},"additionalProperties":false},"name":{"description":"Project name","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"subDir":{"description":"Sub-directory from a starter project to be used as root for starter project.","type":"string"},"zip":{"description":"Project's Zip source","type":"object","properties":{"location":{"description":"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"uri":{"description":"URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.","type":"string"},"variables":{"description":"Overrides of variables encapsulated in a parent devfile. Overriding is done according to K8S strategic merge patch standard rules.","type":"object","additionalProperties":{"type":"string"}},"version":{"description":"Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. To specify `version`, `id` must be defined and used as the import reference source. `version` can be either a specific stack version, or `latest`. If no `version` specified, default version will be used.","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},"projects":{"description":"Projects worked on in the devworkspace, containing names and sources locations","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["git"]},{"required":["zip"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"clonePath":{"description":"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.","type":"string"},"git":{"description":"Project's Git source","type":"object","required":["remotes"],"properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"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"}},"additionalProperties":false},"remotes":{"description":"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"}}},"additionalProperties":false},"name":{"description":"Project name","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"zip":{"description":"Project's Zip source","type":"object","properties":{"location":{"description":"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"schemaVersion":{"description":"Devfile schema version","type":"string","pattern":"^([2-9])\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},"starterProjects":{"description":"StarterProjects is a project that can be used as a starting point when bootstrapping new projects","type":"array","items":{"type":"object","required":["name"],"oneOf":[{"required":["git"]},{"required":["zip"]}],"properties":{"attributes":{"description":"Map of implementation-dependant free-form YAML attributes.","type":"object","additionalProperties":true},"description":{"description":"Description of a starter project","type":"string"},"git":{"description":"Project's Git source","type":"object","required":["remotes"],"properties":{"checkoutFrom":{"description":"Defines from what the project should be checked out. Required if there are more than one remote configured","type":"object","properties":{"remote":{"description":"The remote name should be used as init. Required if there are more than one remote configured","type":"string"},"revision":{"description":"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"}},"additionalProperties":false},"remotes":{"description":"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"}}},"additionalProperties":false},"name":{"description":"Project name","type":"string","maxLength":63,"pattern":"^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"},"subDir":{"description":"Sub-directory from a starter project to be used as root for starter project.","type":"string"},"zip":{"description":"Project's Zip source","type":"object","properties":{"location":{"description":"Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH","type":"string"}},"additionalProperties":false}},"additionalProperties":false}},"variables":{"description":"Map of key-value variables used for string replacement in the devfile. Values can be referenced via {{variable-key}} to replace the corresponding value in string fields in the devfile. Replacement cannot be used for\n\n - schemaVersion, metadata, parent source\n\n - element identifiers, e.g. command id, component name, endpoint name, project name\n\n - references to identifiers, e.g. in events, a command's component, container's volume mount name\n\n - string enums, e.g. command group kind, endpoint exposure","type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false}
</schema>

[User] Provide a JSON object that satisfies the schema "Devfile schema - Version 2.2.0". Here are the required top‑level fields: schemaVersion. Return only the valid JSON object.

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

Devfile schema - Version 2.2.0

Map of implementation-dependant free-form YAML attributes.

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

Command that consists in applying a given component definition, typically bound to a devworkspace event.

For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.

When no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.

Describes component that will be applied

Defines the group this command is part of

Identifies the default command for a given group kind

Kind of group the command is part of

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

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

The commands that comprise this composite command

Kind of group the command is part of

Indicates if the sub-commands should be executed concurrently

CLI Command executed in an existing component container

The actual command-line string

Special variables that can be used:

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

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

Describes component to which given action relates

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

Kind of group the command is part of

Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.

Default value is `false`

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/<project-name>). If there are multiple projects, this will point to the directory of the first one.

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

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

Map of implementation-dependant free-form YAML attributes.

Allows adding and configuring devworkspace-related containers

Annotations that should be added to specific resources for this container

Annotations to be added to deployment

Annotations to be added to service

The arguments to supply to the command running the dockerimage component. The arguments are supplied either to the default command provided in the image or to the overridden command.

Defaults to an empty array, meaning use whatever is defined in the image.

The command to run in the dockerimage component instead of the default one provided in the image.

Defaults to an empty array, meaning use whatever is defined in the image.

Specify if a container should run in its own separated pod, instead of running as part of the main development environment pod.

Default value is `false`

Annotations to be added to Kubernetes Ingress or Openshift Route

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

Examples of Che-specific attributes:
- cookiesAuthEnabled: "true" / "false",
- type: "terminal" / "ide" / "ide-dev",

Describes how the endpoint should be exposed on the network.
- `public` means that the endpoint will be exposed on the public network, typically through a K8S ingress or an OpenShift route.
- `internal` means that the endpoint will be exposed internally outside of the main devworkspace POD, typically by K8S services, to be consumed by other elements running on the same cloud internal network.
- `none` means that the endpoint will not be exposed and will only be accessible inside the main devworkspace POD, on a local address.

Default value is `public`

Path of the endpoint URL

Describes the application and transport protocols of the traffic that will go through this endpoint.
- `http`: Endpoint will have `http` traffic, typically on a TCP connection. It will be automaticaly promoted to `https` when the `secure` field is set to `true`.
- `https`: Endpoint will have `https` traffic, typically on a TCP connection.
- `ws`: Endpoint will have `ws` traffic, typically on a TCP connection. It will be automaticaly promoted to `wss` when the `secure` field is set to `true`.
- `wss`: Endpoint will have `wss` traffic, typically on a TCP connection.
- `tcp`: Endpoint will have traffic on a TCP connection, without specifying an application protocol.
- `udp`: Endpoint will have traffic on an UDP connection, without specifying an application protocol.

Default value is `http`

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

Port number to be used within the container component. The same port cannot be used by two different container components.

Environment variables used in this container.

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

 - `$PROJECTS_ROOT`

 - `$PROJECT_SOURCE`

Toggles whether or not the project source code should be mounted in the component.

Defaults to true for all component types except plugins and components that set `dedicatedPod` to true.

Optional specification of the path in the container where project sources should be transferred/mounted when `mountSources` is `true`. When omitted, the default value of /projects is used.

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

Volume that should be mounted to a component container

The volume mount name is the name of an existing `Volume` component. If several containers mount the same volume name then they will reuse the same volume and will be able to access to the same files.

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

Allows specifying the definition of an image for outer loop builds

Defines if the image should be built during startup.

Default value is `false`

Allows specifying dockerfile type build

The arguments to supply to the dockerfile build.

Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container

Dockerfile's Devfile Registry source

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.

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.

Dockerfile's Git source

Defines from what the project should be checked out. Required if there are more than one remote configured

The remote name should be used as init. Required if there are more than one remote configured

The revision to checkout from. Should be branch name, tag or commit id. Default branch is used if missing or specified revision is not found.

Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.

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.

Specify if a privileged builder pod is required.

Default value is `false`

URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.

Name of the image for the resulting outerloop build

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.

Defines if the component should be deployed during startup.

Default value is `false`

Annotations to be added to Kubernetes Ingress or Openshift Route

Path of the endpoint URL

Port number to be used within the container component. The same port cannot be used by two different container components.

Inlined manifest

Location in a file fetched from a uri.

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.

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.

Path of the endpoint URL

Inlined manifest

Location in a file fetched from a uri.

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

Ephemeral volumes are not stored persistently across restarts. Defaults to false

Size of the volume

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

IDs of commands that should be executed after the devworkspace is completely started. In the case of Che-Theia, these commands should be executed after all plugins and extensions have started, including project cloning. This means that those commands are not triggered until the user opens the IDE in his browser.

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

IDs of commands that should be executed before the devworkspace start. Kubernetes-wise, these commands would typically be executed in init containers of the devworkspace POD.

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

Optional metadata

Optional list of processor architectures that the devfile supports, empty list suggests that the devfile can be used on any architecture

Architecture describes the architecture type

Map of implementation-dependant free-form YAML attributes. Deprecated, use the top-level attributes field instead.

Optional devfile description

Optional devfile display name

Optional devfile global memory limit

Optional devfile icon, can be a URI or a relative path in the project

Optional devfile language

Optional devfile name

Optional devfile project type

Optional devfile provider information

Optional link to a page that provides support information

Optional devfile tags

Optional semver-compatible version

Optional devfile website

Parent devworkspace template

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

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

Describes component that will be applied

Defines the group this command is part of

Identifies the default command for a given group kind

Kind of group the command is part of

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

Map of implementation-dependant free-form YAML attributes.

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

The commands that comprise this composite command

Kind of group the command is part of

Indicates if the sub-commands should be executed concurrently

CLI Command executed in an existing component container

Describes component to which given action relates

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

Kind of group the command is part of

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

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

Allows adding and configuring devworkspace-related containers

Annotations that should be added to specific resources for this container

Annotations to be added to deployment

Annotations to be added to service

Annotations to be added to Kubernetes Ingress or Openshift Route

Path of the endpoint URL

Port number to be used within the container component. The same port cannot be used by two different container components.

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

Volume that should be mounted to a component container

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

Allows specifying the definition of an image for outer loop builds

Defines if the image should be built during startup.

Default value is `false`

Allows specifying dockerfile type build

The arguments to supply to the dockerfile build.

Path of source directory to establish build context. Defaults to ${PROJECT_SOURCE} in the container

Dockerfile's Devfile Registry source

Dockerfile's Git source

Defines from what the project should be checked out. Required if there are more than one remote configured

The remote name should be used as init. Required if there are more than one remote configured

Location of the Dockerfile in the Git repository when using git as Dockerfile src. Defaults to Dockerfile.

Specify if a privileged builder pod is required.

Default value is `false`

URI Reference of a Dockerfile. It can be a full URL or a relative URI from the current devfile as the base URI.

Name of the image for the resulting outerloop build

Defines if the component should be deployed during startup.

Default value is `false`

Annotations to be added to Kubernetes Ingress or Openshift Route

Path of the endpoint URL

Port number to be used within the container component. The same port cannot be used by two different container components.

Inlined manifest

Location in a file fetched from a uri.

Path of the endpoint URL

Inlined manifest

Location in a file fetched from a uri.

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

Ephemeral volumes are not stored persistently across restarts. Defaults to false

Size of the volume

Id in a registry that contains a Devfile yaml file

Reference to a Kubernetes CRD of type DevWorkspaceTemplate

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

Map of implementation-dependant free-form YAML attributes.

Path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.

Project's Git source

Defines from what the project should be checked out. Required if there are more than one remote configured

The remote name should be used as init. Required if there are more than one remote configured

Project name

Project's Zip source

Zip project's source location address. Should be file path of the archive, e.g. file://$FILE_PATH

Registry URL to pull the parent devfile from when using id in the parent reference. To ensure the parent devfile gets resolved consistently in different environments, it is recommended to always specify the `registryUrl` when `id` is used.

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

Description of a starter project

Project's Git source

Project name

Sub-directory from a starter project to be used as root for starter project.

Project's Zip source

URI Reference of a parent devfile YAML file. It can be a full URL or a relative URI with the current devfile as the base URI.

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

Specific stack/sample version to pull the parent devfile from, when using id in the parent reference. To specify `version`, `id` must be defined and used as the import reference source. `version` can be either a specific stack version, or `latest`. If no `version` specified, default version will be used.

Projects worked on in the devworkspace, containing names and sources locations

Project's Git source

Project name

Project's Zip source

Devfile schema version

StarterProjects is a project that can be used as a starting point when bootstrapping new projects

Description of a starter project

Project's Git source

Project name

Project's Zip source

Map of key-value variables used for string replacement in the devfile. Values can be referenced via {{variable-key}} to replace the corresponding value in string fields in the devfile. Replacement cannot be used for

 - schemaVersion, metadata, parent source

 - element identifiers, e.g. command id, component name, endpoint name, project name

 - references to identifiers, e.g. in events, a command's component, container's volume mount name

 - string enums, e.g. command group kind, endpoint exposure

Provide a JSON object that satisfies the schema "Devfile schema - Version 2.2.0". Here are the required top‑level fields: schemaVersion. Return only the valid JSON object.


[System]
You are a helpful assistant that answers strictly in JSON. Here's the JSON schema you must adhere to:
<schema>
{"$schema":"http://json-schema.org/draft-04/schema#","additionalProperties":false,"definitions":{"runObject":{"type":"object","required":["tool"],"properties":{"tool":{"title":"The tool name","description":"The name of the tool to run.","type":"string","enum":["apt-get-install","azurecli-login","choco-install","choco-upgrade","dotnet-restore","dotnet-toolinstall","enable-iis","msi-install","npm-install","nuget-restore","require-azureartifactscredentialprovider","require-azurecli","require-choco","require-dotnetcoresdk","require-dotnetframeworksdk","require-gitsubmodule","require-mssql","require-nodejs","require-npm","require-nuget","require-psmodule","require-vcpkg","require-vscomponent","require-winget","set-env","vcpkg-install","windowsfeature-disable","windowsfeature-enable","windowsfeature-list","winget-install","wsl-install"]},"input":{"title":"The tool input","description":"The input varies by tool. For example, the required version number, the package-id, the input source file or source directory.","anyOf":[{"type":"string"},{"type":"null"}]},"additionalOptions":{"title":"Additional options","description":"Additional Options to be appended to the tool's command line.","anyOf":[{"type":"string"},{"type":"null"}]},"comments":{"title":"Comments","description":"Comments for this tool item. For documentation only; ignored by the tool.","anyOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false}},"id":"https://json.schemastore.org/devinit.schema-6.0.json","properties":{"$schema":{"type":"string"},"run":{"title":"The list of tools to run","description":"'devinit.exe init' runs this list of tools sequentially. See also 'devinit.exe run'.","items":{"allOf":[{"$ref":"#/definitions/runObject"}],"anyOf":[{"$ref":"#/definitions/runObject"}]}},"comments":{"title":"Comments","description":"Comments for this file. For documentation only; ignored by the tool.","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["run"],"title":"Codespaces DevInit Configuration","type":"object"}
</schema>

[User] Provide a JSON object that satisfies the schema "Codespaces DevInit Configuration". Here are the required top‑level fields: run. Return only the valid JSON object.

The tool name

The name of the tool to run.

The tool input

The input varies by tool. For example, the required version number, the package-id, the input source file or source directory.

Additional options

Additional Options to be appended to the tool's command line.

Comments

Comments for this tool item. For documentation only; ignored by the tool.

The list of tools to run

'devinit.exe init' runs this list of tools sequentially. See also 'devinit.exe run'.

Comments

Comments for this file. For documentation only; ignored by the tool.

Codespaces DevInit Configuration

Provide a JSON object that satisfies the schema "Codespaces DevInit Configuration". Here are the required top‑level fields: run. Return only the valid JSON object.