Getting started with USM

This page describes the requirements for using Unified Stream Manager (USM) and outlines the deployment pathways for different environments.

Prerequisites

Before you begin, ensure that your environment meets the following requirements.

  • Confluent Platform version: USM requires Confluent Platform 8.1 or later. If you have an existing deployment, you must upgrade your on-premises cluster before you proceed.
  • Interoperability: Review the Supported Versions and Interoperability to ensure that your Confluent Platform version and deployment toolset are compatible with the USM agent.
  • Deployment toolset: You must use one of the two supported toolsets to deploy and manage the USM agent:
    • Confluent for Kubernetes: Deploy and manage the USM agent as a native Kubernetes resource (CustomResource) in containerized environments.
    • Ansible Playbooks for Confluent Platform: Use Ansible Playbooks for Confluent Platform to deploy and configure the USM agent on Linux-based virtual machines (VMs) or bare-metal servers.

Deployment pathway

Choose the pathway that matches your environment.

  • For a new Confluent Platform deployment: If you are deploying Confluent Platform 8.1 or later for the first time, deploy your cluster, then follow the Registration process overview.
  • For an existing Confluent Platform deployment: If you have an existing deployment, you must first upgrade your cluster to Confluent Platform 8.1 or later. After the upgrade is complete, follow the Registration process overview.
  • For a hybrid deployment (existing Confluent Platform and Confluent Cloud): If you already use both Confluent Platform and Confluent Cloud, first upgrade your Confluent Platform cluster to version 8.1 or later. You might need to upgrade to the Advanced Governance package in Confluent Cloud. Then, follow the Registration process overview, from setting up private network configuration.

Registration process overview

To register your cluster, you need to complete the following high-level steps.

  1. Sign up for Confluent Cloud and configure billing.
  2. Establish a secure network connection between your on-premises environment and Confluent Cloud.
  3. Create a service account with the required roles and generate API credentials for the USM agent.
  4. Deploy the USM agent in your Confluent Platform environment by using your chosen toolset.
  5. Register your Confluent Platform cluster with Confluent Cloud.

Related content