Full support for Devfile 2.x spec

[sleshchenko]

Is your enhancement related to a problem? Please describe.

Currently, devworkspace controller supports only limited of devfile 2.x format. This is epic to track which parts needs to be implemented.

schemaVersion: 2.0.0
metadata:
  name: nodejs-stack
projects:
  - name: project    
    git:
      remotes:                                                           # The only one remote is supported on Che Theia side
        origin: "https://github.com/che-samples/web-nodejs-sample.git"
components:
  - name: editor
    plugin:
      id: eclipse/che-theia/7.1.0
  - name: terminal
    plugin:
      id: eclipse/che-machine-exec-plugin/7.1.0
  - name: typescript-plugin
    plugin:
      id: che-incubator/typescript/1.30.2                                 # patching of plugins configuration are not supported yet
      components:
        - name: "??"
          container:
            memoryLimit: 512Mi
  - name: nodejs
    container:
      image: quay.io/eclipse/che-nodejs10-ubi:nightly
      memoryLimit: 512Mi
      endpoints:
        - name: nodejs
          protocol: http
          targetPort: 3000
      mountSources: true
  - name: cleanup-job
    kubernetes:
      inlined: |
        apiVersion: batch/v1
        kind: Job
        metadata:
          name: pi
        spec:
          template:
            spec:
              containers:
              - name: job
                image: someimage
                command: ["some",  "command", "with", "parameters"]
              restartPolicy: Never
          backoffLimit: 4
  - name: postgres
    kubernetes:                                               # kubernete component is not supported yet
      inlined: |
        kind: Deployment
        metadata:
          name: pi
        spec:
          template:
            spec:
              containers:
              - name: job
                image: someimage
                command: ["some",  "command", "with", "parameters"]
              restartPolicy: Never
          backoffLimit: 4
volumes:                                                    ## volumes are not implemented on that level
  - name: ...
commands:
  - id: download dependencies
    exec:
      component: nodejs
      commandLine: npm install
      workingDir: ${PROJECTS_ROOT}/project/app
      group:
        kind: build                                              # groups are not supported yet
commands:
  - id: cleanup-job
    apply:
      component: cleanup-job 
events:
  postStop:
    - cleanup-job
  preStop: ...
  preStart: ...
  postStart: ...

This issue is not well-described yet. More details will be provided soon.

Devfile 2.0 Feature	Supported	Issue
Plugin mechanism	removed from the spec	devfile/api#333
Parent devfiles	✅	devfile/devworkspace-operator#346
Allow volumes to be shared across components	✅	devfile/devworkspace-operator#237
kubernetes component	✅
projects	✅
starterProjects
Components sourceMapping	✅
Specify size of volume for component	✅	devfile/devworkspace-operator#827
Environment variables for a specific command	✅
Commands group (application lifecycle)
Out of main pod containers
Stacks/Devfile matching rules	not in the spec yet
Devfile metadata: add a link to an external website	✅
Add lifecycle bindings to bind commands to specific events	pre-start only	devfile/devworkspace-operator#629
Containers endpoints (routes/ingresses)	✅
New type of command to apply a component
Run exec commands as specified user
hotReloadCapable
image component		#21187
outer loop components of type image and kubernetes		#21186

[amisevsk]

We should separate the compatibility requirements into two categories: there are parts of the devfile that impact how objects are created on the cluster (e.g. out of pod containers, etc.) and parts that are data to be passed to other components (e.g. commands, projects). For many of the elements listed above, all the devworkspace controller can do is pass data to Theia in a way that Theia will understand.

[che-bot]

Issues go stale after 180 days of inactivity. lifecycle/stale issues rot after an additional 7 days of inactivity and eventually close.

Mark the issue as fresh with /remove-lifecycle stale in a new comment.

If this issue is safe to close now please do so.

Moderators: Add lifecycle/frozen label to avoid stale mode.

[l0rd]

Closing. We will implement missing parts of the spec when there is a real request.

[vaidotasp]

@l0rd can you define what "real request" is?

[l0rd]

@vaidotasp I think it makes sense to re-open this issue so that we can track what's supported and what's not.

I am not sure why I closed it but we are continuously working on supporting the v2 spec (and we have implemented a big part of it already). And we want to prioritize the features that are required in users/customers scenarios (i.e. "real request") rather than guessing what will be useful and what not (for example I would be careful to implement postStop events today as I am not aware of any scenario that would require that).

I have updated the description with what is supported today. We should probably clean it up because there are new fields (i.e. image components) that have been added in the meantime. @amisevsk @AObuchow please have a look.

[l0rd]

/remove-lifecycle stale

[AObuchow]

Support for setting annotations on services and endpoints should probably be added to the list.

Also, support for Specifying size of volume component wasn't solved by devfile/devworkspace-operator#827. Instead, Compute required size for per-workspace PVC when all volumes have sizes specified would be a more relevant issue.

[AObuchow]

@amisevsk correct me if I am wrong, but it seems like the projects and sourceMapping features are supported and can be updated in the table.

Additionally, kubernetes components will be supported once devfile/devworkspace-operator#961 is merged.

[AObuchow]

components.volume.size is now supported in DWO when using the per-workspace storage strategy. See devfile/devworkspace-operator#1020

[che-bot]

Issues go stale after 180 days of inactivity. lifecycle/stale issues rot after an additional 7 days of inactivity and eventually close.

Mark the issue as fresh with /remove-lifecycle stale in a new comment.

If this issue is safe to close now please do so.

Moderators: Add lifecycle/frozen label to avoid stale mode.

[l0rd]

/remove-lifecycle stale

[che-bot]

Issues go stale after 180 days of inactivity. lifecycle/stale issues rot after an additional 7 days of inactivity and eventually close.

Mark the issue as fresh with /remove-lifecycle stale in a new comment.

If this issue is safe to close now please do so.

Moderators: Add lifecycle/frozen label to avoid stale mode.

[amisevsk]

/remove-lifecycle stale