.TH "GCLOUD_ALPHA_CLUSTER\-DIRECTOR_CLUSTERS_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha cluster\-director clusters update \- updates a Cluster Director resource



.SH "SYNOPSIS"
.HP
\f5gcloud alpha cluster\-director clusters update\fR (\fICLUSTER\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-add\-dws\-flex\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fImaxDuration\fR=\fIMAXDURATION\fR],[\fIzone\fR=\fIZONE\fR]\ \fB\-\-add\-labels\fR=[\fIADD_LABELS\fR,...]\ \fB\-\-add\-on\-demand\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIzone\fR=\fIZONE\fR]\ \fB\-\-add\-reserved\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIreservation\fR=\fIRESERVATION\fR]\ \fB\-\-add\-slurm\-node\-sets\fR=[\fIcomputeId\fR=\fICOMPUTEID\fR],[\fIid\fR=\fIID\fR],[\fIlabels\fR=\fILABELS\fR],[\fImaxDynamicNodeCount\fR=\fIMAXDYNAMICNODECOUNT\fR],[\fIstartupScript\fR=\fISTARTUPSCRIPT\fR],[\fIstaticNodeCount\fR=\fISTATICNODECOUNT\fR]\ \fB\-\-add\-slurm\-partitions\fR=[\fIexclusive\fR=\fIEXCLUSIVE\fR],[\fIid\fR=\fIID\fR],[\fInodesetIds\fR=\fINODESETIDS\fR]\ \fB\-\-add\-spot\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIzone\fR=\fIZONE\fR]\ \fB\-\-description\fR=\fIDESCRIPTION\fR\ \fB\-\-remove\-dws\-flex\-instances\fR=[\fIREMOVE_DWS_FLEX_INSTANCES\fR,...]\ \fB\-\-remove\-labels\fR=[\fIREMOVE_LABELS\fR,...]\ \fB\-\-remove\-on\-demand\-instances\fR=[\fIREMOVE_ON_DEMAND_INSTANCES\fR,...]\ \fB\-\-remove\-reserved\-instances\fR=[\fIREMOVE_RESERVED_INSTANCES\fR,...]\ \fB\-\-remove\-slurm\-node\-sets\fR=[\fIREMOVE_SLURM_NODE_SETS\fR,...]\ \fB\-\-remove\-slurm\-partitions\fR=[\fIREMOVE_SLURM_PARTITIONS\fR,...]\ \fB\-\-remove\-spot\-instances\fR=[\fIREMOVE_SPOT_INSTANCES\fR,...]\ \fB\-\-slurm\-default\-partition\fR=\fISLURM_DEFAULT_PARTITION\fR\ \fB\-\-update\-slurm\-login\-node\fR=[\fIcount\fR=\fICOUNT\fR],[\fIstartupScript\fR=\fISTARTUPSCRIPT\fR]\ \fB\-\-update\-slurm\-node\-sets\fR=[\fIid\fR=\fIID\fR],[\fImaxDynamicNodeCount\fR=\fIMAXDYNAMICNODECOUNT\fR],[\fIstaticNodeCount\fR=\fISTATICNODECOUNT\fR]\ \fB\-\-update\-slurm\-partitions\fR=[\fIexclusive\fR=\fIEXCLUSIVE\fR],[\fIid\fR=\fIID\fR],[\fInodesetIds\fR=\fINODESETIDS\fR]\ |\ \fB\-\-config\fR=[\fIcomputeResources\fR=\fICOMPUTERESOURCES\fR],[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIlabels\fR=\fILABELS\fR],[\fIname\fR=\fINAME\fR],[\fInetworkResources\fR=\fINETWORKRESOURCES\fR],[\fIorchestrator\fR=\fIORCHESTRATOR\fR],[\fIstorageResources\fR=\fISTORAGERESOURCES\fR]\ \fB\-\-update\-mask\fR=\fIUPDATE_MASK\fR) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR \fBgcloud alpha cluster\-director clusters update\fR facilitates
the updation of a cluster resource.

There are following ways to update a cluster:
.RS 2m
.IP "\(bu" 2m
[Preferred] Use granular flags to update cluster specs, based on
read\-modify\-update pattern.
.RS 2m
.IP "\(em" 2m
Read the existing cluster specs through \f5get\fR cluster request.
.IP "\(em" 2m
Modify the cluster specs through granular flags.
.IP "\(em" 2m
Update the cluster specs through \f5patch\fR cluster request.
.RE
.sp
.IP "\(bu" 2m
Use \-\-config with cluster specs and \-\-update\-mask flags, both in JSON
format.
.RS 2m
.IP "\(em" 2m
Map and repeated fields update requires existing and new values.
.IP "\(em" 2m
For e.g. if we want to update a cluster to add a new nodeset, then we will use
the update_mask "orchestrator.slurm.node_sets", and the patch cluster must
include all the existing nodesets as well as the new one.
.RE
.sp

.RE
.sp
Please refer to the examples below for more details.



.SH "EXAMPLES"

To update a cluster \f5my\-cluster\fR in location \f5us\-central1\-a\fR with
granular flags, run the following example:

Add labels, compute instances, slurm node sets, slurm partitions and update
description and default partition:

.RS 2m
$ gcloud alpha cluster\-director clusters update my\-cluster \e
    \-\-location us\-central1\-a \e
    \-\-description "My updated cluster description" \e
    \-\-add\-labels env=prod,client=gcloud\-cli \e
    \-\-add\-on\-demand\-instances \e
    id=compute1,zone=us\-central1\-a,machineType=n2\-standard\-2 \e
    \-\-add\-reserved\-instances \e
    id=compute2,reservation=zones/us\-central1\-a/reservations/\e
{reservation},machineType={machineType} \e
    \-\-add\-spot\-instances \e
    id=compute3,zone=us\-central1\-a,machineType=n2\-standard\-2 \e
    \-\-add\-dws\-flex\-instances \e
    id=compute4,zone=us\-central1\-a,machineType=a4\-highgpu\-8g,\e
maxDuration=10000s \e
    \-\-add\-slurm\-node\-sets id=nodeset1,computeId=compute1 \e
    \-\-add\-slurm\-node\-sets id=nodeset2,computeId=compute2 \e
    \-\-add\-slurm\-node\-sets id=nodeset3,computeId=compute3 \e
    \-\-add\-slurm\-node\-sets id=nodeset4,computeId=compute4 \e
    \-\-add\-slurm\-partitions id=partition1,nodesetIds=[nodeset1] \e
    \-\-add\-slurm\-partitions \e
    id=partition2,nodesetIds=[nodeset2,nodeset3,nodeset4] \e
    \-\-slurm\-default\-partition partition1
.RE

Update slurm node sets and slurm partitions:

.RS 2m
$ gcloud alpha cluster\-director clusters update my\-cluster \e
    \-\-location us\-central1\-a \e
    \-\-update\-slurm\-node\-sets \e
    id=nodeset1,staticNodeCount=2,maxDynamicNodeCount=10 \e
    \-\-update\-slurm\-partitions \e
    id=partition1,nodesetIds=[nodeset0],exclusive=true
.RE

Remove slurm node sets, slurm partitions and compute instances and update
default partition:

.RS 2m
$ gcloud alpha cluster\-director clusters update my\-cluster \e
    \-\-location us\-central1\-a \-\-slurm\-default\-partition partition0 \e
    \-\-remove\-labels env,client \e
    \-\-remove\-slurm\-partitions partition1 \e
    \-\-remove\-slurm\-partitions partition2 \e
    \-\-remove\-slurm\-node\-sets nodeset1 \e
    \-\-remove\-slurm\-node\-sets nodeset2 \e
    \-\-remove\-slurm\-node\-sets nodeset3 \e
    \-\-remove\-slurm\-node\-sets nodeset4 \e
    \-\-remove\-on\-demand\-instances compute1 \e
    \-\-remove\-reserved\-instances compute2 \e
    \-\-remove\-spot\-instances compute3 \e
    \-\-remove\-dws\-flex\-instances compute4
.RE

Or cluster \f5my\-cluster\fR in location \f5us\-central1\-a\fR with config JSON
run the following JSON example:

.RS 2m
$ gcloud alpha cluster\-director clusters update my\-cluster \e
    \-\-location=us\-central1\-a \-\-update\-mask=labels \e
    \-\-config='{"key": "value"}'
.RE

Or create a JSON file \f5my\-cluster\-config.json\fR with the cluster specs and
run the following file example:

.RS 2m
$ gcloud alpha cluster\-director clusters update my\-cluster \e
    \-\-location=us\-central1\-a \-\-update\-mask=labels \e
    \-\-config\-from\-file=my\-cluster\-config.json
.RE

Or create a JSON file with the update mask and run the following file example:

.RS 2m
$ gcloud alpha cluster\-director clusters update my\-cluster \e
    \-\-location=us\-central1\-a \e
    \-\-update\-mask\-from\-file=my\-update\-mask.json \e
    \-\-config\-from\-file=my\-cluster\-config.json
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Cluster resource \- Name of the cluster resource. Formats: cluster |
projects/{project}/locations/{locations}/clusters/{cluster} 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

The location id of the cluster resource.

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

Cluster configuration for provisioning with updates.

Exactly one of these must be specified:


.RS 2m
.TP 2m

Flag Configurations to define cluster updates.


.RS 2m
.TP 2m
\fB\-\-add\-dws\-flex\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fImaxDuration\fR=\fIMAXDURATION\fR],[\fIzone\fR=\fIZONE\fR]

Parameters to define cluster DWS Flex instances.

For e.g. \-\-add\-dws\-flex\-instances
id={computeId},zone={zone},machineType={machineType},maxDuration=10000s.

Sets \f5add_dws_flex_instances\fR value.

.RS 2m
.TP 2m
\fBid\fR
Required, sets \f5id\fR value.

.TP 2m
\fBmachineType\fR
Required, sets \f5machineType\fR value.

.TP 2m
\fBmaxDuration\fR
Required, sets \f5maxDuration\fR value.

.TP 2m
\fBzone\fR
Required, sets \f5zone\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-add\-dws\-flex\-instances=id=string,machineType=string,maxDuration=string,zone=string \-\-add\-dws\-flex\-instances=id=string,machineType=string,maxDuration=string,zone=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-add\-dws\-flex\-instances='[{"id": "string", "machineType": "string", "maxDuration": "string", "zone": "string"}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-add\-dws\-flex\-instances=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-add\-labels\fR=[\fIADD_LABELS\fR,...]

Cluster labels as key value pairs.

For e.g. \-\-add\-labels key1=value1,key2=value2.

Sets \f5add_labels\fR value.

.RS 2m
.TP 2m
\fBKEY\fR
Sets \f5KEY\fR value.

.TP 2m
\fBVALUE\fR
Sets \f5VALUE\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-add\-labels={string=string}
.RE


\fBJSON Example:\fR


.RS 2m
\-\-add\-labels='{"string": "string"}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-add\-labels=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-add\-on\-demand\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIzone\fR=\fIZONE\fR]

Parameters to define cluster on demand instances.

For e.g. \-\-add\-on\-demand\-instances
id={computeId},zone={zone},machineType={machineType}.

Sets \f5add_on_demand_instances\fR value.

.RS 2m
.TP 2m
\fBid\fR
Required, sets \f5id\fR value.

.TP 2m
\fBmachineType\fR
Required, sets \f5machineType\fR value.

.TP 2m
\fBzone\fR
Required, sets \f5zone\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-add\-on\-demand\-instances=id=string,machineType=string,zone=string \-\-add\-on\-demand\-instances=id=string,machineType=string,zone=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-add\-on\-demand\-instances='[{"id": "string", "machineType": "string", "zone": "string"}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-add\-on\-demand\-instances=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-add\-reserved\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIreservation\fR=\fIRESERVATION\fR]

Parameters to define cluster reserved instances.

For e.g. \-\-add\-reserved\-instances
id={computeId},reservation=zones/{zone}/reservations/{reservation},machineType={machineType}.

Sets \f5add_reserved_instances\fR value.

.RS 2m
.TP 2m
\fBid\fR
Required, sets \f5id\fR value.

.TP 2m
\fBmachineType\fR
Required, sets \f5machineType\fR value.

.TP 2m
\fBreservation\fR
Required, sets \f5reservation\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-add\-reserved\-instances=id=string,machineType=string,reservation=string \-\-add\-reserved\-instances=id=string,machineType=string,reservation=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-add\-reserved\-instances='[{"id": "string", "machineType": "string", "reservation": "string"}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-add\-reserved\-instances=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-add\-slurm\-node\-sets\fR=[\fIcomputeId\fR=\fICOMPUTEID\fR],[\fIid\fR=\fIID\fR],[\fIlabels\fR=\fILABELS\fR],[\fImaxDynamicNodeCount\fR=\fIMAXDYNAMICNODECOUNT\fR],[\fIstartupScript\fR=\fISTARTUPSCRIPT\fR],[\fIstaticNodeCount\fR=\fISTATICNODECOUNT\fR]

Parameters to define slurm cluster nodeset config.

For e.g. \-\-add\-slurm\-node\-sets
id={nodesetId},computeId={computeId},staticNodeCount={staticNodeCount},maxDynamicNodeCount={maxDynamicNodeCount},startupScript="echo
hello",labels="{key1=value1,key2=value2}"

Defaults:
.RS 2m
.IP "\(em" 2m
staticNodeCount: 1
.RE
.sp

Note:
.RS 2m
.IP "\(em" 2m
startupScript:
.RS 2m
.IP "\(bu" 2m
Either str or file_path
.IP "\(bu" 2m
For file_path, only bash file format (.sh or .bash) is supported.
.IP "\(bu" 2m
For file_path, only absolute path is supported.
.RE
.sp

Sets \f5add_slurm_node_sets\fR value.
.RE
.sp

.RS 2m
.TP 2m
\fBcomputeId\fR
Required, sets \f5computeId\fR value.

.TP 2m
\fBid\fR
Required, sets \f5id\fR value.

.TP 2m
\fBlabels\fR
Sets \f5labels\fR value.

.RS 2m
.TP 2m
\fBKEY\fR
Sets \f5KEY\fR value.

.TP 2m
\fBVALUE\fR
Sets \f5VALUE\fR value.

.RE
.sp
.TP 2m
\fBmaxDynamicNodeCount\fR
Sets \f5maxDynamicNodeCount\fR value.

.TP 2m
\fBstartupScript\fR
Sets \f5startupScript\fR value.

.TP 2m
\fBstaticNodeCount\fR
Sets \f5staticNodeCount\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-add\-slurm\-node\-sets=computeId=string,id=string,labels={string=string},maxDynamicNodeCount=int,startupScript=string,staticNodeCount=int \-\-add\-slurm\-node\-sets=computeId=string,id=string,labels={string=string},maxDynamicNodeCount=int,startupScript=string,staticNodeCount=int
.RE


\fBJSON Example:\fR


.RS 2m
\-\-add\-slurm\-node\-sets='[{"computeId": "string", "id": "string", "labels": {"string": "string"}, "maxDynamicNodeCount": int, "startupScript": "string", "staticNodeCount": int}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-add\-slurm\-node\-sets=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-add\-slurm\-partitions\fR=[\fIexclusive\fR=\fIEXCLUSIVE\fR],[\fIid\fR=\fIID\fR],[\fInodesetIds\fR=\fINODESETIDS\fR]

Parameters to define slurm cluster partitions.

For e.g. \-\-add\-slurm\-partitions
id={partitionId},nodesetIds=[{nodesetId1},{nodesetId2}],exclusive=false.

Sets \f5add_slurm_partitions\fR value.

.RS 2m
.TP 2m
\fBexclusive\fR
Sets \f5exclusive\fR value.

.TP 2m
\fBid\fR
Required, sets \f5id\fR value.

.TP 2m
\fBnodesetIds\fR
Required, sets \f5nodesetIds\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-add\-slurm\-partitions=exclusive=boolean,id=string,nodesetIds=[string] \-\-add\-slurm\-partitions=exclusive=boolean,id=string,nodesetIds=[string]
.RE


\fBJSON Example:\fR


.RS 2m
\-\-add\-slurm\-partitions='[{"exclusive": boolean, "id": "string", "nodesetIds": ["string"]}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-add\-slurm\-partitions=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-add\-spot\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIzone\fR=\fIZONE\fR]

Parameters to define cluster spot instances.

For e.g. \-\-add\-spot\-instances
id={computeId},zone={zone},machineType={machineType}.

Sets \f5add_spot_instances\fR value.

.RS 2m
.TP 2m
\fBid\fR
Required, sets \f5id\fR value.

.TP 2m
\fBmachineType\fR
Required, sets \f5machineType\fR value.

.TP 2m
\fBzone\fR
Required, sets \f5zone\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-add\-spot\-instances=id=string,machineType=string,zone=string \-\-add\-spot\-instances=id=string,machineType=string,zone=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-add\-spot\-instances='[{"id": "string", "machineType": "string", "zone": "string"}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-add\-spot\-instances=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Description of the cluster.

For e.g. \-\-description \fB(ALPHA)\fR Updates a Cluster Director resource.

.TP 2m
\fB\-\-remove\-dws\-flex\-instances\fR=[\fIREMOVE_DWS_FLEX_INSTANCES\fR,...]

Parameters to remove DWS Flex instance config by compute id.

For e.g. \-\-remove\-dws\-flex\-instances {computeId1},{computeId2},...

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

Parameters to remove cluster label by key.

For e.g. \-\-remove\-labels {key1},{key2},...

.TP 2m
\fB\-\-remove\-on\-demand\-instances\fR=[\fIREMOVE_ON_DEMAND_INSTANCES\fR,...]

Parameters to remove on demand instances config by compute id.

For e.g. \-\-remove\-on\-demand\-instances {computeId1},{computeId2},...

.TP 2m
\fB\-\-remove\-reserved\-instances\fR=[\fIREMOVE_RESERVED_INSTANCES\fR,...]

Parameters to remove reserved instance config by compute id.

For e.g. \-\-remove\-reserved\-instances {computeId1},{computeId2},...

.TP 2m
\fB\-\-remove\-slurm\-node\-sets\fR=[\fIREMOVE_SLURM_NODE_SETS\fR,...]

Parameters to remove slurm nodeset config by nodeset id.

For e.g. \-\-remove\-slurm\-node\-sets {nodesetId1},{nodesetId2},...

.TP 2m
\fB\-\-remove\-slurm\-partitions\fR=[\fIREMOVE_SLURM_PARTITIONS\fR,...]

Parameters to remove slurm partition config by partition id.

For e.g. \-\-remove\-slurm\-partitions {partitionId1},{partitionId2},...

.TP 2m
\fB\-\-remove\-spot\-instances\fR=[\fIREMOVE_SPOT_INSTANCES\fR,...]

Parameters to remove spot instance config by compute id.

For e.g. \-\-remove\-spot\-instances {computeId1},{computeId2},...

.TP 2m
\fB\-\-slurm\-default\-partition\fR=\fISLURM_DEFAULT_PARTITION\fR

Parameters to define slurm cluster default partition.

For e.g. \-\-slurm\-default\-partition {partitionId}

.TP 2m
\fB\-\-update\-slurm\-login\-node\fR=[\fIcount\fR=\fICOUNT\fR],[\fIstartupScript\fR=\fISTARTUPSCRIPT\fR]

Parameters to update slurm cluster login node. Only count and startupScript can
be updated.

For e.g. \-\-update\-slurm\-login\-node count=2,startupScript="echo hello".

Sets \f5update_slurm_login_node\fR value.

.RS 2m
.TP 2m
\fBcount\fR
Sets \f5count\fR value.

.TP 2m
\fBstartupScript\fR
Sets \f5startupScript\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-update\-slurm\-login\-node=count=int,startupScript=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-update\-slurm\-login\-node='{"count": int, "startupScript": "string"}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-update\-slurm\-login\-node=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-update\-slurm\-node\-sets\fR=[\fIid\fR=\fIID\fR],[\fImaxDynamicNodeCount\fR=\fIMAXDYNAMICNODECOUNT\fR],[\fIstaticNodeCount\fR=\fISTATICNODECOUNT\fR]

Parameters to define and update slurm cluster nodeset config.

For e.g. \-\-update\-slurm\-node\-sets
id={nodesetId},staticNodeCount={staticNodeCount},maxDynamicNodeCount={maxDynamicNodeCount}.

Sets \f5update_slurm_node_sets\fR value.

.RS 2m
.TP 2m
\fBid\fR
Required, sets \f5id\fR value.

.TP 2m
\fBmaxDynamicNodeCount\fR
Sets \f5maxDynamicNodeCount\fR value.

.TP 2m
\fBstaticNodeCount\fR
Sets \f5staticNodeCount\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-update\-slurm\-node\-sets=id=string,maxDynamicNodeCount=int,staticNodeCount=int \-\-update\-slurm\-node\-sets=id=string,maxDynamicNodeCount=int,staticNodeCount=int
.RE


\fBJSON Example:\fR


.RS 2m
\-\-update\-slurm\-node\-sets='[{"id": "string", "maxDynamicNodeCount": int, "staticNodeCount": int}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-update\-slurm\-node\-sets=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-update\-slurm\-partitions\fR=[\fIexclusive\fR=\fIEXCLUSIVE\fR],[\fIid\fR=\fIID\fR],[\fInodesetIds\fR=\fINODESETIDS\fR]

Parameters to define and update slurm cluster partition config.

For e.g. \-\-update\-slurm\-partitions
id={partitionId},nodesetIds=[{nodesetId1},{nodesetId2}],exclusive=false.

Sets \f5update_slurm_partitions\fR value.

.RS 2m
.TP 2m
\fBexclusive\fR
Sets \f5exclusive\fR value.

.TP 2m
\fBid\fR
Required, sets \f5id\fR value.

.TP 2m
\fBnodesetIds\fR
Sets \f5nodesetIds\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-update\-slurm\-partitions=exclusive=boolean,id=string,nodesetIds=[string] \-\-update\-slurm\-partitions=exclusive=boolean,id=string,nodesetIds=[string]
.RE


\fBJSON Example:\fR


.RS 2m
\-\-update\-slurm\-partitions='[{"exclusive": boolean, "id": "string", "nodesetIds": ["string"]}]'
.RE


\fBFile Example:\fR


.RS 2m
\-\-update\-slurm\-partitions=path_to_file.(yaml|json)
.RE


.RE
.sp
.TP 2m

Cluster configuration for updates.


.RS 2m
.TP 2m
\fB\-\-config\fR=[\fIcomputeResources\fR=\fICOMPUTERESOURCES\fR],[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIlabels\fR=\fILABELS\fR],[\fIname\fR=\fINAME\fR],[\fInetworkResources\fR=\fINETWORKRESOURCES\fR],[\fIorchestrator\fR=\fIORCHESTRATOR\fR],[\fIstorageResources\fR=\fISTORAGERESOURCES\fR]

Configuration of the cluster specs in the form of a JSON object. Required, sets
\f5config\fR value.

.RS 2m
.TP 2m
\fBcomputeResources\fR
Sets \f5computeResources\fR value.

.RS 2m
.TP 2m
\fBKEY\fR
Sets \f5KEY\fR value.

.TP 2m
\fBVALUE\fR
Sets \f5VALUE\fR value.

.RS 2m
.TP 2m
\fBconfig\fR
Sets \f5config\fR value.

.RS 2m
.TP 2m
\fBnewDwsFlexInstances\fR
Sets \f5newDwsFlexInstances\fR value.

.RS 2m
.TP 2m
\fBmachineType\fR
Sets \f5machineType\fR value.

.TP 2m
\fBmaxDuration\fR
Sets \f5maxDuration\fR value.

.TP 2m
\fBzone\fR
Sets \f5zone\fR value.

.RE
.sp
.TP 2m
\fBnewFlexStartInstances\fR
Sets \f5newFlexStartInstances\fR value.

.RS 2m
.TP 2m
\fBmachineType\fR
Sets \f5machineType\fR value.

.TP 2m
\fBmaxDuration\fR
Sets \f5maxDuration\fR value.

.TP 2m
\fBzone\fR
Sets \f5zone\fR value.

.RE
.sp
.TP 2m
\fBnewOnDemandInstances\fR
Sets \f5newOnDemandInstances\fR value.

.RS 2m
.TP 2m
\fBmachineType\fR
Sets \f5machineType\fR value.

.TP 2m
\fBzone\fR
Sets \f5zone\fR value.

.RE
.sp
.TP 2m
\fBnewReservedInstances\fR
Sets \f5newReservedInstances\fR value.

.RS 2m
.TP 2m
\fBmachineType\fR
Sets \f5machineType\fR value.

.TP 2m
\fBreservation\fR
Sets \f5reservation\fR value.

.TP 2m
\fBtype\fR
Sets \f5type\fR value.

.TP 2m
\fBzone\fR
Sets \f5zone\fR value.

.RE
.sp
.TP 2m
\fBnewSpotInstances\fR
Sets \f5newSpotInstances\fR value.

.RS 2m
.TP 2m
\fBmachineType\fR
Sets \f5machineType\fR value.

.TP 2m
\fBzone\fR
Sets \f5zone\fR value.

.RE
.RE
.RE
.RE
.sp
.TP 2m
\fBdescription\fR
Sets \f5description\fR value.

.TP 2m
\fBlabels\fR
Sets \f5labels\fR value.

.RS 2m
.TP 2m
\fBKEY\fR
Sets \f5KEY\fR value.

.TP 2m
\fBVALUE\fR
Sets \f5VALUE\fR value.

.RE
.sp
.TP 2m
\fBname\fR
Sets \f5name\fR value.

.TP 2m
\fBnetworkResources\fR
Sets \f5networkResources\fR value.

.RS 2m
.TP 2m
\fBKEY\fR
Sets \f5KEY\fR value.

.TP 2m
\fBVALUE\fR
Sets \f5VALUE\fR value.

.RS 2m
.TP 2m
\fBconfig\fR
Sets \f5config\fR value.

.RS 2m
.TP 2m
\fBexistingNetwork\fR
Sets \f5existingNetwork\fR value.

.RS 2m
.TP 2m
\fBnetwork\fR
Sets \f5network\fR value.

.TP 2m
\fBsubnetwork\fR
Sets \f5subnetwork\fR value.

.RE
.sp
.TP 2m
\fBnewNetwork\fR
Sets \f5newNetwork\fR value.

.RS 2m
.TP 2m
\fBdescription\fR
Sets \f5description\fR value.

.TP 2m
\fBnetwork\fR
Sets \f5network\fR value.

.RE
.RE
.RE
.RE
.sp
.TP 2m
\fBorchestrator\fR
Sets \f5orchestrator\fR value.

.RS 2m
.TP 2m
\fBslurm\fR
Sets \f5slurm\fR value.

.RS 2m
.TP 2m
\fBdefaultPartition\fR
Sets \f5defaultPartition\fR value.

.TP 2m
\fBloginNodes\fR
Sets \f5loginNodes\fR value.

.RS 2m
.TP 2m
\fBcount\fR
Sets \f5count\fR value.

.TP 2m
\fBdisks\fR
Sets \f5disks\fR value.

.RS 2m
.TP 2m
\fBboot\fR
Required, sets \f5boot\fR value.

.TP 2m
\fBsizeGb\fR
Sets \f5sizeGb\fR value.

.TP 2m
\fBsourceImage\fR
Sets \f5sourceImage\fR value.

.TP 2m
\fBtype\fR
Required, sets \f5type\fR value.

.RE
.sp
.TP 2m
\fBenableOsLogin\fR
Sets \f5enableOsLogin\fR value.

.TP 2m
\fBenablePublicIps\fR
Sets \f5enablePublicIps\fR value.

.TP 2m
\fBlabels\fR
Sets \f5labels\fR value.

.RS 2m
.TP 2m
\fBKEY\fR
Sets \f5KEY\fR value.

.TP 2m
\fBVALUE\fR
Sets \f5VALUE\fR value.

.RE
.sp
.TP 2m
\fBmachineType\fR
Sets \f5machineType\fR value.

.TP 2m
\fBstartupScript\fR
Sets \f5startupScript\fR value.

.TP 2m
\fBstorageConfigs\fR
Sets \f5storageConfigs\fR value.

.RS 2m
.TP 2m
\fBid\fR
Sets \f5id\fR value.

.TP 2m
\fBlocalMount\fR
Sets \f5localMount\fR value.

.RE
.sp
.TP 2m
\fBzone\fR
Sets \f5zone\fR value.

.RE
.sp
.TP 2m
\fBnodeSets\fR
Sets \f5nodeSets\fR value.

.RS 2m
.TP 2m
\fBbootDisk\fR
Sets \f5bootDisk\fR value.

.RS 2m
.TP 2m
\fBboot\fR
Required, sets \f5boot\fR value.

.TP 2m
\fBsizeGb\fR
Sets \f5sizeGb\fR value.

.TP 2m
\fBsourceImage\fR
Sets \f5sourceImage\fR value.

.TP 2m
\fBtype\fR
Required, sets \f5type\fR value.

.RE
.sp
.TP 2m
\fBid\fR
Sets \f5id\fR value.

.TP 2m
\fBlabels\fR
Sets \f5labels\fR value.

.RS 2m
.TP 2m
\fBKEY\fR
Sets \f5KEY\fR value.

.TP 2m
\fBVALUE\fR
Sets \f5VALUE\fR value.

.RE
.sp
.TP 2m
\fBmaxDynamicNodeCount\fR
Sets \f5maxDynamicNodeCount\fR value.

.TP 2m
\fBresourceRequestId\fR
Sets \f5resourceRequestId\fR value.

.TP 2m
\fBstartupScript\fR
Sets \f5startupScript\fR value.

.TP 2m
\fBstaticNodeCount\fR
Sets \f5staticNodeCount\fR value.

.TP 2m
\fBstorageConfigs\fR
Sets \f5storageConfigs\fR value.

.RS 2m
.TP 2m
\fBid\fR
Sets \f5id\fR value.

.TP 2m
\fBlocalMount\fR
Sets \f5localMount\fR value.

.RE
.RE
.sp
.TP 2m
\fBpartitions\fR
Sets \f5partitions\fR value.

.RS 2m
.TP 2m
\fBexclusive\fR
Sets \f5exclusive\fR value.

.TP 2m
\fBid\fR
Sets \f5id\fR value.

.TP 2m
\fBnodeSetIds\fR
Sets \f5nodeSetIds\fR value.

.RE
.RE
.RE
.sp
.TP 2m
\fBstorageResources\fR
Sets \f5storageResources\fR value.

.RS 2m
.TP 2m
\fBKEY\fR
Sets \f5KEY\fR value.

.TP 2m
\fBVALUE\fR
Sets \f5VALUE\fR value.

.RS 2m
.TP 2m
\fBconfig\fR
Sets \f5config\fR value.

.RS 2m
.TP 2m
\fBexistingBucket\fR
Sets \f5existingBucket\fR value.

.RS 2m
.TP 2m
\fBbucket\fR
Sets \f5bucket\fR value.

.RE
.sp
.TP 2m
\fBexistingFilestore\fR
Sets \f5existingFilestore\fR value.

.RS 2m
.TP 2m
\fBfilestore\fR
Sets \f5filestore\fR value.

.RE
.sp
.TP 2m
\fBexistingLustre\fR
Sets \f5existingLustre\fR value.

.RS 2m
.TP 2m
\fBlustre\fR
Sets \f5lustre\fR value.

.RE
.sp
.TP 2m
\fBnewBucket\fR
Sets \f5newBucket\fR value.

.RS 2m
.TP 2m
\fBautoclass\fR
Sets \f5autoclass\fR value.

.RS 2m
.TP 2m
\fBenabled\fR
Sets \f5enabled\fR value.

.RE
.sp
.TP 2m
\fBbucket\fR
Sets \f5bucket\fR value.

.TP 2m
\fBhierarchicalNamespace\fR
Sets \f5hierarchicalNamespace\fR value.

.RS 2m
.TP 2m
\fBenabled\fR
Sets \f5enabled\fR value.

.RE
.sp
.TP 2m
\fBstorageClass\fR
Sets \f5storageClass\fR value.

.RE
.sp
.TP 2m
\fBnewFilestore\fR
Sets \f5newFilestore\fR value.

.RS 2m
.TP 2m
\fBdescription\fR
Sets \f5description\fR value.

.TP 2m
\fBfileShares\fR
Sets \f5fileShares\fR value.

.RS 2m
.TP 2m
\fBcapacityGb\fR
Sets \f5capacityGb\fR value.

.TP 2m
\fBfileShare\fR
Sets \f5fileShare\fR value.

.RE
.sp
.TP 2m
\fBfilestore\fR
Sets \f5filestore\fR value.

.TP 2m
\fBprotocol\fR
Sets \f5protocol\fR value.

.TP 2m
\fBtier\fR
Sets \f5tier\fR value.

.RE
.sp
.TP 2m
\fBnewLustre\fR
Sets \f5newLustre\fR value.

.RS 2m
.TP 2m
\fBcapacityGb\fR
Sets \f5capacityGb\fR value.

.TP 2m
\fBdescription\fR
Sets \f5description\fR value.

.TP 2m
\fBfilesystem\fR
Sets \f5filesystem\fR value.

.TP 2m
\fBlustre\fR
Sets \f5lustre\fR value.

.RE
.RE
.RE
.RE
.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-config=computeResources={string={config={newDwsFlexInstances={machineType=string,maxDuration=string,zone=string},newFlexStartInstances={machineType=string,maxDuration=string,zone=string},newOnDemandInstances={machineType=string,zone=string},newReservedInstances={machineType=string,reservation=string,type=string,zone=string},newSpotInstances={machineType=string,zone=string}}}},description=string,labels={string=string},name=string,networkResources={string={config={existingNetwork={network=string,subnetwork=string},newNetwork={description=string,network=string}}}},orchestrator={slurm={defaultPartition=string,loginNodes={count=int,disks=[{boot=boolean,sizeGb=int,sourceImage=string,type=string}],enableOsLogin=boolean,enablePublicIps=boolean,labels={string=string},machineType=string,startupScript=string,storageConfigs=[{id=string,localMount=string}],zone=string},nodeSets=[{bootDisk={boot=boolean,sizeGb=int,sourceImage=string,type=string},id=string,labels={string=string},maxDynamicNodeCount=int,resourceRequestId=string,startupScript=string,staticNodeCount=int,storageConfigs=[{id=string,localMount=string}]}],partitions=[{exclusive=boolean,id=string,nodeSetIds=[string]}]}},storageResources={string={config={existingBucket={bucket=string},existingFilestore={filestore=string},existingLustre={lustre=string},newBucket={autoclass={enabled=boolean},bucket=string,hierarchicalNamespace={enabled=boolean},storageClass=string},newFilestore={description=string,fileShares=[{capacityGb=int,fileShare=string}],filestore=string,protocol=string,tier=string},newLustre={capacityGb=int,description=string,filesystem=string,lustre=string}}}}
.RE


\fBJSON Example:\fR


.RS 2m
\-\-config='{"computeResources": {"string": {"config": {"newDwsFlexInstances": {"machineType": "string", "maxDuration": "string", "zone": "string"}, "newFlexStartInstances": {"machineType": "string", "maxDuration": "string", "zone": "string"}, "newOnDemandInstances": {"machineType": "string", "zone": "string"}, "newReservedInstances": {"machineType": "string", "reservation": "string", "type": "string", "zone": "string"}, "newSpotInstances": {"machineType": "string", "zone": "string"}}}}, "description": "string", "labels": {"string": "string"}, "name": "string", "networkResources": {"string": {"config": {"existingNetwork": {"network": "string", "subnetwork": "string"}, "newNetwork": {"description": "string", "network": "string"}}}}, "orchestrator": {"slurm": {"defaultPartition": "string", "loginNodes": {"count": int, "disks": [{"boot": boolean, "sizeGb": int, "sourceImage": "string", "type": "string"}], "enableOsLogin": boolean, "enablePublicIps": boolean, "labels": {"string": "string"}, "machineType": "string", "startupScript": "string", "storageConfigs": [{"id": "string", "localMount": "string"}], "zone": "string"}, "nodeSets": [{"bootDisk": {"boot": boolean, "sizeGb": int, "sourceImage": "string", "type": "string"}, "id": "string", "labels": {"string": "string"}, "maxDynamicNodeCount": int, "resourceRequestId": "string", "startupScript": "string", "staticNodeCount": int, "storageConfigs": [{"id": "string", "localMount": "string"}]}], "partitions": [{"exclusive": boolean, "id": "string", "nodeSetIds": ["string"]}]}}, "storageResources": {"string": {"config": {"existingBucket": {"bucket": "string"}, "existingFilestore": {"filestore": "string"}, "existingLustre": {"lustre": "string"}, "newBucket": {"autoclass": {"enabled": boolean}, "bucket": "string", "hierarchicalNamespace": {"enabled": boolean}, "storageClass": "string"}, "newFilestore": {"description": "string", "fileShares": [{"capacityGb": int, "fileShare": "string"}], "filestore": "string", "protocol": "string", "tier": "string"}, "newLustre": {"capacityGb": int, "description": "string", "filesystem": "string", "lustre": "string"}}}}}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-config=path_to_file.(yaml|json)
.RE


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

.TP 2m
\fB\-\-update\-mask\fR=\fIUPDATE_MASK\fR

Update mask to specify the fields to update.

For e.g. \-\-update\-mask "description,labels".

Required, sets \f5update_mask\fR value.

\fBInput Example:\fR


.RS 2m
\-\-update\-mask=string
.RE


\fBFile Example:\fR


.RS 2m
\-\-update\-mask=path_to_file.(yaml|json)
.RE


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


.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.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 "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.