-
Notifications
You must be signed in to change notification settings - Fork 67
Closed
Milestone
Description
The problem
Currently both a contribution and the attribute controller.devfile.io/merge-contribution: true are required to properly "inject" an IDE in workspace Pod:
kind: DevWorkspace
(...)
spec:
contributions:
- name: editor
kubernetes:
name: che-code
template:
components:
- name: tooling-container
attributes:
controller.devfile.io/merge-contribution: trueConsidered that:
- most of the time the template only has one container component or, if there are more than one, the developer wants to use the first container as the dev tooling container.
- the
merge-contributionattribute makes sense in a Che scenario but not in odo or dev console scenarios (yet) so we should not specify it in registry.devfile.io. - we want the devworkspace template to match the original devfile so it's easier to update it if the original devfile is updated.
we should define a convention to apply contributions when that's not explicitly specified in the template/devfile.
A proposal
- opt-in to contribution is implicit: when no component has a
merge-contributionattribute, the contribution should be applied to the first container component. - out-out to contribution is explicit: the author or a devfile should explicitly set
merge-contributiontofalseto avoid contributions to that component. - a devfile with multiple
merge-contributions: trueis invalid: the devworkspace controller should return an error if multiple components havemerge-contributionexplicitly set totrue.
Metadata
Metadata
Assignees
Labels
No labels