Run dashboard in a dedicated deployment with helm chart #18093

sleshchenko · 2020-10-12T08:47:41Z

What does this PR do?

Run dashboard in a dedicated deployment.
Note that after this PR Che Server tomcat will continue serving dashboard resources as well due backward compatibility reason. Tomcat will stop serving dashboard resources only after two sprints after we move helm + che operator to new deployment way.

Screenshot/screencast of this PR

What issues does this PR fix or reference?

It fixes #18076

How to test this PR?

I checked that Dashboard and Dashboard Next are accessible and work as expected in different combination Singlehost/Multihost/DefaultHost/Gateway + Single/Multi-user

note that I generated certificates with chectl before I executed helm command: (chectl server:start --platform=minikube --installer=helm && helm delete che)
custom che server image is used to make sure that dashboard is loaded from Apache server but not Tomcat;

Singlehost

Singlehost Single-User Che

export CHART_DIR=/home/sleshche/projects/che/deploy/kubernetes/helm/che
helm upgrade --install che \
  --force \
  --namespace che \
  --set global.cheDomain=192.168.99.100.nip.io \
  --set global.ingressDomain=192.168.99.100.nip.io \
  --set cheImage=sleshchenko/che-server:cut-dashboard \
  --set global.serverStrategy=single-host \
  --set global.tls.useSelfSignedCerts=true \
  -f ${CHART_DIR}/values/tls.yaml \
  ${CHART_DIR}

Singlehost Mutli-User Che

export CHART_DIR=/home/sleshche/projects/che/deploy/kubernetes/helm/che
helm upgrade --install che \
  --force \
  --namespace che \
  --set global.cheDomain=192.168.99.100.nip.io \
  --set global.ingressDomain=192.168.99.100.nip.io \
  --set cheImage=sleshchenko/che-server:cut-dashboard \
  --set global.serverStrategy=single-host \
  --set global.tls.useSelfSignedCerts=true \
  -f ${CHART_DIR}/values/tls.yaml \
  -f ${CHART_DIR}/values/multi-user.yaml \
  ${CHART_DIR}

SingleHost Gateway

SingleHost Gateway Single-User Che

export CHART_DIR=/home/sleshche/projects/che/deploy/kubernetes/helm/che
helm upgrade --install che \
    --force \
    --namespace che \
    --set global.cheDomain=192.168.99.100.nip.io \
    --set global.ingressDomain=192.168.99.100.nip.io \
    --set cheImage=sleshchenko/che-server:cut-dashboard \
    --set global.tls.useSelfSignedCerts=true \
    --set global.serverStrategy=single-host \
    --set cheSinglehostGateway.deploy=true \
    --set global.singleHostExposure=gateway \
    -f ${CHART_DIR}/values/tls.yaml \
    ${CHART_DIR}

SingleHost Gateway Mutli-User Che

export CHART_DIR=/home/sleshche/projects/che/deploy/kubernetes/helm/che
helm upgrade --install che \
    --force \
    --namespace che \
    --set global.cheDomain=192.168.99.100.nip.io \
    --set global.ingressDomain=192.168.99.100.nip.io \
    --set cheImage=sleshchenko/che-server:cut-dashboard \
    --set global.tls.useSelfSignedCerts=true \
    --set global.serverStrategy=single-host \
    --set cheSinglehostGateway.deploy=true \
    --set global.singleHostExposure=gateway \
    -f ${CHART_DIR}/values/tls.yaml \
    -f ${CHART_DIR}/values/multi-user.yaml \
    ${CHART_DIR}

Multi Host

MultiHost Single-User Che

  export CHART_DIR=/home/sleshche/projects/che/deploy/kubernetes/helm/che
  helm upgrade --install che \
  --force \
  --namespace che \
  --set global.cheDomain=192.168.99.100.nip.io \
  --set global.ingressDomain=192.168.99.100.nip.io \
  --set cheImage=sleshchenko/che-server:cut-dashboard \
  --set global.serverStrategy=multi-host \
  --set global.tls.useSelfSignedCerts=true \
  -f ${CHART_DIR}/values/tls.yaml \
  ${CHART_DIR}

MultiHost Mutli-User Che

  export CHART_DIR=/home/sleshche/projects/che/deploy/kubernetes/helm/che
  helm upgrade --install che \
    --force \
    --namespace che \
    --set global.cheDomain=192.168.99.100.nip.io \
    --set global.ingressDomain=192.168.99.100.nip.io \
    --set cheImage=sleshchenko/che-server:cut-dashboard \
    --set global.serverStrategy=multi-host \
    --set global.tls.useSelfSignedCerts=true \
    -f ${CHART_DIR}/values/tls.yaml \
    -f ${CHART_DIR}/values/multi-user.yaml \
    ${CHART_DIR}

Default Host

Note: it's without TLS, seems that does not work with TLS properly.

Default Host Single-User Che

export CHART_DIR=/home/sleshche/projects/che/deploy/kubernetes/helm/che
helm upgrade --install che \
    --force \
    --namespace che \
    --set global.cheDomain=192.168.99.100 \
    --set global.ingressDomain=192.168.99.100 \
    --set cheImage=sleshchenko/che-server:cut-dashboard \
    --set global.tls.useSelfSignedCerts=false \
    --set global.serverStrategy=default-host \
${CHART_DIR}

Default Host Mutli-User Che

export CHART_DIR=/home/sleshche/projects/che/deploy/kubernetes/helm/che
helm upgrade --install che \
    --force \
    --namespace che \
    --set global.cheDomain=192.168.99.100 \
    --set global.ingressDomain=192.168.99.100 \
    --set cheImage=sleshchenko/che-server:cut-dashboard \
    --set global.tls.useSelfSignedCerts=false \
    --set global.serverStrategy=default-host \
    -f ${CHART_DIR}/values/multi-user.yaml \
    ${CHART_DIR}

PR Checklist

As the author of this Pull Request I made sure that:

Reviewers

Reviewers, please comment how you tested the PR when approving it.

che-bot · 2020-10-12T09:12:57Z

❌ E2E Happy path tests failed ❗

See Details

Jenkins job
test report
logs and configs
Happy path tests DevFile
image: maxura/che-server:18093

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

ℹ️ Use comment "[crw-ci-test]" to rerun happy path E2E test.

che-bot · 2020-10-12T09:20:53Z

❌ E2E Happy path tests failed ❗

See Details

Jenkins job
test report
logs and configs
Happy path tests DevFile
image: maxura/che-server:18093

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

ℹ️ Use comment "[crw-ci-test]" to rerun happy path E2E test.

che-bot · 2020-10-12T13:04:17Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:18093

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

deploy/kubernetes/helm/che/templates/dashboard-deployment.yaml

…g issues

…rs has

che-bot · 2020-10-12T15:07:58Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:18093

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

sparkoo · 2020-10-12T15:16:02Z

deploy/kubernetes/helm/che/templates/dashboard-traefik-gateway-configmap.yaml

+    http:
+      routers:
+        che-dashboard:
+          rule: "PathPrefix(`/dashboard/`)"


does it work without end slash?

Checking, I assume that if we miss end slash, then we'll get broken redirects, like /dashboardanythings -> /dashboard since it's currently done by Che Server.

First Dashboard ingress with end /, the second without. Do you see any issue with end slash?

Added end slash to ingress http path as well.

sparkoo · 2020-10-12T15:17:19Z

What about put dashboard yamls to custom-charts? We would avoid the need of dashboard- file prefix.

sleshchenko · 2020-10-13T07:23:35Z

What about put dashboard yamls to custom-charts? We would avoid the need of dashboard- file prefix.

I thought about it and decided not to move it there since the current custom chart is used for a bit independent components that can be optional if external is configured. I don't see a good case where dashboard can be deployed independently from Che Server, as well as Che Server without Dashboard. It's a kind of cyclic dependency.
But If you have a strong opinion that we should move the dashboard to custom charts, I can try to do it.
@sparkoo WDYT?

sparkoo · 2020-10-13T07:50:35Z

@sleshchenko not a strong opinion about that. I just think it would make things cleaner, not mixing 2 "independent" deployments in one folder. One usecase I can think of now is swap between dashboard and dashboard-next, where you could easily control with simple boolean values what to deploy/use.

if you think it does not make sense, I'm ok with current state as well.

che-bot · 2020-10-13T07:55:46Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:18093

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

.ci/set_tag_version_images_linux.sh

sleshchenko · 2020-10-13T08:13:46Z

One usecase I can think of now is swap between dashboard and dashboard-next, where you could easily control with simple boolean values what to deploy/use.

Good example, but we are not going to support different deployments for Dashboard and Dashboard Next. They are going to be run in one deployment. It's declared in #17647 (comment)

che-bot · 2020-10-13T08:22:17Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:18093

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

sparkoo · 2020-10-13T10:17:45Z

One usecase I can think of now is swap between dashboard and dashboard-next, where you could easily control with simple boolean values what to deploy/use.

Good example, but we are not going to support different deployments for Dashboard and Dashboard Next. They are going to be run in one deployment. It's declared in #17647 (comment)

Another example might be to be able to deploy che-server only for tests. But we're not doing that atm... As I've said, I'm not against the current PR. If you think it's better as is, let's do it.

che-bot · 2020-10-19T11:59:42Z

✅ E2E Happy path tests succeed 🎉

See Details

Jenkins job
logs and configs
Happy path tests DevFile
image: maxura/che-server:18093

Tested with Eclipse Che Multiuser User on K8S (minikube v1.1.1)

che-bot added status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. kind/task Internal things, technical debt, and to-do tasks to be performed. labels Oct 12, 2020

sleshchenko force-pushed the separateDashboard branch 2 times, most recently from c5273ec to 767139d Compare October 12, 2020 08:59

Run dashboard in a dedicated deployment

9817965

sleshchenko force-pushed the separateDashboard branch from 9eed3f7 to 9817965 Compare October 12, 2020 12:44

sleshchenko marked this pull request as ready for review October 12, 2020 12:45

sleshchenko requested a review from nickboldt as a code owner October 12, 2020 12:45

sleshchenko requested review from sparkoo and metlos October 12, 2020 12:46

sleshchenko changed the title ~~Run dashboard in a dedicated deployment~~ Run dashboard in a dedicated deployment with helm chart Oct 12, 2020

skabashnyuk reviewed Oct 12, 2020

View reviewed changes

deploy/kubernetes/helm/che/templates/dashboard-deployment.yaml Show resolved Hide resolved

sleshchenko added 4 commits October 12, 2020 17:37

fixup! Run dashboard in a dedicated deployment

dd7bc79

configure dashboard probes to requests /dashboard/ to detect packagin…

f7ceca9

…g issues

Apply the same probes configuration as registries apache servers has

8d49e54

fixup! Apply the same probes configuration as registries apache serve…

74b0ae3

…rs has

sparkoo reviewed Oct 12, 2020

View reviewed changes

Add end slash to dashboard path to continue support redirects

837a91e

sleshchenko requested a review from vparfonov as a code owner October 13, 2020 07:59

sleshchenko requested a review from mkuznyetsov October 13, 2020 07:59

Bump che dashboard version in helm charts on release

2fa1570

sleshchenko force-pushed the separateDashboard branch from 73c0b37 to 2fa1570 Compare October 13, 2020 08:02

sleshchenko commented Oct 13, 2020

View reviewed changes

.ci/set_tag_version_images_linux.sh Show resolved Hide resolved

sparkoo approved these changes Oct 13, 2020

View reviewed changes

metlos approved these changes Oct 19, 2020

View reviewed changes

mkuznyetsov approved these changes Oct 19, 2020

View reviewed changes

Clean up references to removed deploy_che.sh

0c18486

sleshchenko requested a review from mkuznyetsov October 19, 2020 11:40

mkuznyetsov approved these changes Oct 19, 2020

View reviewed changes

sleshchenko merged commit beaca7c into master Oct 19, 2020

sleshchenko deleted the separateDashboard branch October 19, 2020 13:06

che-bot removed the status/code-review This issue has a pull request posted for it and is awaiting code review completion by the community. label Oct 19, 2020

sleshchenko mentioned this pull request Nov 20, 2020

Chectl does not respect dashboard deployment #18421

Closed

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Run dashboard in a dedicated deployment with helm chart #18093

Run dashboard in a dedicated deployment with helm chart #18093

sleshchenko commented Oct 12, 2020 •

edited

Loading

che-bot commented Oct 12, 2020

che-bot commented Oct 12, 2020

che-bot commented Oct 12, 2020

che-bot commented Oct 12, 2020

sparkoo Oct 12, 2020

sleshchenko Oct 13, 2020

sleshchenko Oct 13, 2020 •

edited

Loading

sleshchenko Oct 13, 2020

sparkoo commented Oct 12, 2020 •

edited

Loading

sleshchenko commented Oct 13, 2020

sparkoo commented Oct 13, 2020

che-bot commented Oct 13, 2020

sleshchenko commented Oct 13, 2020

che-bot commented Oct 13, 2020

sparkoo commented Oct 13, 2020

che-bot commented Oct 19, 2020

Run dashboard in a dedicated deployment with helm chart #18093

Run dashboard in a dedicated deployment with helm chart #18093

Conversation

sleshchenko commented Oct 12, 2020 • edited Loading

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

Reviewers

che-bot commented Oct 12, 2020

che-bot commented Oct 12, 2020

che-bot commented Oct 12, 2020

che-bot commented Oct 12, 2020

sparkoo Oct 12, 2020

Choose a reason for hiding this comment

sleshchenko Oct 13, 2020

Choose a reason for hiding this comment

sleshchenko Oct 13, 2020 • edited Loading

Choose a reason for hiding this comment

sleshchenko Oct 13, 2020

Choose a reason for hiding this comment

sparkoo commented Oct 12, 2020 • edited Loading

sleshchenko commented Oct 13, 2020

sparkoo commented Oct 13, 2020

che-bot commented Oct 13, 2020

sleshchenko commented Oct 13, 2020

che-bot commented Oct 13, 2020

sparkoo commented Oct 13, 2020

che-bot commented Oct 19, 2020

sleshchenko commented Oct 12, 2020 •

edited

Loading

sleshchenko Oct 13, 2020 •

edited

Loading

sparkoo commented Oct 12, 2020 •

edited

Loading