Operating a Cluster

This documentation discusses how to operate a cluster. For related, more specific guides see Packaging, Deploying and Rolling Updates.

Starting

Cluster Bootstrap

When starting clusters on cloud systems such as Kubernetes, AWS, Google Cloud, Azure, Mesos or others, you may want to automate the discovery of nodes for the cluster joining process, using your cloud providers, cluster orchestrator, or other form of service discovery (such as managed DNS).

The Akka Management library includes the Cluster Bootstrap module which handles just that. Please refer to its documentation for more details.

Note

If you are running Akka in a Docker container or the nodes for some other reason have separate internal and external ip addresses you must configure remoting according to Akka behind NAT or in a Docker container

Stopping

See Rolling Updates, Cluster Shutdown and Coordinated Shutdown.

Cluster Management

There are several management tools for the cluster. Complete information on running and managing Akka applications can be found in the project documentation.

HTTP

Information and management of the cluster is available with a HTTP API. See documentation of Akka Management.

JMX

Information and management of the cluster is available as JMX MBeans with the root name akka.Cluster. The JMX information can be displayed with an ordinary JMX console such as JConsole or JVisualVM.

From JMX you can:

see what members that are part of the cluster
see status of this node
see roles of each member
join this node to another node in cluster
mark any node in the cluster as down
tell any node in the cluster to leave

Member nodes are identified by their address, in format akka://actor-system-name@hostname:port.

Monitoring and Observability

Aside from log monitoring and the monitoring provided by your APM or platform provider, Lightbend Telemetry, available through a Lightbend Subscription, can provide additional insights in the run-time characteristics of your application, including metrics, events, and distributed tracing for Akka Actors, Cluster, HTTP, and more.