Configure On-Premises Broker in the Cedalo MQTT Platform

After downloading and deploying a setup from your account at platform.cedalo.cloud, every on-premises platform installation includes a predefined connection to the Pro Mosquitto broker, which is part of the setup. This applies to all versions, regardless of whether you have chosen the Business or Enterprise edition, or whether the setup is a Single Node or Cluster version.

Add New Connection

A new connection to a broker can be established within each project you have defined. A user can own multiple projects and share these with other users. For more details, see Project Management. If you wish to add additional brokers or clusters to your platform, ensure you are using the Enterprise edition, as it is the only edition capable of accessing the project level of the platform.

Within a project, you can add either a new single-node broker or a cluster. Choose one of the options below to start creating a new connection.

Ensure that you use an admin user with sufficient permissions to manage the platform. It is recommended to use the predefined admin user for the Pro Mosquitto broker for this purpose. The default credentials for this user can be found in the Mosquitto folder of your setup.

Single Node

Enter the connection details for your broker. You will need to provide the following information:

• Name: A name used to reference the broker within the project.
• URL: The URL or IP address for the connection. Ensure you include the appropriate prefix, such as mqtt://, mqtts://, ws://, or wss://, before the URL.
• Credentials: The username and password of an admin user with sufficient permissions.
• Certificates: If required, add the server CA and/or client certificate for authentication to securely connect to your broker.

Cluster

A new cluster can be created, or the platform can discover an existing cluster.

Add New Cluster

After clicking "Add Cluster", the platform will prompt you to enter the details for the cluster you wish to create. Before proceeding, ensure that your cluster nodes are configured and available as outlined here.

• Name: The name used to identify the cluster in the configuration. This name will also appear on the project overview page.
• Cluster Mode: Select the cluster mode to use.
• Cluster Nodes: Add the nodes to include in the cluster. Use the admin port connection (default: port 1885). A minimum of three nodes must be configured and accessible to create a cluster.

Click "Create Cluster" to initiate the cluster. Once the cluster is created, you will be prompted to provide the following:

• Public Cluster Connection: Define the public connection the platform will use to connect to the cluster.

After completing these steps, the cluster is ready to use. The platform will detect the current leader via the admin port connection and establish a connection to it. The leader serves as the primary source of truth for the platform and is responsible for displaying the content of the menus. In the background, the leader synchronizes all relevant information with its follower nodes to ensure consistency. If another node takes over the lead, the platform will detect it and display the changes in the UI.

Changes to the cluster are only possible as long as a functional cluster is detected (a majority of nodes is reachable).

Cluster Nodes

To create a cluster, you must specify at least three nodes in the Cluster Nodes menu. Additional nodes can be added later as long as the cluster remains functional (i.e., the majority of nodes are online).

Connections defined here must use the admin port (default: 1885), as these connections allow the platform to administer nodes and communicate with them individually.

Public Cluster Connection

Enter the public connection details in this field. These details are used by the platform to display connection information via the connection tile and are also utilized by the "Publish & Subscribe" tool to connect to the broker.

Use the public port instead of the admin port specified in the Cluster Nodes step. The public port is defined through the HAProxies and is the same port your connecting clients will use. Depending on your HAProxy configuration, you may already be using a DNS instead of an IP address for this connection.

Discover Existing Cluster

An existing cluster can be discovered by adding the admin port connection of one of its nodes. The platform will detect that the node is already part of a cluster and will prompt you to import the cluster details. Click "Import", and the platform will prefill details for all nodes. Since connection details to the cluster are not saved on the cluster itself, the platform will suggest connection details for the detected nodes. Adjust these details if necessary.

Once all detected nodes are accessible, the cluster can be imported. To complete the configuration, you will need to enter the Public Cluster Connection details, as described earlier.

Change Connection Details

To modify existing connection details, open the "Home" menu of your broker connection and click the edit button in the top-right corner of the "Connection" tile. Here, you can update the connection details.

Single Node

It is possible to compltly change the details fo a connection, which could also mean connecting a totally different broker as before. Make sure to use an admin user. If you use a user without sufficient rights, the platform connection to the broker won´t be able to work properly.

Cluster

For clusters, an overview of the defined Public Cluster Connection and all connected Cluster Nodes will be displayed.

Delete a Cluster

To delete a cluster, select the delete action from the Public Cluster Connection section. This will remove the cluster from the platform and initiate its deletion on the individual nodes.

Change Cluster Nodes

Add Node

To add nodes, click "Add Node" and enter the admin port details to connect and include the node in the cluster.

Remove Node

Nodes can only be removed if the cluster contains more than three nodes. A minimum of three nodes is required for a cluster to remain functional.