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

Labelling devfiles in the Dashboard #19953

Closed
3 tasks
sunix opened this issue Jun 9, 2021 · 12 comments
Closed
3 tasks

Labelling devfiles in the Dashboard #19953

sunix opened this issue Jun 9, 2021 · 12 comments
Labels
area/dashboard area/devfile-registry kind/enhancement A feature request - must adhere to the feature request template. severity/P1 Has a major impact to usage or development of the system.
Milestone

Comments

@sunix
Copy link
Contributor

sunix commented Jun 9, 2021

Is your enhancement related to a problem? Please describe.

In the dashboard get-started page, admin can configure Che to have devfiles coming from different devfile registries. The problem is that it is hard to differentiate where the devfile is coming from.
This is what is done in the Red Hat Developer Sandbox SaaS which is mixing CodeReady Workspaces devfiles and Che community devfiles. It is not possible to distinguish from which registry is coming a devfile. A user may use unwillingly the community one rather than the one from CodeReady Workspaces.
A label showing that a devfile is a "community" devfile would help. Labels could be used in other use cases: showing the supported architectures for instance.

Describe the solution you'd like

The idea is to reuse the field from the meta.yaml file that we have already in the devfile registries: The tags field.
In meta.yaml attributes

displayName: Quarkus Postgresql
description: Build and run hotspot or native Quarkus app with postgresql
tags: ["Community", "arm64", "Airgap", "Java", "Quarkus", "OpenJDK", "Maven", "Native", "GraalVM"]
icon: /images/quarkus.svg
globalMemoryLimit: 8Gi
Links:
  self: /devfiles/quarkus-postgresql/devfile.yaml

In index.json (generated) of the registry

[
...
,
  {
    "displayName": "Quarkus Postgresql",
    "description": "Build and run hotspot or native Quarkus app with postgresql",
    "tags": [
      "Community",
      "arm64",
      "Airgap",
      "Java",
      "Quarkus",
      "OpenJDK",
      "Maven",
      "Native",
      "GraalVM"
    ],
    "icon": "/images/quarkus.svg",
    "globalMemoryLimit": "8Gi",
    "links": {
      "self": "/devfiles/quarkus-postgresql/devfile.yaml"
    }
  },

Based on an operator cluster configuration, the admin would set the list of tags that would be displayed as a label in the user dashboard.

This is how would look like the dashboard

  • with only "Community" labels selected in the operator cluster config
    showDevfileTagsInLabels: : ["Community"]
  • having all the devfiles from the community marked with the tag "Community"

image

Here are few subtasks to achieve that:

  • Have an operator configuration option “showDevfileTagsInLabels” to define a list of tags to display as a label. and make it available to the dashboard.
  • Visually display tags labels in the dashboard get-started page for devfile with tags listed in “showDevfileTags”
  • Mark with the tag "community" to all the devfiles coming from the default devfile registry
@sunix sunix added the kind/enhancement A feature request - must adhere to the feature request template. label Jun 9, 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 Jun 9, 2021
@benoitf
Copy link
Contributor

benoitf commented Jun 9, 2021

isn't it conflicting with #19633 ?
AFAIK operator will be able to explicitly give a name to a given devfile registry and it will be in a dedicated section
cc @sleshchenko

@tolusha tolusha added severity/P2 Has a minor but important impact to the usage or development of the system. area/dashboard and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Jun 9, 2021
@ericwill ericwill mentioned this issue Jun 10, 2021
30 tasks
@sunix
Copy link
Contributor Author

sunix commented Jun 11, 2021

@benoitf maybe, but this is definitly required in any case to display things such as supported architectures, etc.

@sleshchenko
Copy link
Member

sleshchenko commented Jun 25, 2021

@benoitf maybe, but this is definitly required in any case to display things such as supported architectures, etc.

@sunix Why? Che Cluster is run on a particular architecture, we even should not display devfiles that are not supported on the current architecture.
Update: OK, it's not about displaying arch, but about filtering it and not displaying.

@vitaliy-guliy
Copy link
Contributor

@svor svor removed this from the 7.33 milestone Jul 20, 2021
@nickboldt
Copy link
Contributor

nickboldt commented Nov 22, 2021

Required for implementing UDI image (if we want to have ALL the tech preview and GA supported stuff in the same container).

See:

Escalating to P1.

@nickboldt nickboldt added severity/P1 Has a major impact to usage or development of the system. and removed severity/P2 Has a minor but important impact to the usage or development of the system. labels Nov 26, 2021
@nickboldt nickboldt added this to the 7.40 milestone Nov 26, 2021
@nickboldt
Copy link
Contributor

PRs to add tags to meta.yaml so we can use that data to display labels on devfile tiles:

@l0rd
Copy link
Contributor

l0rd commented Nov 30, 2021

@ibuziuk the milestone for this issue is 7.40 (release tomorrow) but there is no sprint/current label. Should it be moved to milestone 7.41?

@l0rd
Copy link
Contributor

l0rd commented Dec 14, 2021

@ibuziuk I think we are still missing the dashboard part of this. I have set the milestone to 7.41, feel free to set another milestone if you are not going to work on it during this sprint.

@ibuziuk
Copy link
Member

ibuziuk commented Dec 15, 2021

we are tracking this issue as part of #19633

@benoitf
Copy link
Contributor

benoitf commented Dec 22, 2021

@ibuziuk 7.41.0 release will be cut today. This issue is not yet closed, so please close it if it's done or move it to 7.42

@nickboldt nickboldt modified the milestones: 7.41, 7.42 Dec 22, 2021
@nickboldt
Copy link
Contributor

nickboldt commented Jan 6, 2022

I see #19633 is resolved via eclipse-che/che-dashboard#432 so ... can we close this one too?

@nickboldt
Copy link
Contributor

Followup in #20976

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/dashboard area/devfile-registry kind/enhancement A feature request - must adhere to the feature request template. severity/P1 Has a major impact to usage or development of the system.
Projects
None yet
Development

No branches or pull requests