Preview url on server #14713

sparkoo · 2019-09-30T09:47:34Z

What does this PR do?

Constructs preview url for commands at start-up time. It reuses already defined endpoints or create new Service + Ingress/Route pair, when no suitable existing endpoint found.

test image: quay.io/mvala/che-server:previewurl

example devfile with dockerimage component

---
apiVersion: 1.0.1-beta
metadata:
  name: dummy-go-server
projects:
  -
    name: dummy-http-server
    source:
      type: git
      location: "https://github.com/sparkoo/dummy-http-server.git"
components:
  -
    type: dockerimage
    image: quay.io/eclipse/che-golang-1.10:nightly
    alias: go-cli
    mountSources: true
    memoryLimit: 256Mi
commands:
  -
    name: run on 8081 and /hello path
    previewUrl:
      port: 8081
      path: "/hello"
    actions:
      -
        type: exec
        component: go-cli
        command: "go run main.go 8081 /hello"
        workdir: ${CHE_PROJECTS_ROOT}/dummy-http-server

example devfile with kubernetes component (change component type to `openshift` for openshift component should be enough)

---
apiVersion: 1.0.1-beta
metadata:
  name: dummy-go-k8s
projects:
  -
    name: dummy-http-server
    source:
      type: git
      location: "https://github.com/sparkoo/dummy-http-server.git"
components:
  -
    type: kubernetes
    alias: go-k8s
    mountSources: true
    referenceContent: |
          kind: List
          items:
          - kind: Pod
            apiVersion: v1
            metadata:
              name: go-runner
            spec:
              containers:
                - name: go-110-server
                  image: quay.io/eclipse/che-golang-1.10:nightly
                - name: go-112-server
                  image: quay.io/eclipse/che-golang-1.12:nightly
commands:
  -
    name: run on 8080 and /hello
    previewUrl:
      port: 8080
      path: /hello
    actions:
      -
        type: exec
        component: go-k8s
        command: "go run main.go 8080 /hello"
        workdir: ${CHE_PROJECTS_ROOT}/dummy-http-server

What issues does this PR fix or reference?

#14893

This Theia issue has to be fixed to get previewurl fully working #14892

Docs PR

devfile schema+diagram PreviewUrl redhat-developer/devfile#52
che-docs Preview URL documentation che-docs#839

sleshchenko

I like this approach more than previous with logic in WorkspaceService

...-core-api-workspace/src/main/java/org/eclipse/che/api/workspace/server/WorkspaceService.java

...rkspace/src/test/resources/devfile/schema_test/command/devfile_command_with_preview_url.yaml

...ore-sql-schema/src/main/resources/che-schema/7.3.0/1__add_preview_url_to_devfile_command.sql

...main/java/org/eclipse/che/workspace/infrastructure/kubernetes/KubernetesInternalRuntime.java

che-bot · 2019-10-04T22:46:51Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has failed:

build details
"che-server" docker image: maxura/che-server:14713
test artifacts
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "crw-ci-test" to rerun the test.

che-bot · 2019-10-04T23:48:33Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has failed:

build details
"che-server" docker image: maxura/che-server:14713
test artifacts
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "crw-ci-test" to rerun the test.

che-bot · 2019-10-05T00:27:46Z

E2E tests of Eclipse Che Multiuser on OCP has been successful:

Build details
Test report
docker image: eclipseche/che-server:14713

che-bot · 2019-10-05T20:36:49Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has failed:

build details
"che-server" docker image: maxura/che-server:14713
test artifacts
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "crw-ci-test" to rerun the test.

che-bot · 2019-10-05T21:16:45Z

E2E tests of Eclipse Che Multiuser on OCP has been successful:

Build details
Test report
docker image: eclipseche/che-server:14713

che-bot · 2019-10-07T08:35:30Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has been successful:

build details
logs and configs
"che-server" docker image: maxura/che-server:14713

che-bot · 2019-10-07T09:16:40Z

E2E tests of Eclipse Che Multiuser on OCP has been successful:

Build details
Test report
docker image: eclipseche/che-server:14713

che-bot · 2019-10-07T09:35:21Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has been successful:

build details
logs and configs
"che-server" docker image: maxura/che-server:14713

che-bot · 2019-10-07T10:27:58Z

E2E tests of Eclipse Che Multiuser on OCP has been successful:

Build details
Test report
docker image: eclipseche/che-server:14713

che-bot · 2019-10-07T12:54:54Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has been successful:

build details
logs and configs
"che-server" docker image: maxura/che-server:14713

che-bot · 2019-10-07T13:36:44Z

E2E tests of Eclipse Che Multiuser on OCP has failed:

Build details
Test report
docker image: eclipseche/che-server:14713
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "ci-test" to rerun the test.

che-bot · 2019-10-07T13:58:10Z

E2E tests of Eclipse Che Multiuser on OCP has failed:

Build details
Test report
docker image: eclipseche/che-server:14713
https://github.com/orgs/eclipse/teams/eclipse-che-qa please check this report.
Use command "ci-test" to rerun the test.

che-bot · 2019-10-07T14:07:22Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has been successful:

build details
logs and configs
"che-server" docker image: maxura/che-server:14713

skabashnyuk · 2019-10-07T14:42:22Z

@sparkoo can you add some examples of devfile in pr description?

sparkoo · 2019-10-07T15:47:12Z

@sparkoo can you add some examples of devfile in pr description?

yes, done

che-bot · 2019-10-07T15:51:20Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has been successful:

build details
logs and configs
"che-server" docker image: maxura/che-server:14713

che-bot · 2019-10-07T16:36:09Z

E2E tests of Eclipse Che Multiuser on OCP has been successful:

Build details
Test report
docker image: eclipseche/che-server:14713

che-bot · 2019-10-07T22:19:27Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has been successful:

build details
logs and configs
"che-server" docker image: maxura/che-server:14713

che-bot · 2019-10-07T22:30:00Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has been successful:

build details
logs and configs
"che-server" docker image: maxura/che-server:14713

che-bot · 2019-10-07T23:08:40Z

E2E tests of Eclipse Che Multiuser on OCP has been successful:

Build details
Test report
docker image: eclipseche/che-server:14713

Signed-off-by: Michal Vala <mvala@redhat.com>

…le generator Signed-off-by: Michal Vala <mvala@redhat.com>

…or class Signed-off-by: Michal Vala <mvala@redhat.com>

Signed-off-by: Michal Vala <mvala@redhat.com>

…resses, preload ingresses/routes to avoid multiple k8s api querying Signed-off-by: Michal Vala <mvala@redhat.com>

Signed-off-by: Michal Vala <mvala@redhat.com>

…ntext Signed-off-by: Michal Vala <mvala@redhat.com>

Signed-off-by: Michal Vala <mvala@redhat.com>

…inks map Signed-off-by: Michal Vala <mvala@redhat.com>

Signed-off-by: Michal Vala <mvala@redhat.com>

…s with abstract ancestor Signed-off-by: Michal Vala <mvala@redhat.com>

Signed-off-by: Michal Vala <mvala@redhat.com>

che-bot · 2019-10-24T08:12:04Z

E2E Happy path tests of Eclipse Che Single User on K8S (minikube v1.1.1) has been successful:

build details
logs and configs
"che-server" docker image: maxura/che-server:14713

che-bot · 2019-10-24T09:25:10Z

E2E tests of Eclipse Che Multiuser on OCP has been successful:

Build details
Test report
docker image: eclipseche/che-server:14713

che-bot added kind/enhancement A feature request - must adhere to the feature request template. status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. labels Sep 30, 2019

sleshchenko reviewed Sep 30, 2019

View reviewed changes

This was referenced Sep 30, 2019

🚧 Preview url #14679

Closed

Add previewURL support in Devfile format #13945

Closed

sparkoo mentioned this pull request Oct 7, 2019

Theia doesn't update command's previewUrl on 2nd workspace start #14803

Closed

5 tasks

sparkoo changed the title ~~🚧 Preview url 2 (at startup time)~~ 🚧 Preview url Oct 7, 2019

sparkoo marked this pull request as ready for review October 7, 2019 23:31

sparkoo requested review from amisevsk and l0rd as code owners October 7, 2019 23:31

sparkoo and others added 25 commits October 24, 2019 10:00

utility class for services

8a99193

Signed-off-by: Michal Vala <mvala@redhat.com>

replace CRC32 hash with simple string hashCode for preview url variab…

a4dcb03

…le generator Signed-off-by: Michal Vala <mvala@redhat.com>

ensure previewurl variable name is positive integer, test the generat…

42884e2

…or class Signed-off-by: Michal Vala <mvala@redhat.com>

update preview url variable test

2a69a6c

Signed-off-by: Michal Vala <mvala@redhat.com>

move sql update to 7.4.0

9f74bfd

Signed-off-by: Michal Vala <mvala@redhat.com>

fix db migration script name

2abaa28

Signed-off-by: Michal Vala <mvala@redhat.com>

fix previewurl query params

1ce4214

Signed-off-by: Michal Vala <mvala@redhat.com>

update previewurl test devfile name

45eaa33

Signed-off-by: Michal Vala <mvala@redhat.com>

update PreviewUrl interface javadocs

dd4eb58

Signed-off-by: Michal Vala <mvala@redhat.com>

check both port's int and string values when searching for routes/ing…

8e3b8b6

…resses, preload ingresses/routes to avoid multiple k8s api querying Signed-off-by: Michal Vala <mvala@redhat.com>

more readable checking port

aea7e4b

Signed-off-by: Michal Vala <mvala@redhat.com>

better handle unexpected KubernetesNamespace instance in OpenShift co…

3dac2b6

…ntext Signed-off-by: Michal Vala <mvala@redhat.com>

check casting ingresses/routes

8ca626d

Signed-off-by: Michal Vala <mvala@redhat.com>

propagate warning into the environment

dadf6e3

Signed-off-by: Michal Vala <mvala@redhat.com>

refactor

45c5a95

Signed-off-by: Michal Vala <mvala@redhat.com>

rename PreviewUrlEndpointProvisioner to PreviewUrlExposer

a9db1f1

Signed-off-by: Michal Vala <mvala@redhat.com>

don't use IntOrString.getKind to determine type of the value

11c8056

Signed-off-by: Michal Vala <mvala@redhat.com>

send preview url path in command's attribute instead of full url in l…

2227f6d

…inks map Signed-off-by: Michal Vala <mvala@redhat.com>

load services just once, before looping commands

f3dd8b0

Signed-off-by: Michal Vala <mvala@redhat.com>

Tmp

70f45ac

refactor Preview Url command provisioners for openshift and kubernete…

727714e

…s with abstract ancestor Signed-off-by: Michal Vala <mvala@redhat.com>

set empty ingresses and services explicitly to environment in tests

27d6ff8

Signed-off-by: Michal Vala <mvala@redhat.com>

use existing serviceport when exposing new ingress

93e1691

Signed-off-by: Michal Vala <mvala@redhat.com>

fix test compile, explicitly set empty routes/services

acc3a8c

Signed-off-by: Michal Vala <mvala@redhat.com>

inlined unnecessary private method

c77520e

Signed-off-by: Michal Vala <mvala@redhat.com>

sparkoo merged commit 5d38d7a into eclipse-che:master Oct 24, 2019

sparkoo deleted the previewUrl2 branch October 24, 2019 09:40

sparkoo mentioned this pull request Oct 24, 2019

Server support for previewurl #14893

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Preview url on server #14713

Preview url on server #14713

sparkoo commented Sep 30, 2019 •

edited

Loading

sleshchenko left a comment

che-bot commented Oct 4, 2019

che-bot commented Oct 4, 2019

che-bot commented Oct 5, 2019

che-bot commented Oct 5, 2019

che-bot commented Oct 5, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

skabashnyuk commented Oct 7, 2019

sparkoo commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 24, 2019

che-bot commented Oct 24, 2019

Preview url on server #14713

Preview url on server #14713

Conversation

sparkoo commented Sep 30, 2019 • edited Loading

What does this PR do?

What issues does this PR fix or reference?

Docs PR

sleshchenko left a comment

Choose a reason for hiding this comment

che-bot commented Oct 4, 2019

che-bot commented Oct 4, 2019

che-bot commented Oct 5, 2019

che-bot commented Oct 5, 2019

che-bot commented Oct 5, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

skabashnyuk commented Oct 7, 2019

sparkoo commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 7, 2019

che-bot commented Oct 24, 2019

che-bot commented Oct 24, 2019

sparkoo commented Sep 30, 2019 •

edited

Loading