Skip to content

README.md

Latest commit

 

History

History
100 lines (76 loc) · 6.37 KB

README.md

File metadata and controls

100 lines (76 loc) · 6.37 KB

Module: Slurm Instance

Overview

This module creates a compute instance from instance template for a Slurm cluster.

NOTE: This module is only intended to be used by Slurm modules. For general usage, please consider using:

Module API

For the terraform module API reference, please see README_TF.md.

Copyright (C) SchedMD LLC. Copyright 2018 Google 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

 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.

Requirements

Name Version
terraform ~> 1.0
google >= 3.43
null ~> 3.0

Providers

Name Version
google >= 3.43
null ~> 3.0

Modules

No modules.

Resources

Name Type
google_compute_instance_from_template.slurm_instance resource
null_resource.replace_trigger resource
google_compute_instance_template.base data source
google_compute_zones.available data source

Inputs

Name Description Type Default Required
access_config Access configurations, i.e. IPs via which the VM instance can be accessed via the Internet. 
list(object({
    nat_ip       = string
    network_tier = string
  }))
 [] no
additional_networks Additional network interface details for GCE, if any. 
list(object({
    access_config = optional(list(object({
      nat_ip       = string
      network_tier = string
    })), [])
    alias_ip_range = optional(list(object({
      ip_cidr_range         = string
      subnetwork_range_name = string
    })), [])
    ipv6_access_config = optional(list(object({
      network_tier = string
    })), [])
    network            = optional(string)
    network_ip         = optional(string, "")
    nic_type           = optional(string)
    queue_count        = optional(number)
    stack_type         = optional(string)
    subnetwork         = optional(string)
    subnetwork_project = optional(string)
  }))
 [] no
hostname Hostname of instances string n/a yes
instance_template Instance template self_link used to create compute instances string n/a yes
network Network to deploy to. Only one of network or subnetwork should be specified. string "" no
num_instances Number of instances to create. This value is ignored if static_ips is provided. number 1 no
project_id The GCP project ID string null no
region Region where the instances should be created. string null no
replace_trigger Trigger value to replace the instances. string "" no
static_ips List of static IPs for VM instances list(string) [] no
subnetwork Subnet to deploy to. Only one of network or subnetwork should be specified. string "" no
subnetwork_project The project that subnetwork belongs to string null no
zone Zone where the instances should be created. If not specified, instances will be spread across available zones in the region. string null no

Outputs

Name Description
available_zones List of available zones in region
instances_details List of all details for compute instances
instances_self_links List of self-links for compute instances
names List of available zones in region
slurm_instances List of all resource objects for compute instances