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.

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

Modify the multi-namespace guide for 8.7 #4778

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
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
45 changes: 12 additions & 33 deletions docs/self-managed/setup/guides/multi-namespace-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: "Deploy Camunda 8 Self-Managed across several namespaces for better

Camunda 8 Self-Managed offers flexible deployment options that allow it to span multiple namespaces. This setup consists of a management cluster, which includes the Console, Identity, and Web Modeler components, along with several orchestration clusters (including Zeebe, Operate, Tasklist, and Optimize).

For this configuration, each namespace is set up independently through Helm, with deployments classified into two types: management and automation. Each type has a specific values file designed for its deployment requirements.
For this configuration, each namespace is set up independently through Helm, with deployments classified into two types: `Web Modeler and Console` and `Camunda Orchestration Cluster`. Each type has a specific values file designed for its deployment requirements.

Below, we illustrate multi-namespace Camunda deployment: one namespace will be dedicated to the management cluster, and the other two will be used for the orchestration cluster.
Below, we illustrate multi-namespace Camunda deployment: one namespace will be dedicated to the `Web Modeler and Console` cluster, and the other two will be used for the `Camunda Orchestration cluster`.

## Management deployment
## Web Modeler and Console deployment

This deployment includes centralized Identity and Web Modeler only. Identity allows the other two deployments to authenticate against Keycloak. Web Modeler is a central tool for designing and deploying business process diagrams across all your automation deployments.
This deployment includes Identity, Web Modeler, and Console. Identity allows the other two deployments to authenticate against Keycloak. Web Modeler is a central tool for designing and deploying business process diagrams across all your automation deployments. Console enables you to get a high-level view of your `Camunda Orchestration` clusters.
Create the following Management deployment Helm values file.

```yaml
Expand All @@ -26,24 +26,13 @@ global:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
connectors:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
operate:
core:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
redirectUrl: "https://camunda-team01.example.com/operate,https://camunda-team02.example.com/operate"
tasklist:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
redirectUrl: "https://camunda-team01.example.com/tasklist,https://camunda-team02.example.com/tasklist"
redirectUrl: "https://camunda-team01.example.com/core,https://camunda-team02.example.com/core"
optimize:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
redirectUrl: "https://camunda-team01.example.com/optimize,https://camunda-team02.example.com/optimize"
zeebe:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
zeebe:
enabled: false
zeebeGateway:
enabled: false
operate:
enabled: false
tasklist:
core:
enabled: false
optimize:
enabled: false
Expand All @@ -63,7 +52,7 @@ helm install camunda camunda/camunda-platform \

## Team One deployment

Let's create a Camunda orchestration cluster that can be owned and managed by Team One and will be deployed into namespace `camunda-team01`. This deployment includes Zeebe, Operate, Tasklist, and Optimize, and authenticates against Keycloak in the Management deployment:
Let's create a Camunda orchestration cluster that can be owned and managed by Team One and will be deployed into namespace `camunda-team01`. This deployment includes Core, and Optimize, and authenticates against Keycloak in the Management deployment:

```yaml
# File: camunda-team01.yaml
Expand All @@ -75,13 +64,9 @@ global:
publicIssuerUrl: "https://camunda-main.example.com/auth/realms/camunda-platform"
connectors:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
operate:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
tasklist:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
optimize:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
zeebe:
core:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
service:
url: "http://camunda-main-identity.camunda-main.svc.cluster.local:80/identity"
Expand All @@ -108,7 +93,7 @@ helm template camunda camunda/camunda-platform \

## Team Two deployment

This deployment uses namespace `camunda-team02`, includes Zeebe, Operate, Tasklist, and Optimize, and authenticates against Keycloak in the management deployment:
This deployment uses namespace `camunda-team02`, includes Core, and Optimize, and authenticates against Keycloak in the management deployment:

```yaml
# File: camunda-team02.yaml
Expand All @@ -120,13 +105,7 @@ global:
publicIssuerUrl: "https://camunda-main.example.com/auth/realms/camunda-platform"
connectors:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
operate:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
tasklist:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
optimize:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
zeebe:
core:
existingSecret: <APP_MACHINE2MACHINE_SECRET>
service:
url: "http://camunda-main-identity.camunda-main.svc.cluster.local:80/identity"
Expand Down Expand Up @@ -155,7 +134,7 @@ helm install camunda camunda/camunda-platform \

To use Camunda Console Self-Managed in a multi-namespace setup, obtain Helm deployment configuration for all namespaces/deployments you would like Console to manage.

Update Management deployment to deploy Console Self-Managed. For more details, visit this [Installation guide](/self-managed/setup/install.md#install-console).
Update `Web Modeler and Console` deployment to deploy Console Self-Managed. For more details, visit this [Installation guide](/self-managed/setup/install.md#install-console).

Assuming Camunda clusters have been deployed using the above examples, run the following script to get the release information for all deployments.

Expand Down
Loading