Devfile 2.0.0 proposal

[l0rd]

Devfile 2.0.0 (milestone)

Here is a list of proposals to include in the next version of the Devfile format. Proposals need to be reviewed and approved. We are flagging issues with 👍once they have been reviewed and approved.

1. Repositories Setup

We would like to split Devfile related source code in 2 distinct repositories:

che-incubator/devworkspace-api

The Devfile schema is directly generated from the DevWorkspace API. PRs to change the Devfile format spec (documentation included) should be done here. Issues related to the format should be also created here.

redhat-developer/devfile

The Devfile specification doc and examples are published here. Only PRs to add new examples should be done here.

Subtasks related to the repositories setup:

• Move devfile repository to the devfile organisation 👍
• Move devworkspace-api repository to the devfile organisation 👍
• Setup a GH action to generate and publish the Devfile OpenAPI schema 👍
• Setup a GH action to generate and publish the Devfile Spec Documentation 👍

2. Changes for ODO

• Specify the source mapping path (CHE_PROJECT_ROOT) for component containers 👍
• Id and label for Composite commands 👍
• Specify size of volume for component 👍
• Allow volumes to be shared across components 👍
• On startup, automatically copy files/directories from the Git location of a dev file, to a container superseded by Add lifecycle bindings to bind commands to specific events #32
• Environment variables for a specific command 👍
• Renaming workdir into workingDir 👍
• Commands group (application lifecycle) 👍
• Out of main pod containers 👍
• Stacks/Devfile matching rules 👍
• Devfile metadata: add a link to an external website 👍
• starterProjects and projects description

3. Changes for Che / Codewind

• Polymorphic component type UX in a Devfile 👍
• Renaming dockerimage component type 👍
• Devfile should have a schemaVersion attribute 👍
• The Devfile schema/samples should have optional version and name attributes 👍
• Names mandatory for k8s/openshift/container but not for plugins 👍
• Add lifecycle bindings to bind commands to specific events👍
• Better plugin mechanism 👍
• Containers endpoints (routes/ingresses) 👍
• Find a better naming for chePlugin spec reference 👍
• New type of command to apply a component 👍
• Run exec commands as specified user 👍

4. Changes to support Stacks definition

• Parent devfiles 👍

[slemeur]

There should be a backward compatibility mechanism between devfile 1.x and devfile 2.0. We've discussed about it and that seems still valuable to Che adopters (and downstream products).

[l0rd]

v2.0 has been released