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

fix: Update multiregion.md #2415

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
8 changes: 4 additions & 4 deletions docs/architecture/multiregion.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Docs: Multi-region Overview
[comment]: # (TODO: add link to the multi-region official documentation when 8.5 docs are released.)
[comment]: # (TODO: add a link to the multi-region official documentation when 8.5 docs are released.)
In this repo, it is possible to configure Camunda 8 to be compatible with a multi-region setup. You are able to modify the following values in the values.yaml:

```yaml
Expand All @@ -12,16 +12,16 @@ global:

The `regions` value allows you to set the total number of regions you would like to have. The default is 1 region.

The `regionId` value specifies the ID of the camunda installation in a specific region. The `regionId` **must** start from 0. For example if you two regions, France and England, then France will have a regionId of 0, and England will have a regionId of 1.
The `regionId` value specifies the ID of the camunda installation in a specific region. The `regionId` **must** start from 0. For example, if you have two regions, France and England, then France will have a regionId of 0, and England will have a regionId of 1.

The `InstallationType` value can have three differnet types:
The `InstallationType` value can have three different types:
1. normal
2. failOver
3. failBack

These types mainly dictate how the zeebe pods behave before or after a region outage.</br>
The default is `normal`, meaning that camunda 8 will be installed normally.

When a region outage occurs and quorum is lost between the zeebe brokers, a seperate installation can be made to the surviving region with the `faillover` type. This type of installation sets up temporary zeebe brokers (with the same node IDs of the lost zeebe brokers) in the surviving region in order to establish a quorum.
When a region outage occurs and a quorum is lost between the zeebe brokers, a separate installation can be made to the surviving region with the `faillover` type. This type of installation sets up temporary zeebe brokers (with the same node IDs of the lost zeebe brokers) in the surviving region in order to establish a quorum.

When the failed region is back to a healthy state, an installation can be made to this region with a `failback` type. This will put some zeebe brokers to sleep that have the same node ID as the temporary brokers in the surviving region.