C8SM Zeebe REST API is left out of ingress installation guide

[jessesimpson36]

SUPPORT-23061

In the above ticket, the customer navigated to https://docs.camunda.io/docs/apis-tools/zeebe-api-rest/zeebe-api-rest-overview/

and was missing some key information regarding how to set up the zeebe rest api, and making requests against it.

While working on the ticket, the customer specifically asks:

1. Which service should be called ( kubernetes port-forward ) to access it?
2. Which URL should we use?

It should be noted somewhere that the service that provides the rest api is the zeebe gateway (in case customers have issues connecting to their ingress, they should be able to test via port-forwards). And perhaps there could be a link from above link to the self-managed documentation where we set up the ingress.

I also noticed that the "Combined and separated ingress setup" does not include the necessary options to enable the zeebe rest api.

a snippet like

zeebeGateway:
  contextPath: "/zeebe"
  ingress:
    grpc:
      enabled: true
      className: nginx
      host: "zeebe.camunda.example.com"
+    rest:
+      enabled: true
+      className: nginx
+      host: "camunda.example.com"
+      path: "/zeebe"

should be added.

[upgradingdave]

This is a great suggestion, +1 for this!

We might want to also highlight that ingress path should usually match contextPath for each app, for example:

• global.identity.auth.<app>.redirectUrl should match <app>.contextPath for operate, tasklist, optimize, modeler, connectors, and console.
• zeebeGateway.ingress.rest.path should match zeebe.contextPath

[akeller]

Assigning @conceptualshark and @pepopowitz to this since its an API + SM topic. @jessesimpson36 if Distribution Team plans to deliver these docs changes, you can remove them and assign them as reviewers.

[jessesimpson36]

Sounds good @akeller . I was waiting for our backlog grooming to see if we would assign implementation of this to our next sprint, but we decided not to. I am willing to review a PR on this topic though.