Skip to content

Commit 2f49176

Browse files
committed
Add documentation
1 parent 833d762 commit 2f49176

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

Documents/cluster.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# HMDA Akka Cluster Configuration
2+
3+
## Cluster Management
4+
5+
The project uses the [Akka Cluster HTTP Management](http://developer.lightbend.com/docs/akka-management/current/cluster-http-management.html) module to report on cluster member status as well as to perform cluster
6+
management tasks. Please refer to the documentation of this module for cluster management tasks (i.e. downing a node from the cluster)

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,9 @@ In addition, you'll need Scala's interactive build tool [sbt](http://www.scala-s
7272

7373
## Building and Running
7474

75-
The HMDA Platform uses sbt's multi-project builds, each project representing a specific task.
75+
The HMDA Platform uses sbt's multi-project builds, each project representing a specific task. The platform is an Akka Cluster
76+
application that can be deployed on a single node or as a distributed application. For more information on how Akka Cluster
77+
is used, see the documentation [here](Documents/cluster.md)
7678

7779
### Interactive
7880

0 commit comments

Comments
 (0)