1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-14 00:46:53 +00:00
gcloud-help/gcloud/alpha/managed-kafka/clusters/update
2024-05-30 09:26:18 +00:00

110 lines
4.4 KiB
Text

NAME
gcloud alpha managed-kafka clusters update - update an Apache Kafka for
BigQuery cluster
SYNOPSIS
gcloud alpha managed-kafka clusters update (CLUSTER : --location=LOCATION)
(--no-auto-rebalance --cpu=CPU
--labels=[KEY=VALUE,...] --memory=MEMORY --subnets=[SUBNETS,...])
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update an Apache Kafka for BigQuery cluster.
EXAMPLES
To update an attribute in a cluster named mycluster located in us-central1,
such as the CPU, run the following:
$ gcloud alpha managed-kafka clusters update mycluster \
--location=us-central1 --cpu=3
POSITIONAL ARGUMENTS
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 project attribute:
◆ provide the argument cluster on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
CLUSTER
ID of the cluster or fully qualified identifier for the cluster.
To set the cluster attribute:
▸ provide the argument cluster on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
ID of the location of the Apache Kafka for BigQuery resource. See
https://cloud.google.com/managed-kafka/docs/locations for a list of
supported locations.
To set the location attribute:
▸ provide the argument cluster on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
At least one of these must be specified:
--auto-rebalance
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.
Enabled by default, use --no-auto-rebalance to disable.
--cpu=CPU
The number of vCPUs to provision for the cluster. The minimum is 3.
--labels=[KEY=VALUE,...]
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.
--memory=MEMORY
The memory to provision for the cluster in bytes. The value must be
between 1 GiB and 8 GiB per vCPU. Ex. 1024Mi, 4Gi.
--subnets=[SUBNETS,...]
VPC subnets from which the cluster is accessible. Both broker and
bootstrap server IP addresses and DNS entries are automatically
created in each subnet. 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/PROJECT_ID/regions/REGION/subnetworks/SUBNET.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 $ gcloud help for details.
API REFERENCE
This command uses the managedkafka/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/managed-kafka
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. This variant is also available:
$ gcloud beta managed-kafka clusters update