REST Resource: projects.locations.clusters

Resource: Cluster

A collection of virtual machines and connected resources forming a high-performance computing cluster capable of running large-scale, tightly coupled workloads. A cluster combines a set a compute resources that perform computations, storage resources that contain inputs and store outputs, an orchestrator that is responsible for assigning jobs to compute resources, and network resources that connect everything together.

JSON representation
{
  "name": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "networkResources": {
    string: {
      object (NetworkResource)
    },
    ...
  },
  "storageResources": {
    string: {
      object (StorageResource)
    },
    ...
  },
  "computeResources": {
    string: {
      object (ComputeResource)
    },
    ...
  },
  "orchestrator": {
    object (Orchestrator)
  }
}
Fields
name

string

Identifier. Relative resource name of the cluster, in the format projects/{project}/locations/{location}/clusters/{cluster}.

description

string

Optional. User-provided description of the cluster.

labels

map (key: string, value: string)

Optional. Labels applied to the cluster. Labels can be used to organize clusters and to filter them in queries.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

createTime

string (Timestamp format)

Output only. Time that the cluster was originally created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. Time that the cluster was most recently updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

reconciling

boolean

Output only. Indicates whether changes to the cluster are currently in flight. If this is true, then the current state might not match the cluster's intended state.

networkResources

map (key: string, value: object (NetworkResource))

Optional. Network resources available to the cluster. Must contain at most one value. Keys specify the ID of the network resource by which it can be referenced elsewhere, and must conform to RFC-1034 (lower-case, alphanumeric, and at most 63 characters).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

storageResources

map (key: string, value: object (StorageResource))

Optional. Storage resources available to the cluster. Keys specify the ID of the storage resource by which it can be referenced elsewhere, and must conform to RFC-1034 (lower-case, alphanumeric, and at most 63 characters).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

computeResources

map (key: string, value: object (ComputeResource))

Optional. Compute resources available to the cluster. Keys specify the ID of the compute resource by which it can be referenced elsewhere, and must conform to RFC-1034 (lower-case, alphanumeric, and at most 63 characters).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

orchestrator

object (Orchestrator)

Optional. Orchestrator that is responsible for scheduling and running jobs on the cluster.

NetworkResource

A resource representing a network that connects the various components of a cluster together.

JSON representation
{
  "config": {
    object (NetworkResourceConfig)
  },

  // Union field reference can be only one of the following:
  "network": {
    object (NetworkReference)
  }
  // End of list of possible types for union field reference.
}
Fields
config

object (NetworkResourceConfig)

Immutable. Configuration for this network resource, which describes how it should be created or imported. This field only controls how the network resource is initially created or imported. Subsequent changes to the network resource should be made via the resource's API and will not be reflected in the configuration.

Union field reference. Reference to the network resource in Google Cloud. Exactly one of these fields will be populated based on the configured type of network resource. reference can be only one of the following:
network

object (NetworkReference)

Reference to a network in Google Compute Engine.

NetworkReference

A reference to a VPC network in Google Compute Engine.

JSON representation
{
  "network": string,
  "subnetwork": string
}
Fields
network

string

Output only. Name of the network, in the format projects/{project}/global/networks/{network}.

subnetwork

string

Output only. Name of the particular subnetwork being used by the cluster, in the format projects/{project}/regions/{region}/subnetworks/{subnetwork}.

NetworkResourceConfig

Describes how a network resource should be initialized. Each network resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created.

JSON representation
{

  // Union field config can be only one of the following:
  "newNetwork": {
    object (NewNetworkConfig)
  },
  "existingNetwork": {
    object (ExistingNetworkConfig)
  }
  // End of list of possible types for union field config.
}
Fields
Union field config. Particular type of configuration for this network resource. config can be only one of the following:
newNetwork

object (NewNetworkConfig)

Optional. Immutable. If set, indicates that a new network should be created.

existingNetwork

object (ExistingNetworkConfig)

Optional. Immutable. If set, indicates that an existing network should be imported.

NewNetworkConfig

When set in a NetworkResourceConfig, indicates that a new network should be created.

JSON representation
{
  "network": string,
  "description": string
}
Fields
network

string

Required. Immutable. Name of the network to create, in the format projects/{project}/global/networks/{network}.

description

string

Optional. Immutable. Description of the network. Maximum of 2048 characters.

ExistingNetworkConfig

When set in a NetworkResourceConfig, indicates that an existing network should be imported.

JSON representation
{
  "network": string,
  "subnetwork": string
}
Fields
network

string

Required. Immutable. Name of the network to import, in the format projects/{project}/global/networks/{network}.

subnetwork

string

Required. Immutable. Particular subnetwork to use, in the format projects/{project}/regions/{region}/subnetworks/{subnetwork}.

StorageResource

A resource representing a form of persistent storage that is accessible to compute resources in the cluster.

JSON representation
{
  "config": {
    object (StorageResourceConfig)
  },

  // Union field reference can be only one of the following:
  "filestore": {
    object (FilestoreReference)
  },
  "bucket": {
    object (BucketReference)
  },
  "lustre": {
    object (LustreReference)
  }
  // End of list of possible types for union field reference.
}
Fields
config

object (StorageResourceConfig)

Required. Immutable. Configuration for this storage resource, which describes how it should be created or imported. This field only controls how the storage resource is initially created or imported. Subsequent changes to the storage resource should be made via the resource's API and will not be reflected in the configuration.

Union field reference. Reference to the storage resource in Google Cloud. Exactly one of these fields will be populated based on the configured type of storage resource. reference can be only one of the following:
filestore

object (FilestoreReference)

Reference to a Filestore instance. Populated if and only if the storage resource was configured to use Filestore.

bucket

object (BucketReference)

Reference to a Google Cloud Storage bucket. Populated if and only if the storage resource was configured to use Google Cloud Storage.

lustre

object (LustreReference)

Reference to a Managed Lustre instance. Populated if and only if the storage resource was configured to use Managed Lustre.

FilestoreReference

A reference to a Filestore instance.

JSON representation
{
  "filestore": string
}
Fields
filestore

string

Output only. Name of the Filestore instance, in the format projects/{project}/locations/{location}/instances/{instance}

BucketReference

A reference to a Google Cloud Storage bucket.

JSON representation
{
  "bucket": string
}
Fields
bucket

string

Output only. Name of the bucket.

LustreReference

A reference to a Managed Lustre instance.

JSON representation
{
  "lustre": string
}
Fields
lustre

string

Output only. Name of the Managed Lustre instance, in the format projects/{project}/locations/{location}/instances/{instance}

StorageResourceConfig

Describes how a storage resource should be initialized. Each storage resource can either be imported from an existing Google Cloud resource or initialized when the cluster is created.

JSON representation
{

  // Union field config can be only one of the following:
  "newFilestore": {
    object (NewFilestoreConfig)
  },
  "existingFilestore": {
    object (ExistingFilestoreConfig)
  },
  "newBucket": {
    object (NewBucketConfig)
  },
  "existingBucket": {
    object (ExistingBucketConfig)
  },
  "newLustre": {
    object (NewLustreConfig)
  },
  "existingLustre": {
    object (ExistingLustreConfig)
  }
  // End of list of possible types for union field config.
}
Fields
Union field config. Particular type of configuration for this storage resource. config can be only one of the following:
newFilestore

object (NewFilestoreConfig)

Optional. Immutable. If set, indicates that a new Filestore instance should be created.

existingFilestore

object (ExistingFilestoreConfig)

Optional. Immutable. If set, indicates that an existing Filestore instance should be imported.

newBucket

object (NewBucketConfig)

Optional. Immutable. If set, indicates that a new Cloud Storage bucket should be created.

existingBucket

object (ExistingBucketConfig)

Optional. Immutable. If set, indicates that an existing Cloud Storage bucket should be imported.

newLustre

object (NewLustreConfig)

Optional. Immutable. If set, indicates that a new Managed Lustre instance should be created.

existingLustre

object (ExistingLustreConfig)

Optional. Immutable. If set, indicates that an existing Managed Lustre instance should be imported.

NewFilestoreConfig

When set in a StorageResourceConfig, indicates that a new Filestore instance should be created.

JSON representation
{
  "filestore": string,
  "description": string,
  "fileShares": [
    {
      object (FileShareConfig)
    }
  ],
  "tier": enum (Tier),
  "protocol": enum (Protocol)
}
Fields
filestore

string

Required. Immutable. Name of the Filestore instance to create, in the format projects/{project}/locations/{location}/instances/{instance}

description

string

Optional. Immutable. Description of the instance. Maximum of 2048 characters.

fileShares[]

object (FileShareConfig)

Required. Immutable. File system shares on the instance. Exactly one file share must be specified.

tier

enum (Tier)

Required. Immutable. Service tier to use for the instance.

protocol

enum (Protocol)

Optional. Immutable. Access protocol to use for all file shares in the instance. Defaults to NFS V3 if not set.

FileShareConfig

Message describing filestore configuration

JSON representation
{
  "capacityGb": string,
  "fileShare": string
}
Fields
capacityGb

string (int64 format)

Required. Size of the filestore in GB. Must be between 1024 and 102400, and must meet scalability requirements described at https://cloud.google.com/filestore/docs/service-tiers.

fileShare

string

Required. Filestore share location

Tier

Available service tiers for Filestore instances.

Enums
TIER_UNSPECIFIED Not set.
ZONAL Offers expanded capacity and performance scaling capabilities suitable for high-performance computing application requirements.
REGIONAL Offers features and availability needed for mission-critical, high-performance computing workloads.

Protocol

File access protocol for Filestore instances.

Enums
PROTOCOL_UNSPECIFIED Not set.
NFSV3 NFS 3.0.
NFSV41 NFS 4.1.

ExistingFilestoreConfig

When set in a StorageResourceConfig, indicates that an existing Filestore instance should be imported.

JSON representation
{
  "filestore": string
}
Fields
filestore

string

Required. Immutable. Name of the Filestore instance to import, in the format projects/{project}/locations/{location}/instances/{instance}

NewBucketConfig

When set in a StorageResourceConfig, indicates that a new Google Cloud Storage bucket should be created.

JSON representation
{
  "bucket": string,
  "hierarchicalNamespace": {
    object (GcsHierarchicalNamespaceConfig)
  },

  // Union field option can be only one of the following:
  "autoclass": {
    object (GcsAutoclassConfig)
  },
  "storageClass": enum (StorageClass)
  // End of list of possible types for union field option.
}
Fields
bucket

string

Required. Immutable. Name of the Cloud Storage bucket to create.

hierarchicalNamespace

object (GcsHierarchicalNamespaceConfig)

Optional. Immutable. If set, indicates that the bucket should use hierarchical namespaces.

Union field option. Storage class of the bucket, which can be set automatically or explicitly. option can be only one of the following:
autoclass

object (GcsAutoclassConfig)

Optional. Immutable. If set, indicates that the bucket should use Autoclass.

storageClass

enum (StorageClass)

Optional. Immutable. If set, uses the provided storage class as the bucket's default storage class.

GcsAutoclassConfig

Message describing Google Cloud Storage autoclass configuration

JSON representation
{
  "enabled": boolean,
  "terminalStorageClass": enum (TerminalStorageClass)
}
Fields
enabled

boolean

Required. Enables Auto-class feature.

terminalStorageClass

enum (TerminalStorageClass)

Optional. Terminal storage class of the autoclass bucket

TerminalStorageClass

Terminal storage class types of the autoclass bucket

Enums
TERMINAL_STORAGE_CLASS_UNSPECIFIED Unspecified terminal storage class

StorageClass

Storage class for a Cloud Storage bucket.

Enums
STORAGE_CLASS_UNSPECIFIED Not set.
STANDARD Best for data that is frequently accessed.
NEARLINE Low-cost storage for data that is accessed less frequently.
COLDLINE Very low-cost storage for infrequently accessed data.
ARCHIVE Lowest-cost storage for data archiving, online backup, and disaster recovery.

GcsHierarchicalNamespaceConfig

Message describing Google Cloud Storage hierarchical namespace configuration

JSON representation
{
  "enabled": boolean
}
Fields
enabled

boolean

Required. Enables hierarchical namespace setup for the bucket.

ExistingBucketConfig

When set in a StorageResourceConfig, indicates that an existing Google Cloud Storage bucket should be imported.

JSON representation
{
  "bucket": string
}
Fields
bucket

string

Required. Immutable. Name of the Cloud Storage bucket to import.

NewLustreConfig

When set in a StorageResourceConfig, indicates that a new Managed Lustre instance should be created.

JSON representation
{
  "lustre": string,
  "description": string,
  "filesystem": string,
  "capacityGb": string
}
Fields
lustre

string

Required. Immutable. Name of the Managed Lustre instance to create, in the format projects/{project}/locations/{location}/instances/{instance}

description

string

Optional. Immutable. Description of the Managed Lustre instance. Maximum of 2048 characters.

filesystem

string

Required. Immutable. Filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be 8 characters or less and can only contain letters and numbers.

capacityGb

string (int64 format)

Required. Immutable. Storage capacity of the instance in gibibytes (GiB). Allowed values are between 18000 and 7632000.

ExistingLustreConfig

When set in a StorageResourceConfig, indicates that an existing Managed Lustre instance should be imported.

JSON representation
{
  "lustre": string
}
Fields
lustre

string

Required. Immutable. Name of the Managed Lustre instance to import, in the format projects/{project}/locations/{location}/instances/{instance}

ComputeResource

A resource defining how virtual machines and accelerators should be provisioned for the cluster.

JSON representation
{
  "config": {
    object (ComputeResourceConfig)
  }
}
Fields
config

object (ComputeResourceConfig)

Required. Immutable. Configuration for this compute resource, which describes how it should be created at runtime.

ComputeResourceConfig

Describes how a compute resource should be created at runtime.

JSON representation
{

  // Union field config can be only one of the following:
  "newOnDemandInstances": {
    object (NewOnDemandInstancesConfig)
  },
  "newSpotInstances": {
    object (NewSpotInstancesConfig)
  },
  "newReservedInstances": {
    object (NewReservedInstancesConfig)
  },
  "newFlexStartInstances": {
    object (NewFlexStartInstancesConfig)
  }
  // End of list of possible types for union field config.
}
Fields
Union field config. Particular type of configuration for this compute resource. config can be only one of the following:
newOnDemandInstances

object (NewOnDemandInstancesConfig)

Optional. Immutable. If set, indicates that this resource should use on-demand VMs.

newSpotInstances

object (NewSpotInstancesConfig)

Optional. Immutable. If set, indicates that this resource should use spot VMs.

newReservedInstances

object (NewReservedInstancesConfig)

Optional. Immutable. If set, indicates that this resource should use reserved VMs.

newFlexStartInstances

object (NewFlexStartInstancesConfig)

Optional. Immutable. If set, indicates that this resource should use flex-start VMs.

NewOnDemandInstancesConfig

When set in a ComputeResourceConfig, indicates that on-demand (i.e., using the standard provisioning model) VM instances should be created.

JSON representation
{
  "zone": string,
  "machineType": string
}
Fields
zone

string

Required. Immutable. Name of the zone in which VM instances should run, e.g., us-central1-a. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.

machineType

string

Required. Immutable. Name of the Compute Engine machine type to use, e.g. n2-standard-2.

NewSpotInstancesConfig

When set in a ComputeResourceConfig, indicates that spot VM instances should be created.

JSON representation
{
  "zone": string,
  "machineType": string
}
Fields
zone

string

Required. Immutable. Name of the zone in which VM instances should run, e.g., us-central1-a. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.

machineType

string

Required. Immutable. Name of the Compute Engine machine type to use, e.g. n2-standard-2.

NewReservedInstancesConfig

When set in a ComputeResourceConfig, indicates that VM instances should be created from a reservation.

JSON representation
{

  // Union field source can be only one of the following:
  "reservation": string
  // End of list of possible types for union field source.
}
Fields
Union field source. Source of the reservation source can be only one of the following:
reservation

string

Optional. Immutable. Name of the reservation from which VM instances should be created, in the format projects/{project}/zones/{zone}/reservations/{reservation}.

NewFlexStartInstancesConfig

When set in a ComputeResourceConfig, indicates that VM instances should be created using Flex Start.

JSON representation
{
  "zone": string,
  "machineType": string,
  "maxDuration": string
}
Fields
zone

string

Required. Immutable. Name of the zone in which VM instances should run, e.g., us-central1-a. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.

machineType

string

Required. Immutable. Name of the Compute Engine machine type to use, e.g. n2-standard-2.

maxDuration

string (Duration format)

Required. Immutable. Specifies the time limit for created instances. Instances will be terminated at the end of this duration.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

Orchestrator

The component responsible for scheduling and running workloads on the cluster as well as providing the user interface for interacting with the cluster at runtime.

JSON representation
{

  // Union field option can be only one of the following:
  "slurm": {
    object (SlurmOrchestrator)
  }
  // End of list of possible types for union field option.
}
Fields
Union field option. Particular type of orchestrator to use in this cluster. option can be only one of the following:
slurm

object (SlurmOrchestrator)

Optional. If set, indicates that the cluster should use Slurm as the orchestrator.

SlurmOrchestrator

When set in Orchestrator, indicates that the cluster should use Slurm as the orchestrator.

JSON representation
{
  "loginNodes": {
    object (SlurmLoginNodes)
  },
  "nodeSets": [
    {
      object (SlurmNodeSet)
    }
  ],
  "partitions": [
    {
      object (SlurmPartition)
    }
  ],
  "defaultPartition": string,
  "prologBashScripts": [
    string
  ],
  "epilogBashScripts": [
    string
  ]
}
Fields
loginNodes

object (SlurmLoginNodes)

Required. Configuration for login nodes, which allow users to access the cluster over SSH.

nodeSets[]

object (SlurmNodeSet)

Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.

partitions[]

object (SlurmPartition)

Required. Configuration of Slurm partitions, which group one or more nodesets. Acts as a queue against which jobs can be submitted. At least one partition is required.

defaultPartition

string

Optional. Default partition to use for submitted jobs that do not explicitly specify a partition. Required if and only if there is more than one partition, in which case it must match the id of one of the partitions.

prologBashScripts[]

string

Optional. Slurm prolog scripts, which will be executed by compute nodes before a node begins running a new job. Values must not be empty.

epilogBashScripts[]

string

Optional. Slurm epilog scripts, which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty.

SlurmLoginNodes

Configuration for Slurm login nodes in the cluster. Login nodes are Compute Engine VM instances that allow users to access the cluster over SSH.

JSON representation
{
  "count": string,
  "zone": string,
  "machineType": string,
  "startupScript": string,
  "enableOsLogin": boolean,
  "enablePublicIps": boolean,
  "labels": {
    string: string,
    ...
  },
  "storageConfigs": [
    {
      object (StorageConfig)
    }
  ],
  "instances": [
    {
      object (ComputeInstance)
    }
  ],
  "bootDisk": {
    object (BootDisk)
  }
}
Fields
count

string (int64 format)

Required. Number of login node instances to create.

zone

string

Required. Name of the zone in which login nodes should run, e.g., us-central1-a. Must be in the same region as the cluster, and must match the zone of any other resources specified in the cluster.

machineType

string

Required. Name of the Compute Engine machine type to use for login nodes, e.g. n2-standard-2.

startupScript

string

Optional. Startup script to be run on each login node instance. Max 256KB.

enableOsLogin

boolean

Optional. Whether OS Login should be enabled on login node instances.

enablePublicIps

boolean

Optional. Whether login node instances should be assigned external IP addresses.

labels

map (key: string, value: string)

Optional. Labels that should be applied to each login node instance.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

storageConfigs[]

object (StorageConfig)

Optional. How storage resources should be mounted on each login node.

instances[]

object (ComputeInstance)

Output only. Information about the login node instances that were created in Compute Engine.

bootDisk

object (BootDisk)

Optional. Boot disk for the login node.

StorageConfig

Description of how a storage resource should be mounted on a VM instance.

JSON representation
{
  "id": string,
  "localMount": string
}
Fields
id

string

Required. ID of the storage resource to mount, which must match a key in the cluster's storageResources.

localMount

string

Required. A directory inside the VM instance's file system where the storage resource should be mounted (e.g., /mnt/share).

ComputeInstance

Details about a Compute Engine instance.

JSON representation
{
  "instance": string
}
Fields
instance

string

Output only. Name of the VM instance, in the format projects/{project}/zones/{zone}/instances/{instance}.

BootDisk

A Persistent disk used as the boot disk for a Compute Engine VM instance.

JSON representation
{
  "type": string,
  "sizeGb": string
}
Fields
type

string

Required. Immutable. Persistent disk type, in the format projects/{project}/zones/{zone}/diskTypes/{disk_type}.

sizeGb

string (int64 format)

Required. Immutable. Size of the disk in gigabytes. Must be at least 10GB.

SlurmNodeSet

Configuration for Slurm nodesets in the cluster. Nodesets are groups of compute nodes used by Slurm that are responsible for running workloads submitted to the cluster.

JSON representation
{
  "id": string,
  "computeId": string,
  "storageConfigs": [
    {
      object (StorageConfig)
    }
  ],
  "staticNodeCount": string,
  "maxDynamicNodeCount": string,

  // Union field type can be only one of the following:
  "computeInstance": {
    object (ComputeInstanceSlurmNodeSet)
  }
  // End of list of possible types for union field type.
}
Fields
id

string

Required. Identifier for the nodeset, which allows it to be referenced by partitions. Must conform to RFC-1034 (lower-case, alphanumeric, and at most 63 characters).

computeId

string

Optional. ID of the compute resource on which this nodeset will run. Must match a key in the cluster's computeResources.

storageConfigs[]

object (StorageConfig)

Optional. How storage resources should be mounted on each compute node.

staticNodeCount

string (int64 format)

Optional. Number of nodes to be statically created for this nodeset. The cluster will attempt to ensure that at least this many nodes exist at all times.

maxDynamicNodeCount

string (int64 format)

Optional. Controls how many additional nodes a cluster can bring online to handle workloads. Set this value to enable dynamic node creation and limit the number of additional nodes the cluster can bring online. Leave empty if you do not want the cluster to create nodes dynamically, and instead rely only on static nodes.

Union field type. Additional configuration for the nodeset. If not set, the nodeset will use ComputeInstanceSlurmNodeSet with default values. type can be only one of the following:
computeInstance

object (ComputeInstanceSlurmNodeSet)

Optional. If set, indicates that the nodeset should be backed by Compute Engine instances.

ComputeInstanceSlurmNodeSet

When set in a SlurmNodeSet, indicates that the nodeset should be backed by Compute Engine VM instances.

JSON representation
{
  "startupScript": string,
  "labels": {
    string: string,
    ...
  },
  "bootDisk": {
    object (BootDisk)
  }
}
Fields
startupScript

string

Optional. Startup script to be run on each VM instance in the nodeset. Max 256KB.

labels

map (key: string, value: string)

Optional. Labels that should be applied to each VM instance in the nodeset.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

bootDisk

object (BootDisk)

Optional. Boot disk for the compute instance

SlurmPartition

Configuration for Slurm partitions in the cluster. Partitions are groups of nodesets, and are how clients specify where their workloads should be run.

JSON representation
{
  "id": string,
  "nodeSetIds": [
    string
  ]
}
Fields
id

string

Required. ID of the partition, which is how users will identify it. Must conform to RFC-1034 (lower-case, alphanumeric, and at most 63 characters).

nodeSetIds[]

string

Required. IDs of the nodesets that make up this partition. Values must match SlurmNodeSet.id.

Methods

create

Creates a new Cluster in a given project and location.

delete

Deletes a single Cluster.

get

Gets details of a single Cluster.

list

Lists Clusters in a given project and location.

patch

Updates the parameters of a single Cluster.