Skip to content

Commit

Permalink
Fix typo in documentation mention of redundancy_mode (#2104)
Browse files Browse the repository at this point in the history
  • Loading branch information
gm42 committed Jul 16, 2024
1 parent 43139b3 commit f587893
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/manual/fault_domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ spec:
processGroupIDPrefix: az1
dataHall: az1
databaseConfiguration:
redundancyMode: triple
redundancy_mode: triple
processes:
general:
podTemplate:
Expand All @@ -161,7 +161,7 @@ spec:
"topology.kubernetes.io/zone": "az1"
```

Once the cluster in `az1` is reconciled and running we can change the `redundancyMode` to `three_data_hall`.
Once the cluster in `az1` is reconciled and running we can change the `redundancy_mode` to `three_data_hall`.
For the other two created `FoundationDBCluster` resources you have to set the `seedConnectionString` to the current connection string of the `FoundationDBCluster` resource in az1.
The cluster will be stuck in a reconciling state until the other two `FoundationDBClusters`'s in `az2` and `az3` are created:

Expand All @@ -176,7 +176,7 @@ spec:
dataHall: az1
processGroupIDPrefix: az1
databaseConfiguration:
redundancyMode: three_data_hall
redundancy_mode: three_data_hall
seedConnectionString: ""
processes:
general:
Expand Down Expand Up @@ -290,7 +290,7 @@ All actions that the operator performs like changing the configuration or restar
The locking system is only intended to reduce the risk of frequent reoccurring recoveries.

You can enable this locking system by setting `lockOptions.disableLocks = false` in the cluster spec.
The locking system is automatically enabled by default for any cluster that has multiple regions in its database configuration, a `zoneCount` greater than 1 in its fault domain configuration, or `redundancyMode` equal to `three_data_hall`.
The locking system is automatically enabled by default for any cluster that has multiple regions in its database configuration, a `zoneCount` greater than 1 in its fault domain configuration, or `redundancy_mode` equal to `three_data_hall`.

The locking system uses the `processGroupIDPrefix` from the cluster spec to identify an process group of the operator.
Make sure to set this to a unique value for each Kubernetes cluster, both to support the locking system and to prevent duplicate process group IDs.
Expand Down

0 comments on commit f587893

Please sign in to comment.