6.4 KiB

Raw Blame History

layout	page_title	sidebar_current	description
google	Google: google_container_cluster	docs-google-container-cluster	Creates a GKE cluster.

google_container_cluster

!> Warning: Due to limitations of the API, all arguments except node_version are non-updateable. Changing any will cause recreation of the whole cluster!

~> Note: All arguments including the username and password will be stored in the raw state as plain-text. Read more about sensitive data in state.

Example usage

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

initial_node_count - (Required) The number of nodes to create in this cluster (not including the Kubernetes master).
master_auth - (Required) The authentication information for accessing the Kubernetes master.
name - (Required) The name of the cluster, unique within the project and zone.
zone - (Required) The zone that the master and the number of nodes specified in initial_node_count should be created in.

additional_zones - (Optional) If additional zones are configured, the number of nodes specified in initial_node_count is created in all specified zones.
addons_config - (Optional) The configuration for addons supported by Google Container Engine
cluster_ipv4_cidr - (Optional) The IP address range of the container pods in this cluster. Default is an automatically assigned CIDR.
description - (Optional) Description of the cluster.
logging_service - (Optional) The logging service that the cluster should write logs to. Available options include logging.googleapis.com and none. Defaults to logging.googleapis.com
monitoring_service - (Optional) The monitoring service that the cluster should write metrics to. Available options include monitoring.googleapis.com and none. Defaults to monitoring.googleapis.com
network - (Optional) The name or self_link of the Google Compute Engine network to which the cluster is connected
node_config - (Optional) The machine type and image to use for all nodes in this cluster
node_pool - (Optional) List of node pools associated with this cluster.
node_version - (Optional) The Kubernetes version on the nodes. Also affects the initial master version on cluster creation. Updates affect nodes only. Defaults to the default version set by GKE which is not necessarily the latest version.
project - (Optional) The project in which the resource belongs. If it is not provided, the provider project is used.
subnetwork - (Optional) The name of the Google Compute Engine subnetwork in which the cluster's instances are launched

Master Auth supports the following arguments:

password - The password to use for HTTP basic authentication when accessing the Kubernetes master endpoint
username - The username to use for HTTP basic authentication when accessing the Kubernetes master endpoint

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 cluster node. 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 cluster:
- 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 cluster.
image_type - (Optional) The image type to use for this node.

Addons Config supports the following addons:

http_load_balancing - (Optional) The status of the HTTP Load Balancing add-on. It is enabled by default; set disabled = true to disable.
horizontal_pod_autoscaling - (Optional) The status of the Horizontal Pod Autoscaling addon. It is enabled by default; set disabled = true to disable.

This example addons_config disables both addons:

addons_config {
  http_load_balancing {
    disabled = true
  }
  horizontal_pod_autoscaling {
    disabled = true
  }
}

Node Pool supports the following arguments:

initial_node_count - (Required) The initial node count for the pool.
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.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

endpoint - The IP address of this cluster's Kubernetes master
instance_group_urls - List of instance group URLs which have been assigned to the cluster
master_auth.client_certificate - Base64 encoded public certificate used by clients to authenticate to the cluster endpoint.
master_auth.client_key - Base64 encoded private key used by clients to authenticate to the cluster endpoint
master_auth.cluster_ca_certificate - Base64 encoded public certificate that is the root of trust for the cluster

6.4 KiB Raw Blame History

google_container_cluster

Example usage

Argument Reference

Attributes Reference

6.4 KiB

Raw Blame History