Clusters
Connect to clusters in the Synnax Console.
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
| Name | Description |
|---|---|
| Name | A human-readable name for the cluster. |
| Host | The hostname or IP address of the cluster. |
| Port | The port number of the cluster. |
| Username | The username to use when connecting to the cluster. |
| Password | The password to use when connecting to the cluster. |
| Secure | 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
Cluster Toolbar
The cluster toolbar is located at the bottom right of the screen. From this toolbar, you can add clusters, switch between them, and more.
If you have multiple clusters, you can switch between them by clicking on the cluster you’d like to connect to in the toolbar:
Right-clicking on a cluster in the toolbar will open a context menu with options to connect from, disconnect from, rename, and remove the cluster:
You can also copy a link to the cluster from the context menu. Opening this link will open the Synnax Console with the cluster already connected.
Currently, opening by link is only supported on Mac. Other platforms are planned to be supported in the future.
Next Steps
Next, learn how Synnax’s UI is organized.