Convergence Cluster Seed

This project contains the Convergence Cluster seed. It is a lightweight Akka cluster node that can be used to bootstrap the cluster. The project contains almost no code other than that required to start up the Akka cluster. This makes it very unlikely that the node will crash, and minimizes the amount of memory needed to maintain reliable cluster seeds.

Building

The project can be built using the build script:

scripts/build.sh

Running

• CLUSTER_SEED_NODES: A comma separated list of seed nodes. For example, host1,host2:25521. The format of each entry is hostname[:port]. If the port is omitted, it will default to 25520, which is the default port for Akka Artery Remoting.
• AKKA_LOG_LEVEL: A Log4J Log Level such as INFO, DEBUG.
• REMOTING_BIND_HOSTNAME: The hostname Akka will bind to. Defaults to 0.0.0.0.
• REMOTING_BIND_PORT: The port Akka will bind to. Defaults to 25520.
• REMOTING_EXTERNAL_HOSTNAME: The hostname external hosts will connect to the cluster seed. Required if the cluster seed is behind a proxy, or deployed in a docker environment like Kubernetes.
• REMOTING_EXTERNAL_PORT: The port external hosts will connect to the cluster seed. Required if the cluster seed is behind a proxy, or deployed in a docker environment like Kubernetes.

To run the container execute the following command:

docker run --rm \
  --publish 25520:25520 \
  --env CLUSTER_SEED_NODES="localhost" \
  --env EXTERNAL_HOSTNAME="localhost" \
  --env EXTERNAL_PORT="25520" \
  convergencelabs/convergence-cluster-seed

Note: If set, the EXTERNAL_PORT should match the Docker external port mapped to in the --publish option.

Support

Convergence Labs provides several different channels for support:

• Please use the Convergence Community Forum for general and technical questions, so the whole community can benefit.
• For paid dedicated support or custom development services, contact us directly.
• Chat with us on the Convergence Public Slack.
• Email [email protected] for all other inquiries.

License

The Convergence Server is licensed under the GNU Public License v3 (GPLv3) license. Refer to the LICENSE for the specific terms and conditions of the license.

The Convergence Server is also available under a Commercial License. If you are interested in a non-open source license please contact us at Convergence Labs.