From 7f12bd9f4e066867c2144583bab744faf786ad3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johan=20Andr=C3=A9n?= Date: Tue, 23 May 2017 15:47:05 +0200 Subject: [PATCH] Extra warning about rolling upgrades and sharding added (#23000) * Extra warning about rolling upgrades and sharding added * More clear --- akka-docs/src/main/paradox/java/cluster-sharding.md | 12 +++++++++++- akka-docs/src/main/paradox/scala/cluster-sharding.md | 10 ++++++++++ 2 files changed, 21 insertions(+), 1 deletion(-) diff --git a/akka-docs/src/main/paradox/java/cluster-sharding.md b/akka-docs/src/main/paradox/java/cluster-sharding.md index 548c94bf9c..172739e31f 100644 --- a/akka-docs/src/main/paradox/java/cluster-sharding.md +++ b/akka-docs/src/main/paradox/java/cluster-sharding.md @@ -213,7 +213,7 @@ the cluster have been stopped the state is lost and not needed any more. The state of [Remembering Entities](#cluster-sharding-remembering) is also durable, i.e. it is stored to disk. The stored entities are started also after a complete cluster restart. -Cluster Sharding is using its own Distributed Data `Replicator` per node role. In this way you can use a subset of +Cluster Sharding is using its own Distributed Data `Replicator` per node role. In this way you can use a subset of all nodes for some entity types and another subset for other entity types. Each such replicator has a name that contains the node role and therefore the role configuration must be the same on all nodes in the cluster, i.e. you can't change the roles when performing a rolling upgrade. @@ -423,3 +423,13 @@ of entities that are alive in each shard. The purpose of these messages is testing and monitoring, they are not provided to give access to directly sending messages to the individual entities. + +## Rolling upgrades + +When doing rolling upgrades special care must be taken to not change any of the following aspects of sharding: + + * the `extractShardId` function + * the role that the shard regions run on + * the persistence mode + + If any one of these needs a change it will require a full cluster restart. \ No newline at end of file diff --git a/akka-docs/src/main/paradox/scala/cluster-sharding.md b/akka-docs/src/main/paradox/scala/cluster-sharding.md index 033c6a4602..450aa6e6af 100644 --- a/akka-docs/src/main/paradox/scala/cluster-sharding.md +++ b/akka-docs/src/main/paradox/scala/cluster-sharding.md @@ -425,3 +425,13 @@ of entities that are alive in each shard. The purpose of these messages is testing and monitoring, they are not provided to give access to directly sending messages to the individual entities. + +## Rolling upgrades + +When doing rolling upgrades special care must be taken to not change any of the following aspects of sharding: + + * the `extractShardId` function + * the role that the shard regions run on + * the persistence mode + + If any one of these needs a change it will require a full cluster restart. \ No newline at end of file