Delete a Connect cluster

Deleting a Connect cluster erases all associated data, including connector configurations stored in its primary Kafka cluster. This action is irreversible.

To delete a Connect cluster, you can use the Google Cloud console, the gcloud CLI, the client library, or the Managed Kafka API. You can't use the open source Apache Kafka API to delete a Connect cluster.

Required roles and permissions to delete a Connect cluster

To get the permissions that you need to delete a Connect cluster, ask your administrator to grant you the Managed Kafka Connect Cluster Editor (roles/managedkafka.connectClusterEditor) IAM role on your project. For more information about granting roles, see Manage access to projects, folders, and organizations.

This predefined role contains the permissions required to delete a Connect cluster. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to delete a Connect cluster:

  • Grant the delete a Connect cluster permission on the Connect cluster: managedkafka.connectClusters.delete
  • Grant the list Connect clusters permission on the specified location. This permission is only required for deleting a Connect cluster using the Google Cloud console: managedkafka.connectClusters.list

You might also be able to get these permissions with custom roles or other predefined roles.

For more information about the Managed Kafka Connect Cluster Editor role, see Managed Service for Apache Kafka predefined roles.

Delete a Connect cluster

  • Understand data loss implications: Deleting a Connect cluster erases all data stored within the Connect cluster itself. This includes the following:

    • Connectors and their configurations

    • Any other data directly managed by the Connect cluster

    Deleting a Connect cluster does not delete data in your source or target Kafka clusters. If you're using a source connector to move data to a Kafka topic, deleting the Connect cluster does not delete the data that is already published to that Kafka topic. Similarly, deleting a Connect cluster does not delete the Kafka clusters that the Connect cluster is associated with.

  • Plan for service disruption: Any applications or services depending on data read or written by the Connect cluster might experience disruptions. Plan for this service disruption before deleting the cluster.

  • Review billing implications: You stop incurring charges for the cluster after you delete it. You might still be billed for resources used until deletion.

  • Expect asynchronous operation: Cluster deletion is asynchronous by default. The command returns immediately, and you can track the deletion progress separately.

Console

  1. In the Google Cloud console, go to the Connect clusters page.

    Go to Connect clusters

  2. Select the Connect cluster that you want to delete. You can select more than one.

  3. Click Delete.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Use the gcloud alpha managed-kafka connect-clusters delete command to delete Connect clusters:

    gcloud alpha managed-kafka connect-clusters delete CONNECT_CLUSTER \
    --location=LOCATION [--async]

    Replace the following:

    • CONNECT_CLUSTER: The ID of the Connect cluster you want to delete.

    • LOCATION: The location of the Connect cluster.

    The following flag is optional:

    • --async: Return immediately, without waiting for the operation in progress to complete.

    For example, to delete a Connect cluster named my-connect-cluster in the us-central1 location, you would run:

    gcloud alpha managed-kafka connect-clusters delete \
    my-connect-cluster --location=us-central1

What's next?

Apache Kafka® is a registered trademark of The Apache Software Foundation or its affiliates in the United States and/or other countries.