Documentation and Solution Needed for Using Parent ID Devfiles Without an Internal Devfile Registry

[eye0fra]

Is your enhancement related to a problem? Please describe

With the upcoming deprecation of the internal devfile registry in Eclipse Che, users will need alternative methods for accessing and using parent ID devfiles, particularly when following a "getting started" approach. Currently, the process for obtaining and referencing a parent devfile ID is unclear without relying on the internal registry.

The following issues need to be addressed:

1. How to Obtain the Parent Devfile ID:

   • What are the recommended methods for obtaining the ID of a parent devfile if the internal registry is no longer available?
   • Is parent ID with URI is the only way supported ?
   • Is there a way to use the Che dashboard URL to acquire the parent devfile ID?
   • Would the by Kubernetes resource works (declariteve approach)?

2. Support for Git Repositories:

   • If a Git repository URI is used to reference a parent devfile, how can this be implemented effectively?
   • The solution should work seamlessly with both public and private Git repositories. If using private repositories, what specific steps are required to ensure secure and successful access?

3. Documentation and Guides:

   • There is a need for clear, comprehensive documentation that outlines the steps to follow for users who are transitioning away from the internal devfile registry.
   • This documentation should include examples, best practices, and potential pitfalls to avoid.

Describe the solution you'd like

The goal of this issue is to ensure that users of OpenShift DevSpaces can continue to use parent ID devfiles effectively even after the deprecation of the internal devfile registry. A well-documented and secure process should be established, with clear guidance on how to reference parent devfiles using alternative methods, including support for private Git repositories and Kubernetes resources.

Describe alternatives you've considered

No response

Additional context

No response

[ibuziuk]

@eye0fra could you please take a look at the devfile.io samples / docs - https://devfile.io/docs/2.3.0/referring-to-a-parent-devfile
smth. like this should work for example:

parent:
  id: udi
  registryUrl: https://registry.stage.devfile.io/
  version: 1.0.0

[ibuziuk]

@eye0fra hello, please, find more follow up on this issues with answers inlined:

What are the recommended methods for obtaining the ID of a parent devfile if the internal registry is no longer available?

From Eclipse Che perspective the recommended approach is to use URI reference e.g. :

https://gist.github.com/ibuziuk/ff5d5da5ae887dfd420b10eda17a9a2e

A very powerful feature is that when images in parent devfile are updated the CDE would be also updated accordingly after restart (without any changes in the child devfile)

Is there a way to use the Che dashboard URL to acquire the parent devfile ID?

not sure I get the question, but for existing workspaces you can preview devfile definition from the User Dashboard:

[eye0fra]

Yes, we are currently using the same mechanism.