As an Admin I want to easily update 'Getting Started' / 'Select a Sample' view and point it to repositories we use inside our organization

[ibuziuk]

Is your task related to a problem? Please describe

Motivation

Currently, it is very hard to add custom samples and update devfile registry - https://github.com/ibuziuk/che-devfile-registry
There is a plan to switch to devfile.io and a dedicated devfile registry operator to decouple samples from Dev Spaces as part of - #20251
Whereas this is an ultimate goal and would allow removing devfile-registry operand from the operator, there could be challenges for customers to use this approach

• devfile registry operator is community supported
• setup and configuration of yet another operator could be challenging

Describe the solution you'd like

As an Admin I want to update 'Getting Started' / 'Select a Sample' view and point it to repositories we use inside our organization. Basically, this could boil down to creating the cm with the list of repositories that would be read by the dashboard and displayed accordingly

apiVersion: v1
kind: ConfigMap
metadata:
  name: getting-started
labels:
    app.kubernetes.io/part-of: che.eclipse.org
data:
  getting-started-samples: |-
    [
      {
        "name": "Java Quarkus",
        "description": "Quarkus example with a default REST endpoint application sample",
        "tag": "Community",
        "url": "https://github.com/che-incubator/quarkus-api-example/",
        "icon": {
          "base64data": <base64-encoded-data>,
          "mediatype": "image/png"
        }
      },
      {
        "name": "Eclipse Che Dashboard",
        "description": "Specifies development environment needed to develop the Eclipse Che Dashboard.",
        "tag": "Eclipse Che",
        "url": "https://github.com/che-incubator/quarkus-api-example/",
        "icon": {
          "base64data": <base64-encoded-data>,
          "mediatype": "image/png"
        }
      }
    ]

The pros of this approach:

• simple and straight-forward configuration via single k8s resource
• airgap / private repo support OOTB assuming that OAuth / PAT is configured

Describe alternatives you've considered

No response

Additional context

• description is optional
• tag is optional
• icon is optional, if not set on UD we display the default image:

[tolusha]

Should be the same structure like this?
https://registry.devfile.io/index

[ibuziuk]

we can use a different or similar structure to devfile.io - whatever would be easier to support/maintain. Also, maybe this cm should be managed by the operator

[tolusha]

Also, maybe this cm should be managed by the operator

What does it mean?

My suggestion:

      {
        "displayName": "Eclipse Che Dashboard",
        "description": "Specifies development environment needed to develop the Eclipse Che Dashboard.",
        "tags": ["Eclipse Che", "Dashboard"],
        "url": "https://github.com/che-incubator/quarkus-api-example/",
        "icon": {
          "base64data": <base64-encoded-data>,
          "mediatype": "image/png"
        }
      }

[ibuziuk]

format lgtm, I do not know if it makes sense to have the cm be managed by the operator e.g. app.kubernetes.io/managed-by: che-operator

[tolusha]

The ConfigMap must have some distinguish labels.
I suggest:

apiVersion: v1
kind: ConfigMap
metadata:
  name: getting-started
  labels:
    app.kubernetes.io/part-of: che.eclipse.org
    app.kubernetes.io/component: devfile-metadata
data:
  getting-started-samples: |-
    [
      {
        "displayName": "Eclipse Che Dashboard",
        "description": "Specifies development environment needed to develop the Eclipse Che Dashboard.",
        "tags": ["Eclipse Che", "Dashboard"],
        "url": "https://github.com/che-incubator/quarkus-api-example/",
        "icon": {
          "base64data": <base64-encoded-data>,
          "mediatype": "image/png"
        }
      }
    ]

[ibuziuk]

LGTM, the only thing is app.kubernetes.io/component: devfile-metadata, I would rather use app.kubernetes.io/component: getting-started-samples
@l0rd wdyt? could you please review the proposal?

[tolusha]

Sounds better for me

[l0rd]

Proposal looks good to me 👍

[ibuziuk]

@tolusha just want to double-check if any backports are needed for 7.74.x ? We really want to have this feature in 3.9 ;-)

[tolusha]

We have to backport the doc PR eclipse-che/che-docs#2646

[tolusha]

Here is https://github.com/eclipse-che/che-docs/commits/7.74.x