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

Devfile v2: Breaking change. endpoints.configuration has been moved / removed #3544

Closed
cdrage opened this issue Jul 10, 2020 · 7 comments
Closed
Assignees
Labels
area/devfile-spec Issues or PRs related to the Devfile specification and how odo handles and interprets it. kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation

Comments

@cdrage
Copy link
Member

cdrage commented Jul 10, 2020

/kind feature

Which functionality do you think we should add?

configuration key under endpoints has been removed / moved.

See the current schema: https://devfile.github.io/devfile/_attachments/api-reference.html

For example:

components:    
  - container:    
      name: runtime    
      image: maysunfaisal/springbootruntime    
      command: ['tail']    
      endpoints:    
        - name: '8080/tcp'    
          configuration:    
            public: true    
            protocol: http
          targetPort: 8080    

configuration is no longer valid.

All keys under configuration has been moved one key up.

Thus the above example is now:

components:    
  - container:    
      name: runtime    
      image: maysunfaisal/springbootruntime    
      command: ['tail']    
      endpoints:    
        - name: '8080/tcp'       
          protocol: http
          targetPort: 8080    

Why is this needed?

Change in the API.

@cdrage cdrage added the area/devfile-spec Issues or PRs related to the Devfile specification and how odo handles and interprets it. label Jul 10, 2020
@openshift-ci-robot openshift-ci-robot added the kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation label Jul 10, 2020
@cdrage cdrage changed the title Devfile v2: BRAKING CHANGE. endpoints.configuration has been moved / removed Devfile v2: Breaking change. endpoints.configuration has been moved / removed Jul 10, 2020
@girishramnani girishramnani added the triage/needs-information Indicates an issue needs more information in order to work on it. label Jul 13, 2020
@mohammedzee1000
Copy link
Contributor

mohammedzee1000 commented Jul 15, 2020

Acceptance Criteria:

  • Update the devfile struct to use new format and refactor affected functions
  • Verify and update any devfiles in our registries that need updating
  • Update corresponding odo devfile tests

@girishramnani girishramnani added triage/ready and removed triage/needs-information Indicates an issue needs more information in order to work on it. labels Jul 16, 2020
@yangcao77
Copy link
Contributor

Have you started working on this issue?
I don't want to duplicate the work, if you have started, I will wait for this one to be completed before working on #3515, since that issue is blocked by this one.

@kadel
Copy link
Member

kadel commented Jul 16, 2020

There is PR on the registry to remove configuration field. odo-devfiles/registry#21
This will resolve the current problem until we have proper fix in #2515

@yangcao77
Copy link
Contributor

@kadel Do you mean #3515?
So this one can be closed?

@kadel
Copy link
Member

kadel commented Jul 17, 2020

@kadel Do you mean #3515?

ah, wrong number, yes I meant #3515

So this one can be closed?

Yes, once odo-devfiles/registry#21 is merged

@kadel
Copy link
Member

kadel commented Jul 20, 2020

/close

@openshift-ci-robot
Copy link
Collaborator

@kadel: Closing this issue.

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/devfile-spec Issues or PRs related to the Devfile specification and how odo handles and interprets it. kind/feature Categorizes issue as a feature request. For PRs, that means that the PR is the implementation
Projects
None yet
Development

No branches or pull requests

6 participants