Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre-build DevWorkspace templates for devfile v2 of devfile registry #19718

Closed
Tracked by #14879
benoitf opened this issue Apr 29, 2021 · 6 comments · Fixed by eclipse-che/che-devfile-registry#518
Closed
Tracked by #14879
Assignees
Labels
area/devfile-registry kind/enhancement A feature request - must adhere to the feature request template. sprint/current

Comments

@benoitf
Copy link
Contributor

benoitf commented Apr 29, 2021

Is your enhancement related to a problem? Please describe.

Creating a devWorkspace from a devfile result in dashboard may require several operations like:

  • grabbing the content definition of the selected editor,
  • grabbing recommended plug-ins from the projects
  • grabbing plug-ins definition and potential sidecars to use
    etc.

At the end, we have a workspace definition (DevWorkspace templates) that can be used to create the DevWorkspace

Describe the solution you'd like

pre-built the devWorkspace templates for some editors like theia/intellij, etc and host them in the devfile registry
then, when dashboard wants to create a devWorkspace from a given 'getting started' devfile, it'll only need to apply the templates on k8s api instead of parsing/analyzing/etc.

Describe alternatives you've considered

Additional context

@benoitf benoitf added kind/enhancement A feature request - must adhere to the feature request template. area/devfile-registry area/dashboard labels Apr 29, 2021
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Apr 29, 2021
@ericwill ericwill removed the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label May 3, 2021
@sleshchenko
Copy link
Member

Dropping area/dashboard since it's more on devfile-registry currently.
Please return it back or even better raise a new issue when dashboard already can start handing that.

@l0rd l0rd changed the title prebuild devWorkspace templates for devfile v2 of devfile registry Prebuild DevWorkspace templates for devfile v2 of devfile registry Oct 4, 2021
@l0rd l0rd changed the title Prebuild DevWorkspace templates for devfile v2 of devfile registry Pre-build DevWorkspace templates for devfile v2 of devfile registry Oct 4, 2021
@l0rd l0rd removed this from the DevWorkspace Integration - STEP3 milestone Oct 4, 2021
@svor svor mentioned this issue Nov 9, 2021
18 tasks
@svor
Copy link
Contributor

svor commented Nov 15, 2021

The idea is to generate DW templates at build time and put them into
/usr/local/apache2/htdocs/devfiles/v2/{editor}/ folder in che-devfile-registry image.
Firstly let's do it for che-theia editor (/usr/local/apache2/htdocs/devfiles/v2/che-theia/).
It could be done by using devworkspace-handler library. To use this library you can execute node lib/entrypoint.js --devfile-url:https://github.com/benoitf/console-java-simple/tree/devfile2 --output-file:/tmp/all-ione.yaml.
cc @vinokurig @benoitf

@max-cx
Copy link

max-cx commented Nov 15, 2021

Hi, a question to the assignee of this issue:

Will the outcome require any changes to the relevant content of the Installation Guide or Administration Guide or End-user Guide?

Yes/No?

@vinokurig vinokurig added the status/blocked Issue that can’t be moved forward. Must include a comment on the reason for the blockage. label Nov 16, 2021
@vinokurig
Copy link
Contributor

Is blocked by #20780

@vinokurig vinokurig removed the status/blocked Issue that can’t be moved forward. Must include a comment on the reason for the blockage. label Nov 16, 2021
@vinokurig
Copy link
Contributor

@max-cx

Hi, a question to the assignee of this issue:

Will the outcome require any changes to the relevant content of the Installation Guide or Administration Guide or End-user Guide?

Yes/No?

I don't think so, It's just a technical debt.

@svor
Copy link
Contributor

svor commented Nov 24, 2021

Links of DevWorkspaceTemplates should be added into meta.yaml at build time
and put generated files into devfile folder.
For example final meta.yaml file for Go devfile should be like:

{
  "displayName": "Go",
  "description": "Stack with Go 1.14",
  "tags": [
    "Debian",
    "Go"
  ],
  "icon": "/images/go.svg",
  "links": {
    "v2": "https://github.com/che-samples/golang-echo-example/tree/devfile2",
    "devWorkspaces": {
       "eclipse/che-theia/latest": "/devfiles/go/devworkspace-che-theia-latest.yaml"
       "eclipse/che-theia/next": "/devfiles/go/devworkspace-che-theia-next.yaml"
    },
    "self": "/devfiles/go/devfile.yaml"
  }
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/devfile-registry kind/enhancement A feature request - must adhere to the feature request template. sprint/current
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants