Skip to content

Latest commit

 

History

History
75 lines (59 loc) · 5.58 KB

README_TF.md

File metadata and controls

75 lines (59 loc) · 5.58 KB

slurm_nodeset_tpu

Copyright (C) SchedMD LLC.

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

https://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.

Requirements

Name Version
terraform ~> 1.2
google >= 3.53, < 5.0
null ~> 3.0

Providers

Name Version
google >= 3.53, < 5.0
null ~> 3.0

Modules

No modules.

Resources

Name Type
null_resource.nodeset_tpu resource
google_compute_default_service_account.this data source
google_compute_subnetwork.nodeset_subnetwork data source
google_service_account.this data source

Inputs

Name Description Type Default Required
accelerator_config Nodeset accelerator config, see https://cloud.google.com/tpu/docs/supported-tpu-configurations for details. 
object({
    topology = string
    version  = string
  })
 
{
  "topology": "",
  "version": ""
}
 no
data_disks The data disks to include in the TPU node list(string) [] no
docker_image The gcp container registry id docker image to use in the TPU vms, it defaults to gcr.io/schedmd-slurm-public/tpu:slurm-gcp-6-2-tf-<var.tf_version> string "" no
enable_public_ip Enables IP address to access the Internet. bool false no
network The name of the network to attach the TPU-vm of this nodeset to. string "" no
node_count_dynamic_max Maximum number of nodes allowed in this partition to be created dynamically. number 0 no
node_count_static Number of nodes to be statically created. number 0 no
node_type Specify a node type to base the vm configuration upon it. Not needed if you use accelerator_config string null no
nodeset_name Name of Slurm nodeset. string n/a yes
preemptible Specify whether TPU-vms in this nodeset are preemtible, see https://cloud.google.com/tpu/docs/preemptible for details. bool false no
preserve_tpu Specify whether TPU-vms will get preserve on suspend, if set to true, on suspend vm is stopped, on false it gets deleted bool true no
project_id Project ID to create resources in. string n/a yes
reserved Specify whether TPU-vms in this nodeset are created under a reservation. bool false no
service_account Service account to attach to the TPU-vm.
If none is given, the default service account and scopes will be used.		 
object({
    email  = string
    scopes = set(string)
  })
 null no
subnetwork The name of the subnetwork to attach the TPU-vm of this nodeset to. string null no
tf_version Nodeset Tensorflow version, see https://cloud.google.com/tpu/docs/supported-tpu-configurations#tpu_vm for details. string n/a yes
zone Nodes will only be created in this zone. Check https://cloud.google.com/tpu/docs/regions-zones to get zones with TPU-vm in it. string n/a yes

Outputs

Name Description
nodeset Nodeset details.
nodeset_name Nodeset name.
service_account Service account object, includes email and scopes.