NodeTemplate class

Represents a NodeTemplate resource. Node templates specify properties for creating sole-tenant nodes, such as node type, vCPU and memory requirements, node affinity labels, and region.

To get more information about NodeTemplate, see:

Example Usage

Node Template Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const template = new gcp.compute.NodeTemplate("template", {
    name: "soletenant-tmpl",
    region: "us-central1",
    nodeType: "n1-node-96-624",
});

import pulumi
import pulumi_gcp as gcp

template = gcp.compute.NodeTemplate("template",
    name="soletenant-tmpl",
    region="us-central1",
    node_type="n1-node-96-624")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var template = new Gcp.Compute.NodeTemplate("template", new()
    {
        Name = "soletenant-tmpl",
        Region = "us-central1",
        NodeType = "n1-node-96-624",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewNodeTemplate(ctx, "template", &compute.NodeTemplateArgs{
			Name:     pulumi.String("soletenant-tmpl"),
			Region:   pulumi.String("us-central1"),
			NodeType: pulumi.String("n1-node-96-624"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_nodetemplate" "template" {
  name      = "soletenant-tmpl"
  region    = "us-central1"
  node_type = "n1-node-96-624"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.NodeTemplate;
import com.pulumi.gcp.compute.NodeTemplateArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var template = new NodeTemplate("template", NodeTemplateArgs.builder()
            .name("soletenant-tmpl")
            .region("us-central1")
            .nodeType("n1-node-96-624")
            .build());

    }
}

resources:
  template:
    type: gcp:compute:NodeTemplate
    properties:
      name: soletenant-tmpl
      region: us-central1
      nodeType: n1-node-96-624

Node Template Server Binding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const central1a = gcp.compute.getNodeTypes({
    zone: "us-central1-a",
});
const template = new gcp.compute.NodeTemplate("template", {
    name: "soletenant-with-licenses",
    region: "us-central1",
    nodeType: "n1-node-96-624",
    nodeAffinityLabels: {
        foo: "baz",
    },
    serverBinding: {
        type: "RESTART_NODE_ON_MINIMAL_SERVERS",
    },
});

import pulumi
import pulumi_gcp as gcp

central1a = gcp.compute.get_node_types(zone="us-central1-a")
template = gcp.compute.NodeTemplate("template",
    name="soletenant-with-licenses",
    region="us-central1",
    node_type="n1-node-96-624",
    node_affinity_labels={
        "foo": "baz",
    },
    server_binding={
        "type": "RESTART_NODE_ON_MINIMAL_SERVERS",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var central1a = Gcp.Compute.GetNodeTypes.Invoke(new()
    {
        Zone = "us-central1-a",
    });

    var template = new Gcp.Compute.NodeTemplate("template", new()
    {
        Name = "soletenant-with-licenses",
        Region = "us-central1",
        NodeType = "n1-node-96-624",
        NodeAffinityLabels =
        {
            { "foo", "baz" },
        },
        ServerBinding = new Gcp.Compute.Inputs.NodeTemplateServerBindingArgs
        {
            Type = "RESTART_NODE_ON_MINIMAL_SERVERS",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.GetNodeTypes(ctx, &compute.GetNodeTypesArgs{
			Zone: pulumi.StringRef("us-central1-a"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = compute.NewNodeTemplate(ctx, "template", &compute.NodeTemplateArgs{
			Name:     pulumi.String("soletenant-with-licenses"),
			Region:   pulumi.String("us-central1"),
			NodeType: pulumi.String("n1-node-96-624"),
			NodeAffinityLabels: pulumi.StringMap{
				"foo": pulumi.String("baz"),
			},
			ServerBinding: &compute.NodeTemplateServerBindingArgs{
				Type: pulumi.String("RESTART_NODE_ON_MINIMAL_SERVERS"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_compute_getnodetypes" "central1a" {
  zone = "us-central1-a"
}

resource "gcp_compute_nodetemplate" "template" {
  name      = "soletenant-with-licenses"
  region    = "us-central1"
  node_type = "n1-node-96-624"
  node_affinity_labels = {
    "foo" = "baz"
  }
  server_binding = {
    type = "RESTART_NODE_ON_MINIMAL_SERVERS"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetNodeTypesArgs;
import com.pulumi.gcp.compute.NodeTemplate;
import com.pulumi.gcp.compute.NodeTemplateArgs;
import com.pulumi.gcp.compute.inputs.NodeTemplateServerBindingArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var central1a = ComputeFunctions.getNodeTypes(GetNodeTypesArgs.builder()
            .zone("us-central1-a")
            .build());

        var template = new NodeTemplate("template", NodeTemplateArgs.builder()
            .name("soletenant-with-licenses")
            .region("us-central1")
            .nodeType("n1-node-96-624")
            .nodeAffinityLabels(Map.of("foo", "baz"))
            .serverBinding(NodeTemplateServerBindingArgs.builder()
                .type("RESTART_NODE_ON_MINIMAL_SERVERS")
                .build())
            .build());

    }
}

resources:
  template:
    type: gcp:compute:NodeTemplate
    properties:
      name: soletenant-with-licenses
      region: us-central1
      nodeType: n1-node-96-624
      nodeAffinityLabels:
        foo: baz
      serverBinding:
        type: RESTART_NODE_ON_MINIMAL_SERVERS
variables:
  central1a:
    fn::invoke:
      function: gcp:compute:getNodeTypes
      arguments:
        zone: us-central1-a

Node Template Accelerators

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const central1a = gcp.compute.getNodeTypes({
    zone: "us-central1-a",
});
const template = new gcp.compute.NodeTemplate("template", {
    name: "soletenant-with-accelerators",
    region: "us-central1",
    nodeType: "n1-node-96-624",
    accelerators: [{
        acceleratorType: "nvidia-tesla-t4",
        acceleratorCount: 4,
    }],
});

import pulumi
import pulumi_gcp as gcp

central1a = gcp.compute.get_node_types(zone="us-central1-a")
template = gcp.compute.NodeTemplate("template",
    name="soletenant-with-accelerators",
    region="us-central1",
    node_type="n1-node-96-624",
    accelerators=[{
        "accelerator_type": "nvidia-tesla-t4",
        "accelerator_count": 4,
    }])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var central1a = Gcp.Compute.GetNodeTypes.Invoke(new()
    {
        Zone = "us-central1-a",
    });

    var template = new Gcp.Compute.NodeTemplate("template", new()
    {
        Name = "soletenant-with-accelerators",
        Region = "us-central1",
        NodeType = "n1-node-96-624",
        Accelerators = new[]
        {
            new Gcp.Compute.Inputs.NodeTemplateAcceleratorArgs
            {
                AcceleratorType = "nvidia-tesla-t4",
                AcceleratorCount = 4,
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.GetNodeTypes(ctx, &compute.GetNodeTypesArgs{
			Zone: pulumi.StringRef("us-central1-a"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = compute.NewNodeTemplate(ctx, "template", &compute.NodeTemplateArgs{
			Name:     pulumi.String("soletenant-with-accelerators"),
			Region:   pulumi.String("us-central1"),
			NodeType: pulumi.String("n1-node-96-624"),
			Accelerators: compute.NodeTemplateAcceleratorArray{
				&compute.NodeTemplateAcceleratorArgs{
					AcceleratorType:  pulumi.String("nvidia-tesla-t4"),
					AcceleratorCount: pulumi.Int(4),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_compute_getnodetypes" "central1a" {
  zone = "us-central1-a"
}

resource "gcp_compute_nodetemplate" "template" {
  name      = "soletenant-with-accelerators"
  region    = "us-central1"
  node_type = "n1-node-96-624"
  accelerators {
    accelerator_type  = "nvidia-tesla-t4"
    accelerator_count = 4
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetNodeTypesArgs;
import com.pulumi.gcp.compute.NodeTemplate;
import com.pulumi.gcp.compute.NodeTemplateArgs;
import com.pulumi.gcp.compute.inputs.NodeTemplateAcceleratorArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var central1a = ComputeFunctions.getNodeTypes(GetNodeTypesArgs.builder()
            .zone("us-central1-a")
            .build());

        var template = new NodeTemplate("template", NodeTemplateArgs.builder()
            .name("soletenant-with-accelerators")
            .region("us-central1")
            .nodeType("n1-node-96-624")
            .accelerators(NodeTemplateAcceleratorArgs.builder()
                .acceleratorType("nvidia-tesla-t4")
                .acceleratorCount(4)
                .build())
            .build());

    }
}

resources:
  template:
    type: gcp:compute:NodeTemplate
    properties:
      name: soletenant-with-accelerators
      region: us-central1
      nodeType: n1-node-96-624
      accelerators:
        - acceleratorType: nvidia-tesla-t4
          acceleratorCount: 4
variables:
  central1a:
    fn::invoke:
      function: gcp:compute:getNodeTypes
      arguments:
        zone: us-central1-a

Node Template Disks

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const central1a = gcp.compute.getNodeTypes({
    zone: "us-central1-a",
});
const template = new gcp.compute.NodeTemplate("template", {
    name: "soletenant-with-disks",
    region: "us-central1",
    nodeType: "n2-node-80-640",
    disks: [{
        diskCount: 16,
        diskSizeGb: 375,
        diskType: "local-ssd",
    }],
});

import pulumi
import pulumi_gcp as gcp

central1a = gcp.compute.get_node_types(zone="us-central1-a")
template = gcp.compute.NodeTemplate("template",
    name="soletenant-with-disks",
    region="us-central1",
    node_type="n2-node-80-640",
    disks=[{
        "disk_count": 16,
        "disk_size_gb": 375,
        "disk_type": "local-ssd",
    }])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var central1a = Gcp.Compute.GetNodeTypes.Invoke(new()
    {
        Zone = "us-central1-a",
    });

    var template = new Gcp.Compute.NodeTemplate("template", new()
    {
        Name = "soletenant-with-disks",
        Region = "us-central1",
        NodeType = "n2-node-80-640",
        Disks = new[]
        {
            new Gcp.Compute.Inputs.NodeTemplateDiskArgs
            {
                DiskCount = 16,
                DiskSizeGb = 375,
                DiskType = "local-ssd",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.GetNodeTypes(ctx, &compute.GetNodeTypesArgs{
			Zone: pulumi.StringRef("us-central1-a"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = compute.NewNodeTemplate(ctx, "template", &compute.NodeTemplateArgs{
			Name:     pulumi.String("soletenant-with-disks"),
			Region:   pulumi.String("us-central1"),
			NodeType: pulumi.String("n2-node-80-640"),
			Disks: compute.NodeTemplateDiskArray{
				&compute.NodeTemplateDiskArgs{
					DiskCount:  pulumi.Int(16),
					DiskSizeGb: pulumi.Int(375),
					DiskType:   pulumi.String("local-ssd"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_compute_getnodetypes" "central1a" {
  zone = "us-central1-a"
}

resource "gcp_compute_nodetemplate" "template" {
  name      = "soletenant-with-disks"
  region    = "us-central1"
  node_type = "n2-node-80-640"
  disks {
    disk_count   = 16
    disk_size_gb = 375
    disk_type    = "local-ssd"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetNodeTypesArgs;
import com.pulumi.gcp.compute.NodeTemplate;
import com.pulumi.gcp.compute.NodeTemplateArgs;
import com.pulumi.gcp.compute.inputs.NodeTemplateDiskArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var central1a = ComputeFunctions.getNodeTypes(GetNodeTypesArgs.builder()
            .zone("us-central1-a")
            .build());

        var template = new NodeTemplate("template", NodeTemplateArgs.builder()
            .name("soletenant-with-disks")
            .region("us-central1")
            .nodeType("n2-node-80-640")
            .disks(NodeTemplateDiskArgs.builder()
                .diskCount(16)
                .diskSizeGb(375)
                .diskType("local-ssd")
                .build())
            .build());

    }
}

resources:
  template:
    type: gcp:compute:NodeTemplate
    properties:
      name: soletenant-with-disks
      region: us-central1
      nodeType: n2-node-80-640
      disks:
        - diskCount: 16
          diskSizeGb: 375
          diskType: local-ssd
variables:
  central1a:
    fn::invoke:
      function: gcp:compute:getNodeTypes
      arguments:
        zone: us-central1-a

Import

NodeTemplate can be imported using any of these accepted formats:

projects/{{project}}/regions/{{region}}/nodeTemplates/{{name}}
{{project}}/{{region}}/{{name}}
{{region}}/{{name}}
{{name}}

When using the pulumi import command, NodeTemplate can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/nodeTemplate:NodeTemplate default projects/{{project}}/regions/{{region}}/nodeTemplates/{{name}}
$ pulumi import gcp:compute/nodeTemplate:NodeTemplate default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:compute/nodeTemplate:NodeTemplate default {{region}}/{{name}}
$ pulumi import gcp:compute/nodeTemplate:NodeTemplate default {{name}}

Constructors

NodeTemplate(String name, {NodeTemplateArgs? args, CustomResourceOptions? options}): Creates a new NodeTemplate. name The Pulumi resource name. args Arguments used to configure this NodeTemplate. The set of arguments for NodeTemplate. options Resource options controlling this resource's behavior.
NodeTemplate.reference(String urn): Creates a typed reference to an existing NodeTemplate resource.

Properties

accelerators ↔ Output<List<NodeTemplateAccelerator>?>: List of the type and count of accelerator cards attached to the node template Structure is documented below.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
cpuOvercommitType ↔ Output<String?>: CPU overcommit. Default value is NONE. Possible values are: ENABLED, NONE.
latefinal
creationTimestamp ↔ Output<String>: Creation timestamp in RFC3339 text format.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
description ↔ Output<String?>: An optional textual description of the resource.
latefinal
disks ↔ Output<List<NodeTemplateDisk>?>: List of the type, size and count of disks attached to the node template Structure is documented below.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>: Name of the resource.
latefinal
nodeAffinityLabels ↔ Output<Map<String, String>?>: Labels to use for node affinity, which will be used in instance scheduling.
latefinal
nodeType ↔ Output<String?>: Node type to use for nodes group that are created from this template. Only one of nodeTypeFlexibility and nodeType can be specified.
latefinal
nodeTypeFlexibility ↔ Output<NodeTemplateNodeTypeFlexibility?>: Flexible properties for the desired node type. Node groups that use this node template will create nodes of a type that matches these properties. Only one of nodeTypeFlexibility and nodeType can be specified. Structure is documented below.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
region ↔ Output<String>: Region where nodes using the node template will be created. If it is not provided, the provider region is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
selfLink ↔ Output<String>: The URI of the created resource.
latefinal
serverBinding ↔ Output<NodeTemplateServerBinding>: The server binding policy for nodes using this template. Determines where the nodes should restart following a maintenance event. Structure is documented below.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {NodeTemplateState? state, CustomResourceOptions? options}) → NodeTemplate: Gets an existing NodeTemplate resource's state with the given name and id.