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.

Register additional clusters

To register more clusters, go to the Environments page in the Confluent Cloud Console and click Register Platform cluster. You can choose to reuse an existing USM Agent or create a new agent.

Deregister a Kafka cluster

You can deregister a Kafka cluster from USM using the Confluent CLI. Deregistering the Kafka cluster using the Confluent Cloud Console is not supported.

  1. Log in to the Confluent CLI.

    confluent login

  2. Get the Environment ID using the following steps:

    1. In the Confluent Cloud Console, navigate to the Environments page and select your environment.
    2. Click the Details tab and copy the ID from the About section.

  3. Run the list command to find the specific USM_KAFKA_CLUSTER_ID for the cluster you want to deregister.

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

    From the output, identify the Kafka cluster you want to remove and copy its ID. Note that a USM_KAFKA_CLUSTER_ID always starts with the prefix usmkc-.

  4. Use the confluent unified-stream-manager kafka deregister command with the usmkc- ID you copied.

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

    The following example deregisters a Kafka cluster with the ID usmkc-abc123:

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

  5. The CLI prompts you for confirmation. Type y and press Enter to proceed.

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

Upon successful deregistration, the corresponding Kafka cluster card is removed from the Confluent Cloud Console.

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

Related content