odo should automatically create url for previewUrl

[kadel]

/kind user-story

User Story

As a user I want to just run odo push after cloning project with devfile.yaml in the project root and have the project running and accessible in the cluster, without executing any other command.

Acceptance Criteria

• odo push should automatically create URL for any previewUrl defined in devfile.yaml
• Url should be by default represented by Route on OpenShift and by Ingress on Kuberenetes (Add option to create Route instead of Ingress #2727)
• odo push against k8s cluster with devfile that has previewUrl should show a warning listing all previewUrl ports and inform user that she/he needs to use odo url create command to specify host for URL
• odo push --ignorePreviewUrl should ignore all previewUrl in the devfile. No Ingress or Route will be auto-created based on the previewUrls in devfile.yaml

Notes

PreviewUrl documentation https://github.com/redhat-developer/devfile/blob/master/docs/devfile.md#previewurl

• This might be possible just for OpenShift, and for Kubernetes, the Ingress host might be required.
• What to do for Kubernetes than?
  • Options:
    • fail and tell the user to run odo url create --port 9080 --host mycluster.example.com ?
    • ignore preview and tell user to run odo url create with --host to create url?

Example:
For the following devfile, odo push should automatically create URL for port 9080

apiVersion: 1.0.0
metadata:
  generateName: openLiberty
attributes:
  odo.autorestart: "false"
projects:
  - name: openLiberty
    source:
      type: git
      location: https://github.com/rajivnathan/openLiberty.git
components:
  - alias: devruntime
    mountSources: true
    type: dockerimage
    image: jeevandroid/open-liberty-dev:latest
    memoryLimit: 768Mi
    volumes:
      - name: m2
        containerPath: /home/user/.m2
    endpoints:
      - name: 9080/tcp
        port: 9080
      - name: 9443/tcp
        port: 9443
commands:
  - actions:
      - command: /artifacts/bin/build.sh
        component: devruntime
        type: exec
        workdir: /projects/openLiberty
    name: devBuild
  - name: devRun
    previewUrl:
      port: 9080
      path: /
    actions:
      - type: exec
        command: /artifacts/bin/run.sh
        component: devruntime
        workdir: /projects/openLiberty

/kind user-story
/area OpenShift
/area url
/area devfile
/priority medium

[johnmcollier]

I'm in favour of option #2 for Kube:

• If a preview URL is set in the devfile, and the user hasn't already run odo url create ..., then we tell them to run it after odo push completes.

What about also adding --host and --port flags to odo push? Then the user could specify them during their first odo push, if they wish.

[kadel]

• If a preview URL is set in the devfile, and the user hasn't already run odo url create ..., then we tell them to run it after odo push completes.

+1

What about also adding --host and --port flags to odo push? Then the user could specify them during their first odo push, if they wish.

I was thinking about that.
But I'm afraid that it would get too complicated. For example, there might be multiple previewUrls in a devfile. Plus I would like to be a little bit careful with adding flags to odo push as it could get quickly out of the hands.
Much better is to have --now flag in most of the commands. When used it will execute push action automatically. For example, you can do odo url create --now instead of odo url create; odo push

[mik-dass]

But I'm afraid that it would get too complicated. For example, there might be multiple previewUrls in a devfile. Plus I would like to be a little bit careful with adding flags to odo push as it could get quickly out of the hands.
Much better is to have --now flag in most of the commands. When used it will execute push action automatically.

+1

@kadel @girishramnani Should we save this previewURL in the env.yaml file before push? Also what if the previewURL port is not exposed by the component? Should we fail or ignore?

[girishramnani]

blocked on #2885

[kadel]

Should we save this previewURL in the env.yaml file before push?

If needed we can save some information there.

Also what if the previewURL port is not exposed by the component? Should we fail or ignore?

Not sure to be honest. We might have to check the devfile spec if this is valid or verify what Che does in this situation.

[kadel]

One possible way how this could be implemented is:

when using OpenShift:

when odo push detects that there is a previewURL present in the devfile (this needs to happen early in the process) it does the equivalent of odo url create --port <previewURL.port> (saves the information to the env.yaml) and then continues with the normal odo push process

when using Kubernetes:

when odo push detects that there is a previewURL present in the devfile (this needs to happen early in the process) it shows the warning message: "previewURL for port is defined in devfile, but it cannot be automatically created. Please use 'odo url create' command to create url"

when using Docker:

when odo push detects that there is a previewURL present in the devfile (this needs to happen early in the process) it does the equivalent of odo url create --port <previewURL.port> (saves the information to the env.yaml) and then continues with the normal odo push process

When doing the equivalent of odo url create --port <previewURL.port> for OpenShift or Docker, the URL name should be autogenerated based on the rules that we normally have. If there is a conflict with URL that is already defined in env.yaml, odo puh should just show a warning and skip url creation

[mik-dass]

@kadel I also feel the creation of previewURL should be done only on the first push.

odo create nodejs
odo push
// preview URL created of route kind
odo url delete <name> -f
odo url create <new-name> --ingress --host com
odo push

In this scenario odo push shouldn't create the preview URL again. So I guess it's best to only create preview URLs only during first push.

Also on a openshift cluster

odo create nodejs
odo url create <new-name> --ingress --host com
odo push
// preview URL created of route kind

So we should detect if a URL already exists for a certain port and avoid creation of preview URLs.

[kadel]

@kadel I also feel the creation of previewURL should be done only on the first push.

I would actually be ok if it creates url again. If It is defined in devfile it should be created. If someone wants to really delete the URL then it should be deleted from devfile.yaml

Otherwise, you will have problems when someone adds previewUrl into devfile.yaml after it was pushed.

odo create nodejs
odo push
// preview URL created of route kind
odo url delete <name> -f
odo push
# the url should be recreated

So we should detect if a URL already exists for a certain port and avoid creation of preview URLs.

Yes

[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

[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-robot]

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