Skip to content

Commit

Permalink
Merge branch 'main' into docs-add-restore-details
Browse files Browse the repository at this point in the history
  • Loading branch information
johanwelgemoed authored Mar 20, 2024
2 parents e7466e4 + 3d10a5a commit 00674a3
Show file tree
Hide file tree
Showing 15 changed files with 50 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/components/modeler/desktop-modeler/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Ensure your computer has access to the (remote) network.

[Inspect the connection](#how-can-i-get-details-about-a-secure-remote-connection) to understand if it can be established.

Secure connections to Zeebe require [HTTP/2 over TLS with protocol negotiation via ALPN](../../../self-managed/platform-deployment/troubleshooting.md#zeebe-ingress-grpc). Ensure your proxy supports these features and does not forcefully downgrade the connection to HTTP/1.
Secure connections to Zeebe require [HTTP/2 over TLS with protocol negotiation via ALPN](/self-managed/operational-guides/troubleshooting/troubleshooting.md#zeebe-ingress-grpc). Ensure your proxy supports these features and does not forcefully downgrade the connection to HTTP/1.

## Debug Zeebe connection issues

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ sidebar_label: "Zeebe connection"
---

:::note
Web Modeler Self-Managed is available to [enterprise customers](../../../../reference/licenses.md#web-modeler) only.
Web Modeler Self-Managed is available to [enterprise customers](/reference/licenses.md#web-modeler) only.
:::

You try to connect (i.e., to deploy) to a remote Zeebe cluster and Web Modeler reports an error.

To resolve this issue, check if you can connect to Zeebe through another client, i.e., [`zbctl`](/docs/apis-tools/cli-client/index.md).
If that doesn't work, resolve the general connection issue first (see [the platform deployment troubleshooting section](/docs/self-managed/platform-deployment/troubleshooting.md), for example.)
To resolve this issue, check if you can connect to Zeebe through another client, i.e., [`zbctl`](/apis-tools/cli-client/index.md).
If that doesn't work, resolve the general connection issue first (see [the platform deployment troubleshooting section](/self-managed/operational-guides/troubleshooting/troubleshooting.md), for example.)

If that works, further debug your Zeebe connection with the help of the information stated below. Enabling [debug logging in `modeler-restapi`](#how-can-i-debug-log-grpc--zeebe-communication) may also help to understand the issue.

Expand Down Expand Up @@ -41,7 +41,7 @@ Failure to connect may have several reasons:
### Configure the gateway to accept secure connections

Ensure you properly configure the remote cluster URL to accept secure connections.
Refer to the [Zeebe Gateway configuration documentation](../../../zeebe-deployment/security/secure-client-communication.md#gateway)
Refer to the [Zeebe Gateway configuration documentation](/self-managed/zeebe-deployment/security/secure-client-communication.md#gateway)
for additional information.

### Configure the gateway to support ALPN
Expand All @@ -50,7 +50,7 @@ for additional information.
by the server.

Secure connections to Zeebe require an Ingress controller that supports HTTP/2 over TLS with protocol negotiation via ALPN.
Ensure you properly [configured your Zeebe ingress to support ALPN](../../../platform-deployment/troubleshooting.md#zeebe-ingress-grpc).
Ensure you properly [configured your Zeebe ingress to support ALPN](/self-managed/operational-guides/troubleshooting/troubleshooting.md#zeebe-ingress-grpc).

### Configure `modeler-restapi` to trust a custom Zeebe SSL certificate

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,21 +43,21 @@ However, according to the official Kubernetes documentation about [Ingress TLS](

> There is a gap between TLS features supported by various Ingress controllers. Please refer to documentation on nginx, GCE, or any other platform specific Ingress controller to understand how TLS works in your environment.
Therefore, if you are not using the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx), ensure you pay attention to TLS configuration of the Ingress controller of your choice. Find more details about the Zeebe Ingress setup in the [Kubernetes platforms supported by Camunda](./helm-kubernetes/platforms/platforms.md).
Therefore, if you are not using the [ingress-nginx controller](https://github.com/kubernetes/ingress-nginx), ensure you pay attention to TLS configuration of the Ingress controller of your choice. Find more details about the Zeebe Ingress setup in the [Kubernetes platforms supported by Camunda](/self-managed/platform-deployment/helm-kubernetes/platforms/platforms.md).

## Identity `contextPath`

Camunda 8 Self-Managed can be accessed externally via different methods. One such method is the [combined Ingress setup](./helm-kubernetes/guides/ingress-setup.md#combined-ingress-setup). In that configuration, Camunda Identity is accessed using a specific path, configured by setting the `contextPath` variable, for example `https://camunda.example.com/identity`.
Camunda 8 Self-Managed can be accessed externally via different methods. One such method is the [combined Ingress setup](/self-managed/platform-deployment/helm-kubernetes/guides/ingress-setup.md#combined-ingress-setup). In that configuration, Camunda Identity is accessed using a specific path, configured by setting the `contextPath` variable, for example `https://camunda.example.com/identity`.

For security reasons, Camunda Identity requires secure access (HTTPS) when a `contextPath` is configured. If you want to use Camunda Identity with HTTP, use a [separate Ingress setup](./helm-kubernetes/guides/ingress-setup.md#separated-ingress-setup) (applications such as Operate, Optimize, etc, can still be accessed in a combined setup).
For security reasons, Camunda Identity requires secure access (HTTPS) when a `contextPath` is configured. If you want to use Camunda Identity with HTTP, use a [separate Ingress setup](/self-managed/platform-deployment/helm-kubernetes/guides/ingress-setup.md#separated-ingress-setup) (applications such as Operate, Optimize, etc, can still be accessed in a combined setup).

:::note
Due to limitations, the Identity `contextPath` approach is unavailable when using a browser in Incognito mode.
:::

## Web Modeler database schema

The Web Modeler `restapi` component requires a [database connection](../../modeler/web-modeler/configuration#database). This connection should not point to the same database as Keycloak does.
The Web Modeler `restapi` component requires a [database connection](/self-managed/modeler/web-modeler/configuration/configuration.md#database). This connection should not point to the same database as Keycloak does.

## Gateway timeout on redirect

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,14 @@ zeebe-gateway:
```
:::note Web Modeler
The configuration above only contains the Ingress-related values under `webModeler`. Note the additional [installation instructions and configuration hints](../../helm-kubernetes/deploy.md#installing-web-modeler).
The configuration above only contains the Ingress-related values under `webModeler`. Note the additional [installation instructions and configuration hints](/self-managed/platform-deployment/helm-kubernetes/deploy.md#installing-web-modeler).
:::

:::note Console
The configuration above only contains the Ingress-related values under `Console`. Review the additional [installation instructions and configuration hints](../../helm-kubernetes/deploy.md#install-console).
The configuration above only contains the Ingress-related values under `Console`. Review the additional [installation instructions and configuration hints](/self-managed/platform-deployment/helm-kubernetes/deploy.md#install-console).
:::

Incorporate the custom values mentioned in the example above into the value file you're using to deploy Camunda as outlined in [deploying Camunda 8](../../helm-kubernetes/deploy.md):
Incorporate the custom values mentioned in the example above into the value file you're using to deploy Camunda as outlined in [deploying Camunda 8](/self-managed/platform-deployment/helm-kubernetes/deploy.md):

```shell
helm install demo camunda/camunda-platform -f values-combined-ingress.yaml
Expand Down Expand Up @@ -187,10 +187,10 @@ Console:
```

:::note Web Modeler
The configuration above only contains the Ingress-related values under `webModeler`. Review the additional [installation instructions and configuration hints](../../helm-kubernetes/deploy.md#installing-web-modeler).
The configuration above only contains the Ingress-related values under `webModeler`. Review the additional [installation instructions and configuration hints](/self-managed/platform-deployment/helm-kubernetes/deploy.md#installing-web-modeler).
:::

Incorporate the custom values mentioned in the example above into the value file you're using to deploy Camunda as outlined in [deploying Camunda 8](../../helm-kubernetes/deploy.md):
Incorporate the custom values mentioned in the example above into the value file you're using to deploy Camunda as outlined in [deploying Camunda 8](/self-managed/platform-deployment/helm-kubernetes/deploy.md):

```shell
helm install demo camunda/camunda-platform -f values-separated-ingress.yaml
Expand Down Expand Up @@ -237,4 +237,4 @@ ingress-nginx ingress-nginx \

## Troubleshooting

If something is not working as expected, check the guide for [general deployment troubleshooting](../../troubleshooting.md).
If something is not working as expected, check the guide for [general deployment troubleshooting](/self-managed/operational-guides/troubleshooting/troubleshooting.md).
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Alternatively, one can use a **Network Load Balancer** (NLB) to terminate TLS wi

## Pitfalls to avoid

For general deployment pitfalls, visit the [deployment troubleshooting guide](../../../troubleshooting.md).
For general deployment pitfalls, visit the [deployment troubleshooting guide](/self-managed/operational-guides/troubleshooting/troubleshooting.md).

### Volume performance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Here is a recommended start to run Camunda 8:

## Pitfalls to avoid

For general deployment pitfalls, visit the [deployment troubleshooting guide](../../troubleshooting.md).
For general deployment pitfalls, visit the [deployment troubleshooting guide](/self-managed/operational-guides/troubleshooting/troubleshooting.md).

### Volume performance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Here is a recommended start to run Camunda 8:

## Pitfalls to avoid

For general deployment pitfalls, visit the [deployment troubleshooting guide](../../troubleshooting.md).
For general deployment pitfalls, visit the [deployment troubleshooting guide](/self-managed/operational-guides/troubleshooting/troubleshooting.md).

### Volume performance

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Any version not explicitly marked in the table above is not tested, and we canno

## Pitfalls to avoid

For general deployment pitfalls, visit the [deployment troubleshooting guide](../../troubleshooting.md).
For general deployment pitfalls, visit the [deployment troubleshooting guide](/self-managed/operational-guides/troubleshooting/troubleshooting.md).

### Security Context Constraints (SCCs)

Expand Down
12 changes: 6 additions & 6 deletions docs/self-managed/platform-deployment/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ This chapter contains information for users who want to deploy and run Camunda 8
Camunda 8 includes the following components:

- Zeebe Broker and Gateway
- Operate (requiring Elasticsearch)
- Tasklist (requiring Elasticsearch)
- Connectors (requiring Operate)
- Optimize (requiring Elasticsearch and Identity)
- Identity (requiring Keycloak)
- Web Modeler (requiring Identity, Keycloak, and PostgreSQL) [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#web-modeler)
- Operate
- Tasklist
- Connectors
- Optimize
- Identity
- Web Modeler [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#web-modeler)
- Console [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#console-sm)

All components except Web Modeler and Console are single Java applications.
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,6 @@ module.exports = {
"self-managed/platform-deployment/helm-kubernetes/guides/multi-namespace-deployment",
],
},
"self-managed/platform-deployment/troubleshooting",
],
},
"self-managed/platform-deployment/docker",
Expand Down Expand Up @@ -901,6 +900,7 @@ module.exports = {
},
{
Troubleshooting: [
"self-managed/operational-guides/troubleshooting/troubleshooting",
"self-managed/operational-guides/troubleshooting/log-levels",
],
},
Expand Down
4 changes: 4 additions & 0 deletions static/.htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ RewriteEngine on
RewriteCond %{SERVER_PORT} !^443$
RewriteRule (.*) https://%{SERVER_NAME}/$1 [R=301,L]

# Consolidate SM troubleshooting pages (next only)

RewriteRule ^docs/next/self-managed/platform-deployment/troubleshooting/?$ /docs/next/self-managed/operational-guides/troubleshooting/$1 [R=301,L]

# Rename whitelist to allowlist
RewriteRule ^docs/components/console/manage-clusters/manage-ip-whitelists/?$ /docs/components/console/manage-clusters/manage-ip-allowlists/$1 [R=301,L]
RewriteRule ^docs/next/components/console/manage-clusters/manage-ip-whitelists/?$ /docs/next/components/console/manage-clusters/manage-ip-allowlists/$1 [R=301,L]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ This chapter contains information for users who want to deploy and run Camunda 8
Camunda 8 includes the following components:

- Zeebe Broker and Gateway
- Operate (requiring Elasticsearch)
- Tasklist (requiring Elasticsearch)
- Connectors (requiring Operate)
- Optimize (requiring Elasticsearch and Identity)
- Identity (requiring Keycloak)
- Web Modeler (requiring Identity, Keycloak, and PostgreSQL) [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#web-modeler)
- Operate
- Tasklist
- Connectors
- Optimize
- Identity
- Web Modeler [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#web-modeler)

All components except Web Modeler are single Java applications.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ This chapter contains information for users who want to deploy and run Camunda 8
Camunda 8 includes the following components:

- Zeebe Broker and Gateway
- Operate (requiring Elasticsearch)
- Tasklist (requiring Elasticsearch)
- Connectors (requiring Operate)
- Optimize (requiring Elasticsearch and Identity)
- Identity (requiring Keycloak)
- Web Modeler (requiring Identity, Keycloak, and PostgreSQL) [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#web-modeler)
- Operate
- Tasklist
- Connectors
- Optimize
- Identity
- Web Modeler [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#web-modeler)

All components except Web Modeler are single Java applications.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Web Modeler Self-Managed is available to [enterprise customers](../../../../refe
You try to connect (i.e., to deploy) to a remote Zeebe cluster and Web Modeler reports an error.

To resolve this issue, check if you can connect to Zeebe through another client, i.e., [`zbctl`](/docs/apis-tools/cli-client/index.md).
If that doesn't work, resolve the general connection issue first (see [the platform deployment troubleshooting section](/docs/self-managed/platform-deployment/troubleshooting.md), for example.)
If that doesn't work, resolve the general connection issue first (see [the platform deployment troubleshooting section](/self-managed/platform-deployment/troubleshooting.md), for example.)

If that works, further debug your Zeebe connection with the help of the information stated below. Enabling [debug logging in `modeler-restapi`](#how-can-i-debug-log-grpc--zeebe-communication) may also help to understand the issue.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ This chapter contains information for users who want to deploy and run Camunda 8
Camunda 8 includes the following components:

- Zeebe Broker and Gateway
- Operate (requiring Elasticsearch)
- Tasklist (requiring Elasticsearch)
- Connectors (requiring Operate)
- Optimize (requiring Elasticsearch and Identity)
- Identity (requiring Keycloak)
- Web Modeler (requiring Identity, Keycloak, and PostgreSQL) [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#web-modeler)
- Operate
- Tasklist
- Connectors
- Optimize
- Identity
- Web Modeler [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#web-modeler)
- Console [<span class="badge badge--enterprise-only">Enterprise only</span>](../../../reference/licenses/#console-sm)

All components except Web Modeler and Console are single Java applications.
Expand Down

0 comments on commit 00674a3

Please sign in to comment.