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

Need to fix version v1alpha1 of devfile API #111

Closed
amisevsk opened this issue Aug 11, 2020 · 0 comments · Fixed by #125
Closed

Need to fix version v1alpha1 of devfile API #111

amisevsk opened this issue Aug 11, 2020 · 0 comments · Fixed by #125
Labels
area/api Enhancement or issue related to the api/devfile specification area/devworkspace Improvent or additions to the DevWorkspaces CRD severity/blocker Issues that prevent developers from working
Milestone

Comments

@amisevsk
Copy link
Contributor

Is your feature request related to a problem? Please describe.

Recent discussions around issues such as #102 has brought forward the realization that we haven't actually fixed the devfile spec for v1alpha1 and it is still possible to merge breaking changes there. This is an issue because this API is already consumed by the devworkspace operator and the OpenShift console, though this usage is a fairly minimal subset of the spec:

kind: DevWorkspace
apiVersion: workspace.devfile.io/v1alpha1
metadata:
  name: web-terminal
  annotations:
    controller.devfile.io/restricted-access: "true"
  labels:
    console.openshift.io/terminal: "true"
spec:
  started: true
  routingClass: 'web-terminal'
  template:
    components:
      - plugin:
          name: web-terminal
          id: redhat-developer/web-terminal/4.5.0

Having conflicting specs with the workspace.devfile.io/v1alpha1/DevWorkspace GVK will make it impossible to use v1alpha1, and any breaking changes that aren't compatible with the yaml above will break the devworkspace operator in a way that's not easily fixed, since it likely isn't possible to migrate between specs within the same GVK.

Describe the solution you'd like

We need to fix v1alpha1 as soon as possible, and push any not-backwards-compatible changes to a v1alpha2 or v1beta1 version instead.

@amisevsk amisevsk added area/api Enhancement or issue related to the api/devfile specification area/devworkspace Improvent or additions to the DevWorkspaces CRD severity/blocker Issues that prevent developers from working labels Aug 11, 2020
@kadel kadel added this to the 2.0 milestone Aug 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Enhancement or issue related to the api/devfile specification area/devworkspace Improvent or additions to the DevWorkspaces CRD severity/blocker Issues that prevent developers from working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants