.TH "GCLOUD_ALPHA_CLUSTER\-DIRECTOR_CLUSTERS_CREATE" 1



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



.SH "SYNOPSIS"
.HP
\f5gcloud alpha cluster\-director clusters create\fR (\fICLUSTER\fR\ :\ \fB\-\-location\fR=\fILOCATION\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\-\-slurm\-login\-node\fR=[\fIcount\fR=\fICOUNT\fR],[\fIenableOSLogin\fR=\fIENABLEOSLOGIN\fR],[\fIenablePublicIPs\fR=\fIENABLEPUBLICIPS\fR],[\fIlabels\fR=\fILABELS\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIstartupScript\fR=\fISTARTUPSCRIPT\fR],[\fIzone\fR=\fIZONE\fR]\ \fB\-\-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\-\-slurm\-partitions\fR=[\fIexclusive\fR=\fIEXCLUSIVE\fR],[\fIid\fR=\fIID\fR],[\fInodesetIds\fR=\fINODESETIDS\fR]\ (\fB\-\-create\-network\fR=[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIname\fR=\fINAME\fR]\ |\ \fB\-\-network\fR=\fINETWORK\fR\ \fB\-\-subnet\fR=\fISUBNET\fR)\ :\ \fB\-\-buckets\fR=[\fIBUCKETS\fR,...]\ \fB\-\-create\-buckets\fR=[\fIenableAutoclass\fR=\fIENABLEAUTOCLASS\fR],[\fIenableHNS\fR=\fIENABLEHNS\fR],[\fIname\fR=\fINAME\fR],[\fIstorageClass\fR=\fISTORAGECLASS\fR]\ \fB\-\-create\-filestores\fR=[\fIcapacityGb\fR=\fICAPACITYGB\fR],[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIfileshare\fR=\fIFILESHARE\fR],[\fIname\fR=\fINAME\fR],[\fIprotocol\fR=\fIPROTOCOL\fR],[\fItier\fR=\fITIER\fR]\ \fB\-\-create\-lustres\fR=[\fIcapacityGb\fR=\fICAPACITYGB\fR],[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIfilesystem\fR=\fIFILESYSTEM\fR],[\fIname\fR=\fINAME\fR]\ \fB\-\-description\fR=\fIDESCRIPTION\fR\ \fB\-\-dws\-flex\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fImaxDuration\fR=\fIMAXDURATION\fR],[\fIzone\fR=\fIZONE\fR]\ \fB\-\-filestores\fR=[\fIFILESTORES\fR,...]\ \fB\-\-labels\fR=[\fILABELS\fR,...]\ \fB\-\-lustres\fR=[\fILUSTRES\fR,...]\ \fB\-\-on\-demand\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIzone\fR=\fIZONE\fR]\ \fB\-\-reserved\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIreservation\fR=\fIRESERVATION\fR]\ \fB\-\-slurm\-default\-partition\fR=\fISLURM_DEFAULT_PARTITION\fR\ \fB\-\-spot\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIzone\fR=\fIZONE\fR]]) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

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

There are following ways to create a cluster:
.RS 2m
.IP "\(bu" 2m
[Preferred] Use granular flags to define cluster specs.
.IP "\(bu" 2m
Use \-\-config flag with cluster specs in JSON format.
.RE
.sp

Please refer to the examples below for more details.



.SH "EXAMPLES"

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

.RS 2m
$ gcloud alpha cluster\-director clusters create my\-cluster \e
    \-\-location us\-central1\-a \e
    \-\-description "My cluster description" \e
    \-\-labels env=prod,client=gcloud\-cli \e
    \-\-create\-network name=network0 \e
    \-\-create\-filestores \e
    name=locations/us\-central1\-a/instances/filestore0,\e
tier=BASIC_HDD,capacityGb={filestoreSize},fileshare={fileshare} \e
    \-\-filestores locations/us\-central1\-a/instances/filestore1 \e
    \-\-create\-buckets name=bucket0 \-\-buckets bucket1 \e
    \-\-create\-lustres \e
    name=locations/us\-central1\-a/instances/lustre0,\e
capacityGb={lustreSize},filesystem={filesystem} \e
    \-\-lustres locations/us\-central1\-a/instances/lustre1 \e
    \-\-reserved\-instances \e
    id=compute0,machineType={machineType},reservation=zones/\e
us\-central1\-a/reservations/{reservation} \e
    \-\-slurm\-login\-node \e
    machineType={machineType},zone=us\-central1\-a \e
    \-\-slurm\-node\-sets id=nodeset0,computeId=compute0 \e
    \-\-slurm\-partitions id=partition0,nodesetIds=[nodeset0] \e
    \-\-slurm\-default\-partition partition0 \-\-format json
.RE

To create a cluster \f5my\-cluster\fR in location \f5us\-central1\-a\fR with
config in JSON string format run the following example:

.RS 2m
$ gcloud alpha cluster\-director clusters create my\-cluster \e
    \-\-location=us\-central1\-a \-\-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 create my\-cluster \e
    \-\-location=us\-central1\-a \-\-config=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.

Exactly one of these must be specified:


.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. 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


.TP 2m

Flag Configurations to define cluster spec.


.RS 2m
.TP 2m
\fB\-\-slurm\-login\-node\fR=[\fIcount\fR=\fICOUNT\fR],[\fIenableOSLogin\fR=\fIENABLEOSLOGIN\fR],[\fIenablePublicIPs\fR=\fIENABLEPUBLICIPS\fR],[\fIlabels\fR=\fILABELS\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIstartupScript\fR=\fISTARTUPSCRIPT\fR],[\fIzone\fR=\fIZONE\fR]

Parameters to define slurm cluster login node.

For e.g. \-\-slurm\-login\-node
machineType={machineType},zone={zone},count={count},enableOSLogin=true,enablePublicIPs=true,startupScript="echo
hello",labels="{key1=value1,key2=value2}"

Defaults:
.RS 2m
.IP "\(em" 2m
count: 1
.IP "\(em" 2m
enableOSLogin: true
.IP "\(em" 2m
enablePublicIPs: true
.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

Required, sets \f5slurm_login_node\fR value.
.RE
.sp

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

.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
Required, sets \f5machineType\fR value.

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

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

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-slurm\-login\-node=count=int,enableOSLogin=boolean,enablePublicIPs=boolean,labels={string=string},machineType=string,startupScript=string,zone=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-slurm\-login\-node='{"count": int, "enableOSLogin": boolean, "enablePublicIPs": boolean, "labels": {"string": "string"}, "machineType": "string", "startupScript": "string", "zone": "string"}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-slurm\-login\-node=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\-\-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. \-\-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

Required, sets \f5slurm_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
\-\-slurm\-node\-sets=computeId=string,id=string,labels={string=string},maxDynamicNodeCount=int,startupScript=string,staticNodeCount=int \-\-slurm\-node\-sets=computeId=string,id=string,labels={string=string},maxDynamicNodeCount=int,startupScript=string,staticNodeCount=int
.RE


\fBJSON Example:\fR


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


\fBFile Example:\fR


.RS 2m
\-\-slurm\-node\-sets=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\-\-slurm\-partitions\fR=[\fIexclusive\fR=\fIEXCLUSIVE\fR],[\fIid\fR=\fIID\fR],[\fInodesetIds\fR=\fINODESETIDS\fR]

Parameters to define slurm cluster partitions.

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

Required, sets \f5slurm_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
\-\-slurm\-partitions=exclusive=boolean,id=string,nodesetIds=[string] \-\-slurm\-partitions=exclusive=boolean,id=string,nodesetIds=[string]
.RE


\fBJSON Example:\fR


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


\fBFile Example:\fR


.RS 2m
\-\-slurm\-partitions=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\-\-buckets\fR=[\fIBUCKETS\fR,...]

Reference of existing Google Cloud Storage bucket.

For e.g. \-\-buckets {bucket\-path}

.TP 2m
\fB\-\-create\-buckets\fR=[\fIenableAutoclass\fR=\fIENABLEAUTOCLASS\fR],[\fIenableHNS\fR=\fIENABLEHNS\fR],[\fIname\fR=\fINAME\fR],[\fIstorageClass\fR=\fISTORAGECLASS\fR]

Parameters to create a Google Cloud Storage bucket.

For e.g. \-\-create\-buckets name={bucket\-path}

Supported storageClass values:
.RS 2m
.IP "\(em" 2m
STANDARD
.IP "\(em" 2m
NEARLINE
.IP "\(em" 2m
COLDLINE
.IP "\(em" 2m
ARCHIVE
.RE
.sp

Defaults:
.RS 2m
.IP "\(em" 2m
storageClass: STANDARD
.RE
.sp

Note:
.RS 2m
.IP "\(em" 2m
Either storageClass or enableAutoclass can be set.
.IP "\(em" 2m
if enableAutoclass is set, enableHNS should not be set.
.IP "\(em" 2m
HNS: Hierarchical namespace.
.RE
.sp

Sets \f5create_buckets\fR value.

.RS 2m
.TP 2m
\fBenableAutoclass\fR
Sets \f5enableAutoclass\fR value.

.TP 2m
\fBenableHNS\fR
Sets \f5enableHNS\fR value.

.TP 2m
\fBname\fR
Required, sets \f5name\fR value.

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

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-create\-buckets=enableAutoclass=boolean,enableHNS=boolean,name=string,storageClass=string \-\-create\-buckets=enableAutoclass=boolean,enableHNS=boolean,name=string,storageClass=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-create\-buckets='[{"enableAutoclass": boolean, "enableHNS": boolean, "name": "string", "storageClass": "string"}]'
.RE


\fBFile Example:\fR


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


.TP 2m
\fB\-\-create\-filestores\fR=[\fIcapacityGb\fR=\fICAPACITYGB\fR],[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIfileshare\fR=\fIFILESHARE\fR],[\fIname\fR=\fINAME\fR],[\fIprotocol\fR=\fIPROTOCOL\fR],[\fItier\fR=\fITIER\fR]

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:
.RS 2m
.IP "\(em" 2m
ZONAL
.IP "\(em" 2m
REGIONAL
.RE
.sp

Supported protocol values:
.RS 2m
.IP "\(em" 2m
NFSV3
.IP "\(em" 2m
NFSV41
.IP "\(em" 2m
If not specified, defaults to NFSV3
.RE
.sp

Defaults:
.RS 2m
.IP "\(em" 2m
protocol: NFSV3.
.RE
.sp

Sets \f5create_filestores\fR value.

.RS 2m
.TP 2m
\fBcapacityGb\fR
Required, sets \f5capacityGb\fR value.

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

.TP 2m
\fBfileshare\fR
Required, sets \f5fileshare\fR value.

.TP 2m
\fBname\fR
Required, sets \f5name\fR value.

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

.TP 2m
\fBtier\fR
Required, sets \f5tier\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-create\-filestores=capacityGb=int,description=string,fileshare=string,name=string,protocol=string,tier=string \-\-create\-filestores=capacityGb=int,description=string,fileshare=string,name=string,protocol=string,tier=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-create\-filestores='[{"capacityGb": int, "description": "string", "fileshare": "string", "name": "string", "protocol": "string", "tier": "string"}]'
.RE


\fBFile Example:\fR


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


.TP 2m
\fB\-\-create\-lustres\fR=[\fIcapacityGb\fR=\fICAPACITYGB\fR],[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIfilesystem\fR=\fIFILESYSTEM\fR],[\fIname\fR=\fINAME\fR]

Parameters to create a Lustre instance.

For e.g. \-\-create\-lustres
name=locations/{location}/instances/{lustre},capacityGb={lustreSize},filesystem={filesystem}.

Sets \f5create_lustres\fR value.

.RS 2m
.TP 2m
\fBcapacityGb\fR
Required, sets \f5capacityGb\fR value.

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

.TP 2m
\fBfilesystem\fR
Required, sets \f5filesystem\fR value.

.TP 2m
\fBname\fR
Required, sets \f5name\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-create\-lustres=capacityGb=int,description=string,filesystem=string,name=string \-\-create\-lustres=capacityGb=int,description=string,filesystem=string,name=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-create\-lustres='[{"capacityGb": int, "description": "string", "filesystem": "string", "name": "string"}]'
.RE


\fBFile Example:\fR


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


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

Description of the cluster.

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

.TP 2m
\fB\-\-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. \-\-dws\-flex\-instances
id={computeId},zone={zone},machineType={machineType},maxDuration=10000s.

Sets \f5dws_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
\-\-dws\-flex\-instances=id=string,machineType=string,maxDuration=string,zone=string \-\-dws\-flex\-instances=id=string,machineType=string,maxDuration=string,zone=string
.RE


\fBJSON Example:\fR


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


\fBFile Example:\fR


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


.TP 2m
\fB\-\-filestores\fR=[\fIFILESTORES\fR,...]

Reference of existing filestore instance.

For e.g. \-\-filestores locations/{location}/instances/{filestore}

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

Cluster labels as key value pairs.

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

Sets \f5labels\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
\-\-labels={string=string}
.RE


\fBJSON Example:\fR


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


\fBFile Example:\fR


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


.TP 2m
\fB\-\-lustres\fR=[\fILUSTRES\fR,...]

Reference of existing Lustre instance.

For e.g. \-\-lustres locations/{location}/instances/{lustre}

.TP 2m
\fB\-\-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. \-\-on\-demand\-instances
id={computeId},zone={zone},machineType={machineType}.

Sets \f5on_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
\-\-on\-demand\-instances=id=string,machineType=string,zone=string \-\-on\-demand\-instances=id=string,machineType=string,zone=string
.RE


\fBJSON Example:\fR


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


\fBFile Example:\fR


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


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

Parameters to define cluster reserved instances.

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

Sets \f5reserved_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
\-\-reserved\-instances=id=string,machineType=string,reservation=string \-\-reserved\-instances=id=string,machineType=string,reservation=string
.RE


\fBJSON Example:\fR


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


\fBFile Example:\fR


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


.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\-\-spot\-instances\fR=[\fIid\fR=\fIID\fR],[\fImachineType\fR=\fIMACHINETYPE\fR],[\fIzone\fR=\fIZONE\fR]

Parameters to define cluster spot instances.

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

Sets \f5spot_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
\-\-spot\-instances=id=string,machineType=string,zone=string \-\-spot\-instances=id=string,machineType=string,zone=string
.RE


\fBJSON Example:\fR


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


\fBFile Example:\fR


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


.TP 2m

Network configuration for the cluster.

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-create\-network\fR=[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIname\fR=\fINAME\fR]

Parameters to create a network.

For e.g. \-\-create\-network name={network},description=\fB(ALPHA)\fR Creates a
Cluster Director resource..

Sets \f5create_network\fR value.

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

.TP 2m
\fBname\fR
Required, sets \f5name\fR value.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-create\-network=description=string,name=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-create\-network='{"description": "string", "name": "string"}'
.RE


\fBFile Example:\fR


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


.TP 2m

Use an existing network source for the cluster.


.RS 2m
.TP 2m
\fB\-\-network\fR=\fINETWORK\fR

Reference of existing network name.

For e.g. \-\-network {network}

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

.TP 2m
\fB\-\-subnet\fR=\fISUBNET\fR

Reference of existing subnetwork name.

For e.g. \-\-subnet regions/{region}/subnetworks/{subnetwork}

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


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