Connect a Cluster

Learn how to connect a cluster using the Synnax Console.

Prerequisites

This page assumes you’ve already:

Adding a New Cluster

Adding a new cluster is as simple as clicking the Add Cluster button in the top right corner of the cluster toolbar and entering your connection parameters, as shown below.

This will add a new cluster to the list and set it as active. The console continuously monitors the connection to the cluster and displays it in the bottom right corner of the UI.

Parameters

NameDescription
NameA human-readable name for the cluster.
HostThe hostname or IP address of the cluster.
PortThe port number of the cluster.
UsernameThe username to use when connecting to the cluster. If you didn't set a username when starting the cluster, this defaults to 'synnax'.
PasswordThe password to use when connecting to the cluster. If you didn't set a password when starting the cluster, this defaults to 'seldon'.
SecureA boolean value indicating whether to use TLS when connecting to the cluster. This parameter only works with secure clusters.

The console will not connect to remote clusters (i.e. host is not ‘localhost’) started with the --insecure flag.

Demo Cluster

Synnax has a demo cluster that can be connected to which always plots some data. To connect, enter the following parameters:

  • Host: demo.synnaxlabs.com
  • Port: 9090
  • Username: synnax
  • Password: seldon
  • Secure: True

Switching Clusters

If you have multiple clusters, you can switch between them by double clicking on the cluster you’d like to to connect in the toolbar:

Next Steps

You can find a basic overview of the console UI on the UI overview page.