From 834a84fdd6e64fe37e24612652daf6f80c13bc87 Mon Sep 17 00:00:00 2001 From: Patrik Nordwall Date: Thu, 20 Aug 2015 19:07:41 +0200 Subject: [PATCH] =cls #17846 Add experimental note to ddata mode docs --- .../src/main/resources/reference.conf | 2 ++ akka-docs/rst/java/cluster-sharding.rst | 24 ++++++++++++------- akka-docs/rst/scala/cluster-sharding.rst | 24 ++++++++++++------- 3 files changed, 34 insertions(+), 16 deletions(-) diff --git a/akka-cluster-sharding/src/main/resources/reference.conf b/akka-cluster-sharding/src/main/resources/reference.conf index 7a477c8dfe..db56c8f2e0 100644 --- a/akka-cluster-sharding/src/main/resources/reference.conf +++ b/akka-cluster-sharding/src/main/resources/reference.conf @@ -68,6 +68,8 @@ akka.cluster.sharding { # Parameter which determines how the coordinator will be store a state # valid values either "persistence" or "ddata" + # The "ddata" mode is experimental, since it depends on the experimental + # module akka-distributed-data-experimental. state-store-mode = "persistence" # The shard saves persistent snapshots after this number of persistent diff --git a/akka-docs/rst/java/cluster-sharding.rst b/akka-docs/rst/java/cluster-sharding.rst index 217d62c879..b5caa18af8 100644 --- a/akka-docs/rst/java/cluster-sharding.rst +++ b/akka-docs/rst/java/cluster-sharding.rst @@ -179,14 +179,22 @@ shard resolution, e.g. to avoid too fine grained shards. Distributed Data Mode --------------------- -Instead of using ``akka-persistence`` is possible to use ``akka-distributed-data`` module. In such case -state of the ``ShardCoordinator`` will be replicated inside a cluster by the ``akka-distributed-data`` -module with the ``WriteMajority`` consistency. This mode could be enabled by setting up -``akka.cluster.sharding.state-store-mode`` as ``ddata``. -It make possible to remove ``akka-persistence`` dependency from a project if this dependency -has not using in user code and ``remember-entities`` is ``off``. -Note that option also could lead to the shards duplication in case of a cluster fragmentation -due to a broken replication between nodes. +Instead of using :ref:`persistence-java` it is possible to use the :ref:`distributed_data_java` module +as storage for the state of the sharding coordinator. In such case the state of the +``ShardCoordinator`` will be replicated inside a cluster by the Distributed Data module with +``WriteMajority``/``ReadMajority`` consistency. + +This mode can be enabled by setting configuration property ``akka.cluster.sharding.state-store-mode`` +as ``ddata``. + +You must explicitly add the ``akka-distributed-data-experimental`` dependency to your build if +you use this mode. It is possible to remove ``akka-persistence`` dependency from a project if it +is not used in user code and ``remember-entities`` is ``off``. + +.. warning:: + + The ``ddata`` mode is considered as **“experimental”** as of its introduction in Akka 2.4.0, since + it depends on the experimental Distributed Data module. Proxy Only Mode --------------- diff --git a/akka-docs/rst/scala/cluster-sharding.rst b/akka-docs/rst/scala/cluster-sharding.rst index 5c2e63eb39..1f0f0b8957 100644 --- a/akka-docs/rst/scala/cluster-sharding.rst +++ b/akka-docs/rst/scala/cluster-sharding.rst @@ -182,14 +182,22 @@ shard resolution, e.g. to avoid too fine grained shards. Distributed Data Mode --------------------- -Instead of using ``akka-persistence`` is possible to use ``akka-distributed-data`` module. In such case -state of the ``ShardCoordinator`` will be replicated inside a cluster by the ``akka-distributed-data`` -module with the ``WriteMajority`` consistency. This mode could be enabled by setting up -``akka.cluster.sharding.state-store-mode`` as ``ddata``. -It make possible to remove ``akka-persistence`` dependency from a project if this dependency -has not using in user code and ``remember-entities`` is ``off``. -Note that option also could lead to the shards duplication in case of a cluster fragmentation -due to a broken replication between nodes. +Instead of using :ref:`persistence-scala` it is possible to use the :ref:`distributed_data_scala` module +as storage for the state of the sharding coordinator. In such case the state of the +``ShardCoordinator`` will be replicated inside a cluster by the Distributed Data module with +``WriteMajority``/``ReadMajority`` consistency. + +This mode can be enabled by setting configuration property ``akka.cluster.sharding.state-store-mode`` +as ``ddata``. + +You must explicitly add the ``akka-distributed-data-experimental`` dependency to your build if +you use this mode. It is possible to remove ``akka-persistence`` dependency from a project if it +is not used in user code and ``remember-entities`` is ``off``. + +.. warning:: + + The ``ddata`` mode is considered as **“experimental”** as of its introduction in Akka 2.4.0, since + it depends on the experimental Distributed Data module. Proxy Only Mode ---------------