Update a Connect cluster
Stay organized with collections Save and categorize content based on your preferences.

You can edit a Connect cluster to update properties like the number of vCPUs, memory, network, and labels.

To edit 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 update a Connect cluster.

Before you begin

Not all the properties of a Connect cluster are editable. Review the properties of a Connect cluster before you update.

Required roles and permissions to edit a Connect cluster

To get the permissions that you need to edit 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 edit a Connect cluster. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to edit a Connect cluster:

Grant the update a Connect cluster permission on the specified location: managedkafka.connectClusters.update
Grant the view a Connect cluster permission on the specified location. This permission is only required for updating a Connect Cluster using the Google Cloud console: managedkafka.connectors.list

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

For more information about this role, see Managed Service for Apache Kafka predefined roles.

Edit a Connect cluster

Updating certain properties, such as CPU and memory, requires a cluster restart.

Cluster restarts preserve data but might increase latency. The initial number of workers in the cluster determines the restart duration.

You can update the following Connect cluster properties:

Property	Editable
vCPUs	Yes
Memory	Yes
Network	Yes
Primary Subnet	Yes
Additional Subnets	Yes (Add/Delete)
Resolvable DNS domains	Yes (Add/Delete)
Connect cluster name	No
Kafka cluster	No
Location	No
Labels	Yes (Add/Edit/Delete)
Secrets	Yes (Add/Delete)

Console

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

Go to Connect clusters

The Connect clusters you created in a project are listed.
Click on the Connect cluster that you want to update.

The Connect cluster details page is displayed.
Click Edit.

The Edit Kafka Connect cluster page is displayed.
Make the necessary changes to the editable properties.
Click Save.

gcloud

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.
Run the gcloud alpha managed-kafka connect-clusters update command:
```
gcloud alpha managed-kafka connect-clusters update CONNECT_CLUSTER_ID \
    --location=LOCATION \
    [--cpu=CPU --memory=MEMORY --clear-configs \
     | --config-file=CONFIG_FILE \
     | --configs=CONFIGS --clear-dns-names \
     | --dns-name=DNS_NAME --clear-labels \
     | --labels=LABELS --clear-secrets \
     | --secret=SECRET [--primary-subnet=PRIMARY_SUBNET \
     : --additional-subnet=ADDITIONAL_SUBNET]] \
    [--async]
```
Replace the following:
- CONNECT_CLUSTER_ID: The ID or name of the Connect cluster. The name of a Connect cluster is immutable.
- LOCATION: The location of the Connect cluster. The location of a Connect cluster is immutable.
- CPU: The number of vCPUs for the Connect cluster. The minimum value is 3 vCPUs.
- MEMORY: The amount of memory for the Connect cluster. Use "MB", "MiB", "GB", "GiB", "TB", or "TiB" units. For example, "10GiB". You must provision between 1 GiB and 8 GiB per vCPU.
- CONFIG_FILE: The path to the JSON or YAML file containing the configuration that are overridden from the cluster or connector defaults. This also supports inline JSON or YAML.
- CONFIGS: Configuration for the Connect clusteare overridden from the cluster defaults. The key of the map is a Kafka topic property name, for example: cleanup.policy=compact,compression.type=r that producer.
- DNSNAME: DNS domain name from the subnet's network to be made visible to the Connect Cluster.
- LABELS: (Optional) Labels to associate with the cluster. For more information about the format for labels, see Labels. List of label KEY=VALUE pairs to add. Keys must start with a lowercase character and contain only hyphens (-), underscores (), lowercase characters, and numbers. Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
- SECRET: (Optional) Secrets to load into workers. Exact Secret versions from Secret Manager must be provided, aliases are not supported. Up to 32 secrets may be loaded into one cluster. Format: projects/PROJECT_ID/secrets/SECRET_NAME/versions/VERSION_ID
- PRIMARY_SUBNET: The primary subnet for the Connect cluster.
  The format of the subnet is projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET_ID.
  The primary subnet must be in the same region as the Connect cluster. See Connected subnets.
- ADDITIONAL_SUBNET: (Optional) Additional subnets for the Connect cluster. The other subnets can be in a different region than the Connect cluster, but must be in the same VPC network. See Connected subnets.

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.