Enabling clustering

Last Updated : Aug 13, 2024 |

About this task

This task explains how to configure the parameters required to enable the Communication Manager clustering feature.

If you are integrating with Kafka, you must enable clustering.
Note:

The Kafka integration feature is reserved for future use.

Before you begin

  • Make sure you configure or collect the following CCM, CSP, and Communication Manager details:

    • Configure the DNS IP in Communication Manager, also used in CSP.

    • CCM IP address, user name, and password.

    • Data Center Name given during CSP installation.

    • KafkaFQDN and PrimaryZooFQDN given during CSP installation.

    • My FQDN and Alias FQDN of Communication Manager.

  • Install Communication Manager Release 10.1.0.2 or later release service pack.

Procedure

  1. On the Communication Manager SMI, click Administration > Server (Maintenance).
  2. In the navigation pane, click Server Configuration > Cluster Enablement.
  3. For CM Cluster, select Yes.

    By default, Yes is selected if you deploy Communication Manager with a 300K (X-Large) profile.

    By default, No is selected if you deploy Communication Manager with a profile other than 300K (X-Large).

    The SMI page displays the Configure Cluster Enablement Data section with the fields required to enable the Communication Manager clustering feature.

  4. In the Customer ID field, enter the customer ID.
  5. In the Kafka Deployment Mode field, select one of the following and enter the required details:

    • Onpremise: Select this option to configure Kafka deployed on on-premise.

    • Cloud: Select this option to configure Kafka deployed on cloud environment.

  6. In the Do you wish to have CM metrics on Prometheus (TCP Port 9000) field, select Yes to save the Communication Manager metrics on Prometheus.

    The Communication Manager metrics include parameters such as CPU, memory, homed users count, and AMS resource utilization.

    The SMI page displays the Configure Cluster Control Manager Details section.

  7. Click Save to save the settings and configurations.

    The Cluster Enablement pop-up prompts to restart the server.

  8. Select Restart Now to restart the server immediately, or click Cancel to restart the server later.
    Important:

    Do not restart the server multiple times as it may lead to a full Communication Manager reboot.

    After you enable Communication Manager as a cluster Communication Manager, you cannot change the configuration to non-cluster.

  9. Repeat steps 1 to 7 for the remaining Communication Manager instances in the cluster.

Verify the kafka status and the Master Communication Manager IP address to confirm the cluster configuration.

  1. On the command line interface, run the # kafkactl status command and verify the following:

    • JKC is running.

    • Kafka Broker is connected.

    • Timestamp since Kafka Broker is connected to Communication Manager.

    • Kproxy reports Communication Manager status as UP.

    • ZKC is connected to the Kafka.

  2. To verify the Master Communication Manager IP address, do the following:
    1. On the SAT command line interface, type # display cluster master-cm.
    2. Ensure an IP address is registered against the Master CM IP Address field.
Related information
Configure Cluster Enablement Data field descriptions