Complete the cluster registration

The final step in setting up Unified Stream Manager (USM) is to register your Confluent Platform cluster with Confluent Cloud. This process links the deployed USM Agent to a specific cluster ID from your self-managed environment.

Before you begin

  • You must have the cluster ID for your Confluent Platform cluster. To get the ID, log in to your cluster by using the Confluent Platform CLI and run the command confluent cluster list.

  • Ensure that your Confluent Cloud environment has the Advanced Governance package, which is required for USM. To upgrade your environment, see the upgrade instructions.

  1. Log in to your Confluent Platform cluster by using the Confluent Platform CLI.

  2. Get your cluster ID by listing the available clusters:

    confluent cluster list

  3. Return to the registration wizard in the Confluent Cloud Console and enter the Confluent Platform cluster ID. The Metadata region is automatically selected based on your private network configuration. You cannot change this setting.

  4. Enter a descriptive Cluster name to be used in the Confluent Cloud Console.

  5. Click Register cluster.

    After the registration succeeds, click Close Wizard. You are directed to the Confluent Platform Clusters page, which displays your newly registered cluster.

(Optional) If you haven’t upgraded your environment to include the Advanced Governance package, run the following command.

confluent environment update <environment-ID> --governance-package advanced

For example, to upgrade an environment with the ID env-abc123:

confluent environment update env-abc123 --governance-package advanced

The command will return a confirmation similar to this:
+---------------------------+------------+
| Current                   | false      |
| ID                        | env-abc123 |
| Name                      | env-name   |
| Stream Governance Package | ADVANCED   |
+---------------------------+------------+

To register a Confluent Platform cluster with the Confluent CLI, use the following command. Replace the placeholders with your own values:

confluent unified-stream-manager kafka register <cluster-ID> --name <cluster-name> --cloud <cloud-type> --region <region-name>

For example, to register a Kafka cluster with ID 4k0R9d1GTS5tI9f4Y2xZ0Q in AWS region us-east-1:

confluent unified-stream-manager kafka register 4k0R9d1GTS5tI9f4Y2xZ0Q --name my-kafka-cluster --cloud aws --region us-east-1

The command returns a confirmation similar to the following:

+--------------------------------+--------------------------+
| ID                             | usmkc-global-abcdef12345 |
| Name                           | my-kafka-cluster         |
| Confluent Platform Kafka       | 4k0R9d1GTS5tI9f4Y2xZ0Q   |
| Cluster ID                     |                          |
| Cloud                          | AWS                      |
| Region                         | us-east-1                |
| Environment                    | env-abc123               |
+--------------------------------+--------------------------+

For a complete reference of related commands, see the confluent unified-stream-manager documentation.

Register additional clusters

To register additional clusters:

  1. In the Confluent Cloud Console, navigate to the Environments page.

  2. Select your environment.

  3. In the navigation menu, click Clusters.

  4. On the Clusters page, click Register platform cluster.

    ../../_images/usm-additional-cluster.png

  5. Select your agent deployment option.

../../_images/usm-agent-choice-dialog.png

The registration dialog provides two options:

  • New agent: Deploy a new USM Agent in the Confluent Platform environment where the Kafka cluster resides to create a fresh agent deployment for the cluster.

  • Existing agent: Reuse an already deployed USM Agent in the Confluent Platform environment where the Kafka cluster resides to register additional clusters.

After you make your selection, click Get started to continue the registration process.

Deregister a Kafka cluster

When you deregister a Kafka cluster, the cluster is removed as a USM entity from Confluent Cloud. The USM Agent continues to run in your Confluent Platform environment and emits events, but Confluent Cloud rejects them because the Confluent Platform cluster no longer has a corresponding mapping in Confluent Cloud.

To stop these events, remove the USM-specific configuration from the Kafka cluster. After you remove the configuration, you can remove the USM Agent entirely, provided if no other Kafka or Connect cluster is using the agent.

You can deregister a Kafka cluster from USM using the Confluent Cloud Console or the Confluent CLI.

In the Confluent Cloud Console, you can deregister a Kafka cluster using one of the following methods:

  • From the Environments overview page

  • From the Clusters list

  • From the Cluster settings

  1. In the Confluent Cloud Console, navigate to the Environments page and select your environment.

  2. On the Environment overview page, locate the Recently created platform clusters section.

  3. On the cluster card for the cluster you want to remove, click the More icon (three vertical dots) and select Deregister cluster.

    Environment overview page showing the Deregister cluster option in the More menu

  4. In the Deregistering Confluent Platform Kafka cluster dialog, enter the cluster name exactly as shown.

    Deregistering Confluent Platform Kafka cluster confirmation dialog

  5. Click Deregister.

The cluster is removed from the Confluent Cloud Console.

  1. In the Confluent Cloud Console, navigate to the Environments page and select your environment.

  2. In the left navigation menu, click Clusters.

  3. On the Clusters page, select the Confluent Platform tab.

  4. Locate the cluster you want to deregister, click the More icon (three vertical dots), and select Deregister cluster.

    Clusters page showing the Deregister cluster option in the More menu

  5. In the Deregistering Confluent Platform Kafka cluster dialog, enter the cluster name exactly as shown.

  6. Click Deregister.

The cluster is removed from the Confluent Cloud Console.

  1. In the Confluent Cloud Console, navigate to the Environments page and select your environment.

  2. On the Clusters page, click the name of the cluster you want to deregister.

  3. In the left navigation, click Settings.

  4. On the General tab, click Deregister cluster at the bottom of the page.

    Cluster settings page showing the Deregister cluster button at the bottom

  5. In the Deregistering Confluent Platform Kafka cluster dialog, enter the cluster name and click Deregister.

The cluster is removed from the Confluent Cloud Console.

  1. Log in to the Confluent CLI.

    confluent login

  2. Get your environment ID. To find the environment ID:

    1. In the Confluent Cloud Console, navigate to the Environments page and select your environment.

    2. Click the Details tab and then copy the ID from the About section.

  3. List the clusters in your environment to find the USM_KAFKA_CLUSTER_ID of the cluster that you want to deregister:

    confluent unified-stream-manager kafka list --environment <YOUR_ENVIRONMENT_ID>

    From the output, identify the cluster that you want to deregister and copy its ID. The USM_KAFKA_CLUSTER_ID starts with the prefix usmkc-.

  4. Deregister the cluster:

    confluent unified-stream-manager kafka deregister <USM_KAFKA_CLUSTER_ID> --environment <YOUR_ENVIRONMENT_ID>

    For example, to deregister a cluster with the ID usmkc-abc123:

    confluent unified-stream-manager kafka deregister usmkc-abc123 --environment env-12345

  5. When prompted, enter y to confirm.

    Are you sure you want to deregister USM Kafka cluster "usmkc-abc123"? (y/n): y
Deregistered USM Kafka cluster "usmkc-abc123".

The cluster is removed from the Confluent Cloud Console.

For more information about related commands, see the confluent unified stream manager CLI documentation.

Related content