--- title: "POST /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools" method: POST path: "/v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools" tags: ["projects"] --- # POST /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools `POST /v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools` ## Request - Base URL: `https://container.googleapis.com` - URL: `https://container.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools` - Auth: one of: - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/container` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/container` Creates a node pool for a cluster. ## Path parameters - `projectsId` string, required - `locationsId` string, required - `clustersId` string, required ## Request body - CreateNodePoolRequest: CreateNodePoolRequest creates a node pool for a cluster. - `clusterId` string: Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - `nodePool` NodePool: NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. - `autopilotConfig` AutopilotConfig: AutopilotConfig contains configuration of autopilot feature for this node pool. - `enabled` boolean: Denotes that nodes belonging to this node pool are Autopilot nodes. - `autoscaling` NodePoolAutoscaling: NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. - `autoprovisioned` boolean: Can this node pool be deleted automatically. - `enabled` boolean: Is autoscaling enabled for this node pool. - `locationPolicy` 'LOCATION_POLICY_UNSPECIFIED' | 'BALANCED' | 'ANY': Location policy used when scaling up a node pool. - `maxNodeCount` integer: Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster. - `minNodeCount` integer: Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count. - `totalMaxNodeCount` integer: Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields. - `totalMinNodeCount` integer: Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields. - `bestEffortProvisioning` BestEffortProvisioning: Best effort provisioning. - `enabled` boolean: When this is enabled, cluster/node pool creations will ignore non-fatal errors like stockout to best provision as many nodes as possible right now and eventually bring up all target number of nodes - `minProvisionNodes` integer: Minimum number of nodes to be provisioned to be considered as succeeded, and the rest of nodes will be provisioned gradually and eventually when stockout issue has been resolved. - `conditions` StatusCondition[]: Output only. Which conditions caused the current node pool state. - `canonicalCode` 'OK' | 'CANCELLED' | 'UNKNOWN' | 'INVALID_ARGUMENT' | 'DEADLINE_EXCEEDED' | 'NOT_FOUND' | 'ALREADY_EXISTS' | 'PERMISSION_DENIED' | 'UNAUTHENTICATED' | 'RESOURCE_EXHAUSTED' | 'FAILED_PRECONDITION' | 'ABORTED' | 'OUT_OF_RANGE' | 'UNIMPLEMENTED' | 'INTERNAL' | 'UNAVAILABLE' | 'DATA_LOSS': Canonical code of the condition. - `code` 'UNKNOWN' | 'GCE_STOCKOUT' | 'GKE_SERVICE_ACCOUNT_DELETED' | 'GCE_QUOTA_EXCEEDED' | 'SET_BY_OPERATOR' | 'CLOUD_KMS_KEY_ERROR' | 'CA_EXPIRING' | 'NODE_SERVICE_ACCOUNT_MISSING_PERMISSIONS' | 'CLOUD_KMS_KEY_DESTROYED': Machine-friendly representation of the condition Deprecated. Use canonical_code instead. - `message` string: Human-friendly representation of the condition - `config` NodeConfig: Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. - `accelerators` 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. - `acceleratorCount` string, int64: The number of the accelerator cards exposed to an instance. - `acceleratorType` string: The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) - `gpuDriverInstallationConfig` GPUDriverInstallationConfig: GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. - `gpuDriverVersion` 'GPU_DRIVER_VERSION_UNSPECIFIED' | 'INSTALLATION_DISABLED' | 'DEFAULT' | 'LATEST' | 'SPECIFIC': Mode for how the GPU driver is installed. - `specificVersion` string: Optional. The specific version of the GPU driver to install. Use this field only with gpu_driver_version set to SPECIFIC. Otherwise, an error will be returned. - `gpuPartitionSize` string: Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning). - `gpuSharingConfig` GPUSharingConfig: GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. - `gpuSharingStrategy` 'GPU_SHARING_STRATEGY_UNSPECIFIED' | 'TIME_SHARING' | 'MPS': The type of GPU sharing strategy to enable on the GPU node. - `maxSharedClientsPerGpu` string, int64: The max number of containers that can share a physical GPU. - `advancedMachineFeatures` AdvancedMachineFeatures: Specifies options for controlling advanced machine features. - `enableNestedVirtualization` boolean: Whether or not to enable nested virtualization (defaults to false). - `performanceMonitoringUnit` 'PERFORMANCE_MONITORING_UNIT_UNSPECIFIED' | 'ARCHITECTURAL' | 'STANDARD' | 'ENHANCED': Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node. - `threadsPerCore` string, int64: The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. - `bootDisk` BootDisk: BootDisk specifies the boot disk configuration for node pools. - `diskType` string: Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.) - `provisionedIops` string, int64: For Hyperdisk-Balanced only, the provisioned IOPS config value. - `provisionedThroughput` string, int64: For Hyperdisk-Balanced only, the provisioned throughput config value. - `sizeGb` string, int64: Disk size in GB. Replaces NodeConfig.disk_size_gb - `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 - `confidentialNodes` ConfidentialNodes: ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. - `confidentialInstanceType` 'CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED' | 'SEV' | 'SEV_SNP' | 'TDX': Defines the type of technology used by the confidential node. - `enabled` boolean: Whether Confidential Nodes feature is enabled. - `consolidationDelay` string, google-duration: Consolidation delay defines duration after which the Cluster Autoscaler can scale down underutilized nodes. If not set, nodes are scaled down by default behavior, i.e. according to the chosen autoscaling profile. - `containerdConfig` ContainerdConfig: ContainerdConfig contains configuration to customize containerd. - `privateRegistryAccessConfig` PrivateRegistryAccessConfig: PrivateRegistryAccessConfig contains access configuration for private container registries. - `certificateAuthorityDomainConfig` CertificateAuthorityDomainConfig[]: Private registry access configuration. - `fqdns` string[]: List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - `my.customdomain.com` - `10.0.1.2:5000` - `gcpSecretManagerCertificateConfig` GCPSecretManagerCertificateConfig: GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). - … - `enabled` boolean: Private registry access is enabled. - `registryHosts` RegistryHostConfig[]: RegistryHostConfig configures containerd registry host configuration. Each registry_hosts represents a hosts.toml file. At most 25 registry_hosts are allowed. - `hosts` HostConfig[]: HostConfig configures a list of host-specific configurations for the server. Each server can have at most 10 host configurations. - `ca` CertificateConfig[]: CA configures the registry host certificate. - … - `capabilities` string[]: Capabilities represent the capabilities of the registry host, specifying what operations a host is capable of performing. If not set, containerd enables all capabilities by default. - `client` CertificateConfigPair[]: Client configures the registry host client certificate and key. - … - `dialTimeout` string, google-duration: Specifies the maximum duration allowed for a connection attempt to complete. A shorter timeout helps reduce delays when falling back to the original registry if the mirror is unreachable. Maximum allowed value is 180s. If not set, containerd sets default 30s. The value should be a decimal number of seconds with an `s` suffix. - `header` RegistryHeader[]: Header configures the registry host headers. - … - `host` string: Host configures the registry host/mirror. It supports fully qualified domain names (FQDNs) and IP addresses. Specifying scheme, port or path is supported. Scheme can only be http or https. Wildcards are NOT supported. Examples: - `my.customdomain.com` - `https://my.customdomain.com/path` - `10.0.1.2:5000` - `overridePath` boolean: OverridePath is used to indicate the host's API root endpoint is defined in the URL path rather than by the API specification. This may be used with non-compliant OCI registries which are missing the /v2 prefix. If not set, containerd sets default false. - `server` string: Defines the host name of the registry server, which will be used to create configuration file as /etc/containerd/hosts.d//hosts.toml. It supports fully qualified domain names (FQDN) and IP addresses: Specifying port is supported, while scheme and path are NOT supported. Wildcards are NOT supported. Examples: - `my.customdomain.com` - `10.0.1.2:5000` - `writableCgroups` WritableCgroups: Defines writable cgroups configuration. - `enabled` boolean: Optional. Whether writable cgroups is enabled. - `diskSizeGb` integer: Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 15 GB for node pools running GKE versions 1.36.3-gke.1480000 or later. Or, for earlier versions, the smallest allowed disk size is 12 GB. If unspecified, the default disk size is 100GB. - `diskType` string: Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - `effectiveCgroupMode` 'EFFECTIVE_CGROUP_MODE_UNSPECIFIED' | 'EFFECTIVE_CGROUP_MODE_V1' | 'EFFECTIVE_CGROUP_MODE_V2': Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. - `enableConfidentialStorage` boolean: Optional. Reserved for future use. - `ephemeralStorageLocalSsdConfig` EphemeralStorageLocalSsdConfig: EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. - `dataCacheCount` integer: Number of local SSDs to use for GKE Data Cache. - `ephemeralCapacityGb` string, int64: Capacity set aside for Ephemeral Storage if using mixed Local SSD modes. The remaining capacity is Raw Block. - `localSsdCount` integer: Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. - `fastSocket` FastSocket: Configuration of Fast Socket feature. - `enabled` boolean: Whether Fast Socket features are enabled in the node pool. - `flexStart` boolean: Flex Start flag for enabling Flex Start VM. - `gcfsConfig` GcfsConfig: GcfsConfig contains configurations of Google Container File System (image streaming). - `enabled` boolean: Whether to use GCFS. - `gpuDirectConfig` GPUDirectConfig: GPUDirectConfig specifies the GPU direct strategy on the node pool. - `gpuDirectStrategy` 'GPU_DIRECT_STRATEGY_UNSPECIFIED' | 'RDMA': The type of GPU direct strategy to enable on the node pool. - `gvnic` VirtualNIC: Configuration of gVNIC feature. - `enabled` boolean: Whether gVNIC features are enabled in the node pool. - `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. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. - `kubeletConfig` NodeKubeletConfig: Node kubelet configs. - `allowedUnsafeSysctls` string[]: Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. - `containerLogMaxFiles` integer: Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified. - `containerLogMaxSize` string: Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified. - `containerLogMaxWorkers` integer: Optional. Defines the maximum number of concurrent workers to rotate container log files. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 1 and 10, inclusive. The default value is 1 if unspecified. - `containerLogMonitorInterval` string, google-duration: Optional. Specifies the interval at which the container logs are monitored for performing the log rotate operation. The value must be a positive interval between 3s and 300s, inclusive. The default value is "10s" 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 between 1ms and 1 second, inclusive. - `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. - `crashLoopBackOff` CrashLoopBackOffConfig: Contains config to modify node-level parameters for container restart behavior. - `maxContainerRestartPeriod` string: Optional. The maximum duration the backoff delay can accrue to for container restarts, minimum 1 second, maximum 300 seconds. If not set, defaults to the internal crashloopbackoff maximum. 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". See https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#configurable-container-restart-delay for more details. - `evictionMaxPodGracePeriodSeconds` integer: Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300]. - `evictionMinimumReclaim` EvictionMinimumReclaim: Eviction minimum reclaims are the resource amounts of minimum reclaims for each eviction signal. - `imagefsAvailable` string: Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `imagefsInodesFree` string: Optional. Minimum reclaim for eviction due to imagefs inodes free signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `memoryAvailable` string: Optional. Minimum reclaim for eviction due to memory available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `nodefsAvailable` string: Optional. Minimum reclaim for eviction due to nodefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `nodefsInodesFree` string: Optional. Minimum reclaim for eviction due to nodefs inodes free signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `pidAvailable` string: Optional. Minimum reclaim for eviction due to pid available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `evictionSoft` EvictionSignals: Eviction signals are the current state of a particular resource at a specific point in time. The kubelet uses eviction signals to make eviction decisions by comparing the signals to eviction thresholds, which are the minimum amount of the resource that should be available on the node. - `imagefsAvailable` string: Optional. Amount of storage available on filesystem that container runtime uses for storing images layers. If the container filesystem and image filesystem are not separate, then imagefs can store both image layers and writeable layers. Defines the amount of "imagefs.available" signal in kubelet. Default is unset, if not specified in the kubelet config. It takses percentage value for now. Sample format: "30%". Must be >= 15% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `imagefsInodesFree` string: Optional. Amount of inodes available on filesystem that container runtime uses for storing images layers. Defines the amount of "imagefs.inodesFree" signal in kubelet. Default is unset, if not specified in the kubelet config. Linux only. It takses percentage value for now. Sample format: "30%". Must be >= 5% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `memoryAvailable` string: Optional. Memory available (i.e. capacity - workingSet), in bytes. Defines the amount of "memory.available" signal in kubelet. Default is unset, if not specified in the kubelet config. Format: positive number + unit, e.g. 100Ki, 10Mi, 5Gi. Valid units are Ki, Mi, Gi. Must be >= 100Mi and <= 50% of the node's memory. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `nodefsAvailable` string: Optional. Amount of storage available on filesystem that kubelet uses for volumes, daemon logs, etc. Defines the amount of "nodefs.available" signal in kubelet. Default is unset, if not specified in the kubelet config. It takses percentage value for now. Sample format: "30%". Must be >= 10% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `nodefsInodesFree` string: Optional. Amount of inodes available on filesystem that kubelet uses for volumes, daemon logs, etc. Defines the amount of "nodefs.inodesFree" signal in kubelet. Default is unset, if not specified in the kubelet config. Linux only. It takses percentage value for now. Sample format: "30%". Must be >= 5% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `pidAvailable` string: Optional. Amount of PID available for pod allocation. Defines the amount of "pid.available" signal in kubelet. Default is unset, if not specified in the kubelet config. It takses percentage value for now. Sample format: "30%". Must be >= 10% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `evictionSoftGracePeriod` EvictionGracePeriod: Eviction grace periods are grace periods for each eviction signal. - `imagefsAvailable` string: Optional. Grace period for eviction due to imagefs available signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `imagefsInodesFree` string: Optional. Grace period for eviction due to imagefs inodes free signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `memoryAvailable` string: Optional. Grace period for eviction due to memory available signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `nodefsAvailable` string: Optional. Grace period for eviction due to nodefs available signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `nodefsInodesFree` string: Optional. Grace period for eviction due to nodefs inodes free signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `pidAvailable` string: Optional. Grace period for eviction due to pid available signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals - `imageGcHighThresholdPercent` integer: Optional. Defines the percent of disk usage after which image garbage collection is always run. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and greater than image_gc_low_threshold_percent. The default value is 85 if unspecified. - `imageGcLowThresholdPercent` integer: Optional. Defines the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and smaller than image_gc_high_threshold_percent. The default value is 80 if unspecified. - `imageMaximumGcAge` string: Optional. Defines the maximum age an image can be unused before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration greater than image_minimum_gc_age or "0s". The default value is "0s" if unspecified, which disables this field, meaning images won't be garbage collected based on being unused for too long. - `imageMinimumGcAge` string: Optional. Defines the minimum age for an unused image before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration less than or equal to 2 minutes. The default value is "2m0s" if unspecified. - `insecureKubeletReadonlyPortEnabled` boolean: Enable or disable Kubelet read only port. - `maxParallelImagePulls` integer: Optional. Defines the maximum number of image pulls in parallel. The range is 2 to 5, inclusive. The default value is 2 or 3 depending on the disk type. See https://kubernetes.io/docs/concepts/containers/images/#maximum-parallel-image-pulls for more details. - `memoryManager` MemoryManager: The option enables the Kubernetes NUMA-aware Memory Manager feature. Detailed description about the feature can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/). - `policy` string: Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified. - `podPidsLimit` string, int64: Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304. - `reservedResourcesConfig` ReservedResourcesConfig: ReservedResourcesConfig contains the configuration for the reserved resources on the node. - `cpuReservedMillicore` string, int64: Optional. The amount of CPU to reserve for system daemons. This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. - `effectiveCpuReservedMillicore` string, int64: Output only. The effective amount of CPU reserved for system daemons. If `cpu_reserved_millicore` is specified, user-specified value is used. Otherwise the GKE default is applied. - `effectiveMemoryReservedMib` string, int64: Output only. The effective amount of memory reserved for system daemons. If `memory_reserved_mib` is specified, the user-specified value is used. Otherwise the GKE default is applied. - `memoryReservedMib` string, int64: Optional. The amount of memory to reserve for system daemons (in MiB). This is a user-specified value. If unspecified, GKE decides the default based on node version using different formula. - `reservedSystemCpus` string: Optional. The reserved_system_cpus option specifies the CPU list reserved for the host system services. Format: a list of CPU IDs (e.g. "0-3", "0,1") that can be parsed as a cpuset. - `shutdownGracePeriodCriticalPodsSeconds` integer: Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. - `shutdownGracePeriodSeconds` integer: Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. - `singleProcessOomKill` boolean: Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - `topologyManager` TopologyManager: TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). - `policy` string: Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). - `scope` string: The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes - `labels` object: The Kubernetes labels (key/value pairs) to apply to each node. The values in this field are added to the set of default labels Kubernetes applies to nodes. This field has the following restrictions: * Labels must use a valid Kubernetes syntax and character set, as defined in https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set. * This field supports up to 1,024 total characters in a single request. Depending on the Kubernetes version, keys in this field might conflict with the keys of the default labels, which might change which of your labels are applied to the nodes. Assume that the behavior is unpredictable and avoid label key conflicts. For more information about the default labels, see: https://kubernetes.io/docs/reference/labels-annotations-taints/ - `linuxNodeConfig` LinuxNodeConfig: Parameters that can be configured on Linux nodes. - `accurateTimeConfig` AccurateTimeConfig: AccurateTimeConfig contains configuration for the accurate time synchronization feature. - `enablePtpKvmTimeSync` boolean: Enables enhanced time synchronization using PTP-KVM. - `additionalEtcHosts` EtcHostsEntry[]: Optional. Additional entries to be added to /etc/hosts. - `host` string: The hostname of the host. - `ip` string: The IPv4 or IPv6 address of the host. - `additionalEtcResolvConf` ResolvedConfEntry[]: Optional. Additional entries to be added to /etc/resolv.conf. - `key` string: The key of resolved.conf - `value` string[]: Optional. The value of resolved.conf - `additionalEtcSystemdResolvedConf` ResolvedConfEntry[]: Optional. Additional entries to be added to /etc/systemd/resolved.conf. - `key` string: The key of resolved.conf - `value` string[]: Optional. The value of resolved.conf - `cgroupMode` 'CGROUP_MODE_UNSPECIFIED' | 'CGROUP_MODE_V1' | 'CGROUP_MODE_V2': cgroup_mode specifies the cgroup mode to be used on the node. - `customNodeInit` CustomNodeInit: Support for running custom init code while bootstrapping nodes. - `initScript` InitScript: InitScript provide a simply bash script to be executed on the node. - `args` string[]: Optional. The optional arguments line to be passed to the init script. - `gcpSecretManagerSecretUri` string: The resource name of the secret manager secret hosting the init script. Both global and regional secrets are supported with format below: Global secret: projects/{project}/secrets/{secret}/versions/{version} Regional secret: projects/{project}/locations/{location}/secrets/{secret}/versions/{version} Example: projects/1234567890/secrets/script_1/versions/1. Accept version number only, not support version alias. User can't configure both gcp_secret_manager_secret_uri and gcs_uri. - `gcsGeneration` string, int64: The generation of the init script stored in Gloud Storage. This is the required field to identify the version of the init script. User can get the genetaion from `gcloud storage objects describe gs://BUCKET_NAME/OBJECT_NAME --format="value(generation)"` or from the "Version history" tab of the object in the Cloud Console UI. - `gcsUri` string: The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. - `diskIoScheduler` DiskIoScheduler: DiskIoScheduler contains the configuration for the disk IO scheduler. - `nodeAttachedDiskIoScheduler` string: Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. - `nodeSystemIoScheduler` string: Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. - `hugepages` HugepagesConfig: Hugepages amount in both 2m and 1g size - `hugepageSize1g` integer: Optional. Amount of 1G hugepages - `hugepageSize2m` integer: Optional. Amount of 2M hugepages - `kernelOverrides` KernelOverrides: Parameters that can be configured on the kernel. - `kernelCommandlineOverrides` KernelCommandlineOverrides: Definition of possible additional kernel command line arguments to be configured to the kernel. - `initOnAlloc` 'INIT_ON_ALLOC_UNSPECIFIED' | 'INIT_ON_ALLOC_OFF': Optional. Defines the change of init_on_alloc. - `specRstackOverflow` 'SPEC_RSTACK_OVERFLOW_UNSPECIFIED' | 'SPEC_RSTACK_OVERFLOW_OFF': Optional. Defines the change of spec_rstack_overflow. - `lruGen` LRUGen: lrugen (Multi-Gen LRU) options See https://docs.kernel.org/admin-guide/mm/multigen_lru.html - `enabled` boolean: Optional. Enable lrugen. - `minTtlMs` integer: Optional. Users can write N to min_ttl_ms to prevent the working set of N milliseconds from getting evicted. - `nodeKernelModuleLoading` NodeKernelModuleLoading: Configuration for kernel module loading on nodes. - `policy` 'POLICY_UNSPECIFIED' | 'ENFORCE_SIGNED_MODULES' | 'DO_NOT_ENFORCE_SIGNED_MODULES': Set the node module loading policy for nodes in the node pool. - `nodeVfioConfig` NodeVfioConfig: Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. - `dmaEntryLimit` integer: Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. - `swapConfig` SwapConfig: Configuration for swap memory on a node pool. - `bootDiskProfile` BootDiskProfile: Swap on the node's boot disk. - `swapSizeGib` string, int64: Specifies the size of the swap space in gibibytes (GiB). - `swapSizePercent` integer: Specifies the size of the swap space as a percentage of the boot disk size. - `dedicatedLocalSsdProfile` DedicatedLocalSsdProfile: Provisions a new, separate local NVMe SSD exclusively for swap. - `diskCount` string, int64: The number of physical local NVMe SSD disks to attach. - `enabled` boolean: Optional. Enables or disables swap for the node pool. - `encryptionConfig` EncryptionConfig: Defines encryption settings for the swap space. - `disabled` boolean: Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). - `ephemeralLocalSsdProfile` EphemeralLocalSsdProfile: Swap on the local SSD shared with pod ephemeral storage. - `swapSizeGib` string, int64: Specifies the size of the swap space in gibibytes (GiB). - `swapSizePercent` integer: Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. - `sysctls` object: The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes - `timeZone` string: Optional. Configures the timezone of the node. - `transparentHugepageDefrag` 'TRANSPARENT_HUGEPAGE_DEFRAG_UNSPECIFIED' | 'TRANSPARENT_HUGEPAGE_DEFRAG_ALWAYS' | 'TRANSPARENT_HUGEPAGE_DEFRAG_DEFER' | 'TRANSPARENT_HUGEPAGE_DEFRAG_DEFER_WITH_MADVISE' | 'TRANSPARENT_HUGEPAGE_DEFRAG_MADVISE' | 'TRANSPARENT_HUGEPAGE_DEFRAG_NEVER': Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. - `transparentHugepageEnabled` 'TRANSPARENT_HUGEPAGE_ENABLED_UNSPECIFIED' | 'TRANSPARENT_HUGEPAGE_ENABLED_ALWAYS' | 'TRANSPARENT_HUGEPAGE_ENABLED_MADVISE' | 'TRANSPARENT_HUGEPAGE_ENABLED_NEVER': Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. - `localNvmeSsdBlockConfig` LocalNvmeSsdBlockConfig: LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs - `localSsdCount` integer: Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. - `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. - `localSsdEncryptionMode` 'LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED' | 'STANDARD_ENCRYPTION' | 'EPHEMERAL_KEY_ENCRYPTION': Specifies which method should be used for encrypting the Local SSDs attached to the node. - `loggingConfig` NodePoolLoggingConfig: NodePoolLoggingConfig specifies logging configuration for node pools. - `variantConfig` LoggingVariantConfig: LoggingVariantConfig specifies the behaviour of the logging component. - `variant` 'VARIANT_UNSPECIFIED' | 'DEFAULT' | 'MAX_THROUGHPUT': Logging variant deployed on nodes. - `machineType` string: The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. - `maxRunDuration` string, google-duration: The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. - `metadata` object: 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-os-login" - "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" 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. - `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](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) - `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](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). - `nodeImageConfig` CustomImageConfig: CustomImageConfig contains the information r - `image` string: The name of the image to use for this node. - `imageProject` string: The project containing the image to use for this node. - `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 [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. - `preemptible` boolean: Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. - `reservationAffinity` ReservationAffinity: [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. - `consumeReservationType` 'UNSPECIFIED' | 'NO_RESERVATION' | 'ANY_RESERVATION' | 'SPECIFIC_RESERVATION' | 'ANY_RESERVATION_THEN_FAIL': 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 "compute.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). - `resourceLabels` object: The resource labels for the node pool to use to annotate any related Google Compute Engine resources. - `resourceManagerTags` ResourceManagerTags: A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. - `tags` object: TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` - `sandboxConfig` SandboxConfig: SandboxConfig contains configurations of the sandbox to use for the node. - `type` 'UNSPECIFIED' | 'GVISOR' | 'MICROVM': Type of the sandbox to use for the node. - `secondaryBootDiskUpdateStrategy` SecondaryBootDiskUpdateStrategy: SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. - `secondaryBootDisks` SecondaryBootDisk[]: List of secondary boot disks attached to the nodes. - `diskImage` string: Fully-qualified resource ID for an existing disk image. - `mode` 'MODE_UNSPECIFIED' | 'CONTAINER_IMAGE_CACHE': Disk mode (container image cache, etc.) - `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. - `shieldedInstanceConfig` ShieldedInstanceConfig: A set of Shielded Instance options. - `enableIntegrityMonitoring` boolean: Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. - `enableSecureBoot` boolean: Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. - `soleTenantConfig` SoleTenantConfig: SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. - `minNodeCpus` integer: Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group. - `nodeAffinities` NodeAffinity[]: NodeAffinities used to match to a shared sole tenant node group. - `key` string: Key for NodeAffinity. - `operator` 'OPERATOR_UNSPECIFIED' | 'IN' | 'NOT_IN': Operator for NodeAffinity. - `values` string[]: Values for NodeAffinity. - `spot` boolean: Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. - `storagePools` string[]: List of Storage Pools where boot disks are provisioned. - `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. - `taintConfig` TaintConfig: TaintConfig contains the configuration for the taints of the node pool. - `architectureTaintBehavior` 'ARCHITECTURE_TAINT_BEHAVIOR_UNSPECIFIED' | 'NONE' | 'ARM': Optional. Controls architecture tainting behavior. - `taints` 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/ - `effect` 'EFFECT_UNSPECIFIED' | 'NO_SCHEDULE' | 'PREFER_NO_SCHEDULE' | 'NO_EXECUTE': Effect for taint. - `key` string: Key for taint. - `value` string: Value for taint. - `windowsNodeConfig` WindowsNodeConfig: Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings. - `osVersion` 'OS_VERSION_UNSPECIFIED' | 'OS_VERSION_LTSC2019' | 'OS_VERSION_LTSC2022': OSVersion specifies the Windows node config to be used on the node. - `workloadMetadataConfig` WorkloadMetadataConfig: WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. - `mode` 'MODE_UNSPECIFIED' | 'GCE_METADATA' | 'GKE_METADATA': Mode is the configuration for how to expose metadata to workloads running on the node pool. - `etag` string: Output only. This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - `initialNodeCount` integer: The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - `instanceGroupUrls` string[]: Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. - `kubeletCertInfo` KubeletCertInfo: Contains expiry information about the kubelet certificate. - `nonTpmBootstrapCertExpireTime` string, google-datetime: Output only. - `tpmBootstrapCertExpireTime` string, google-datetime: Output only. - `locations` string[]: The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. - `maintenancePolicy` NodePoolMaintenancePolicy: Defines the maintenance policy for the node pool. - `exclusionUntilEndOfSupport` ExclusionUntilEndOfSupport: Defines the maintenance exclusion for the node pool. - `enabled` boolean: Optional. Indicates whether the exclusion is enabled. - `endTime` string, google-datetime: Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel. - `startTime` string, google-datetime: Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time. - `management` NodeManagement: NodeManagement defines the set of node management services turned on for the node pool. - `autoRepair` boolean: A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. - `autoUpgrade` boolean: A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. - `upgradeOptions` AutoUpgradeOptions: AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. - `autoUpgradeStartTime` string: Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - `description` string: Output only. This field is set when upgrades are about to commence with the description of the upgrade. - `maxPodsConstraint` MaxPodsConstraint: Constraints applied to pods. - `maxPodsPerNode` string, int64: Constraint enforced on the max num of pods per node. - `name` string: The name of the node pool. - `networkConfig` NodeNetworkConfig: Parameters for node pool-level network config. - `acceleratorNetworkProfile` string: Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. - `additionalNodeNetworkConfigs` AdditionalNodeNetworkConfig[]: We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface - `network` string: Name of the VPC where the additional interface belongs - `subnetwork` string: Name of the subnetwork where the additional interface belongs - `additionalPodNetworkConfigs` AdditionalPodNetworkConfig[]: We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node - `maxPodsPerNode` MaxPodsConstraint: Constraints applied to pods. - `maxPodsPerNode` string, int64: Constraint enforced on the max num of pods per node. - `networkAttachment` string: The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range. - `secondaryPodRange` string: The name of the secondary range on the subnet which provides IP address for this pod range. - `subnetwork` string: Name of the subnetwork where the additional pod network belongs. - `createPodRange` boolean: Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for `pod_range` and `pod_ipv4_cidr_block` if they are not specified. If neither `create_pod_range` or `pod_range` are specified, the cluster-level default (`ip_allocation_policy.cluster_ipv4_cidr_block`) is used. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - `datapathProvider` 'DATAPATH_PROVIDER_UNSPECIFIED' | 'LEGACY_DATAPATH' | 'ADVANCED_DATAPATH' | 'MIGRATE_TO_ADVANCED_DATAPATH' | 'MIGRATE_TO_LEGACY_DATAPATH': The datapath provider for this node pool. - `enablePrivateNodes` boolean: Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from Cluster.NetworkConfig.default_enable_private_nodes - `network` string: Optional. Immutable. The VPC network for the node pool. - `networkPerformanceConfig` NetworkPerformanceConfig: Configuration of all network bandwidth tiers - `totalEgressBandwidthTier` 'TIER_UNSPECIFIED' | 'TIER_1': Specifies the total network bandwidth tier for the NodePool. - `networkTierConfig` NetworkTierConfig: NetworkTierConfig contains network tier information. - `networkTier` 'NETWORK_TIER_UNSPECIFIED' | 'NETWORK_TIER_DEFAULT' | 'NETWORK_TIER_PREMIUM' | 'NETWORK_TIER_STANDARD': Network tier configuration. - `podCidrOverprovisionConfig` PodCIDROverprovisionConfig: [PRIVATE FIELD] Config for pod CIDR size overprovisioning. - `disable` boolean: Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. - `podIpv4CidrBlock` string: The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - `podIpv4RangeUtilization` number, double: Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. - `podRange` string: The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - `subnetwork` string: Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable. - `nodeDrainConfig` NodeDrainConfig: NodeDrainConfig contains the node drain related configurations for this node pool. - `graceTerminationDuration` string, google-duration: The duration of the grace termination period for node drain. - `pdbTimeoutDuration` string, google-duration: The duration of the PDB timeout period for node drain. - `respectPdbDuringNodePoolDeletion` boolean: Whether to respect PDB during node pool deletion. - `placementPolicy` PlacementPolicy: PlacementPolicy defines the placement policy used by the node pool. - `policyName` string: If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - `tpuTopology` string: Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies - `type` 'TYPE_UNSPECIFIED' | 'COMPACT': The type of placement. - `podIpv4CidrSize` integer: Output only. The pod CIDR block size per node in this node pool. - `queuedProvisioning` QueuedProvisioning: QueuedProvisioning defines the queued provisioning used by the node pool. - `enabled` boolean: Denotes that this node pool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. - `selfLink` string: Output only. Server-defined URL for the resource. - `status` 'STATUS_UNSPECIFIED' | 'PROVISIONING' | 'RUNNING' | 'RUNNING_WITH_ERROR' | 'RECONCILING' | 'STOPPING' | 'ERROR': Output only. The status of the nodes in this pool instance. - `statusMessage` string: Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - `updateInfo` UpdateInfo: UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. - `blueGreenInfo` BlueGreenInfo: Information relevant to blue-green upgrade. - `blueInstanceGroupUrls` string[]: The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. - `bluePoolDeletionStartTime` string: Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - `greenInstanceGroupUrls` string[]: The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool. - `greenPoolVersion` string: Version of green pool. - `phase` 'PHASE_UNSPECIFIED' | 'UPDATE_STARTED' | 'CREATING_GREEN_POOL' | 'CORDONING_BLUE_POOL' | 'DRAINING_BLUE_POOL' | 'NODE_POOL_SOAKING' | 'DELETING_BLUE_POOL' | 'ROLLBACK_STARTED': Current blue-green upgrade phase. - `upgradeSettings` UpgradeSettings: These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. - `blueGreenSettings` BlueGreenSettings: Settings for blue-green upgrade. - `autoscaledRolloutPolicy` AutoscaledRolloutPolicy: Autoscaled rollout policy utilizes the cluster autoscaler during blue-green upgrade to scale both the blue and green pools. - `waitForDrainDuration` string, google-duration: Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. - `nodePoolSoakDuration` string, google-duration: Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. - `standardRolloutPolicy` StandardRolloutPolicy: Standard rollout policy is the default policy for blue-green. - `batchNodeCount` integer: Number of blue nodes to drain in a batch. - `batchPercentage` number, float: Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0]. - `batchSoakDuration` string, google-duration: Soak time after each batch gets drained. Default to zero. - `maxSurge` integer: The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process. - `maxUnavailable` integer: The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. - `strategy` 'NODE_POOL_UPDATE_STRATEGY_UNSPECIFIED' | 'BLUE_GREEN' | 'SURGE' | 'SHORT_LIVED': Update strategy of the node pool. - `version` string: The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). - `parent` string: The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`. - `projectId` string: Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - `zone` string: Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. ## Response `200` Successful response - Operation: This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only. - `clusterConditions` StatusCondition[]: Which conditions caused the current cluster state. Deprecated. Use field error instead. - `canonicalCode` 'OK' | 'CANCELLED' | 'UNKNOWN' | 'INVALID_ARGUMENT' | 'DEADLINE_EXCEEDED' | 'NOT_FOUND' | 'ALREADY_EXISTS' | 'PERMISSION_DENIED' | 'UNAUTHENTICATED' | 'RESOURCE_EXHAUSTED' | 'FAILED_PRECONDITION' | 'ABORTED' | 'OUT_OF_RANGE' | 'UNIMPLEMENTED' | 'INTERNAL' | 'UNAVAILABLE' | 'DATA_LOSS': Canonical code of the condition. - `code` 'UNKNOWN' | 'GCE_STOCKOUT' | 'GKE_SERVICE_ACCOUNT_DELETED' | 'GCE_QUOTA_EXCEEDED' | 'SET_BY_OPERATOR' | 'CLOUD_KMS_KEY_ERROR' | 'CA_EXPIRING' | 'NODE_SERVICE_ACCOUNT_MISSING_PERMISSIONS' | 'CLOUD_KMS_KEY_DESTROYED': Machine-friendly representation of the condition Deprecated. Use canonical_code instead. - `message` string: Human-friendly representation of the condition - `detail` string: Output only. Detailed operation progress, if available. - `endTime` string: Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - `error` Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code` integer: The status code, which should be an enum value of google.rpc.Code. - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use. - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `location` string: Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - `name` string: Output only. The server-assigned ID for the operation. - `nodepoolConditions` StatusCondition[]: Which conditions caused the current node pool state. Deprecated. Use field error instead. - `canonicalCode` 'OK' | 'CANCELLED' | 'UNKNOWN' | 'INVALID_ARGUMENT' | 'DEADLINE_EXCEEDED' | 'NOT_FOUND' | 'ALREADY_EXISTS' | 'PERMISSION_DENIED' | 'UNAUTHENTICATED' | 'RESOURCE_EXHAUSTED' | 'FAILED_PRECONDITION' | 'ABORTED' | 'OUT_OF_RANGE' | 'UNIMPLEMENTED' | 'INTERNAL' | 'UNAVAILABLE' | 'DATA_LOSS': Canonical code of the condition. - `code` 'UNKNOWN' | 'GCE_STOCKOUT' | 'GKE_SERVICE_ACCOUNT_DELETED' | 'GCE_QUOTA_EXCEEDED' | 'SET_BY_OPERATOR' | 'CLOUD_KMS_KEY_ERROR' | 'CA_EXPIRING' | 'NODE_SERVICE_ACCOUNT_MISSING_PERMISSIONS' | 'CLOUD_KMS_KEY_DESTROYED': Machine-friendly representation of the condition Deprecated. Use canonical_code instead. - `message` string: Human-friendly representation of the condition - `operationType` 'TYPE_UNSPECIFIED' | 'CREATE_CLUSTER' | 'DELETE_CLUSTER' | 'UPGRADE_MASTER' | 'UPGRADE_NODES' | 'REPAIR_CLUSTER' | 'UPDATE_CLUSTER' | 'CREATE_NODE_POOL' | 'DELETE_NODE_POOL' | 'SET_NODE_POOL_MANAGEMENT' | 'AUTO_REPAIR_NODES' | 'AUTO_UPGRADE_NODES' | 'SET_LABELS' | 'SET_MASTER_AUTH' | 'SET_NODE_POOL_SIZE' | 'SET_NETWORK_POLICY' | 'SET_MAINTENANCE_POLICY' | 'RESIZE_CLUSTER' | 'FLEET_FEATURE_UPGRADE': Output only. The operation type. - `progress` OperationProgress: Information about operation (or operation stage) progress. - `metrics` Metric[]: Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] - `doubleValue` number, double: For metrics with floating point value. - `intValue` string, int64: For metrics with integer value. - `name` string: Required. Metric name, e.g., "nodes total", "percent done". - `stringValue` string: For metrics with custom values (ratios, visual progress, etc.). - `name` string: A non-parameterized string describing an operation stage. Unset for single-stage operations. - `stages` OperationProgress[]: Substages of an operation or a stage. - `status` 'STATUS_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'DONE' | 'ABORTING': Status of an operation stage. Unset for single-stage operations. - `selfLink` string: Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - `startTime` string: Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - `status` 'STATUS_UNSPECIFIED' | 'PENDING' | 'RUNNING' | 'DONE' | 'ABORTING': Output only. The current status of the operation. - `statusMessage` string: Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - `targetLink` string: Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - `zone` string: Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. ## Changes - **2026-11-03** `649eae563481`: 4 info - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/container` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/container` was removed from the endpoint's security scheme `Oauth2c` [Operation history](https://skmtc.dev/google/apis/container/changes/v1/projects/:projectsId/locations/:locationsId/clusters/:clustersId/nodePools/post.md) --- [API](https://skmtc.dev/google/apis/container.md) - [All operations](https://skmtc.dev/google/apis/container/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/container/revisions/649eae563481?raw)