Reference documentation and code samples for the Google Cloud Hypercompute Cluster V1beta Client class SlurmOrchestrator.
When set in Orchestrator, indicates that the cluster should use Slurm as the orchestrator.
Generated from protobuf message google.cloud.hypercomputecluster.v1beta.SlurmOrchestrator
Namespace
Google \ Cloud \ HypercomputeCluster \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ login_nodes |
SlurmLoginNodes
Required. Configuration for login nodes, which allow users to access the cluster over SSH. |
↳ node_sets |
array<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 |
array<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. |
↳ default_partition |
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. |
↳ prolog_bash_scripts |
array
Optional. Slurm prolog scripts, which will be executed by compute nodes before a node begins running a new job. Values must not be empty. |
↳ epilog_bash_scripts |
array
Optional. Slurm epilog scripts, which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty. |
getLoginNodes
Required. Configuration for login nodes, which allow users to access the cluster over SSH.
| Returns | |
|---|---|
| Type | Description |
SlurmLoginNodes|null |
|
hasLoginNodes
clearLoginNodes
setLoginNodes
Required. Configuration for login nodes, which allow users to access the cluster over SSH.
| Parameter | |
|---|---|
| Name | Description |
var |
SlurmLoginNodes
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNodeSets
Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setNodeSets
Required. Configuration of Slurm nodesets, which define groups of compute resources that can be used by Slurm. At least one compute node is required.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SlurmNodeSet>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPartitions
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPartitions
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SlurmPartition>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDefaultPartition
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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDefaultPartition
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrologBashScripts
Optional. Slurm prolog scripts, which will be executed by compute nodes before a node begins running a new job. Values must not be empty.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPrologBashScripts
Optional. Slurm prolog scripts, which will be executed by compute nodes before a node begins running a new job. Values must not be empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEpilogBashScripts
Optional. Slurm epilog scripts, which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEpilogBashScripts
Optional. Slurm epilog scripts, which will be executed by compute nodes whenever a node finishes running a job. Values must not be empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|