HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/current/help/man/man1/gcloud_beta_managed-kafka_clusters_update.1
.TH "GCLOUD_BETA_MANAGED\-KAFKA_CLUSTERS_UPDATE" 1



.SH "NAME"
.HP
gcloud beta managed\-kafka clusters update \- update a Managed Service for Apache Kafka cluster



.SH "SYNOPSIS"
.HP
\f5gcloud beta managed\-kafka clusters update\fR (\fICLUSTER\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-auto\-rebalance\fR\ \fB\-\-cpu\fR=\fICPU\fR\ \fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-memory\fR=\fIMEMORY\fR\ \fB\-\-ssl\-principal\-mapping\-rules\fR=\fISSL_PRINCIPAL_MAPPING_RULES\fR\ \fB\-\-subnets\fR=[\fISUBNETS\fR,...]\ \fB\-\-clear\-mtls\-ca\-pools\fR\ |\ \fB\-\-mtls\-ca\-pools\fR=[\fIMTLS_CA_POOLS\fR,...]) [\fB\-\-allow\-broker\-downscale\-on\-cluster\-upscale\fR] [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Update a Managed Service for Apache Kafka cluster.



.SH "EXAMPLES"

To update an attribute in a cluster named mycluster located in us\-central1,
such as the CPU, run the following:

.RS 2m
$ gcloud beta managed\-kafka clusters update mycluster \e
    \-\-location=us\-central1 \-\-cpu=3
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Cluster resource \- Identifies the cluster to be updated. The arguments in this
group can be used to specify the attributes of this resource. (NOTE) Some
attributes are not given arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5cluster\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fICLUSTER\fR

ID of the cluster or fully qualified identifier for the cluster.

To set the \f5cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

ID of the location of the Managed Service for Apache Kafka resource. See
https://cloud.google.com/managed\-service\-for\-apache\-kafka/docs/locations for
a list of supported locations.


To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

At least one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-auto\-rebalance\fR

Whether the automatic rebalancing is enabled. If automatic rebalancing is
enabled, topic partitions are rebalanced among brokers when the number of CPUs
in the cluster changes. Automatic rebalancing is enabled by default. Use
\-\-no\-auto\-rebalance to disable this flag.

.TP 2m
\fB\-\-cpu\fR=\fICPU\fR

The number of vCPUs to provision for the cluster. The minimum is 3.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add. Keys must start with a lowercase character
and contain only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase
characters, and numbers. Values must contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers.

.TP 2m
\fB\-\-memory\fR=\fIMEMORY\fR

The memory to provision for the cluster in bytes. The value must be between 1
GiB and 8 GiB per vCPU. Ex. 1024Mi, 4Gi.

.TP 2m
\fB\-\-ssl\-principal\-mapping\-rules\fR=\fISSL_PRINCIPAL_MAPPING_RULES\fR

The rules for mapping mTLS certificate Distinguished Names (DNs) to shortened
principal names for Kafka ACLs. This flag corresponds exactly to the
\f5ssl.principal.mapping.rules\fR broker config and matches the format and
syntax defined in the Apache Kafka documentation. Setting or modifying this
field will trigger a rolling restart of the Kafka brokers to apply the change.
An empty string means that the default Kafka behavior is used. Example:
"RULE:^CN=(.\fB?),OU=ServiceUsers.\fR$/$1@example.com/,DEFAULT"

.TP 2m
\fB\-\-subnets\fR=[\fISUBNETS\fR,...]

A comma\-separated list of VPC subnets from which the cluster is accessible.
Both broker and bootstrap server IP addresses and DNS entries are automatically
created in each subnet. Only one subnet per network is allowed, and the subnet
must be located in the same region as the cluster. The project may differ. A
minimum of 1 subnet is required. A maximum of 10 subnets can be specified. Use
commas to separate multiple subnets. The name of the subnet must be in the
format
projects/\f5\fIPROJECT_ID\fR\fR/regions/\f5\fIREGION\fR\fR/subnetworks/\f5\fISUBNET\fR\fR.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-mtls\-ca\-pools\fR

Remove all the CA pools from the cluster. This will remove all root certificates
from the truststore of each broker in the cluster.

.TP 2m
\fB\-\-mtls\-ca\-pools\fR=[\fIMTLS_CA_POOLS\fR,...]

A comma\-separated list of CA pools from the Google Cloud Certificate Authority
Service. The root certificates of these CA pools will be installed in the
truststore of each broker in the cluster for use with mTLS. A maximum of 10 CA
pools can be specified. CA pools can be in a different project and region than
the cluster. This command overwrites the entire set of pools currently
configured on the cluster. If you want to add a new pool to an existing
configuration, you must provide the full list of both the old and new CA pools
in the command. Each CA pool must be in the format
projects/\f5\fIPROJECT_ID\fR\fR/locations/\f5\fILOCATION\fR\fR/caPools/\f5\fICA_POOL\fR\fR.
Clear the CA pools using the \f5\-\-clear\-mtls\-ca\-pools\fR flag.


.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-allow\-broker\-downscale\-on\-cluster\-upscale\fR

If enabled, this setting allows an update operation that could significantly
decrease the per\-broker vCPU and/or memory allocation, which can lead to
reduced performance and availability. By default, an update operation will fail
if it results in a reduction of 10% or more to the brokers' vCPU or memory
allocation.

.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.


.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBmanagedkafka/v1\fR API. The full documentation for this
API can be found at:
https://cloud.google.com/managed\-service\-for\-apache\-kafka/docs



.SH "NOTES"

This command is currently in beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud managed\-kafka clusters update
.RE

.RS 2m
$ gcloud alpha managed\-kafka clusters update
.RE