File: //snap/google-cloud-cli/current/lib/surface/cluster_director/clusters/create.py
# -*- coding: utf-8 -*- #
# Copyright 2025 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Command to create a cluster-director cluster resource."""
import textwrap
from googlecloudsdk.api_lib.hypercomputecluster import utils as api_utils
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.cluster_director.clusters import flags
from googlecloudsdk.command_lib.cluster_director.clusters import utils
from googlecloudsdk.core import log
DETAILED_HELP = {
"DESCRIPTION": textwrap.dedent("""
*{command}* facilitates the creation of a cluster resource.
There are following ways to create a cluster:
- [Preferred] Use granular flags to define cluster specs.
- Use --config flag with cluster specs in JSON format.
Please refer to the examples below for more details.
"""),
"EXAMPLES": textwrap.dedent("""
To create a cluster `my-cluster` in location `us-central1-a` with granular flags, run the following example:
$ {command} my-cluster --location us-central1-a \
--description "My cluster description" \
--labels env=prod,client=gcloud-cli \
--create-network name=network0 \
--create-filestores name=locations/us-central1-a/instances/filestore0,tier=BASIC_HDD,capacityGb={filestoreSize},fileshare={fileshare} \
--filestores locations/us-central1-a/instances/filestore1 \
--create-buckets name=bucket0 \
--buckets bucket1 \
--create-lustres name=locations/us-central1-a/instances/lustre0,capacityGb={lustreSize},filesystem={filesystem} \
--lustres locations/us-central1-a/instances/lustre1 \
--reserved-instances id=compute0,machineType={machineType},reservation=zones/us-central1-a/reservations/{reservation} \
--slurm-login-node machineType={machineType},zone=us-central1-a \
--slurm-node-sets id=nodeset0,computeId=compute0 \
--slurm-partitions id=partition0,nodesetIds=[nodeset0] \
--slurm-default-partition partition0 \
--format json
To create a cluster `my-cluster` in location `us-central1-a` with config in JSON string format run the following example:
$ {command} my-cluster --location=us-central1-a --config='{"key": "value"}'
Or create a JSON file `my-cluster-config.json` with the cluster specs and run the following file example:
$ {command} my-cluster --location=us-central1-a --config=my-cluster-config.json
"""),
}
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class Create(base.CreateCommand):
"""Creates a Cluster Director resource."""
@classmethod
def Args(cls, parser):
"""Specifies command flags.
Args:
parser: argparse.Parser: Parser object for command line inputs.
"""
base.ASYNC_FLAG.AddToParser(parser)
api_version = api_utils.GetApiVersion(cls.ReleaseTrack())
utils.AddClusterNameArgToParser(parser=parser, api_version=api_version)
group = parser.add_group(
help="Cluster configuration for provisioning.",
mutex=True,
required=True,
)
flags.AddConfig(parser=group, api_version=api_version)
flag_group = group.add_group(
help="Flag Configurations to define cluster spec.",
)
flags.AddDescription(parser=flag_group, api_version=api_version)
flags.AddLabels(parser=flag_group, api_version=api_version)
network_group = flag_group.add_group(
mutex=True,
required=True,
help="Network configuration for the cluster.",
)
flags.AddCreateNetwork(parser=network_group, api_version=api_version)
network_source_group = network_group.add_group(
help="Use an existing network source for the cluster.",
)
flags.AddNetworkSource(
parser=network_source_group, api_version=api_version, required=True
)
flags.AddSubnetSource(
parser=network_source_group, api_version=api_version, required=True
)
flags.AddCreateFilestores(parser=flag_group, api_version=api_version)
flags.AddFilestores(parser=flag_group, api_version=api_version)
flags.AddCreateGcsBuckets(parser=flag_group, api_version=api_version)
flags.AddGcsBuckets(parser=flag_group, api_version=api_version)
flags.AddCreateLustres(parser=flag_group, api_version=api_version)
flags.AddLustres(parser=flag_group, api_version=api_version)
flags.AddOnDemandInstances(parser=flag_group, api_version=api_version)
flags.AddSpotInstances(parser=flag_group, api_version=api_version)
flags.AddReservedInstances(parser=flag_group, api_version=api_version)
flags.AddDwsFlexInstances(parser=flag_group, api_version=api_version)
flags.AddSlurmLoginNode(
parser=flag_group, api_version=api_version, required=True
)
flags.AddSlurmNodeSets(
parser=flag_group, api_version=api_version, required=True
)
flags.AddSlurmPartitions(
parser=flag_group, api_version=api_version, required=True
)
flags.AddSlurmDefaultPartition(parser=flag_group, api_version=api_version)
def Run(self, args):
"""Constructs and sends request.
Args:
args: argparse.Namespace, An object that contains the values for the
arguments specified in the .Args() method.
Returns:
ProcessHttpResponse of the request made.
"""
release_track = self.ReleaseTrack()
client = api_utils.GetClientInstance(release_track)
messages = api_utils.GetMessagesModule(release_track)
cluster_util = utils.ClusterUtil(args=args, message_module=messages)
cluster_ref = cluster_util.cluster_ref
if args.IsSpecified("config"):
cluster = cluster_util.MakeClusterFromConfig()
else:
cluster = cluster_util.MakeCluster()
operation = client.projects_locations_clusters.Create(
messages.HypercomputeclusterProjectsLocationsClustersCreateRequest(
parent=cluster_ref.Parent().RelativeName(),
clusterId=cluster_ref.Name(),
cluster=cluster,
)
)
log.status.Print(
"Create request issued for: [{0}]".format(cluster_ref.Name())
)
if args.async_:
return operation
response = api_utils.WaitForOperation(
client=client,
operation=operation,
message="Waiting for operation [{0}] to complete".format(
operation.name
),
max_wait_sec=7200,
)
log.status.Print("Created cluster [{0}].".format(cluster_ref.Name()))
return response
Create.detailed_help = DETAILED_HELP