diff --git a/akka-cluster-sharding/src/main/resources/reference.conf b/akka-cluster-sharding/src/main/resources/reference.conf index db56c8f2e0..8206019d46 100644 --- a/akka-cluster-sharding/src/main/resources/reference.conf +++ b/akka-cluster-sharding/src/main/resources/reference.conf @@ -95,6 +95,8 @@ akka.cluster.sharding { updating-state-timeout = 5 s # Settings for the coordinator singleton. Same layout as akka.cluster.singleton. + # The "role" of the singleton configuration is not used. The singleton role will + # be the same as "akka.cluster.sharding.role". coordinator-singleton = ${akka.cluster.singleton} # The id of the dispatcher to use for ClusterSharding actors. diff --git a/akka-cluster-sharding/src/main/scala/akka/cluster/sharding/ClusterSharding.scala b/akka-cluster-sharding/src/main/scala/akka/cluster/sharding/ClusterSharding.scala index 700320c6b2..938fec5e90 100644 --- a/akka-cluster-sharding/src/main/scala/akka/cluster/sharding/ClusterSharding.scala +++ b/akka-cluster-sharding/src/main/scala/akka/cluster/sharding/ClusterSharding.scala @@ -123,9 +123,6 @@ import akka.dispatch.Dispatchers * * The `ShardRegion` actor can also be started in proxy only mode, i.e. it will not * host any entities itself, but knows how to delegate messages to the right location. - * A `ShardRegion` starts in proxy only mode if the roles of the node does not include - * the node role specified in `akka.cluster.sharding.role` config property - * or if the specified `entityProps` is `None`/`null`. * * If the state of the entities are persistent you may stop entities that are not used to * reduce memory consumption. This is done by the application specific implementation of diff --git a/akka-cluster-sharding/src/main/scala/akka/cluster/sharding/ClusterShardingSettings.scala b/akka-cluster-sharding/src/main/scala/akka/cluster/sharding/ClusterShardingSettings.scala index 7ad745cd41..bac03c9c58 100644 --- a/akka-cluster-sharding/src/main/scala/akka/cluster/sharding/ClusterShardingSettings.scala +++ b/akka-cluster-sharding/src/main/scala/akka/cluster/sharding/ClusterShardingSettings.scala @@ -129,6 +129,10 @@ final class ClusterShardingSettings( def withTuningParameters(tuningParameters: ClusterShardingSettings.TuningParameters): ClusterShardingSettings = copy(tuningParameters = tuningParameters) + /** + * The `role` of the `ClusterSingletonManagerSettings` is not used. The `role` of the + * coordinator singleton will be the same as the `role` of `ClusterShardingSettings`. + */ def withCoordinatorSingletonSettings(coordinatorSingletonSettings: ClusterSingletonManagerSettings): ClusterShardingSettings = copy(coordinatorSingletonSettings = coordinatorSingletonSettings)