Odo: devfile component created out of java-quarkus component contains url with invalid name `8080/http`
/kind bug
What versions of software are you using?
Operating System: Linux
Output of odo version: odo 2.0.0
How did you run odo exactly?
```odo crate java-quarkus --starter
Validation
✓ Checking devfile existence [32581ns]
✓ Checking devfile compatibility [42265ns]
✓ Creating a devfile component from registry: DefaultDevfileRegistry [47653ns]
✓ Validating devfile component [96807ns]
Starter Project
✓ Downloading starter project quarkus-ex from https://github.com/odo-devfiles/quarkus-ex [687ms]
Please use odo push command to create the component with source deployed
## Actual behavior
In not pushed state odo describe returns 8080/http name for the URL
```odo describe-o json
{
"kind": "Component",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {
"name": "java-quarkus",
"namespace": "myproject",
"creationTimestamp": null
},
"spec": {
"app": "app",
"type": "java-quarkus",
"urls": {
"kind": "List",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {},
"items": [
{
"kind": "url",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {
"name": "8080/http",
"creationTimestamp": null
},
"spec": {
"port": 8080,
"secure": false,
"kind": "route"
},
"status": {
"state": "Not Pushed"
}
}
]
},
"storages": {
"kind": "List",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {},
"items": [
{
"kind": "storage",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {
"name": "m2",
"creationTimestamp": null
},
"spec": {
"size": "3Gi",
"path": "/home/user/.m2",
"containerName": "tools"
}
}
]
},
"ports": [
"5858"
]
},
"status": {
"state": "Not Pushed"
}
}
even with url name '8080/http` devfile validation goes through without errors
odo" push
Validation
✓ Validating the devfile [40656ns]
Creating Kubernetes resources for component java-quarkus
✓ Waiting for component to start [5s]
Applying URL changes
✓ URL 8080-http: http://8080-http-java-quarkus-myproject.apps-crc.testing/ created
Syncing to component java-quarkus
✓ Checking files for pushing [1ms]
✓ Syncing files to the component [146ms]
Executing postStart event commands for component java-quarkus
✓ Executing init-compile command "mvn -Dmaven.repo.local=/home/user/.m2/repository compile" [39s]
Executing devfile commands for component java-quarkus
✓ Executing dev-run command "mvn -Dmaven.repo.local=/home/user/.m2/repository quarkus:dev", if not running [1s]
Pushing devfile component java-quarkus
✓ Changes successfully pushed to component
After push odo describe returns 8080-http name for the component's URL
odo describe -o json
{
"kind": "Component",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {
"name": "java-quarkus",
"namespace": "myproject",
"creationTimestamp": null
},
"spec": {
"app": "app",
"type": "java-quarkus",
"urls": {
"kind": "List",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {},
"items": [
{
"kind": "url",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {
"name": "8080-http",
"creationTimestamp": null
},
"spec": {
"host": "8080-http-java-quarkus-myproject.apps-crc.testing",
"protocol": "http",
"port": 8080,
"secure": false,
"kind": "route",
"path": "/"
},
"status": {
"state": "Pushed"
}
}
]
},
"storages": {
"kind": "List",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {},
"items": [
{
"kind": "storage",
"apiVersion": "odo.dev/v1alpha1",
"metadata": {
"name": "m2",
"creationTimestamp": null
},
"spec": {
"size": "3Gi",
"path": "/home/user/.m2",
"containerName": "tools"
}
}
]
},
"env": [
{
"name": "PROJECTS_ROOT",
"value": "/projects"
},
{
"name": "DEBUG_PORT",
"value": "5858"
}
],
"ports": [
"5858"
]
},
"status": {
"state": "Pushed"
}
}
Expected behavior
If 8080/http should be originally 8080-http right after component is created. That name 8080/http with '/' should be caught during validation rather than replaced to 8080-http during deployment.
Any logs, error output, etc?
N/A
dgolovin
All 25 comments
I like the idea that odo is smart enough to do this but I also see that is kind of work would make it less transparent to odo. So while we get to the conclusion of things I have opened a PR to rename 8080/http to 8080-http.
registry PR link - https://github.com/odo-devfiles/registry/pull/58
girishramnani
on 24 Oct 2020
@kadel I was think what if this conversion is done when the devfile is downloaded so the moment someone uses any other commands they see - 8080-http instead of 8080/http. This can be done as part of post validation work in the parser?
girishramnani
on 30 Oct 2020
actually I remembered that we need to decouple the url created from the name of the url. the name of the url should be "8080/http" but the url should have "8080-http". but this shouldn't change the name of the url to "8080-http"
girishramnani
on 30 Oct 2020
so I tried doing the above where the name stays 8080/http but the metadata.name for the route becomes 8080/http-java-quarkus
which is invalid with error
unable to create route: error creating route: Route.route.openshift.io "8080/http-java-quarkus" is invalid: [metadata.name: Invalid value: "8080/http-java-quarkus": a DNS-1123 subdomain must consist of lower case alphanumeric characters
so now we either change the 8080/http the moment we download the devfile or we fail on validation @kadel
girishramnani
on 30 Oct 2020
blocked on the decision
girishramnani
on 30 Oct 2020
so now we either change the
8080/httpthe moment we download the devfile or we fail on validation @kadel
We should not change it. If the name is defined as 8080/http it either needs to stay like this or the validation needs to fail.
This depends on Devfile spec. Assuming the current definition where the endpoint name is just plain string without any other restriction the correct way is not to fail.
The problem is that we use an endpoint name for Ingress/Route name. We need to decouple these two fields.
When the Ingres/Route is generated we should generate valid metadata.name for Kubernetes resource (this can be based on endpoint name). And save the actual name as a label. From that point, the label value should be considered as an URL name.
If the user runs odo url create 8080/http or if devfile contains endpoint with name: 8080/http the odo should generate Ingress or Route with label odo.openshift.io/url-name: 8080/http.
We should use the value of this label everywhere in odo as an URL name (including in env.yaml).
If odo needs to query Cluster for url, it shouldn't query for the resource name, but it should always use label selectors.
For example, if odo needs a list of all URLs for a component named frontend in application myapp it should list all Ingress and Routes that have app.kubernetes.io/instance: frontend and app.kubernetes.io/part-of: myapp labels and in the output display values from odo.openshift.io/url-name label.
metadata.name should not play any role in this. Even if we would start using random generated metada.name everything should keep working (not suggesting that we should do this :-) )
kadel
on 30 Oct 2020
yeah but the approach you are mentioning will break existing urls present in working devfile components. any transition plans? or plain old delete and create again?
girishramnani
on 2 Nov 2020
So the approach with labels won't work :/ Label values must be alphanumeric with _ - . no other characters are allowed.
The only place we can store URL name in the cluster is as annotations, everything else will have restrictions.
I've opened an issue on the Devfile spec repo about this
kadel
on 2 Nov 2020
one approach that came out of the discussion was to store the name in the annotations, but then the odo.openshift.io/url-name becomes an annotation and cannot be used in label selector so we can store
url-identifier in the label ( url-name would be misleading ) which converts / to - so label selection is possible and we have annotation that we use as a name.
We could have gone with just adding a validation for the url name but the architectural reasoning that @kadel provided was that we cannot drive the validation rules in the devfile spec based on odo's implementation detail.
girishramnani
on 2 Nov 2020
I am thinking if I change many things in the url package that might conflict with the url refactor.
girishramnani
on 4 Nov 2020
@kadel It is really a big usability problem right now. It affects especially initial user experience for quarkus projects. Because right after creating the project this leads to problems to open it in browser and new users left hanging with project that looks totally broken without no easy way out.
Is that possible as a hot fix just update url name in devfile to be the same as after deployment?
dgolovin
on 10 Nov 2020
@dgolovin as we changed the url from 8080/http to 8080-http in quarkus to temporarily resolve the problem so currently is this an urgent issue?
girishramnani
on 17 Nov 2020
@girishramnani just verified it. Works for me OOTB now.
dgolovin
on 19 Nov 2020
A long term solution is needed here or else we would be changing devfiles in future whenever this occurs
solution -
one approach that came out of the discussion was to store the name in the annotations, but then the
odo.openshift.io/url-namebecomes an annotation and cannot be used in label selector so we can store
url-identifierin the label (url-namewould be misleading ) which converts/to-so label selection is possible and we haveannotationthat we use as a name.We could have gone with just adding a validation for the url name but the architectural reasoning that @kadel provided was that we cannot drive the validation rules in the devfile spec based on odo's implementation detail.
girishramnani
on 28 Dec 2020
Also this solution would be a breaking change - would break existing components
girishramnani
on 28 Dec 2020
I've opened an issue on the Devfile spec repo about this
Can you share the issue number please? @kadel
dharmit
on 28 Dec 2020
Moving this out of this sprint for time being since the discussion and inputs need to come in from different teams involved in this.
dharmit
on 28 Dec 2020
the devfile spec was updated https://github.com/devfile/api/issues/201 Name and Id need to follow the same rules ad k8s names
kadel
on 17 Mar 2021
so then this is a non-issue now? or we need to update the devfile library to close this issue? @kadel ?
girishramnani
on 6 May 2021
Added to sprint just so we can discuss if we need to close this issue
girishramnani
on 6 May 2021
So the idea here is that we need to validate if the current version of api ( currently in odo ) enforces the validation mentioned in https://github.com/devfile/api/issues/201 - if so then we can close this issue or else
the scope of this issue would be upgrade to the latest version of api
girishramnani
on 10 May 2021
so to confirm this I created a nodejs devfile and changed the endpoint to look like this
endpoints:
- name: 3000/http
targetPort: 3000
which is invalid.
And when I tried to push this devfile it failed
odo push
✗ invalid devfile schema. errors :
- components.0.container.endpoints.0.name: Does not match pattern '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$'
Now its not the most descriptive of errors but does enforce the validation. Should I consider this to complete the AC of this issue @kadel or we wanna enhance something here?
girishramnani
on 10 May 2021
it gets cought in odo create
odo create nodejs --devfile devfile.yaml
Devfile Object Validation
✓ Creating a devfile component from devfile path: /Users/girish/GoProjects/src/github.com/openshift/odo/ts2/devfile.yaml [61260ns]
Validation
✓ Validating if devfile name is correct [34581ns]
✗ invalid devfile schema. errors :
- components.0.container.endpoints.0.name: Does not match pattern '^[a-z0-9]([-a-z0-9]*[a-z0-9])?$'
Confirmed that this should close the issue
girishramnani
on 10 May 2021
Related issues
prietyc123
·
7Comments
dharmit
·
6Comments
dharmit
·
8Comments
maysunfaisal
·
8Comments
valaparthvi
·
3Comments
Most helpful comment
I like the idea that odo is smart enough to do this but I also see that is kind of work would make it less transparent to odo. So while we get to the conclusion of things I have opened a PR to rename
8080/httpto8080-http.registry PR link - https://github.com/odo-devfiles/registry/pull/58