Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add the REST config to the Ingress guides #4602

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
+57 −12
Draft

Add the REST config to the Ingress guides #4602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f31f5c4
update ingress rest config, add note
conceptualshark Nov 13, 2024
b0af6c1
add rest config to ingress setup in 8.5, 8.6
conceptualshark Nov 13, 2024
e9202eb
update context path instructions
conceptualshark Nov 14, 2024
bbdda47
Add back into next
conceptualshark Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,17 @@ Ensure you [authenticate](./zeebe-api-rest-authentication.md) before accessing t

## Context paths

For SaaS: `https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v1/`, and for Self-Managed installations: `http://localhost:8080/v1/`.
### SaaS

:::note
Find your region and cluster id under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).

For Self-Managed, the host and port depend on your configuration. The context path mentioned here is the default for the Zeebe component.
:::
Example path: `https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v1/`

### Self-Managed

The context path should match the host and path defined in your Zeebe Gateway [configuration](/self-managed/setup/guides/ingress-setup.md). The path used here is the default.

Example path: `http://localhost:8080/v1/`

## API Explorer

Expand Down
11 changes: 11 additions & 0 deletions docs/self-managed/setup/guides/ingress-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ In this setup, a single Ingress/domain is used to access Camunda 8 web applicati

![Camunda 8 Self-Managed Architecture Diagram - Combined Ingress](../../assets/camunda-platform-8-self-managed-architecture-diagram-combined-ingress.png)

:::note
**Operate, Tasklist, Optimize, Modeler, Connectors, Console:** The Ingress path value for each Component (`global.identity.auth.<component>.redirectUrl`) should match the `contextPath` for that Component.

**Zeebe:** `zeebeGateway.ingress.rest.path` should match `zeebe.contextPath`.
:::

```yaml
# Chart values for the Camunda 8 Helm chart in combined Ingress setup.

Expand Down Expand Up @@ -87,6 +93,11 @@ zeebeGateway:
enabled: true
className: nginx
host: "zeebe.camunda.example.com"
rest:
enabled: true
className: nginx
host: "camunda.example.com"
path: "/zeebe"
```

:::note Web Modeler
Expand Down
12 changes: 8 additions & 4 deletions versioned_docs/version-8.5/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,17 @@ Ensure you [authenticate](./zeebe-api-rest-authentication.md) before accessing t

## Context paths

For SaaS: `https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v1/`, and for Self-Managed installations: `http://localhost:8080/v1/`.
### SaaS

:::note
Find your region and cluster id under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).

For Self-Managed, the host and port depend on your configuration. The context path mentioned here is the default for the Zeebe component.
:::
Example path: `https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v1/`

### Self-Managed

The context path should match the host and path defined in your Zeebe Gateway [configuration](/self-managed/setup/guides/ingress-setup.md). The path used here is the default.

Example path: `http://localhost:8080/v1/`

## API Explorer

Expand Down
11 changes: 11 additions & 0 deletions versioned_docs/version-8.5/self-managed/setup/guides/ingress-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ In this setup, a single Ingress/domain is used to access Camunda 8 web applicati

![Camunda 8 Self-Managed Architecture Diagram - Combined Ingress](../../assets/camunda-platform-8-self-managed-architecture-diagram-combined-ingress.png)

:::note
**Operate, Tasklist, Optimize, Modeler, Connectors, Console:** The Ingress path value for each Component (`global.identity.auth.<component>.redirectUrl`) should match the `contextPath` for that Component.

**Zeebe:** `zeebeGateway.ingress.rest.path` should match `zeebe.contextPath`.
:::

```yaml
# Chart values for the Camunda 8 Helm chart in combined Ingress setup.

Expand Down Expand Up @@ -99,6 +105,11 @@ zeebeGateway:
enabled: true
className: nginx
host: "zeebe.camunda.example.com"
rest:
enabled: true
className: nginx
host: "camunda.example.com"
path: "/zeebe"
```

:::note Web Modeler
Expand Down
12 changes: 8 additions & 4 deletions versioned_docs/version-8.6/apis-tools/zeebe-api-rest/zeebe-api-rest-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,17 @@ Ensure you [authenticate](./zeebe-api-rest-authentication.md) before accessing t

## Context paths

For SaaS: `https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v1/`, and for Self-Managed installations: `http://localhost:8080/v1/`.
### SaaS

:::note
Find your region and cluster id under **Connection information** in your client credentials (revealed when you click on your client under the **API** tab within your cluster).

For Self-Managed, the host and port depend on your configuration. The context path mentioned here is the default for the Zeebe component.
:::
Example path: `https://${REGION}.zeebe.camunda.io:443/${CLUSTER_ID}/v1/`

### Self-Managed

The context path should match the host and path defined in your Zeebe Gateway [configuration](/self-managed/setup/guides/ingress-setup.md). The path used here is the default.

Example path: `http://localhost:8080/v1/`

## API Explorer

Expand Down
11 changes: 11 additions & 0 deletions versioned_docs/version-8.6/self-managed/setup/guides/ingress-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ In this setup, a single Ingress/domain is used to access Camunda 8 web applicati

![Camunda 8 Self-Managed Architecture Diagram - Combined Ingress](../../assets/camunda-platform-8-self-managed-architecture-diagram-combined-ingress.png)

:::note
**Operate, Tasklist, Optimize, Modeler, Connectors, Console:** The Ingress path value for each Component (`global.identity.auth.<component>.redirectUrl`) should match the `contextPath` for that Component.

**Zeebe:** `zeebeGateway.ingress.rest.path` should match `zeebe.contextPath`.
:::

```yaml
# Chart values for the Camunda 8 Helm chart in combined Ingress setup.

Expand Down Expand Up @@ -101,6 +107,11 @@ zeebeGateway:
enabled: true
className: nginx
host: "zeebe.camunda.example.com"
rest:
enabled: true
className: nginx
host: "camunda.example.com"
path: "/zeebe"
```

:::note Web Modeler
Expand Down
Loading