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

Avoid any modifications to the devfile in conversion to a DevWorkspace #22614

Closed
amisevsk opened this issue Oct 17, 2023 · 1 comment
Closed
Assignees
Labels
area/dashboard area/devfile-converter library used to convert v1 to v2 or v2 to v1 devfiles area/factory/dashboard Issues related to factories frontend (che user dashboard side) kind/enhancement A feature request - must adhere to the feature request template. severity/P2 Has a minor but important impact to the usage or development of the system. team/A This team is responsible for the Che Operator and all its operands as well as chectl and Hosted Che

Comments

@amisevsk
Copy link
Contributor

Is your enhancement related to a problem? Please describe

We have some feature requests for adding the ability for DevWorkspaces to complete setup from a devfile automatically (e.g. #22491). This would involve the DevWorkspace patching itself to update its components, etc. to match a devfile within a cloned git repository.

However, this is currently difficult to do as DevWorkspaces set up via normal flows (e.g. the factory flow, etc.) are modified from the underlying devfile before being applied to the cluster.

Describe the solution you'd like

When creating a workspace from a devfile or repository with a devfile in it, we should implement conversion so that the contents of the original devfile are the same as the .spec.template field of the DevWorkspace, with any Che-specific settings (e.g. environment variables) added via container contributions. For example, in testing creation of a workspace from https://github.com/eclipse-che/che-dashboard/, I see the following environment variables added to each container:

  • CHE_DASHBOARD_URL
  • CHE_PLUGIN_REGISTRY_URL
  • CHE_PLUGIN_REGISTRY_INTERNAL_URL
  • CLUSTER_CONSOLE_URL
  • CLUSTER_CONSOLE_TITLE
  • OPENVSX_REGISTRY_URL

While these variables are necessary for running Che, they could be added to the main development container by including them in the injected editor (e.g. the Code DevWorkspaceTemplate)

Any cases where this isn't possible should be noted as requiring special handling or potential improvements in the DevWorkspace Operator.

Describe alternatives you've considered

No response

Additional context

Related: #22491

@amisevsk amisevsk added kind/enhancement A feature request - must adhere to the feature request template. area/dashboard area/factory/dashboard Issues related to factories frontend (che user dashboard side) area/devfile-converter library used to convert v1 to v2 or v2 to v1 devfiles labels Oct 17, 2023
@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 Oct 17, 2023
@dmytro-ndp dmytro-ndp added team/A This team is responsible for the Che Operator and all its operands as well as chectl and Hosted Che severity/P1 Has a major impact to usage or development of the system. severity/P2 Has a minor but important impact to the usage or development of the system. and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. severity/P1 Has a major impact to usage or development of the system. labels Oct 18, 2023
@l0rd l0rd moved this to 📋 Backlog in Eclipse Che Team A Backlog Nov 3, 2023
@svor svor self-assigned this Nov 6, 2023
@ibuziuk ibuziuk moved this to 📅 Planned in Eclipse Che Team A Backlog Nov 8, 2023
@svor svor moved this from 📅 Planned to 🚧 In Progress in Eclipse Che Team A Backlog Nov 16, 2023
@dmytro-ndp
Copy link
Contributor

After the issue is resolved, we will be able to remove setting up CHE_PLUGIN_REGISTRY_URL and CHE_PLUGIN_REGISTRY_INTERNAL_URL variables in Dev Spaces tests pipelines: https://gitlab.cee.redhat.com/codeready-workspaces/crw-jenkins/-/blob/3.9.0/vars/dsUtil.groovy#L117-122

@svor svor moved this from 🚧 In Progress to Ready for Review in Eclipse Che Team A Backlog Nov 24, 2023
@svor svor moved this from Ready for Review to ✅ Done in Eclipse Che Team A Backlog Nov 28, 2023
@svor svor closed this as completed Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/dashboard area/devfile-converter library used to convert v1 to v2 or v2 to v1 devfiles area/factory/dashboard Issues related to factories frontend (che user dashboard side) kind/enhancement A feature request - must adhere to the feature request template. severity/P2 Has a minor but important impact to the usage or development of the system. team/A This team is responsible for the Che Operator and all its operands as well as chectl and Hosted Che
Projects
None yet
Development

No branches or pull requests

4 participants