Google Compute Engine Node Group

This page shows how to write Terraform for Compute Engine Node Group and write them securely.

google_compute_node_group (Terraform)

The Node Group in Compute Engine can be configured in Terraform with the resource name google_compute_node_group. The following sections describe 2 examples of how to use the resource and its parameters.

Example Usage from GitHub
resource "google_compute_node_group" "this" {
  description   = var.description
  name          =
  node_template = var.node_template
  project       = var.project
  size          = var.size
resource "google_compute_node_group" "soletenant_grp" {
  name        = "soletenant-group"
  zone        = "us-central1-a"
  description = "Sole-tenant nodes to host Windows VMs"

  size          = 1

Review your Terraform file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).


Creation timestamp in RFC3339 text format.

An optional textual description of the resource.

Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT.

Name of the resource.

The URL of the node template to which this node group belongs.

The total number of nodes in the node group.

  • zone optional computed - string

Zone where this node group is located

  • autoscaling_policy list block

    Maximum size of the node group. Set to a value less than or equal to 100 and greater than or equal to min-nodes.

    Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.

    • mode optional computed - string

    The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler. - ON: Enables scaling in and scaling out. - ONLY_SCALE_OUT: Enables only scaling out. You must use this mode if your node groups are configured to restart their hosted VMs on minimal servers. Possible values: ["OFF", "ON", "ONLY_SCALE_OUT"]

  • maintenance_window list block

    instances.start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.

  • timeouts single block

Explanation in Terraform Registry

Represents a NodeGroup resource to manage a group of sole-tenant nodes. To get more information about NodeGroup, see:

  • API documentation
  • How-to Guides
    • Sole-Tenant Nodes

      Warning: Due to limitations of the API, Terraform cannot update the number of nodes in a node group and changes to node group size either through Terraform config or through external changes will cause Terraform to delete and recreate the node group.

Tips: Best Practices for The Other Google Compute Engine Resources

In addition to the google_compute_disk, Google Compute Engine has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.



Ensure the encryption key for your GCE disk is stored securely

It is better to store the encryption key for your GCE disk securely. Secret Manager could be used instead.



Ensure your VPC firewall blocks unwanted outbound traffic

It is better to block unwanted outbound traffic not to expose resources in the VPC to unwanted attacks.



Ensure appropriate service account is assigned to your GCE instance

It is better to create a custom service account for the instance and assign it.



Ensure OS login for your GCE instances is enabled at project level

It is better to enable OS login for your GCE instances. Enabling OS login ensures that SSH keys used to connect to instances are mapped with IAM users, allowing centralized and automated SSH key management.



Ensure to use modern TLS protocols

It's better to adopt TLS v1.2+ instead of outdated TLS protocols.



Ensure VPC flow logging is enabled

It is better to enable VPC flow logging. VPC flow logging allows us to audit traffic in your network.

Review your Google Compute Engine settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

Frequently asked questions

What is Google Compute Engine Node Group?

Google Compute Engine Node Group is a resource for Compute Engine of Google Cloud Platform. Settings can be wrote in Terraform.

Where can I find the example code for the Google Compute Engine Node Group?

For Terraform, the niveklabs/google and sylvioneto/terraform_gcp source code examples are useful. See the Terraform Example section for further details.


Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.