gcloud alpha cluster-director clusters update

NAME
gcloud alpha cluster-director clusters update - updates the parameters of a Cluster Director resource
SYNOPSIS
gcloud alpha cluster-director clusters update (CLUSTER : --location=LOCATION) --config=[compute=COMPUTE],[description=DESCRIPTION],[labels=LABELS],[name=NAME],[networkResources=NETWORKRESOURCES],[networks=NETWORKS],[orchestrator=ORCHESTRATOR],[reconciling=RECONCILING],[storageResources=STORAGERESOURCES],[storages=STORAGES] --update-mask=UPDATE_MASK [--async] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
(ALPHA) Updates the parameters of a Cluster Director resource.
EXAMPLES
To update the labels of a cluster my-cluster in location us-central1-a with config file my-cluster-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 with 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.json

Or 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 - Identifier. Name of the cluster. 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 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
The location id of the cluster resource.

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
--config=[compute=COMPUTE],[description=DESCRIPTION],[labels=LABELS],[name=NAME],[networkResources=NETWORKRESOURCES],[networks=NETWORKS],[orchestrator=ORCHESTRATOR],[reconciling=RECONCILING],[storageResources=STORAGERESOURCES],[storages=STORAGES]
Required, Configuration of the cluster specs to be updated in shorthand | JSON string | file path format.
compute
Sets compute value.
resourceRequests
Sets resourceRequests value.
disks
Sets disks value.
boot
Sets boot value.
sizeGb
Sets sizeGb value.
sourceImage
Sets sourceImage value.
type
Sets type value.
guestAccelerators
Sets guestAccelerators value.
acceleratorType
Sets acceleratorType value.
count
Sets count value.
id
Sets id value.
machineType
Sets machineType value.
maxRunDuration
Sets maxRunDuration value.
provisioningModel
Sets provisioningModel value.
reservationAffinity
Sets reservationAffinity value.
key
Sets key value.
type
Sets type value.
values
Sets values value.
terminationAction
Sets terminationAction value.
zone
Sets zone value.
description
Sets description value.
labels
Sets labels value.
KEY
Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
name
Sets name value.
networkResources
Sets networkResources value.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
computeNetwork
Sets computeNetwork value.
network
Sets network value.
subnetwork
Sets subnetwork value.
config
Sets config value.
existingComputeNetwork
Sets existingComputeNetwork value.
network
Sets network value.
subnetwork
Sets subnetwork value.
newComputeNetwork
Sets newComputeNetwork value.
description
Sets description value.
network
Sets network value.
networks
Sets networks value.
initializeParams
Sets initializeParams value.
description
Sets description value.
network
Sets network value.
network
Sets network value.
networkSource
Sets networkSource value.
network
Sets network value.
subnetwork
Sets subnetwork value.
subnetwork
Sets subnetwork value.
orchestrator
Sets orchestrator value.
slurm
Sets slurm value.
config
Sets config value.
prologEpilogTimeout
Sets prologEpilogTimeout value.
prologFlags
Sets prologFlags value.
requeueExitCodes
Sets requeueExitCodes value.
requeueHoldExitCodes
Sets requeueHoldExitCodes value.
defaultPartition
Sets defaultPartition value.
epilogBashScripts
Sets epilogBashScripts value.
loginNodes
Sets loginNodes value.
count
Sets count value.
disks
Sets disks value.
boot
Sets boot value.
sizeGb
Sets sizeGb value.
sourceImage
Sets sourceImage value.
type
Sets type value.
enableOsLogin
Sets enableOsLogin value.
enablePublicIps
Sets enablePublicIps value.
instances
Sets instances value.
instance
Sets instance value.
labels
Sets labels value.
KEY
Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
machineType
Sets machineType value.
serviceAccount
Sets serviceAccount value.
email
Sets email value.
scopes
Sets scopes value.
startupScript
Sets startupScript value.
storageConfigs
Sets storageConfigs value.
id
Sets id value.
localMount
Sets localMount value.
zone
Sets zone value.
nodeSets
Sets nodeSets value.
canIpForward
Sets canIpForward value.
enableOsLogin
Sets enableOsLogin value.
enablePublicIps
Sets enablePublicIps value.
id
Sets id value.
labels
Sets labels value.
KEY
Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
maxDynamicNodeCount
Sets maxDynamicNodeCount value.
resourceRequestId
Sets resourceRequestId value.
serviceAccount
Sets serviceAccount value.
email
Sets email value.
scopes
Sets scopes value.
startupScript
Sets startupScript value.
staticNodeCount
Sets staticNodeCount value.
storageConfigs
Sets storageConfigs value.
id
Sets id value.
localMount
Sets localMount value.
partitions
Sets partitions value.
exclusive
Sets exclusive value.
id
Sets id value.
nodeSetIds
Sets nodeSetIds value.
prologBashScripts
Sets prologBashScripts value.
taskEpilogBashScripts
Sets taskEpilogBashScripts value.
taskPrologBashScripts
Sets taskPrologBashScripts value.
reconciling
Sets reconciling value.
storageResources
Sets storageResources value.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
bucket
Sets bucket value.
bucket
Sets bucket value.
config
Sets config value.
existingBucket
Sets existingBucket value.
bucket
Sets bucket value.
existingFilestore
Sets existingFilestore value.
filestore
Sets filestore value.
existingLustre
Sets existingLustre value.
lustre
Sets lustre value.
newBucket
Sets newBucket value.
autoclass
Sets autoclass value.
enabled
Sets enabled value.
terminalStorageClass
Sets terminalStorageClass value.
bucket
Sets bucket value.
hierarchicalNamespace
Sets hierarchicalNamespace value.
enabled
Sets enabled value.
storageClass
Sets storageClass value.
newFilestore
Sets newFilestore value.
description
Sets description value.
fileShares
Sets fileShares value.
capacityGb
Sets capacityGb value.
fileShare
Sets fileShare value.
filestore
Sets filestore value.
protocol
Sets protocol value.
tier
Sets tier value.
newLustre
Sets newLustre value.
capacityGb
Sets capacityGb value.
description
Sets description value.
filesystem
Sets filesystem value.
lustre
Sets lustre value.
filestore
Sets filestore value.
filestore
Sets filestore value.
lustre
Sets lustre value.
lustre
Sets lustre value.
storages
Sets storages value.
id
Sets id value.
initializeParams
Sets initializeParams value.
filestore
Sets filestore value.
description
Sets description value.
fileShares
Sets fileShares value.
capacityGb
Sets capacityGb value.
fileShare
Sets fileShare value.
filestore
Sets filestore value.
protocol
Sets protocol value.
tier
Sets tier value.
gcs
Sets gcs value.
autoclass
Sets autoclass value.
enabled
Sets enabled value.
terminalStorageClass
Sets terminalStorageClass value.
bucket
Sets bucket value.
hierarchicalNamespace
Sets hierarchicalNamespace value.
enabled
Sets enabled value.
storageClass
Sets storageClass value.
lustre
Sets lustre value.
capacityGb
Sets capacityGb value.
description
Sets description value.
filesystem
Sets filesystem value.
lustre
Sets lustre value.
storage
Sets storage value.
storageSource
Sets storageSource value.
bucket
Sets bucket value.
filestore
Sets filestore value.
lustre
Sets lustre value.
Shorthand Example: 
--config=compute={resourceRequests=[{disks=[{boot=boolean,sizeGb=int,sourceImage=string,type=string}],guestAccelerators=[{acceleratorType=string,count=int}],id=string,machineType=string,maxRunDuration=int,provisioningModel=string,reservationAffinity={key=string,type=string,values=[string]},terminationAction=string,zone=string}]},description=string,labels={string=string},name=string,networkResources={string={computeNetwork={network=string,subnetwork=string},config={existingComputeNetwork={network=string,subnetwork=string},newComputeNetwork={description=string,network=string}}}},networks=[{initializeParams={description=string,network=string},network=string,networkSource={network=string,subnetwork=string},subnetwork=string}],orchestrator={slurm={config={prologEpilogTimeout=string,prologFlags=[string],requeueExitCodes=[int],requeueHoldExitCodes=[int]},defaultPartition=string,epilogBashScripts=[string],loginNodes={count=int,disks=[{boot=boolean,sizeGb=int,sourceImage=string,type=string}],enableOsLogin=boolean,enablePublicIps=boolean,instances=[{instance=string}],labels={string=string},machineType=string,serviceAccount={email=string,scopes=[string]},startupScript=string,storageConfigs=[{id=string,localMount=string}],zone=string},nodeSets=[{canIpForward=boolean,enableOsLogin=boolean,enablePublicIps=boolean,id=string,labels={string=string},maxDynamicNodeCount=int,resourceRequestId=string,serviceAccount={email=string,scopes=[string]},startupScript=string,staticNodeCount=int,storageConfigs=[{id=string,localMount=string}]}],partitions=[{exclusive=boolean,id=string,nodeSetIds=[string]}],prologBashScripts=[string],taskEpilogBashScripts=[string],taskPrologBashScripts=[string]}},reconciling=boolean,storageResources={string={bucket={bucket=string},config={existingBucket={bucket=string},existingFilestore={filestore=string},existingLustre={lustre=string},newBucket={autoclass={enabled=boolean,terminalStorageClass=string},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}},filestore={filestore=string},lustre={lustre=string}}},storages=[{id=string,initializeParams={filestore={description=string,fileShares=[{capacityGb=int,fileShare=string}],filestore=string,protocol=string,tier=string},gcs={autoclass={enabled=boolean,terminalStorageClass=string},bucket=string,hierarchicalNamespace={enabled=boolean},storageClass=string},lustre={capacityGb=int,description=string,filesystem=string,lustre=string}},storage=string,storageSource={bucket=string,filestore=string,lustre=string}}]

JSON Example: 

--config='{"compute": {"resourceRequests": [{"disks": [{"boot": boolean, "sizeGb": int, "sourceImage": "string", "type": "string"}], "guestAccelerators": [{"acceleratorType": "string", "count": int}], "id": "string", "machineType": "string", "maxRunDuration": int, "provisioningModel": "string", "reservationAffinity": {"key": "string", "type": "string", "values": ["string"]}, "terminationAction": "string", "zone": "string"}]}, "description": "string", "labels": {"string": "string"}, "name": "string", "networkResources": {"string": {"computeNetwork": {"network": "string", "subnetwork": "string"}, "config": {"existingComputeNetwork": {"network": "string", "subnetwork": "string"}, "newComputeNetwork": {"description": "string", "network": "string"}}}}, "networks": [{"initializeParams": {"description": "string", "network": "string"}, "network": "string", "networkSource": {"network": "string", "subnetwork": "string"}, "subnetwork": "string"}], "orchestrator": {"slurm": {"config": {"prologEpilogTimeout": "string", "prologFlags": ["string"], "requeueExitCodes": [int], "requeueHoldExitCodes": [int]}, "defaultPartition": "string", "epilogBashScripts": ["string"], "loginNodes": {"count": int, "disks": [{"boot": boolean, "sizeGb": int, "sourceImage": "string", "type": "string"}], "enableOsLogin": boolean, "enablePublicIps": boolean, "instances": [{"instance": "string"}], "labels": {"string": "string"}, "machineType": "string", "serviceAccount": {"email": "string", "scopes": ["string"]}, "startupScript": "string", "storageConfigs": [{"id": "string", "localMount": "string"}], "zone": "string"}, "nodeSets": [{"canIpForward": boolean, "enableOsLogin": boolean, "enablePublicIps": boolean, "id": "string", "labels": {"string": "string"}, "maxDynamicNodeCount": int, "resourceRequestId": "string", "serviceAccount": {"email": "string", "scopes": ["string"]}, "startupScript": "string", "staticNodeCount": int, "storageConfigs": [{"id": "string", "localMount": "string"}]}], "partitions": [{"exclusive": boolean, "id": "string", "nodeSetIds": ["string"]}], "prologBashScripts": ["string"], "taskEpilogBashScripts": ["string"], "taskPrologBashScripts": ["string"]}}, "reconciling": boolean, "storageResources": {"string": {"bucket": {"bucket": "string"}, "config": {"existingBucket": {"bucket": "string"}, "existingFilestore": {"filestore": "string"}, "existingLustre": {"lustre": "string"}, "newBucket": {"autoclass": {"enabled": boolean, "terminalStorageClass": "string"}, "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"}}, "filestore": {"filestore": "string"}, "lustre": {"lustre": "string"}}}, "storages": [{"id": "string", "initializeParams": {"filestore": {"description": "string", "fileShares": [{"capacityGb": int, "fileShare": "string"}], "filestore": "string", "protocol": "string", "tier": "string"}, "gcs": {"autoclass": {"enabled": boolean, "terminalStorageClass": "string"}, "bucket": "string", "hierarchicalNamespace": {"enabled": boolean}, "storageClass": "string"}, "lustre": {"capacityGb": int, "description": "string", "filesystem": "string", "lustre": "string"}}, "storage": "string", "storageSource": {"bucket": "string", "filestore": "string", "lustre": "string"}}]}'

File Example: 

--config=path_to_file.(yaml|json)
--update-mask=UPDATE_MASK
Required, Field mask to be updated in shorthand | JSON string | file path format. Input Example: 
--update-mask=string

File Example: 

--update-mask=path_to_file.(yaml|json)
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 hypercomputecluster/v1alpha API. The full documentation for this API can be found at: https://cloud.google.com/ai-hypercomputer/docs/cluster-director
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.