.TH "GCLOUD_BETA_DATAPROC_CLUSTERS_UPDATE" 1



.SH "NAME"
.HP
gcloud beta dataproc clusters update \- update labels and/or the number of worker nodes in a cluster



.SH "SYNOPSIS"
.HP
\f5gcloud beta dataproc clusters update\fR (\fICLUSTER\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-async\fR] [\fB\-\-graceful\-decommission\-timeout\fR=\fIGRACEFUL_DECOMMISSION_TIMEOUT\fR] [\fB\-\-min\-secondary\-worker\-fraction\fR=\fIMIN_SECONDARY_WORKER_FRACTION\fR] [\fB\-\-num\-secondary\-workers\fR=\fINUM_SECONDARY_WORKERS\fR] [\fB\-\-num\-workers\fR=\fINUM_WORKERS\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-autoscaling\-policy\fR=\fIAUTOSCALING_POLICY\fR\ |\ \fB\-\-disable\-autoscaling\fR] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fB\-\-delete\-expiration\-time\fR=\fIDELETE_EXPIRATION_TIME\fR\ |\ \fB\-\-delete\-max\-age\fR=\fIDELETE_MAX_AGE\fR\ |\ \fB\-\-no\-delete\-max\-age\fR] [\fB\-\-delete\-max\-idle\fR=\fIDELETE_MAX_IDLE\fR\ |\ \fB\-\-no\-delete\-max\-idle\fR] [\fB\-\-identity\-config\-file\fR=\fIIDENTITY_CONFIG_FILE\fR\ |\ \fB\-\-add\-user\-mappings\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-remove\-user\-mappings\fR=[\fIKEY\fR,...]] [\fB\-\-stop\-expiration\-time\fR=\fISTOP_EXPIRATION_TIME\fR\ |\ \fB\-\-stop\-max\-age\fR=\fISTOP_MAX_AGE\fR\ |\ \fB\-\-no\-stop\-max\-age\fR] [\fB\-\-stop\-max\-idle\fR=\fISTOP_MAX_IDLE\fR\ |\ \fB\-\-no\-stop\-max\-idle\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Update the number of worker nodes and/or the labels in a cluster.



.SH "EXAMPLES"

To resize a cluster, run:

.RS 2m
$ gcloud beta dataproc clusters update my\-cluster \e
    \-\-region=us\-central1 \-\-num\-workers=5
.RE

To change the number preemptible workers in a cluster, run:

.RS 2m
$ gcloud beta dataproc clusters update my\-cluster \e
    \-\-region=us\-central1 \-\-num\-preemptible\-workers=5
.RE

To add the label 'customer=acme' to a cluster, run:

.RS 2m
$ gcloud beta dataproc clusters update my\-cluster \e
    \-\-region=us\-central1 \-\-update\-labels=customer=acme
.RE

To update the label 'customer=ackme' to 'customer=acme', run:

.RS 2m
$ gcloud beta dataproc clusters update my\-cluster \e
    \-\-region=us\-central1 \-\-update\-labels=customer=acme
.RE

To remove the label whose key is 'customer', run:

.RS 2m
$ gcloud beta dataproc clusters update my\-cluster \e
    \-\-region=us\-central1 \-\-remove\-labels=customer
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Cluster resource \- The name of the cluster to update. 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\-\-region\fR=\fIREGION\fR

Dataproc region for the cluster. Each Dataproc region constitutes an independent
resource namespace constrained to deploying instances into Compute Engine zones
inside the region. Overrides the default \f5dataproc/region\fR property value
for this command invocation.

To set the \f5region\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\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5dataproc/region\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

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

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

.TP 2m
\fB\-\-graceful\-decommission\-timeout\fR=\fIGRACEFUL_DECOMMISSION_TIMEOUT\fR

The graceful decommission timeout for decommissioning Node Managers in the
cluster, used when removing nodes. Graceful decommissioning allows removing
nodes from the cluster without interrupting jobs in progress. Timeout specifies
how long to wait for jobs in progress to finish before forcefully removing nodes
(and potentially interrupting jobs). Timeout defaults to 0 if not set (for
forceful decommission), and the maximum allowed timeout is 1 day. See $ gcloud
topic datetimes for information on duration formats.

.TP 2m
\fB\-\-min\-secondary\-worker\-fraction\fR=\fIMIN_SECONDARY_WORKER_FRACTION\fR

Minimum fraction of new secondary worker nodes added in a scale up update
operation, required to update the cluster. If it is not met, cluster updation
will rollback the addition of secondary workers. Must be a decimal value between
0 and 1. Defaults to 0.0001.

.TP 2m
\fB\-\-num\-secondary\-workers\fR=\fINUM_SECONDARY_WORKERS\fR

The new number of secondary worker nodes in the cluster.

.TP 2m
\fB\-\-num\-workers\fR=\fINUM_WORKERS\fR

The new number of worker nodes in the cluster.

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

List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.

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

At most one of these can be specified:


.RS 2m
.TP 2m

Autoscaling policy resource \- The autoscaling policy to use. This represents a
Cloud 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 "\(bu" 2m
provide the argument \f5\-\-autoscaling\-policy\fR on the command line with a
fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-autoscaling\-policy\fR on the command line with a
fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5dataproc/region\fR.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-autoscaling\-policy\fR=\fIAUTOSCALING_POLICY\fR

ID of the autoscaling policy or fully qualified identifier for the autoscaling
policy.

To set the \f5autoscaling_policy\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-autoscaling\-policy\fR on the command line.
.RE
.sp

.RE
.sp
.TP 2m
\fB\-\-disable\-autoscaling\fR

Disable autoscaling, if it is enabled. This is an alias for passing the empty
string to \-\-autoscaling\-policy'.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud beta dataproc clusters update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud beta dataproc clusters update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

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

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-delete\-expiration\-time\fR=\fIDELETE_EXPIRATION_TIME\fR

The time when the cluster will be auto\-deleted, such as
"2017\-08\-29T18:52:51.142Z". See $ gcloud topic datetimes for information on
time formats.

.TP 2m
\fB\-\-delete\-max\-age\fR=\fIDELETE_MAX_AGE\fR

The lifespan of the cluster with auto\-deletion upon completion, such as "2h" or
"1d". See $ gcloud topic datetimes for information on duration formats.

.TP 2m
\fB\-\-no\-delete\-max\-age\fR

Cancels the cluster auto\-deletion by maximum cluster age (configured by
\-\-delete\-max\-age or \-\-delete\-expiration\-time flags)

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-delete\-max\-idle\fR=\fIDELETE_MAX_IDLE\fR

The duration after the last job completes to auto\-delete the cluster, such as
"2h" or "1d". See $ gcloud topic datetimes for information on duration formats.

.TP 2m
\fB\-\-no\-delete\-max\-idle\fR

Cancels the cluster auto\-deletion by cluster idle duration (configured by
\-\-delete\-max\-idle flag)

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-identity\-config\-file\fR=\fIIDENTITY_CONFIG_FILE\fR

Path to a YAML (or JSON) file that contains the configuration for Secure
Multi\-Tenancy on the cluster. The path can be a Cloud Storage URL (example:
\'gs://path/to/file') or a local filesystem path. The mappings provided in the
file will overwrite existing mappings.

The YAML file is formatted as follows:

.RS 2m
  # Mapping header (first line) required.
  user_service_account_mapping:
    bob@company.com: service\-account\-bob@project.iam.gserviceaccount.com
    alice@company.com: service\-account\-alice@project.iam.gserviceaccount.com
.RE

.TP 2m
\fB\-\-add\-user\-mappings\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of user\-to\-service\-account mappings to add to current mappings. If a
mapping exists, its value is modified; otherwise, the new mapping is added.

.TP 2m
\fB\-\-remove\-user\-mappings\fR=[\fIKEY\fR,...]

List of user\-to\-service\-account mappings to remove from the current mappings.
If a mapping does not exist, it is ignored.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-stop\-expiration\-time\fR=\fISTOP_EXPIRATION_TIME\fR

The time when the cluster will be auto\-stopped, such as
"2017\-08\-29T18:52:51.142Z". See $ gcloud topic datetimes for information on
time formats.

.TP 2m
\fB\-\-stop\-max\-age\fR=\fISTOP_MAX_AGE\fR

The lifespan of the cluster, with auto\-stop upon completion, such as "2h" or
"1d". See $ gcloud topic datetimes for information on duration formats.

.TP 2m
\fB\-\-no\-stop\-max\-age\fR

Cancels the cluster auto\-stop by maximum cluster age (configured by
\-\-stop\-max\-age or \-\-stop\-expiration\-time flags)

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-stop\-max\-idle\fR=\fISTOP_MAX_IDLE\fR

The duration after the last job completes to auto\-stop the cluster, such as
"2h" or "1d". See $ gcloud topic datetimes for information on duration formats.

.TP 2m
\fB\-\-no\-stop\-max\-idle\fR

Cancels the cluster auto\-stop by cluster idle duration (configured by
\-\-stop\-max\-idle flag)


.RE
.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 "NOTES"

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

.RS 2m
$ gcloud dataproc clusters update
.RE

.RS 2m
$ gcloud alpha dataproc clusters update
.RE