NodeConfig

Parameters that describe the nodes in a cluster.

JSON representation
{
  "machineType": string,
  "diskSizeGb": integer,
  "oauthScopes": [
    string
  ],
  "serviceAccount": string,
  "metadata": {
    string: string,
    ...
  },
  "imageType": string,
  "labels": {
    string: string,
    ...
  },
  "localSsdCount": integer,
  "tags": [
    string
  ],
  "preemptible": boolean,
  "accelerators": [
    {
      object (AcceleratorConfig)
    }
  ],
  "sandboxConfig": {
    object (SandboxConfig)
  },
  "nodeGroup": string,
  "reservationAffinity": {
    object (ReservationAffinity)
  },
  "diskType": string,
  "minCpuPlatform": string,
  "workloadMetadataConfig": {
    object (WorkloadMetadataConfig)
  },
  "taints": [
    {
      object (NodeTaint)
    }
  ],
  "bootDiskKmsKey": string,
  "shieldedInstanceConfig": {
    object (ShieldedInstanceConfig)
  },
  "linuxNodeConfig": {
    object (LinuxNodeConfig)
  },
  "kubeletConfig": {
    object (NodeKubeletConfig)
  }
}
Fields
machineType

string

The name of a Google Compute Engine machine type.

If unspecified, the default machine type is e2-medium.

diskSizeGb

integer

Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB.

If unspecified, the default disk size is 100GB.

oauthScopes[]

string

The set of Google API scopes to be made available on all of the node VMs under the "default" service account.

The following scopes are recommended, but not required, and by default are not included:

  • https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes.
  • https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Google Container Registry).

If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.

serviceAccount

string

The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.

metadata

map (key: string, value: string)

The metadata key/value pairs assigned to instances in the cluster.

Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" - "serial-port-logging-enable"

Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB.

The total size of all keys and values must be less than 512 KB.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

imageType

string

The image type to use for this node. Note that for a given image type, the latest version of it will be used.

labels

map (key: string, value: string)

The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

localSsdCount

integer

The number of local SSD disks to be attached to the node.

The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.

tags[]

string

The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.

preemptible

boolean

Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.

accelerators[]

object (AcceleratorConfig)

A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.

sandboxConfig

object (SandboxConfig)

Sandbox configuration for this node.

nodeGroup

string

Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes.

reservationAffinity

object (ReservationAffinity)

The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.

diskType

string

Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

If unspecified, the default disk type is 'pd-standard'

minCpuPlatform

string

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 minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read how to specify min CPU platform

workloadMetadataConfig

object (WorkloadMetadataConfig)

The workload metadata configuration for this node.

taints[]

object (NodeTaint)

List of kubernetes taints to be applied to each node.

For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/

bootDiskKmsKey

string

The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption

shieldedInstanceConfig

object (ShieldedInstanceConfig)

Shielded Instance options.

linuxNodeConfig

object (LinuxNodeConfig)

Parameters that can be configured on Linux nodes.

kubeletConfig

object (NodeKubeletConfig)

Node kubelet configs.

AcceleratorConfig

AcceleratorConfig represents a Hardware Accelerator request.

JSON representation
{
  "acceleratorCount": string,
  "acceleratorType": string
}
Fields
acceleratorCount

string (int64 format)

The number of the accelerator cards exposed to an instance.

acceleratorType

string

The accelerator type resource name. List of supported accelerators here

SandboxConfig

SandboxConfig contains configurations of the sandbox to use for the node.

JSON representation
{
  "sandboxType": string,
  "type": enum (Type)
}
Fields
sandboxType
(deprecated)

string

Type of the sandbox to use for the node (e.g. 'gvisor')

type

enum (Type)

Type of the sandbox to use for the node.

Type

Possible types of sandboxes.

Enums
UNSPECIFIED Default value. This should not be used.
GVISOR Run sandbox using gvisor.

ReservationAffinity

ReservationAffinity is the configuration of desired reservation which instances could take capacity from.

JSON representation
{
  "consumeReservationType": enum (Type),
  "key": string,
  "values": [
    string
  ]
}
Fields
consumeReservationType

enum (Type)

Corresponds to the type of reservation consumption.

key

string

Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.

values[]

string

Corresponds to the label value(s) of reservation resource(s).

Type

Indicates whether to consume capacity from a reservation or not.

Enums
UNSPECIFIED Default value. This should not be used.
NO_RESERVATION Do not consume from any reserved capacity.
ANY_RESERVATION Consume any reservation available.
SPECIFIC_RESERVATION Must consume from a specific reservation. Must specify key value fields for specifying the reservations.

WorkloadMetadataConfig

WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.

JSON representation
{
  "nodeMetadata": enum (NodeMetadata),
  "mode": enum (Mode)
}
Fields
nodeMetadata
(deprecated)

enum (NodeMetadata)

NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.

mode

enum (Mode)

Mode is the configuration for how to expose metadata to workloads running on the node pool.

NodeMetadata

NodeMetadata is the configuration for if and how to expose the node metadata to the workload running on the node.

Enums
UNSPECIFIED Not set.
SECURE

Prevent workloads not in hostNetwork from accessing certain VM metadata, specifically kube-env, which contains Kubelet credentials, and the instance identity token.

Metadata concealment is a temporary security solution available while the bootstrapping process for cluster nodes is being redesigned with significant security improvements. This feature is scheduled to be deprecated in the future and later removed.

EXPOSE Expose all VM metadata to pods.
GKE_METADATA_SERVER Run the GKE Metadata Server on this node. The GKE Metadata Server exposes a metadata API to workloads that is compatible with the V1 Compute Metadata APIs exposed by the Compute Engine and App Engine Metadata Servers. This feature can only be enabled if Workload Identity is enabled at the cluster level.

Mode

Mode is the configuration for how to expose metadata to workloads running on the node.

Enums
MODE_UNSPECIFIED Not set.
GCE_METADATA Expose all Compute Engine metadata to pods.
GKE_METADATA Run the GKE Metadata Server on this node. The GKE Metadata Server exposes a metadata API to workloads that is compatible with the V1 Compute Metadata APIs exposed by the Compute Engine and App Engine Metadata Servers. This feature can only be enabled if Workload Identity is enabled at the cluster level.

NodeTaint

Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.

See here for more information, including usage and the valid values.

JSON representation
{
  "key": string,
  "value": string,
  "effect": enum (Effect)
}
Fields
key

string

Key for taint.

value

string

Value for taint.

effect

enum (Effect)

Effect for taint.

Effect

Possible values for Effect in taint.

Enums
EFFECT_UNSPECIFIED Not set
NO_SCHEDULE NoSchedule
PREFER_NO_SCHEDULE PreferNoSchedule
NO_EXECUTE NoExecute

LinuxNodeConfig

Parameters that can be configured on Linux nodes.

JSON representation
{
  "sysctls": {
    string: string,
    ...
  }
}
Fields
sysctls

map (key: string, value: string)

The Linux kernel parameters to be applied to the nodes and all pods running on the nodes.

The following parameters are supported.

net.core.netdev_max_backlog net.core.rmem_max net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

NodeKubeletConfig

Node kubelet configs.

JSON representation
{
  "cpuManagerPolicy": string,
  "cpuCfsQuota": boolean,
  "cpuCfsQuotaPeriod": string
}
Fields
cpuManagerPolicy

string

Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/

The following values are allowed. - "none": the default, which represents the existing scheduling behavior. - "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.

cpuCfsQuota

boolean

Enable CPU CFS quota enforcement for containers that specify CPU limits.

This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all.

Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits.

The default value is 'true' if unspecified.

cpuCfsQuotaPeriod

string

Set the CPU CFS quota period value 'cpu.cfs_period_us'.

The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration.