From 4029669e1fe0cf876e2d391445faccf8781d1efd Mon Sep 17 00:00:00 2001 From: Konrad Malawski Date: Tue, 9 Feb 2016 14:21:38 +0100 Subject: [PATCH] =doc hide auto downing from default sample config in cluster --- akka-docs/rst/java/cluster-usage.rst | 8 ++++---- akka-docs/rst/scala/cluster-usage.rst | 8 ++++---- .../src/main/resources/application.conf | 9 +++++++++ .../src/main/resources/application.conf | 11 ++++++++++- 4 files changed, 27 insertions(+), 9 deletions(-) diff --git a/akka-docs/rst/java/cluster-usage.rst b/akka-docs/rst/java/cluster-usage.rst index 552223a183..6972f7a41b 100644 --- a/akka-docs/rst/java/cluster-usage.rst +++ b/akka-docs/rst/java/cluster-usage.rst @@ -1,9 +1,9 @@ .. _cluster_usage_java: -###################### - Cluster Usage -###################### +############# +Cluster Usage +############# For introduction to the Akka Cluster concepts please see :ref:`cluster`. @@ -28,7 +28,7 @@ It joins the cluster and an actor subscribes to cluster membership events and lo The ``application.conf`` configuration looks like this: -.. includecode:: ../../../akka-samples/akka-sample-cluster-java/src/main/resources/application.conf +.. includecode:: ../../../akka-samples/akka-sample-cluster-java/src/main/resources/application.conf#snippet To enable cluster capabilities in your Akka project you should, at a minimum, add the :ref:`remoting-java` settings, but with ``akka.cluster.ClusterActorRefProvider``. diff --git a/akka-docs/rst/scala/cluster-usage.rst b/akka-docs/rst/scala/cluster-usage.rst index cfa6bff926..4cef8875a2 100644 --- a/akka-docs/rst/scala/cluster-usage.rst +++ b/akka-docs/rst/scala/cluster-usage.rst @@ -1,9 +1,9 @@ .. _cluster_usage_scala: -####################### - Cluster Usage -####################### +############# +Cluster Usage +############# For introduction to the Akka Cluster concepts please see :ref:`cluster`. @@ -22,7 +22,7 @@ It joins the cluster and an actor subscribes to cluster membership events and lo The ``application.conf`` configuration looks like this: -.. includecode:: ../../../akka-samples/akka-sample-cluster-scala/src/main/resources/application.conf +.. includecode:: ../../../akka-samples/akka-sample-cluster-scala/src/main/resources/application.conf#snippet To enable cluster capabilities in your Akka project you should, at a minimum, add the :ref:`remoting-scala` settings, but with ``akka.cluster.ClusterActorRefProvider``. diff --git a/akka-samples/akka-sample-cluster-java/src/main/resources/application.conf b/akka-samples/akka-sample-cluster-java/src/main/resources/application.conf index 6968532f37..4b2b44c9e9 100644 --- a/akka-samples/akka-sample-cluster-java/src/main/resources/application.conf +++ b/akka-samples/akka-sample-cluster-java/src/main/resources/application.conf @@ -1,3 +1,4 @@ +#//#snippet akka { actor { provider = "akka.cluster.ClusterActorRefProvider" @@ -15,7 +16,14 @@ akka { "akka.tcp://ClusterSystem@127.0.0.1:2551", "akka.tcp://ClusterSystem@127.0.0.1:2552"] + #//#snippet + # excluded from snippet auto-down-unreachable-after = 10s + #//#snippet + # auto downing is NOT safe for production deployments. + # you may want to use it during development, read more about it in the docs. + # + # auto-down-unreachable-after = 10s } } @@ -28,3 +36,4 @@ akka.extensions=["akka.cluster.metrics.ClusterMetricsExtension"] # Sigar native library extract location during tests. # Note: use per-jvm-instance folder when running multiple jvm on one host. akka.cluster.metrics.native-library-extract-folder=${user.dir}/target/native +#//#snippet diff --git a/akka-samples/akka-sample-cluster-scala/src/main/resources/application.conf b/akka-samples/akka-sample-cluster-scala/src/main/resources/application.conf index 6968532f37..676a223350 100644 --- a/akka-samples/akka-sample-cluster-scala/src/main/resources/application.conf +++ b/akka-samples/akka-sample-cluster-scala/src/main/resources/application.conf @@ -1,3 +1,4 @@ +#//#snippet akka { actor { provider = "akka.cluster.ClusterActorRefProvider" @@ -15,7 +16,14 @@ akka { "akka.tcp://ClusterSystem@127.0.0.1:2551", "akka.tcp://ClusterSystem@127.0.0.1:2552"] + #//#snippet + # excluded from snippet auto-down-unreachable-after = 10s + #//#snippet + # auto downing is NOT safe for production deployments. + # you may want to use it during development, read more about it in the docs. + # + # auto-down-unreachable-after = 10s } } @@ -26,5 +34,6 @@ akka.cluster.metrics.enabled=off akka.extensions=["akka.cluster.metrics.ClusterMetricsExtension"] # Sigar native library extract location during tests. -# Note: use per-jvm-instance folder when running multiple jvm on one host. +# Note: use per-jvm-instance folder when running multiple jvm on one host. akka.cluster.metrics.native-library-extract-folder=${user.dir}/target/native +#//#snippet