port names should match endpoint names

[kadel]

Assuming that devfile containers have following endpoints

      endpoints:
        - name: first
          targetPort: 3000
        - name: second
          targetPort: 4000

The k8s Service that gets generated for odo should have matching port names

Current situation:

  ports:
  - name: port-3000
    port: 3000
    protocol: TCP
    targetPort: 3000
  - name: port-4000
    port: 4000
    protocol: TCP
    targetPort: 4000

/priority high
/kind bug

[mik-dass]

The service port naming is done here https://github.com/devfile/library/blob/5d88bd3c1220097161ef07d78c9fe7605be24ab7/pkg/devfile/generator/utils.go#L229.

[kadel]

The service port naming is done here https://github.com/devfile/library/blob/5d88bd3c1220097161ef07d78c9fe7605be24ab7/pkg/devfile/generator/utils.go#L229.

We should coordinate with the Devfiles team to change this.

[mik-dass]

Currently we allow multiple URLs on the same port, but k8s doesn't allow services to have two ports with the same port number and protocol combination.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[openshift-bot]

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

[kadel]

/lifecycle rotten /remove-lifecycle stale

…

On Tue, 12 Oct 2021 at 17:06, OpenShift Bot ***@***.***> wrote: Stale issues rot after 30d of inactivity. Mark the issue as fresh by commenting /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. Exclude this issue from closing by commenting /lifecycle frozen. If this issue is safe to close now please do so with /close. /lifecycle rotten /remove-lifecycle stale — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#4737 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAN65SCDEKDQSE6FHU4MULUGRFFVANCNFSM45HMQDXA> .

[openshift-bot]

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

[openshift-ci]

@openshift-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/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.

[kadel]

/reopen.

[kadel]

This problem was again raised by user on slack

I'm using odo 2.3.1 with OpenShift 4.9 and trying to set the Service port name in the devfile, but it wont stick. I always get a default value of name: "port-8080" in my Service when what I want is a port name of "http" (for Service Mesh and Kiali usage). Here is my devfile snippet, any ideas what I need to set:
components:

• container:
  endpoints:
  • exposure: public
    name: "http"
    path: /
    targetPort: 8080

[valaparthvi]

The service port naming is done here https://github.com/devfile/library/blob/5d88bd3c1220097161ef07d78c9fe7605be24ab7/pkg/devfile/generator/utils.go#L229.

These changes were made to accommodate another issue that odo was facing, see #4060, devfile/api#287, and devfile/library#51.

[yangcao77]

Currently we allow multiple URLs on the same port, but k8s doesn't allow services to have two ports with the same port number and protocol combination.

This is also another issue that tools will face, and why the change was initially made in library. As devfile allows multiple endpoints within same component to use same port. but you can only expose a port number once in a K8s service. In other word, if it behavior as described in the main issue description, the K8s service spec generated will be invalid :

      endpoints:
        - name: first
          targetPort: 3000
        - name: second
          targetPort: 3000

The k8s Service that gets generated is valid:

  ports:
  - name: first
    port: 3000
    protocol: TCP
    targetPort: 3000
  - name: second
    port: 3000
    protocol: TCP
    targetPort: 3000

[yangcao77]

The service port naming is done here https://github.com/devfile/library/blob/5d88bd3c1220097161ef07d78c9fe7605be24ab7/pkg/devfile/generator/utils.go#L229.

These changes were made to accommodate another issue that odo was facing, see #4060, devfile/api#287, and devfile/library#51.

This is not the same issue with devfile/api#287, and devfile/library#51. those were pod container port name
The service port naming conversion was done in this PR: devfile/library@ccd9d18#diff-9126bba4cbc803f4a34bfee5d830ed5af0ed5ebb1450bd7f2ebd4f554ea15a97
And IIRC, we were trying to resolve the issue mention in my last comment: #4737 (comment)

[yangcao77]

To summarize the current issue:
The devfile Spec & Odo:

• Endpoint has limitation of 63 chars length
• allows multiple endpoints under the same component shares the same port number

K8s:

• pod container port name has to be within 15 chars length
• service cannot have duplicate port exposure
  This was the reasons we decided to use our own naming conversion for pod container port name and service port name.

Now, a Odo user reports the service port name does not match the actual endpoint name. And we are looking for a more appropriate solution for the container port name & service port name.

[kadel]

• allows multiple endpoints under the same component shares the same port number

Can we make this invalid? I'm not sure if there is a case where it would be required to have endpoints exposing the same port on one container component

[elsony]

Need to check to make sure it doesn't causes problems on update/migration

[valaparthvi]

• Remove the duplicate endpoint support from odo
• Check if limiting the endpoint char length from 63 to 15 has any side effect on update/migration.

[valaparthvi]

Once devfile/api#702 is merged, we should add validation check to odo url create to ensure that the name length does not exceed 15 before writing the information to devfile otherwise it will cause an error every time the devfile is parsed.

Example

➜  odo url create --port 3030 --ingress --host `minikube ip`                                                                      
 ✓  URL nodejs-abc-cusv-3050 created for component: nodejs-abc-cusv                                                                                        

To apply the URL configuration changes, please use `odo push`      

➜  odo url create --port 3030 3030-myport --ingress --host `minikube ip`                                                                      
 ✓  URL 3030-myport created for component: nodejs-abc-cusv                                                                                        

To apply the URL configuration changes, please use `odo push`    

➜  odo push                                                                 
 ✗  1 error occurred:                                                           
        * devfile contains multiple endpoint entries with same TargetPort: 3030 

➜  odo url delete 3030-myport                                               
 ✗  failed to parse the devfile devfile.yaml, with error: 1 error occurred:     
        * devfile contains multiple endpoint entries with same TargetPort: 3030                                                                      

Scope of the issue:

1. • Add validation check for duplicate endpoint to odo url create, and tests.
2. Once container & service port name should use endpoint name  devfile/api#700 adds changes to devfile to use the endpoint names as container and service port name,
   1. • add tests to ensure this feature.
   2. • Add 15 char length validation for url name to odo url create .