Managing clusters

The Manage clusters page displays all the clusters you have added to Event Endpoint Management. You can add new clusters, edit the details you provided about the cluster, and delete the cluster.

If you’re using Event Endpoint Management 11.4.1 and later, you can use this page to add a cluster manually. After you have added a cluster you can check the status of the gateway visibility in the table.

To access the Manage clusters page:

1. Log in to the Event Endpoint Management UI with your login credentials.
2. In the navigation pane, click Manage clusters.

Adding a cluster

To add a cluster, complete the following steps.

1. Click Create cluster.
2. In the Add cluster window, provide a unique name for the cluster in the Cluster name field, then click Next.
3. Enter a bootstrap server URL for the Kafka cluster.

4. Optional: You can click Add URL, and add one or more additional bootstrap servers, then click Next.

   Note: After you click Next, Event Endpoint Management validates the entered bootstrap server URLs. While validating, if any untrusted certificates are found on the bootstrap server URLs, you are asked to confirm whether you accept the certificates found. If you do, select the Accept all certificates checkbox, and click Next.

5. Optional: If a No connection warning message is displayed, follow the steps to add your server manually.
6. Optional: If the Kafka endpoint is configured to require mutual TLS authentication, then you must upload the private and public keys that were provided to you by your Kafka Cluster Administrator. Upload the private and public keys in PEM format.
7. If the entered bootstrap server URLs require SASL credentials to authenticate with Kafka, you are prompted to provide credential details. If required, select the Security protocol, and enter your username and password.
8. Click Add cluster.

Event Endpoint Management validates whether the entered credentials are valid to connect to the cluster. If valid, or if credentials were not required, your cluster is added to Event Endpoint Management, and you are returned to the Manage clusters page, where your new cluster appears, and can be edited.

Adding a cluster manually

You might want to add a Kafka cluster manually when it is located behind a different firewall or is subject to specific network policies that restrict visibility from your Event Endpoint Management instance.

To add a cluster manually, complete the following steps.

1. Click Create cluster.
2. In the Add cluster window, provide a unique name for the cluster in the Cluster name field, then click Next.
3. Enter the bootstrap server URL of your Kafka cluster in host:port format. If the Event Endpoint Management cannot verify the connection, a No connection information message is displayed.
4. Click Add servers manually.
5. Optional: Upload associated certificates. The table is populated with the relevant details. Click Next.
6. If the Kafka endpoint is configured to require mutual TLS authentication, then you must upload the private and public keys that were provided to you by your Kafka Cluster Administrator. Upload the private and public keys in PEM format.
7. Click Next.
8. Update the Credentials page as required.
9. Click Add cluster.

Your cluster is added to Event Endpoint Management, and you are returned to the Manage clusters page, where your new cluster is displayed with the Gateway visibility state as Pending validation.

Editing a cluster

To edit the details of a cluster, complete the following steps.

1. Locate the cluster to be edited in the Manage clusters page table and click the edit icon

   The Cluster information screen is displayed with your existing cluster name. You can edit the cluster name and provide a new name, or leave it as it is.

   Note: The cluster name must not be the same as the name of another cluster. The maximum length of a cluster name is 200 characters.

2. Click Next. The existing bootstrap servers for your cluster are displayed. Amend the bootstrap server URLs for the Kafka cluster.

   Optional: You can click Add URL to add one or more additional bootstrap servers, then click Next.

   Note: When you click Next, Event Endpoint Management validates the entered bootstrap server URLs. While validating, if any untrusted certificates are found on the bootstrap server URLs, you will be asked to confirm if you accept the certificates found. If you do, select the Accept all certificates checkbox. Even if you have previously accepted these certificates, you will need to accept them again, and click Next.

3. If the entered bootstrap server URLs require SASL credentials to authenticate with Kafka, you will be prompted to provide the credential details. If required, select the Security protocol to enter your username and password, and click Save.

   Note: After clicking Save, Event Endpoint Management validates whether the entered credentials are valid to connect to the cluster. If the credentials are valid, or credentials were not required, your cluster will be edited and saved accordingly.

Editing a cluster in Event Endpoint Management 11.4.1 and later

If you’re using Event Endpoint Management 11.4.1 and later, complete the following steps to edit the details of a cluster.

1. Locate the cluster to be edited in the Manage clusters page table and click the edit icon

2. The Cluster information screen is displayed with your existing cluster name. You can edit the cluster name and provide a new name, or leave it as it is.

   Note: The cluster name must not be the same as the name of another cluster. The maximum length of a cluster name is 200 characters.

3. Click Save to exit the dialog or click Server to edit the server details.
4. If you clicked Server, the existing bootstrap servers for your cluster are displayed. If required, amend the bootstrap server URLs for the Kafka cluster.
5. Optional: You can click Add URL to add one or more additional bootstrap servers.
6. Click Save to exit the dialog or click Credentials to edit the credentials.
7. If you clicked Credentials, clear the Use existing credentials checkbox to update the credentials as required.
8. Click Save.

Deleting a cluster

Clusters can be deleted from Event Endpoint Management if they are no longer in use. You can only delete a cluster if all previously added topics from this cluster have been deleted.

To delete a cluster from Event Endpoint Management, complete the following steps.

1. Locate the cluster you want to delete in the list on the Manage clusters page, and click the delete icon to open the Delete cluster dialog.
2. Confirm the cluster that you want to delete by entering the cluster name.
3. Click Delete. This will be visible in the footer if you have entered the cluster name that you want to delete correctly.

Cluster validation states

The table on the Manage clusters page displays the status of all the gateways added to Event Endpoint Management. See the following table for a description of the different validation states.