Clarify docs around cluster shutdown (#30825)

* Clarify docs around cluster shutdown

Previous docs could give the impression that changing the number of cluster nodes required a full shutdown.  This clarifies that the shutdown is only needed if changing the number of shards and that adjusting the number of shards is not required for changing the number of nodes.
This commit is contained in:
Levi Ramsey 2021-10-28 02:44:21 -04:00 committed by GitHub
parent d11a15c50f
commit 1adc1a9250
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -167,9 +167,10 @@ If you need to change any of the following aspects of sharding it will require a
* The `extractShardId` function
* The role that the shard regions run on
* The persistence mode - It's important to use the same mode on all nodes in the cluster
* If the [amount of nodes](https://doc.akka.io/docs/akka/2.5/cluster-sharding.html#an-example) is changed, the [`number-of-shards`](https://doc.akka.io/docs/akka/current/typed/cluster-sharding.html#shard-allocation) may be adapted as well
* The persistence mode - It's important to use the same mode on all nodes in the cluster
* The @ref:[`number-of-shards`](../typed/cluster-sharding.md#basic-example) - Note: changing the number
of nodes in the cluster does not require changing the number of shards.
### Cluster configuration change
* A full restart is required if you change the [SBR strategy](https://doc.akka.io/docs/akka/current/split-brain-resolver.html#strategies)