- NAME
-
- gcloud alpha cluster-director clusters update - updates a Cluster Director resource
- SYNOPSIS
-
-
gcloud alpha cluster-director clusters update(CLUSTER:--location=LOCATION) (--add-dws-flex-instances=[id=ID],[machineType=MACHINETYPE],[maxDuration=MAXDURATION],[zone=ZONE]--add-filestore-instances=[ADD_FILESTORE_INSTANCES,…]--add-labels=[ADD_LABELS,…]--add-lustre-instances=[ADD_LUSTRE_INSTANCES,…]--add-new-filestore-instances=[capacityGb=CAPACITYGB],[description=DESCRIPTION],[fileshare=FILESHARE],[name=NAME],[protocol=PROTOCOL],[tier=TIER]--add-new-lustre-instances=[capacityGb=CAPACITYGB],[description=DESCRIPTION],[filesystem=FILESYSTEM],[name=NAME]--add-new-storage-buckets=[enableAutoclass=ENABLEAUTOCLASS],[enableHNS=ENABLEHNS],[name=NAME],[storageClass=STORAGECLASS]--add-on-demand-instances=[id=ID],[machineType=MACHINETYPE],[zone=ZONE]--add-reserved-instances=[id=ID],[machineType=MACHINETYPE],[reservation=RESERVATION]--add-slurm-node-sets=[computeId=COMPUTEID],[id=ID],[labels=LABELS],[maxDynamicNodeCount=MAXDYNAMICNODECOUNT],[startupScript=STARTUPSCRIPT],[staticNodeCount=STATICNODECOUNT]--add-slurm-partitions=[exclusive=EXCLUSIVE],[id=ID],[nodesetIds=NODESETIDS]--add-spot-instances=[id=ID],[machineType=MACHINETYPE],[zone=ZONE]--add-storage-buckets=[ADD_STORAGE_BUCKETS,…]--description=DESCRIPTION--remove-dws-flex-instances=[REMOVE_DWS_FLEX_INSTANCES,…]--remove-filestore-instances=[REMOVE_FILESTORE_INSTANCES,…]--remove-labels=[REMOVE_LABELS,…]--remove-lustre-instances=[REMOVE_LUSTRE_INSTANCES,…]--remove-on-demand-instances=[REMOVE_ON_DEMAND_INSTANCES,…]--remove-reserved-instances=[REMOVE_RESERVED_INSTANCES,…]--remove-slurm-node-sets=[REMOVE_SLURM_NODE_SETS,…]--remove-slurm-partitions=[REMOVE_SLURM_PARTITIONS,…]--remove-spot-instances=[REMOVE_SPOT_INSTANCES,…]--remove-storage-buckets=[REMOVE_STORAGE_BUCKETS,…]--slurm-default-partition=SLURM_DEFAULT_PARTITION--update-slurm-login-node=[count=COUNT],[startupScript=STARTUPSCRIPT]--update-slurm-node-sets=[id=ID],[maxDynamicNodeCount=MAXDYNAMICNODECOUNT],[staticNodeCount=STATICNODECOUNT]--update-slurm-partitions=[exclusive=EXCLUSIVE],[id=ID],[nodesetIds=NODESETIDS] |--config=[computeResources=COMPUTERESOURCES],[description=DESCRIPTION],[labels=LABELS],[name=NAME],[networkResources=NETWORKRESOURCES],[orchestrator=ORCHESTRATOR],[storageResources=STORAGERESOURCES]--update-mask=UPDATE_MASK) [--async] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)gcloud alpha cluster-director clusters updatefacilitates the updation of a cluster resource.There are following ways to update a cluster:
-
[Preferred] Use granular flags to update cluster specs, based on
read-modify-update pattern.
-
Read the existing cluster specs through
getcluster request. - Modify the cluster specs through granular flags.
-
Update the cluster specs through
patchcluster request.
-
Read the existing cluster specs through
-
Use --config with cluster specs and --update-mask flags, both in JSON format.
- Map and repeated fields update requires existing and new values.
- 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.
-
[Preferred] Use granular flags to update cluster specs, based on
read-modify-update pattern.
- EXAMPLES
-
To update a cluster
my-clusterin locationus-central1-awith granular flags, run the following example:Add labels, compute instances, slurm node sets, slurm partitions and update description and default partition:
gcloud alpha cluster-director clusters update my-cluster --location us-central1-a --description "My updated cluster description" --add-labels env=prod,client=gcloud-cli --add-on-demand-instances id=compute1,zone=us-central1-a,machineType=n2-standard-2 --add-reserved-instances id=compute2,reservation=zones/us-central1-a/reservations/{reservation},machineType={machineType} --add-spot-instances id=compute3,zone=us-central1-a,machineType=n2-standard-2 --add-dws-flex-instances id=compute4,zone=us-central1-a,machineType=a4-highgpu-8g,maxDuration=10000s --add-new-lustre-instances lustre=locations/us-central1-a/instances/lustre1,capacityGb=1024,filesystem=lustre1 --add-lustre-instances locations/us-central1-a/instances/lustre0 --add-slurm-node-sets id=nodeset1,computeId=compute1 --add-slurm-node-sets id=nodeset2,computeId=compute2 --add-slurm-node-sets id=nodeset3,computeId=compute3 --add-slurm-node-sets id=nodeset4,computeId=compute4 --add-slurm-partitions id=partition1,nodesetIds=[nodeset1] --add-slurm-partitions id=partition2,nodesetIds=[nodeset2,nodeset3,nodeset4] --slurm-default-partition partition1Update slurm node sets and slurm partitions:
gcloud alpha cluster-director clusters update my-cluster --location us-central1-a --update-slurm-node-sets id=nodeset1,staticNodeCount=2,maxDynamicNodeCount=10 --update-slurm-partitions id=partition1,nodesetIds=[nodeset0],exclusive=trueRemove slurm node sets, slurm partitions and compute instances and update default partition:
gcloud alpha cluster-director clusters update my-cluster --location us-central1-a --slurm-default-partition partition0 --remove-labels env,client --remove-lustre-instances locations/us-central1-a/instances/lustre0 --remove-slurm-partitions partition1 --remove-slurm-partitions partition2 --remove-slurm-node-sets nodeset1 --remove-slurm-node-sets nodeset2 --remove-slurm-node-sets nodeset3 --remove-slurm-node-sets nodeset4 --remove-on-demand-instances compute1 --remove-reserved-instances compute2 --remove-spot-instances compute3 --remove-dws-flex-instances compute4Or cluster
my-clusterin locationus-central1-awith config JSON run the following JSON example:gcloud alpha cluster-director clusters update my-cluster --location=us-central1-a --update-mask=labels --config='{"key": "value"}'Or create a JSON file
my-cluster-config.jsonwith the cluster specs and run the following file example:gcloud alpha cluster-director clusters update my-cluster --location=us-central1-a --update-mask=labels --config-from-file=my-cluster-config.jsonOr create a JSON file with the update mask and run the following file example:
gcloud alpha cluster-director clusters update my-cluster --location=us-central1-a --update-mask-from-file=my-update-mask.json --config-from-file=my-cluster-config.json - POSITIONAL ARGUMENTS
-
-
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
projectattribute:-
provide the argument
clusteron the command line with a fully specified name; -
provide the argument
--projecton 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
clusterattribute:-
provide the argument
clusteron the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location=LOCATION-
The location id of the cluster resource.
To set the
locationattribute:-
provide the argument
clusteron the command line with a fully specified name; -
provide the argument
--locationon the command line.
-
provide the argument
-
provide the argument
-
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.
- REQUIRED FLAGS
-
-
Cluster configuration for provisioning with updates.
Exactly one of these must be specified:
-
Flag Configurations to define cluster updates.
--add-dws-flex-instances=[id=ID],[machineType=MACHINETYPE],[maxDuration=MAXDURATION],[zone=ZONE]-
Parameters to define cluster DWS Flex instances.
For e.g. --add-dws-flex-instances id={computeId},zone={zone},machineType={machineType},maxDuration=10000s.
Sets
add_dws_flex_instancesvalue.id-
Required, sets
idvalue. machineType-
Required, sets
machineTypevalue. maxDuration-
Required, sets
maxDurationvalue. zone-
Required, sets
zonevalue.
Shorthand Example:--add-dws-flex-instances=id=string,machineType=string,maxDuration=string,zone=string --add-dws-flex-instances=id=string,machineType=string,maxDuration=string,zone=string
JSON Example:--add-dws-flex-instances='[{"id": "string", "machineType": "string", "maxDuration": "string", "zone": "string"}]'
File Example:--add-dws-flex-instances=path_to_file.(yaml|json)
--add-filestore-instances=[ADD_FILESTORE_INSTANCES,…]-
Reference of existing filestore instance.
For e.g. --add-filestore-instances locations/{location}/instances/{filestore}
--add-labels=[ADD_LABELS,…]-
Cluster labels as key value pairs.
For e.g. --add-labels key1=value1,key2=value2.
Sets
add_labelsvalue.KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.
Shorthand Example:--add-labels={string=string}
JSON Example:--add-labels='{"string": "string"}'
File Example:--add-labels=path_to_file.(yaml|json)
--add-lustre-instances=[ADD_LUSTRE_INSTANCES,…]-
Reference of existing Lustre instance.
For e.g. --add-lustre-instances locations/{location}/instances/{lustre}
--add-new-filestore-instances=[capacityGb=CAPACITYGB],[description=DESCRIPTION],[fileshare=FILESHARE],[name=NAME],[protocol=PROTOCOL],[tier=TIER]-
Parameters to create a filestore instance.
For e.g. --create-filestores name=locations/{location}/instances/{filestore},tier=REGIONAL,capacityGb={filestoreSize},fileshare={fileshare}
Supported tier values:
- ZONAL
- REGIONAL
Supported protocol values:
- NFSV3
- NFSV41
- If not specified, defaults to NFSV3
Defaults:
- protocol: NFSV3.
Sets
add_new_filestore_instancesvalue.capacityGb-
Required, sets
capacityGbvalue. description-
Sets
descriptionvalue. -
Required, sets
filesharevalue. name-
Required, sets
namevalue. protocol-
Sets
protocolvalue. tier-
Required, sets
tiervalue.
Shorthand Example:--add-new-filestore-instances=capacityGb=int,description=string,fileshare=string,name=string,protocol=string,tier=string --add-new-filestore-instances=capacityGb=int,description=string,fileshare=string,name=string,protocol=string,tier=string
JSON Example:--add-new-filestore-instances='[{"capacityGb": int, "description": "string", "fileshare": "string", "name": "string", "protocol": "string", "tier": "string"}]'
File Example:--add-new-filestore-instances=path_to_file.(yaml|json)
--add-new-lustre-instances=[capacityGb=CAPACITYGB],[description=DESCRIPTION],[filesystem=FILESYSTEM],[name=NAME]-
Parameters to create a Lustre instance.
For e.g. --add-new-lustre-instances name=locations/{location}/instances/{lustre},capacityGb={lustreSize},filesystem={filesystem}.
Sets
add_new_lustre_instancesvalue.capacityGb-
Required, sets
capacityGbvalue. description-
Sets
descriptionvalue. filesystem-
Required, sets
filesystemvalue. name-
Required, sets
namevalue.
Shorthand Example:--add-new-lustre-instances=capacityGb=int,description=string,filesystem=string,name=string --add-new-lustre-instances=capacityGb=int,description=string,filesystem=string,name=string
JSON Example:--add-new-lustre-instances='[{"capacityGb": int, "description": "string", "filesystem": "string", "name": "string"}]'
File Example:--add-new-lustre-instances=path_to_file.(yaml|json)
--add-new-storage-buckets=[enableAutoclass=ENABLEAUTOCLASS],[enableHNS=ENABLEHNS],[name=NAME],[storageClass=STORAGECLASS]-
Parameters to create a Google Cloud Storage bucket.
For e.g. --add-new-storage-buckets name={bucket-path}
Supported storageClass values:
- STANDARD
- NEARLINE
- COLDLINE
- ARCHIVE
Defaults:
- storageClass: STANDARD
Note:
- Either storageClass or enableAutoclass can be set.
- if enableAutoclass is set, enableHNS should not be set.
- HNS: Hierarchical namespace.
Sets
add_new_storage_bucketsvalue.enableAutoclass-
Sets
enableAutoclassvalue. enableHNS-
Sets
enableHNSvalue. name-
Required, sets
namevalue. storageClass-
Sets
storageClassvalue.
Shorthand Example:--add-new-storage-buckets=enableAutoclass=boolean,enableHNS=boolean,name=string,storageClass=string --add-new-storage-buckets=enableAutoclass=boolean,enableHNS=boolean,name=string,storageClass=string
JSON Example:--add-new-storage-buckets='[{"enableAutoclass": boolean, "enableHNS": boolean, "name": "string", "storageClass": "string"}]'
File Example:--add-new-storage-buckets=path_to_file.(yaml|json)
--add-on-demand-instances=[id=ID],[machineType=MACHINETYPE],[zone=ZONE]-
Parameters to define cluster on demand instances.
For e.g. --add-on-demand-instances id={computeId},zone={zone},machineType={machineType}.
Sets
add_on_demand_instancesvalue.id-
Required, sets
idvalue. machineType-
Required, sets
machineTypevalue. zone-
Required, sets
zonevalue.
Shorthand Example:--add-on-demand-instances=id=string,machineType=string,zone=string --add-on-demand-instances=id=string,machineType=string,zone=string
JSON Example:--add-on-demand-instances='[{"id": "string", "machineType": "string", "zone": "string"}]'
File Example:--add-on-demand-instances=path_to_file.(yaml|json)
--add-reserved-instances=[id=ID],[machineType=MACHINETYPE],[reservation=RESERVATION]-
Parameters to define cluster reserved instances.
For e.g. --add-reserved-instances id={computeId},reservation=zones/{zone}/reservations/{reservation},machineType={machineType}.
Sets
add_reserved_instancesvalue.id-
Required, sets
idvalue. machineType-
Required, sets
machineTypevalue. reservation-
Required, sets
reservationvalue.
Shorthand Example:--add-reserved-instances=id=string,machineType=string,reservation=string --add-reserved-instances=id=string,machineType=string,reservation=string
JSON Example:--add-reserved-instances='[{"id": "string", "machineType": "string", "reservation": "string"}]'
File Example:--add-reserved-instances=path_to_file.(yaml|json)
--add-slurm-node-sets=[computeId=COMPUTEID],[id=ID],[labels=LABELS],[maxDynamicNodeCount=MAXDYNAMICNODECOUNT],[startupScript=STARTUPSCRIPT],[staticNodeCount=STATICNODECOUNT]-
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:
- staticNodeCount: 1
Note:
-
startupScript:
- Either str or file_path
- For file_path, only bash file format (.sh or .bash) is supported.
- For file_path, only absolute path is supported.
Sets
add_slurm_node_setsvalue.
computeId-
Required, sets
computeIdvalue. id-
Required, sets
idvalue. labels-
Sets
labelsvalue.KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.
maxDynamicNodeCount-
Sets
maxDynamicNodeCountvalue. startupScript-
Sets
startupScriptvalue. staticNodeCount-
Sets
staticNodeCountvalue.
Shorthand Example:--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
JSON Example:--add-slurm-node-sets='[{"computeId": "string", "id": "string", "labels": {"string": "string"}, "maxDynamicNodeCount": int, "startupScript": "string", "staticNodeCount": int}]'
File Example:--add-slurm-node-sets=path_to_file.(yaml|json)
--add-slurm-partitions=[exclusive=EXCLUSIVE],[id=ID],[nodesetIds=NODESETIDS]-
Parameters to define slurm cluster partitions.
For e.g. --add-slurm-partitions id={partitionId},nodesetIds=[{nodesetId1},{nodesetId2}],exclusive=false.
Sets
add_slurm_partitionsvalue.exclusive-
Sets
exclusivevalue. id-
Required, sets
idvalue. nodesetIds-
Required, sets
nodesetIdsvalue.
Shorthand Example:--add-slurm-partitions=exclusive=boolean,id=string,nodesetIds=[string] --add-slurm-partitions=exclusive=boolean,id=string,nodesetIds=[string]
JSON Example:--add-slurm-partitions='[{"exclusive": boolean, "id": "string", "nodesetIds": ["string"]}]'
File Example:--add-slurm-partitions=path_to_file.(yaml|json)
--add-spot-instances=[id=ID],[machineType=MACHINETYPE],[zone=ZONE]-
Parameters to define cluster spot instances.
For e.g. --add-spot-instances id={computeId},zone={zone},machineType={machineType}.
Sets
add_spot_instancesvalue.id-
Required, sets
idvalue. machineType-
Required, sets
machineTypevalue. zone-
Required, sets
zonevalue.
Shorthand Example:--add-spot-instances=id=string,machineType=string,zone=string --add-spot-instances=id=string,machineType=string,zone=string
JSON Example:--add-spot-instances='[{"id": "string", "machineType": "string", "zone": "string"}]'
File Example:--add-spot-instances=path_to_file.(yaml|json)
--add-storage-buckets=[ADD_STORAGE_BUCKETS,…]-
Reference of existing Google Cloud Storage bucket.
For e.g. --add-storage-buckets {bucket-path}
--description=DESCRIPTION-
Description of the cluster.
For e.g. --description
(ALPHA)Updates a Cluster Director resource. --remove-dws-flex-instances=[REMOVE_DWS_FLEX_INSTANCES,…]-
Parameters to remove DWS Flex instance config by compute id.
For e.g. --remove-dws-flex-instances {computeId1},{computeId2},…
--remove-filestore-instances=[REMOVE_FILESTORE_INSTANCES,…]-
Parameters to remove filestore instance config by filestore name.
For e.g. --remove-filestore-instances locations/{location}/instances/{filestore1},locations/{location}/instances/{filestore2},…
--remove-labels=[REMOVE_LABELS,…]-
Parameters to remove cluster label by key.
For e.g. --remove-labels {key1},{key2},…
--remove-lustre-instances=[REMOVE_LUSTRE_INSTANCES,…]-
Parameters to remove lustre instance config by lustre name.
For e.g. --remove-lustre-instances locations/{location}/instances/{lustre1},locations/{location}/instances/{lustre2},…
--remove-on-demand-instances=[REMOVE_ON_DEMAND_INSTANCES,…]-
Parameters to remove on demand instances config by compute id.
For e.g. --remove-on-demand-instances {computeId1},{computeId2},…
--remove-reserved-instances=[REMOVE_RESERVED_INSTANCES,…]-
Parameters to remove reserved instance config by compute id.
For e.g. --remove-reserved-instances {computeId1},{computeId2},…
--remove-slurm-node-sets=[REMOVE_SLURM_NODE_SETS,…]-
Parameters to remove slurm nodeset config by nodeset id.
For e.g. --remove-slurm-node-sets {nodesetId1},{nodesetId2},…
--remove-slurm-partitions=[REMOVE_SLURM_PARTITIONS,…]-
Parameters to remove slurm partition config by partition id.
For e.g. --remove-slurm-partitions {partitionId1},{partitionId2},…
--remove-spot-instances=[REMOVE_SPOT_INSTANCES,…]-
Parameters to remove spot instance config by compute id.
For e.g. --remove-spot-instances {computeId1},{computeId2},…
--remove-storage-buckets=[REMOVE_STORAGE_BUCKETS,…]-
Parameters to remove Google Cloud Storage bucket by bucket name.
For e.g. --remove-storage-buckets {bucket1},{bucket2},…
--slurm-default-partition=SLURM_DEFAULT_PARTITION-
Parameters to define slurm cluster default partition.
For e.g. --slurm-default-partition {partitionId}
--update-slurm-login-node=[count=COUNT],[startupScript=STARTUPSCRIPT]-
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
update_slurm_login_nodevalue.count-
Sets
countvalue. startupScript-
Sets
startupScriptvalue.
Shorthand Example:--update-slurm-login-node=count=int,startupScript=string
JSON Example:--update-slurm-login-node='{"count": int, "startupScript": "string"}'
File Example:--update-slurm-login-node=path_to_file.(yaml|json)
--update-slurm-node-sets=[id=ID],[maxDynamicNodeCount=MAXDYNAMICNODECOUNT],[staticNodeCount=STATICNODECOUNT]-
Parameters to define and update slurm cluster nodeset config.
For e.g. --update-slurm-node-sets id={nodesetId},staticNodeCount={staticNodeCount},maxDynamicNodeCount={maxDynamicNodeCount}.
Sets
update_slurm_node_setsvalue.id-
Required, sets
idvalue. maxDynamicNodeCount-
Sets
maxDynamicNodeCountvalue. staticNodeCount-
Sets
staticNodeCountvalue.
Shorthand Example:--update-slurm-node-sets=id=string,maxDynamicNodeCount=int,staticNodeCount=int --update-slurm-node-sets=id=string,maxDynamicNodeCount=int,staticNodeCount=int
JSON Example:--update-slurm-node-sets='[{"id": "string", "maxDynamicNodeCount": int, "staticNodeCount": int}]'
File Example:--update-slurm-node-sets=path_to_file.(yaml|json)
--update-slurm-partitions=[exclusive=EXCLUSIVE],[id=ID],[nodesetIds=NODESETIDS]-
Parameters to define and update slurm cluster partition config.
For e.g. --update-slurm-partitions id={partitionId},nodesetIds=[{nodesetId1},{nodesetId2}],exclusive=false.
Sets
update_slurm_partitionsvalue.exclusive-
Sets
exclusivevalue. id-
Required, sets
idvalue. nodesetIds-
Sets
nodesetIdsvalue.
Shorthand Example:--update-slurm-partitions=exclusive=boolean,id=string,nodesetIds=[string] --update-slurm-partitions=exclusive=boolean,id=string,nodesetIds=[string]
JSON Example:--update-slurm-partitions='[{"exclusive": boolean, "id": "string", "nodesetIds": ["string"]}]'
File Example:--update-slurm-partitions=path_to_file.(yaml|json)
-
Cluster configuration for updates.
--config=[computeResources=COMPUTERESOURCES],[description=DESCRIPTION],[labels=LABELS],[name=NAME],[networkResources=NETWORKRESOURCES],[orchestrator=ORCHESTRATOR],[storageResources=STORAGERESOURCES]-
Configuration of the cluster specs in the form of a JSON object. Required, sets
configvalue.computeResources-
Sets
computeResourcesvalue.KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.config-
Sets
configvalue.newDwsFlexInstances-
Sets
newDwsFlexInstancesvalue.machineType-
Sets
machineTypevalue. maxDuration-
Sets
maxDurationvalue. zone-
Sets
zonevalue.
newFlexStartInstances-
Sets
newFlexStartInstancesvalue.machineType-
Sets
machineTypevalue. maxDuration-
Sets
maxDurationvalue. zone-
Sets
zonevalue.
newOnDemandInstances-
Sets
newOnDemandInstancesvalue.machineType-
Sets
machineTypevalue. zone-
Sets
zonevalue.
newReservedInstances-
Sets
newReservedInstancesvalue.machineType-
Sets
machineTypevalue. reservation-
Sets
reservationvalue. type-
Sets
typevalue. zone-
Sets
zonevalue.
newSpotInstances-
Sets
newSpotInstancesvalue.machineType-
Sets
machineTypevalue. zone-
Sets
zonevalue.
description-
Sets
descriptionvalue. labels-
Sets
labelsvalue.KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.
name-
Sets
namevalue. networkResources-
Sets
networkResourcesvalue.KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.config-
Sets
configvalue.existingNetwork-
Sets
existingNetworkvalue.network-
Sets
networkvalue. subnetwork-
Sets
subnetworkvalue.
newNetwork-
Sets
newNetworkvalue.description-
Sets
descriptionvalue. network-
Sets
networkvalue.
orchestrator-
Sets
orchestratorvalue.slurm-
Sets
slurmvalue.defaultPartition-
Sets
defaultPartitionvalue. loginNodes-
Sets
loginNodesvalue.count-
Sets
countvalue. disks-
Sets
disksvalue.boot-
Required, sets
bootvalue. sizeGb-
Sets
sizeGbvalue. sourceImage-
Sets
sourceImagevalue. type-
Required, sets
typevalue.
enableOsLogin-
Sets
enableOsLoginvalue. enablePublicIps-
Sets
enablePublicIpsvalue. labels-
Sets
labelsvalue.KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.
machineType-
Sets
machineTypevalue. startupScript-
Sets
startupScriptvalue. storageConfigs-
Sets
storageConfigsvalue.id-
Sets
idvalue. localMount-
Sets
localMountvalue.
zone-
Sets
zonevalue.
nodeSets-
Sets
nodeSetsvalue.bootDisk-
Sets
bootDiskvalue.boot-
Required, sets
bootvalue. sizeGb-
Sets
sizeGbvalue. sourceImage-
Sets
sourceImagevalue. type-
Required, sets
typevalue.
id-
Sets
idvalue. labels-
Sets
labelsvalue.KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.
maxDynamicNodeCount-
Sets
maxDynamicNodeCountvalue. resourceRequestId-
Sets
resourceRequestIdvalue. startupScript-
Sets
startupScriptvalue. staticNodeCount-
Sets
staticNodeCountvalue. storageConfigs-
Sets
storageConfigsvalue.id-
Sets
idvalue. localMount-
Sets
localMountvalue.
partitions-
Sets
partitionsvalue.exclusive-
Sets
exclusivevalue. id-
Sets
idvalue. nodeSetIds-
Sets
nodeSetIdsvalue.
storageResources-
Sets
storageResourcesvalue.KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.config-
Sets
configvalue.existingBucket-
Sets
existingBucketvalue.bucket-
Sets
bucketvalue.
existingFilestore-
Sets
existingFilestorevalue.filestore-
Sets
filestorevalue.
existingLustre-
Sets
existingLustrevalue.lustre-
Sets
lustrevalue.
newBucket-
Sets
newBucketvalue.autoclass-
Sets
autoclassvalue.enabled-
Sets
enabledvalue.
bucket-
Sets
bucketvalue. hierarchicalNamespace-
Sets
hierarchicalNamespacevalue.enabled-
Sets
enabledvalue.
storageClass-
Sets
storageClassvalue.
newFilestore-
Sets
newFilestorevalue.description-
Sets
descriptionvalue. -
Sets
fileSharesvalue.capacityGb-
Sets
capacityGbvalue. -
Sets
fileSharevalue.
filestore-
Sets
filestorevalue. protocol-
Sets
protocolvalue. tier-
Sets
tiervalue.
newLustre-
Sets
newLustrevalue.capacityGb-
Sets
capacityGbvalue. description-
Sets
descriptionvalue. filesystem-
Sets
filesystemvalue. lustre-
Sets
lustrevalue.
Shorthand Example:--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}}}}
JSON Example:--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"}}}}}'
File Example:--config=path_to_file.(yaml|json)
This flag argument must be specified if any of the other arguments in this group are specified.
--update-mask=UPDATE_MASK-
Update mask to specify the fields to update.
For e.g. --update-mask "description,labels".
Required, sets
update_maskvalue.Input Example:--update-mask=stringFile Example:--update-mask=path_to_file.(yaml|json)
This flag argument must be specified if any of the other arguments in this group are specified.
-
Flag Configurations to define cluster updates.
-
Cluster configuration for provisioning with updates.
- 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 helpfor details. - 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.
gcloud alpha cluster-director clusters update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-04 UTC.