[ISSUE][8.8] Ingress rule for camunda-zeebe (Orchestration Cluster) not rendered unless contextPath is explicitly set

[Langleu]

Describe the issue:

The ingress rules for the camunda-zeebe (Orchestration Cluster) is no longer rendered unless contextPath is explicitly set. Currently, if no value is provided, nothing is rendered.

If it's the intended behaviour let me know and we can close it but for me it felt like a regression that it has to be explicitly set now.

Actual behavior:

When orchstration.contextPath is not defined, the ingress rules for the orchestration cluster is missing.

Expected behavior:

If orchstration.contextPath is not set, the chart should still render the ingress with / as the default path. Afaik was the previous behaviour.

How to reproduce:

export CAMUNDA_HELM_CHART_VERSION="0.0.0-snapshot-alpha"

helm template camunda oci://ghcr.io/camunda/helm/camunda-platform --version "$CAMUNDA_HELM_CHART_VERSION" --set "global.ingress.enabled=true" > template.yml

helm template camunda oci://ghcr.io/camunda/helm/camunda-platform --version "$CAMUNDA_HELM_CHART_VERSION" --set "global.ingress.enabled=true" --set "orchestration.contextPath=/" > template.yml

Logs:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: camunda-camunda-platform-http
  labels:
    app: camunda-platform
    app.kubernetes.io/instance: camunda
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/name: camunda-platform
    app.kubernetes.io/part-of: camunda-platform
    helm.sh/chart: camunda-platform-0.0.0-snapshot-alpha
  annotations: 
    ingress.kubernetes.io/rewrite-target: /
    nginx.ingress.kubernetes.io/proxy-body-size: 10m
    nginx.ingress.kubernetes.io/proxy-buffer-size: 128k
    nginx.ingress.kubernetes.io/proxy-buffering: "on"
    nginx.ingress.kubernetes.io/ssl-redirect: "false"
spec:
  ingressClassName: nginx
  rules:
    - http:
        paths:

vs

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: camunda-camunda-platform-http
  labels:
    app: camunda-platform
    app.kubernetes.io/instance: camunda
    app.kubernetes.io/managed-by: Helm
    app.kubernetes.io/name: camunda-platform
    app.kubernetes.io/part-of: camunda-platform
    helm.sh/chart: camunda-platform-0.0.0-snapshot-alpha
  annotations: 
    ingress.kubernetes.io/rewrite-target: /
    nginx.ingress.kubernetes.io/proxy-body-size: 10m
    nginx.ingress.kubernetes.io/proxy-buffer-size: 128k
    nginx.ingress.kubernetes.io/proxy-buffering: "on"
    nginx.ingress.kubernetes.io/ssl-redirect: "false"
spec:
  ingressClassName: nginx
  rules:
    - http:
        paths:
          # Orchestration.
          - backend:
              service:
                name: camunda-zeebe
                port:
                  number: 8080
            path: /
            pathType: Prefix

Environment:

• Platform: AWS / OpenShift / independent of the platform
• Helm CLI version: 3.19.0
• Chart version: alpha-snapshot
• Values file: N/A (problem occurs when orchstration.contextPath is not set)

[eamonnmoloney]

This is by design. The is logic

The priority is developer experience.

contextPath defaults to "" for all components. Developer experience is to portforward to a service/pod. On that forward, each components servlet listens on "/".

As everything is set to serve off the root, there is no config for ingress that would be valid so we shouldn't render any routes.

We consider any non empty value to be valid and that will be rendered

[Langleu]

You're right, sorry about the noise!
My bad, got all the recent changes confused where it was set then not set and by that time the values.yml changed so much that the value was required again but nowhere defined in the file anymore.

[eamonnmoloney]

Thinking of the UX for this issue, what is best? Should we fail the install in the case a user enables ingress without setting the contextPath?

@theburi @camunda/distribution

[Langleu]

Afaik it was previously only defined in the documentation where you had an explicit /operate or /tasklist.
The docs have previously mentioned this but not yet bumped to 8.8, but now it would need an explicit /, which under the hood results in /operate, /tasklist, /identity, and /v{1,2}.

Can be ambiguous that the / results in all of the other paths, where previously you had very explicit contexts. So instead now a more explicit documentation explaining the behaviour.
At the same time, probably part of the Helm upgrade guide as well, so people aren't surprised where the endpoint went. Previous paths morphing into / under orchestration.contextPath