[UD] A new workspace cannot be created if the target devfile includes a parent with the storage-type field

[olexii4]

Describe the bug

A new workspace cannot be created if it is based on a devfile with a parent with the storage-type field e.g.

...
metadata:
attributes:
  controller.devfile.io/storage-type: ephemeral
...

Che version

7.97@latest

Steps to reproduce

1. Try to create a new workspace from the source

https://gist.githubusercontent.com/olexii4/dfb21012e08eedf8fc17ae608708fe87/raw/bec54efa905b915695dcb7fc5806cb4b456aa343/devfile.yaml

2. You can see an error message:
   

Expected behavior

1. Try to create a new workspace from the source

https://gist.githubusercontent.com/olexii4/dfb21012e08eedf8fc17ae608708fe87/raw/bec54efa905b915695dcb7fc5806cb4b456aa343/devfile.yaml

2. A new workspace should be created without errors.

Runtime

OpenShift

Screenshots

No response

Installation method

chectl/next

Environment

macOS

Eclipse Che Logs

No response

Additional context

No response

[ibuziuk]

@olexii4 some relevant discussion related to this issue - devfile/registry#401 (comment)

@thepetk @michael-valdron wdyt should be the right behaviour, imo the attributes defined in the child devfile should get the priotity

[thepetk]

Yeah I think is quite similar with devfile/registry#401 (comment)

I was able to reproduce the error using an updated version of mine:

• https://raw.githubusercontent.com/thepetk/registry/7b6e32eb8c3e490aefd1036a66bef9cf1013cfe8/stacks/test/devfile-child.yaml

@thepetk @michael-valdron wdyt should be the right behaviour, imo the attributes defined in the child devfile should get the priotity

I would expect that the following structure should be ok to override the parent attributes:

parent:
    uri: "...."
    attributes:
          controller.devfile.io/storage-type: empheral

However this is not the case, as the parent schema does not support overrides in the attributes field. Therefore, I would expect that if passed correctly (through the parent block), no change would be applied to the parent devfile as it's not supported, BUT we should be able to create the workspace.

I can confirm this is not the case too. See:

• https://raw.githubusercontent.com/thepetk/registry/bf0e3bc6abd6a5c0f5c15db577e623cb42ba1ea5/stacks/test/devfile-child.yaml

One question I have: Are there any additions to the child devfile attributes done by default from Devworkspace during the workspace creation process? This would justify the above error as both parent & child could share the same block. More specifically is the:

attributes:
  controller.devfile.io/storage-type:

added in any of the steps to the devfile we are trying to create a workspace from?

The main reason I'm asking is what I described above. In case no attributes.controller.devfile.io/storage-type exists in the child devfile, we shouldn't get an error of having the same attributes both in child and parent.

NOTE: FWIW I can confirm that this is not a generic issue for the attributes therefore, if I change the attribute in parent to a dummy attribute value the issue is gone.

[olexii4]

Yeah I think is quite similar with devfile/registry#401 (comment)

I was able to reproduce the error using an updated version of mine:

• https://raw.githubusercontent.com/thepetk/registry/7b6e32eb8c3e490aefd1036a66bef9cf1013cfe8/stacks/test/devfile-child.yaml

@thepetk @michael-valdron wdyt should be the right behaviour, imo the attributes defined in the child devfile should get the priotity

I would expect that the following structure should be ok to override the parent attributes:

parent:
uri: "...."
attributes:
controller.devfile.io/storage-type: empheral
However this is not the case, as the parent schema does not support overrides in the attributes field. Therefore, I would expect that if passed correctly (through the parent block), no change would be applied to the parent devfile as it's not supported, BUT we should be able to create the workspace.

I can confirm this is not the case too. See:

• https://raw.githubusercontent.com/thepetk/registry/bf0e3bc6abd6a5c0f5c15db577e623cb42ba1ea5/stacks/test/devfile-child.yaml

One question I have: Are there any additions to the child devfile attributes done by default from Devworkspace during the workspace creation process? This would justify the above error as both parent & child could share the same block. More specifically is the:

attributes:
controller.devfile.io/storage-type:
added in any of the steps to the devfile we are trying to create a workspace from?

The main reason I'm asking is what I described above. In case no attributes.controller.devfile.io/storage-type exists in the child devfile, we shouldn't get an error of having the same attributes both in child and parent.

NOTE: FWIW I can confirm that this is not a generic issue for the attributes therefore, if I change the attribute in parent to a dummy attribute value the issue is gone.

@thepetk @ibuziuk The parent schema does not support overrides in the attributes field, so che-dashboard shouldn't apply attributes.controller.devfile.io/storage-type into the child devfile if it exists in the parent, and the Change Storage Type widget should be disabled:

The described solution is implemented in this PR.

WDYT?

[ibuziuk]

makes sense 👍 @thepetk wdyt?