chore: Pre-build DevWorkspace templates for devfile v2

[vinokurig]

Signed-off-by: Igor Vinokur ivinokur@redhat.com

What does this PR do?

Generate DW templates at build time and put them into /usr/local/apache2/htdocs/devfiles/v2/che-thei/ folder in the che-devfile-registry image.

Screenshot/screencast of this PR

What issues does this PR fix or reference?

fixes eclipse-che/che#19718

How to test this PR?

1. Build and run the che-devfile-registry image.
2. Go to <devfile-registry URL>/devfiles/v2/che-theia/.
3. See: List of the generated tamplates.

PR Checklist

As the author of this Pull Request I made sure that:

• The Eclipse Contributor Agreement is valid
• Code produced is complete
• Code builds without errors
• Tests are covering the bugfix
• The repository devfile is up to date and works
• Sections What issues does this PR fix or reference and How to test this PR completed
• Relevant user documentation updated
• Relevant contributing documentation updated
• CI/CD changes implemented, documented and communicated

Reviewers

Reviewers, please comment how you tested the PR when approving it.

[github-actions]

Click here to review and test in web IDE:

[github-actions]

Click here to review and test in web IDE:

[github-actions]

Click here to review and test in web IDE:

[github-actions]

Click here to review and test in web IDE:

[benoitf]

I think it won't work in brew environment (cc @nickboldt for downstreaming)

[vinokurig]

Wouldn't it be overridden here: https://github.com/redhat-developer/codeready-workspaces/blob/crw-2-rhel-8/dependencies/che-devfile-registry/build/dockerfiles/Dockerfile?

[nickboldt]

yes, CRW devfile registry is a fork. There's no sync between che devfile reg and the crw one.

Therefore you need to manually apply these changes to downstream. But you cannot just npm install in brew unless either:

• you prebuild the bits in jenkins as a tarball then unpack them during the brew build as if doing an offline build, or
• use cachito to fetch npm dependencies https://issues.redhat.com/browse/CRW-2444

[github-actions]

Click here to review and test in web IDE:

[benoitf]

Thank you for all the fixes

I still have a couple of questions:

• how do we get the link to this dev workspace templates ? I don't see meta.yaml being updated with the link to che-theia devWorkspace templates for example ?
• What are the images of che-theia used ? for example when we cut a release like 7.40.0 what devworkspace.yaml file will contain ? as it should reference che-theia:7.40.0 images in that case ?

[github-actions]

Click here to review and test in web IDE:

[vinokurig]

@svor @benoitf

• The meta.yaml file is updated with devWorkspaces links.
• DevWorkspace templates are generated for both next and latest versions in the extension directory.
• shellcheck successfully passed.

[benoitf]

I tested but I have as links

links": {
"v2": "https://github.com/che-samples/java-guestbook/tree/devfilev2",
"self": "/devfiles/java-mongo/devfile.yaml",
"devWorkspaces": {
"eclipse/che-theia/latest": "devfiles/java-mongo/devworkspace-che-theia-latest.yaml",
"eclipse/che-theia/next": "devfiles/java-mongo/devworkspace-che-theia-next.yaml"

so I suppose there is a missing / before devfiles ?

[github-actions]

Click here to review and test in web IDE:

[vinokurig]

@benoitf

I tested but I have as links

"links": {
"v2": "https://github.com/che-samples/java-guestbook/tree/devfilev2",
"self": "/devfiles/java-mongo/devfile.yaml",
"devWorkspaces": {
"eclipse/che-theia/latest": "devfiles/java-mongo/devworkspace-che-theia-latest.yaml",
"eclipse/che-theia/next": "devfiles/java-mongo/devworkspace-che-theia-next.yaml"
}

so I suppose there is a missing / before devfiles ?

fixed

[vinokurig]

@nickboldt @svor @benoitf

seems reasonable. Please remember to submit a PR for downstreaming this into https://github.com/redhat-developer/codeready-workspaces/tree/crw-2-rhel-8/dependencies/che-devfile-registry/devfiles for CRW 2.14

I think it should be done as a next iteration and in the scope of a separate issue.

[benoitf]

looks ok to me as first step

[benoitf]

probably it requires a change in release.sh to handle the tag replacement for latest images in DevWorkspaceTemplates but I don't know if you plan to do it now or later. But it needs to be addressed

[svor]

Release DevWorkspaceTemplates in devfile registry #20824
Related issue for CRW: https://issues.redhat.com/browse/CRW-2500

[svor]

Is it ok that the content of resulted meta.yaml is in json format?

[benoitf]

@svor

Index file is in JSON and it's where we're adding the links

The generated file is in yaml file as expected

[svor]

@benoitf I mean in devfiles/go folder i see meta.yaml and its content is in JSON:

bash-5.0# ls
devfile.yaml  devworkspace-che-theia-latest.yaml  devworkspace-che-theia-next.yaml  meta.yaml
bash-5.0# cat meta.yaml 
{
  "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",
    "self": "/devfiles/go/devfile.yaml",
    "devWorkspaces": {
      "eclipse/che-theia/latest": "/devfiles/go/devworkspace-che-theia-latest.yaml",
      "eclipse/che-theia/next": "/devfiles/go/devworkspace-che-theia-next.yaml"
    }
  }
}

But it's not related to this PR

[nickboldt]

Downstream issue is https://issues.redhat.com/browse/CRW-2500

[benoitf]

@svor OK that's a bug that needs to be fixed

[svor]

@svor OK that's a bug that needs to be fixed

issue for that eclipse-che/che#20828