terraform-provider-google/website/docs/r/container_node_pool.html.markdown

layout	page_title	sidebar_current	description
google	Google: google_container_node_pool	docs-google-container-node-pool	Manages a GKE NodePool resource.

google_container_node_pool

Manages a Node Pool resource within GKE. For more information see the official documentation and API.

Example usage

resource "google_container_node_pool" "np" {
  name               = "my-node-pool"
  zone               = "us-central1-a"
  cluster            = "${google_container_cluster.primary.name}"
  initial_node_count = 3
}

resource "google_container_cluster" "primary" {
  name               = "marcellus-wallace"
  zone               = "us-central1-a"
  initial_node_count = 3

  additional_zones = [
    "us-central1-b",
    "us-central1-c",
  ]

  master_auth {
    username = "mr.yoda"
    password = "adoy.rm"
  }

  node_config {
    oauth_scopes = [
      "https://www.googleapis.com/auth/compute",
      "https://www.googleapis.com/auth/devstorage.read_only",
      "https://www.googleapis.com/auth/logging.write",
      "https://www.googleapis.com/auth/monitoring",
    ]
  }
}

Argument Reference

• zone - (Required) The zone in which the cluster resides.

• cluster - (Required) The cluster to create the node pool for.

• initial_node_count - (Required) The initial node count for the pool.

---

• project - (Optional) The project in which to create the node pool. If blank, the provider-configured project will be used.

• name - (Optional) The name of the node pool. If left blank, Terraform will auto-generate a unique name.

• name_prefix - (Optional) Creates a unique name for the node pool beginning with the specified prefix. Conflicts with name.

• node_config - (Optional) The machine type and image to use for all nodes in this pool

• autoscaling - (Optional) Configuration required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Structure is documented below.

Node Config supports the following arguments:

• machine_type - (Optional) The name of a Google Compute Engine machine type. Defaults to n1-standard-1.

• disk_size_gb - (Optional) Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. Defaults to 100GB.

• local_ssd_count - (Optional) The amount of local SSD disks that will be attached to each node pool. Defaults to 0.

• oauth_scopes - (Optional) The set of Google API scopes to be made available on all of the node VMs under the "default" service account. These can be either FQDNs, or scope aliases. The following scopes are necessary to ensure the correct functioning of the node pool:

  • compute-rw (https://www.googleapis.com/auth/compute)
  • storage-ro (https://www.googleapis.com/auth/devstorage.read_only)
  • logging-write (https://www.googleapis.com/auth/logging.write), if logging_service points to Google
  • monitoring (https://www.googleapis.com/auth/monitoring), if monitoring_service points to Google

• service_account - (Optional) The service account to be used by the Node VMs. If not specified, the "default" service account is used.

• metadata - (Optional) The metadata key/value pairs assigned to instances in the node pool.

• image_type - (Optional) The image type to use for this node.

• labels - (Optional) The Kubernetes labels (key/value pairs) to be applied to each node.

• tags - (Optional) The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls.

• preemptible - (Optional) A boolean that represents whether or not the underlying node VMs are preemptible. See the official documentation for more information. Defaults to false.

• min_cpu_platform - (Optional) Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as Intel Haswell. See the official documentation for more information.

The autoscaling block supports:

• min_node_count - (Required) Minimum number of nodes in the NodePool. Must be >=1 and <= max_node_count.

• max_node_count - (Required) Maximum number of nodes in the NodePool. Must be >= min_node_count.

Import

Node pools can be imported using the zone, cluster and name, e.g.

$ terraform import google_container_node_pool.mainpool us-east1-a/my-cluster/main-pool