From 08d89b17082b21977809230a496de8a7cf56cd2e Mon Sep 17 00:00:00 2001 From: Amara Graham Date: Tue, 19 Mar 2024 11:00:20 -0500 Subject: [PATCH 1/2] remove technology from components list (#3493) --- docs/self-managed/platform-deployment/overview.md | 12 ++++++------ .../self-managed/platform-deployment/overview.md | 12 ++++++------ .../self-managed/platform-deployment/overview.md | 12 ++++++------ .../self-managed/platform-deployment/overview.md | 12 ++++++------ 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/self-managed/platform-deployment/overview.md b/docs/self-managed/platform-deployment/overview.md index 01524991acf..11dfb856dec 100644 --- a/docs/self-managed/platform-deployment/overview.md +++ b/docs/self-managed/platform-deployment/overview.md @@ -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) [Enterprise only](../../../reference/licenses/#web-modeler) +- Operate +- Tasklist +- Connectors +- Optimize +- Identity +- Web Modeler [Enterprise only](../../../reference/licenses/#web-modeler) - Console [Enterprise only](../../../reference/licenses/#console-sm) All components except Web Modeler and Console are single Java applications. diff --git a/versioned_docs/version-8.2/self-managed/platform-deployment/overview.md b/versioned_docs/version-8.2/self-managed/platform-deployment/overview.md index 5dbdd3403f2..0ebd55eee53 100644 --- a/versioned_docs/version-8.2/self-managed/platform-deployment/overview.md +++ b/versioned_docs/version-8.2/self-managed/platform-deployment/overview.md @@ -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) [Enterprise only](../../../reference/licenses/#web-modeler) +- Operate +- Tasklist +- Connectors +- Optimize +- Identity +- Web Modeler [Enterprise only](../../../reference/licenses/#web-modeler) All components except Web Modeler are single Java applications. diff --git a/versioned_docs/version-8.3/self-managed/platform-deployment/overview.md b/versioned_docs/version-8.3/self-managed/platform-deployment/overview.md index bef25dedb54..2baaeda9ebc 100644 --- a/versioned_docs/version-8.3/self-managed/platform-deployment/overview.md +++ b/versioned_docs/version-8.3/self-managed/platform-deployment/overview.md @@ -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) [Enterprise only](../../../reference/licenses/#web-modeler) +- Operate +- Tasklist +- Connectors +- Optimize +- Identity +- Web Modeler [Enterprise only](../../../reference/licenses/#web-modeler) All components except Web Modeler are single Java applications. diff --git a/versioned_docs/version-8.4/self-managed/platform-deployment/overview.md b/versioned_docs/version-8.4/self-managed/platform-deployment/overview.md index 01524991acf..11dfb856dec 100644 --- a/versioned_docs/version-8.4/self-managed/platform-deployment/overview.md +++ b/versioned_docs/version-8.4/self-managed/platform-deployment/overview.md @@ -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) [Enterprise only](../../../reference/licenses/#web-modeler) +- Operate +- Tasklist +- Connectors +- Optimize +- Identity +- Web Modeler [Enterprise only](../../../reference/licenses/#web-modeler) - Console [Enterprise only](../../../reference/licenses/#console-sm) All components except Web Modeler and Console are single Java applications. From 3d10a5acbc6b4afe2b1fd20f2fbaed8678fdee5c Mon Sep 17 00:00:00 2001 From: Amara Graham Date: Tue, 19 Mar 2024 15:07:58 -0500 Subject: [PATCH 2/2] Consolidate troubleshooting in SM (#3479) * move troubleshooting and adjust links * fix links * htaccess typo * reorder sidebar, adjust redirect for next only --- .../modeler/desktop-modeler/troubleshooting.md | 2 +- .../troubleshooting/troubleshoot-zeebe-connection.md | 10 +++++----- .../troubleshooting}/troubleshooting.md | 8 ++++---- .../helm-kubernetes/guides/ingress-setup.md | 12 ++++++------ .../platforms/amazon-eks/amazon-eks.md | 2 +- .../helm-kubernetes/platforms/google-gke.md | 2 +- .../helm-kubernetes/platforms/microsoft-aks.md | 2 +- .../helm-kubernetes/platforms/redhat-openshift.md | 2 +- sidebars.js | 2 +- static/.htaccess | 4 ++++ .../troubleshooting/troubleshoot-zeebe-connection.md | 2 +- 11 files changed, 26 insertions(+), 22 deletions(-) rename docs/self-managed/{platform-deployment => operational-guides/troubleshooting}/troubleshooting.md (80%) diff --git a/docs/components/modeler/desktop-modeler/troubleshooting.md b/docs/components/modeler/desktop-modeler/troubleshooting.md index 92436eb3665..066463cf87a 100644 --- a/docs/components/modeler/desktop-modeler/troubleshooting.md +++ b/docs/components/modeler/desktop-modeler/troubleshooting.md @@ -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 diff --git a/docs/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md b/docs/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md index 653174f015f..3afd25ee0f4 100644 --- a/docs/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md +++ b/docs/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md @@ -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. @@ -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 @@ -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 diff --git a/docs/self-managed/platform-deployment/troubleshooting.md b/docs/self-managed/operational-guides/troubleshooting/troubleshooting.md similarity index 80% rename from docs/self-managed/platform-deployment/troubleshooting.md rename to docs/self-managed/operational-guides/troubleshooting/troubleshooting.md index d66b403a527..5f846e0f9ac 100644 --- a/docs/self-managed/platform-deployment/troubleshooting.md +++ b/docs/self-managed/operational-guides/troubleshooting/troubleshooting.md @@ -43,13 +43,13 @@ 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. @@ -57,7 +57,7 @@ Due to limitations, the Identity `contextPath` approach is unavailable when usin ## 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 diff --git a/docs/self-managed/platform-deployment/helm-kubernetes/guides/ingress-setup.md b/docs/self-managed/platform-deployment/helm-kubernetes/guides/ingress-setup.md index 838b9b2753a..9476fc02c76 100644 --- a/docs/self-managed/platform-deployment/helm-kubernetes/guides/ingress-setup.md +++ b/docs/self-managed/platform-deployment/helm-kubernetes/guides/ingress-setup.md @@ -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 @@ -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 @@ -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). diff --git a/docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/amazon-eks.md b/docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/amazon-eks.md index 34a764b8393..de0788db18f 100644 --- a/docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/amazon-eks.md +++ b/docs/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/amazon-eks.md @@ -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 diff --git a/docs/self-managed/platform-deployment/helm-kubernetes/platforms/google-gke.md b/docs/self-managed/platform-deployment/helm-kubernetes/platforms/google-gke.md index 9443a9906d0..d489b3eea94 100644 --- a/docs/self-managed/platform-deployment/helm-kubernetes/platforms/google-gke.md +++ b/docs/self-managed/platform-deployment/helm-kubernetes/platforms/google-gke.md @@ -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 diff --git a/docs/self-managed/platform-deployment/helm-kubernetes/platforms/microsoft-aks.md b/docs/self-managed/platform-deployment/helm-kubernetes/platforms/microsoft-aks.md index 5095ef5a551..8603e60baf5 100644 --- a/docs/self-managed/platform-deployment/helm-kubernetes/platforms/microsoft-aks.md +++ b/docs/self-managed/platform-deployment/helm-kubernetes/platforms/microsoft-aks.md @@ -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 diff --git a/docs/self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md b/docs/self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md index b6d84169834..ba5bfcb4de8 100644 --- a/docs/self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md +++ b/docs/self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md @@ -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) diff --git a/sidebars.js b/sidebars.js index 4ae2cb9d364..e2fc81ac8ab 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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", @@ -901,6 +900,7 @@ module.exports = { }, { Troubleshooting: [ + "self-managed/operational-guides/troubleshooting/troubleshooting", "self-managed/operational-guides/troubleshooting/log-levels", ], }, diff --git a/static/.htaccess b/static/.htaccess index 90fdc7afe81..c4412b4a229 100644 --- a/static/.htaccess +++ b/static/.htaccess @@ -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] diff --git a/versioned_docs/version-8.4/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md b/versioned_docs/version-8.4/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md index 653174f015f..36c0093e6da 100644 --- a/versioned_docs/version-8.4/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md +++ b/versioned_docs/version-8.4/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md @@ -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.