node_pools

Creates, updates, deletes, gets or lists a node_pools resource.

Overview

Name	node_pools
Type	Resource
Id	google.container.node_pools

Fields

The following fields are returned by SELECT queries:

projects_zones_clusters_node_pools_get

Name	Datatype	Description
name	string	The name of the node pool.
autopilotConfig	object	Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. (id: AutopilotConfig)
autoscaling	object	Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. (id: NodePoolAutoscaling)
bestEffortProvisioning	object	Enable best effort provisioning for nodes (id: BestEffortProvisioning)
conditions	array	Output only. Which conditions caused the current node pool state.
config	object	The node configuration of the pool. (id: NodeConfig)
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 (int32)	The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
instanceGroupUrls	array	Output only. The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
kubeletCertInfo	object	Output only. Contains expiry information about the kubelet certificate. (id: KubeletCertInfo)
locations	array	The list of Google Compute Engine zones in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
maintenancePolicy	object	Optional. Specifies the maintenance policy for the node pool. (id: NodePoolMaintenancePolicy)
management	object	NodeManagement configuration for this NodePool. (id: NodeManagement)
maxPodsConstraint	object	The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. (id: MaxPodsConstraint)
networkConfig	object	Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. (id: NodeNetworkConfig)
nodeDrainConfig	object	Specifies the node drain configuration for this node pool. (id: NodeDrainConfig)
placementPolicy	object	Specifies the node placement policy. (id: PlacementPolicy)
podIpv4CidrSize	integer (int32)	Output only. The pod CIDR block size per node in this node pool.
queuedProvisioning	object	Specifies the configuration of queued provisioning. (id: QueuedProvisioning)
selfLink	string	Output only. Server-defined URL for the resource.
status	string	Output only. The status of the nodes in this pool instance. (STATUS_UNSPECIFIED, PROVISIONING, RUNNING, RUNNING_WITH_ERROR, RECONCILING, STOPPING, ERROR)
statusMessage	string	Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
updateInfo	object	Output only. Update info contains relevant information during a node pool update. (id: UpdateInfo)
upgradeSettings	object	Upgrade settings control disruption and speed of the upgrade. (id: UpgradeSettings)
version	string	The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.

projects_locations_clusters_node_pools_get

Name	Datatype	Description
name	string	The name of the node pool.
autopilotConfig	object	Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler. (id: AutopilotConfig)
autoscaling	object	Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present. (id: NodePoolAutoscaling)
bestEffortProvisioning	object	Enable best effort provisioning for nodes (id: BestEffortProvisioning)
conditions	array	Output only. Which conditions caused the current node pool state.
config	object	The node configuration of the pool. (id: NodeConfig)
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 (int32)	The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
instanceGroupUrls	array	Output only. The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
kubeletCertInfo	object	Output only. Contains expiry information about the kubelet certificate. (id: KubeletCertInfo)
locations	array	The list of Google Compute Engine zones in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
maintenancePolicy	object	Optional. Specifies the maintenance policy for the node pool. (id: NodePoolMaintenancePolicy)
management	object	NodeManagement configuration for this NodePool. (id: NodeManagement)
maxPodsConstraint	object	The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. (id: MaxPodsConstraint)
networkConfig	object	Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. (id: NodeNetworkConfig)
nodeDrainConfig	object	Specifies the node drain configuration for this node pool. (id: NodeDrainConfig)
placementPolicy	object	Specifies the node placement policy. (id: PlacementPolicy)
podIpv4CidrSize	integer (int32)	Output only. The pod CIDR block size per node in this node pool.
queuedProvisioning	object	Specifies the configuration of queued provisioning. (id: QueuedProvisioning)
selfLink	string	Output only. Server-defined URL for the resource.
status	string	Output only. The status of the nodes in this pool instance. (STATUS_UNSPECIFIED, PROVISIONING, RUNNING, RUNNING_WITH_ERROR, RECONCILING, STOPPING, ERROR)
statusMessage	string	Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
updateInfo	object	Output only. Update info contains relevant information during a node pool update. (id: UpdateInfo)
upgradeSettings	object	Upgrade settings control disruption and speed of the upgrade. (id: UpgradeSettings)
version	string	The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.

projects_zones_clusters_node_pools_list

Name	Datatype	Description
nodePools	array	A list of node pools for a cluster.

projects_locations_clusters_node_pools_list

Name	Datatype	Description
nodePools	array	A list of node pools for a cluster.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_zones_clusters_node_pools_get	select	projectId, zone, clusterId, nodePoolId	name	Retrieves the requested node pool.
projects_locations_clusters_node_pools_get	select	projectsId, locationsId, clustersId, nodePoolsId	clusterId, nodePoolId, zone, projectId	Retrieves the requested node pool.
projects_zones_clusters_node_pools_list	select	projectId, zone, clusterId	parent	Lists the node pools for a cluster.
projects_locations_clusters_node_pools_list	select	projectsId, locationsId, clustersId	zone, projectId, clusterId	Lists the node pools for a cluster.
projects_zones_clusters_node_pools_create	insert	projectId, zone, clusterId		Creates a node pool for a cluster.
projects_locations_clusters_node_pools_create	insert	projectsId, locationsId, clustersId		Creates a node pool for a cluster.
projects_zones_clusters_node_pools_update	update	projectId, zone, clusterId, nodePoolId		Updates the version and/or image type for the specified node pool.
projects_locations_clusters_node_pools_update	replace	projectsId, locationsId, clustersId, nodePoolsId		Updates the version and/or image type for the specified node pool.
projects_zones_clusters_node_pools_delete	delete	projectId, zone, clusterId, nodePoolId	name	Deletes a node pool from a cluster.
projects_locations_clusters_node_pools_delete	delete	projectsId, locationsId, clustersId, nodePoolsId	clusterId, zone, nodePoolId, projectId	Deletes a node pool from a cluster.
projects_zones_clusters_node_pools_autoscaling	exec	projectId, zone, clusterId, nodePoolId		Sets the autoscaling settings for the specified node pool.
projects_zones_clusters_node_pools_rollback	exec	projectId, zone, clusterId, nodePoolId		Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
projects_zones_clusters_node_pools_set_management	exec	projectId, zone, clusterId, nodePoolId		Sets the NodeManagement options for a node pool.
projects_zones_clusters_node_pools_set_size	exec	projectId, zone, clusterId, nodePoolId		Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.
projects_locations_clusters_node_pools_set_size	exec	projectsId, locationsId, clustersId, nodePoolsId		Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.
projects_locations_clusters_node_pools_rollback	exec	projectsId, locationsId, clustersId, nodePoolsId		Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
projects_locations_clusters_node_pools_set_management	exec	projectsId, locationsId, clustersId, nodePoolsId		Sets the NodeManagement options for a node pool.
projects_locations_clusters_node_pools_complete_upgrade	exec	projectsId, locationsId, clustersId, nodePoolsId		CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.
projects_locations_clusters_node_pools_set_autoscaling	exec	projectsId, locationsId, clustersId, nodePoolsId		Sets the autoscaling settings for the specified node pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clusterId	string
clustersId	string
locationsId	string
nodePoolId	string
nodePoolsId	string
projectId	string
projectsId	string
zone	string
clusterId	string
name	string
nodePoolId	string
parent	string
projectId	string
zone	string

SELECT examples

projects_zones_clusters_node_pools_get

Retrieves the requested node pool.

SELECT
name,
autopilotConfig,
autoscaling,
bestEffortProvisioning,
conditions,
config,
etag,
initialNodeCount,
instanceGroupUrls,
kubeletCertInfo,
locations,
maintenancePolicy,
management,
maxPodsConstraint,
networkConfig,
nodeDrainConfig,
placementPolicy,
podIpv4CidrSize,
queuedProvisioning,
selfLink,
status,
statusMessage,
updateInfo,
upgradeSettings,
version
FROM google.container.node_pools
WHERE projectId = '{{ projectId }}' -- required
AND zone = '{{ zone }}' -- required
AND clusterId = '{{ clusterId }}' -- required
AND nodePoolId = '{{ nodePoolId }}' -- required
AND name = '{{ name }}'
;

projects_locations_clusters_node_pools_get

Retrieves the requested node pool.

SELECT
name,
autopilotConfig,
autoscaling,
bestEffortProvisioning,
conditions,
config,
etag,
initialNodeCount,
instanceGroupUrls,
kubeletCertInfo,
locations,
maintenancePolicy,
management,
maxPodsConstraint,
networkConfig,
nodeDrainConfig,
placementPolicy,
podIpv4CidrSize,
queuedProvisioning,
selfLink,
status,
statusMessage,
updateInfo,
upgradeSettings,
version
FROM google.container.node_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND nodePoolsId = '{{ nodePoolsId }}' -- required
AND clusterId = '{{ clusterId }}'
AND nodePoolId = '{{ nodePoolId }}'
AND zone = '{{ zone }}'
AND projectId = '{{ projectId }}'
;

projects_zones_clusters_node_pools_list

Lists the node pools for a cluster.

SELECT
nodePools
FROM google.container.node_pools
WHERE projectId = '{{ projectId }}' -- required
AND zone = '{{ zone }}' -- required
AND clusterId = '{{ clusterId }}' -- required
AND parent = '{{ parent }}'
;

projects_locations_clusters_node_pools_list

Lists the node pools for a cluster.

SELECT
nodePools
FROM google.container.node_pools
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND clustersId = '{{ clustersId }}' -- required
AND zone = '{{ zone }}'
AND projectId = '{{ projectId }}'
AND clusterId = '{{ clusterId }}'
;

INSERT examples

projects_zones_clusters_node_pools_create

Creates a node pool for a cluster.

INSERT INTO google.container.node_pools (
data__zone,
data__projectId,
data__nodePool,
data__clusterId,
data__parent,
projectId,
zone,
clusterId
)
SELECT 
'{{ zone }}',
'{{ projectId }}',
'{{ nodePool }}',
'{{ clusterId }}',
'{{ parent }}',
'{{ projectId }}',
'{{ zone }}',
'{{ clusterId }}'
RETURNING
name,
clusterConditions,
detail,
endTime,
error,
location,
nodepoolConditions,
operationType,
progress,
selfLink,
startTime,
status,
statusMessage,
targetLink,
zone
;

projects_locations_clusters_node_pools_create

Creates a node pool for a cluster.

INSERT INTO google.container.node_pools (
data__zone,
data__projectId,
data__nodePool,
data__clusterId,
data__parent,
projectsId,
locationsId,
clustersId
)
SELECT 
'{{ zone }}',
'{{ projectId }}',
'{{ nodePool }}',
'{{ clusterId }}',
'{{ parent }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ clustersId }}'
RETURNING
name,
clusterConditions,
detail,
endTime,
error,
location,
nodepoolConditions,
operationType,
progress,
selfLink,
startTime,
status,
statusMessage,
targetLink,
zone
;

Manifest

# Description fields are for documentation purposes
- name: node_pools
props:
  - name: projectId
    value: "{{ projectId }}"
    description: Required parameter for the node_pools resource.
  - name: zone
    value: "{{ zone }}"
    description: Required parameter for the node_pools resource.
  - name: clusterId
    value: "{{ clusterId }}"
    description: Required parameter for the node_pools resource.
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the node_pools resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the node_pools resource.
  - name: clustersId
    value: "{{ clustersId }}"
    description: Required parameter for the node_pools resource.
  - name: zone
    value: "{{ zone }}"
    description: |
      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.
  - name: projectId
    value: "{{ projectId }}"
    description: |
      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.
  - name: nodePool
    description: |
      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.
    value:
      config:
        windowsNodeConfig:
          osVersion: "{{ osVersion }}"
        gpuDirectConfig:
          gpuDirectStrategy: "{{ gpuDirectStrategy }}"
        metadata: "{{ metadata }}"
        diskSizeGb: {{ diskSizeGb }}
        serviceAccount: "{{ serviceAccount }}"
        machineType: "{{ machineType }}"
        advancedMachineFeatures:
          enableNestedVirtualization: {{ enableNestedVirtualization }}
          performanceMonitoringUnit: "{{ performanceMonitoringUnit }}"
          threadsPerCore: "{{ threadsPerCore }}"
        bootDiskKmsKey: "{{ bootDiskKmsKey }}"
        sandboxConfig:
          type: "{{ type }}"
        storagePools:
          - "{{ storagePools }}"
        minCpuPlatform: "{{ minCpuPlatform }}"
        diskType: "{{ diskType }}"
        resourceLabels: "{{ resourceLabels }}"
        soleTenantConfig:
          minNodeCpus: {{ minNodeCpus }}
          nodeAffinities:
            - operator: "{{ operator }}"
              key: "{{ key }}"
              values: "{{ values }}"
        loggingConfig:
          variantConfig:
            variant: "{{ variant }}"
        localSsdEncryptionMode: "{{ localSsdEncryptionMode }}"
        labels: "{{ labels }}"
        preemptible: {{ preemptible }}
        ephemeralStorageLocalSsdConfig:
          localSsdCount: {{ localSsdCount }}
          dataCacheCount: {{ dataCacheCount }}
        containerdConfig:
          writableCgroups:
            enabled: {{ enabled }}
          privateRegistryAccessConfig:
            enabled: {{ enabled }}
            certificateAuthorityDomainConfig:
              - fqdns: "{{ fqdns }}"
                gcpSecretManagerCertificateConfig:
                  secretUri: "{{ secretUri }}"
          registryHosts:
            - hosts: "{{ hosts }}"
              server: "{{ server }}"
        imageType: "{{ imageType }}"
        maxRunDuration: "{{ maxRunDuration }}"
        spot: {{ spot }}
        reservationAffinity:
          consumeReservationType: "{{ consumeReservationType }}"
          values:
            - "{{ values }}"
          key: "{{ key }}"
        secondaryBootDiskUpdateStrategy: "{{ secondaryBootDiskUpdateStrategy }}"
        localNvmeSsdBlockConfig:
          localSsdCount: {{ localSsdCount }}
        flexStart: {{ flexStart }}
        nodeGroup: "{{ nodeGroup }}"
        effectiveCgroupMode: "{{ effectiveCgroupMode }}"
        gcfsConfig:
          enabled: {{ enabled }}
        secondaryBootDisks:
          - mode: "{{ mode }}"
            diskImage: "{{ diskImage }}"
        linuxNodeConfig:
          sysctls: "{{ sysctls }}"
          transparentHugepageDefrag: "{{ transparentHugepageDefrag }}"
          diskIoScheduler:
            nodeSystemIoScheduler: "{{ nodeSystemIoScheduler }}"
            nodeAttachedDiskIoScheduler: "{{ nodeAttachedDiskIoScheduler }}"
          transparentHugepageEnabled: "{{ transparentHugepageEnabled }}"
          nodeKernelModuleLoading:
            policy: "{{ policy }}"
          nodeVfioConfig:
            dmaEntryLimit: {{ dmaEntryLimit }}
          customNodeInit:
            initScript:
              args: "{{ args }}"
              gcsUri: "{{ gcsUri }}"
              gcsGeneration: "{{ gcsGeneration }}"
              gcpSecretManagerSecretUri: "{{ gcpSecretManagerSecretUri }}"
          hugepages:
            hugepageSize2m: {{ hugepageSize2m }}
            hugepageSize1g: {{ hugepageSize1g }}
          swapConfig:
            encryptionConfig:
              disabled: {{ disabled }}
            ephemeralLocalSsdProfile:
              swapSizeGib: "{{ swapSizeGib }}"
              swapSizePercent: {{ swapSizePercent }}
            dedicatedLocalSsdProfile:
              diskCount: "{{ diskCount }}"
            enabled: {{ enabled }}
            bootDiskProfile:
              swapSizeGib: "{{ swapSizeGib }}"
              swapSizePercent: {{ swapSizePercent }}
          cgroupMode: "{{ cgroupMode }}"
          accurateTimeConfig:
            enablePtpKvmTimeSync: {{ enablePtpKvmTimeSync }}
        confidentialNodes:
          enabled: {{ enabled }}
          confidentialInstanceType: "{{ confidentialInstanceType }}"
        nodeImageConfig:
          image: "{{ image }}"
          imageProject: "{{ imageProject }}"
        accelerators:
          - gpuPartitionSize: "{{ gpuPartitionSize }}"
            acceleratorCount: "{{ acceleratorCount }}"
            gpuDriverInstallationConfig:
              gpuDriverVersion: "{{ gpuDriverVersion }}"
            gpuSharingConfig:
              maxSharedClientsPerGpu: "{{ maxSharedClientsPerGpu }}"
              gpuSharingStrategy: "{{ gpuSharingStrategy }}"
            acceleratorType: "{{ acceleratorType }}"
        bootDisk:
          diskType: "{{ diskType }}"
          provisionedThroughput: "{{ provisionedThroughput }}"
          sizeGb: "{{ sizeGb }}"
          provisionedIops: "{{ provisionedIops }}"
        workloadMetadataConfig:
          mode: "{{ mode }}"
        gvnic:
          enabled: {{ enabled }}
        fastSocket:
          enabled: {{ enabled }}
        enableConfidentialStorage: {{ enableConfidentialStorage }}
        taints:
          - key: "{{ key }}"
            value: "{{ value }}"
            effect: "{{ effect }}"
        oauthScopes:
          - "{{ oauthScopes }}"
        resourceManagerTags:
          tags: "{{ tags }}"
        tags:
          - "{{ tags }}"
        taintConfig:
          architectureTaintBehavior: "{{ architectureTaintBehavior }}"
        localSsdCount: {{ localSsdCount }}
        shieldedInstanceConfig:
          enableSecureBoot: {{ enableSecureBoot }}
          enableIntegrityMonitoring: {{ enableIntegrityMonitoring }}
        consolidationDelay: "{{ consolidationDelay }}"
        kubeletConfig:
          singleProcessOomKill: {{ singleProcessOomKill }}
          podPidsLimit: "{{ podPidsLimit }}"
          insecureKubeletReadonlyPortEnabled: {{ insecureKubeletReadonlyPortEnabled }}
          containerLogMaxFiles: {{ containerLogMaxFiles }}
          memoryManager:
            policy: "{{ policy }}"
          topologyManager:
            policy: "{{ policy }}"
            scope: "{{ scope }}"
          imageMinimumGcAge: "{{ imageMinimumGcAge }}"
          imageGcHighThresholdPercent: {{ imageGcHighThresholdPercent }}
          cpuCfsQuotaPeriod: "{{ cpuCfsQuotaPeriod }}"
          shutdownGracePeriodSeconds: {{ shutdownGracePeriodSeconds }}
          cpuCfsQuota: {{ cpuCfsQuota }}
          imageGcLowThresholdPercent: {{ imageGcLowThresholdPercent }}
          allowedUnsafeSysctls:
            - "{{ allowedUnsafeSysctls }}"
          evictionMinimumReclaim:
            nodefsInodesFree: "{{ nodefsInodesFree }}"
            memoryAvailable: "{{ memoryAvailable }}"
            imagefsInodesFree: "{{ imagefsInodesFree }}"
            imagefsAvailable: "{{ imagefsAvailable }}"
            nodefsAvailable: "{{ nodefsAvailable }}"
            pidAvailable: "{{ pidAvailable }}"
          shutdownGracePeriodCriticalPodsSeconds: {{ shutdownGracePeriodCriticalPodsSeconds }}
          evictionSoftGracePeriod:
            nodefsInodesFree: "{{ nodefsInodesFree }}"
            memoryAvailable: "{{ memoryAvailable }}"
            imagefsInodesFree: "{{ imagefsInodesFree }}"
            imagefsAvailable: "{{ imagefsAvailable }}"
            nodefsAvailable: "{{ nodefsAvailable }}"
            pidAvailable: "{{ pidAvailable }}"
          maxParallelImagePulls: {{ maxParallelImagePulls }}
          imageMaximumGcAge: "{{ imageMaximumGcAge }}"
          evictionSoft:
            nodefsInodesFree: "{{ nodefsInodesFree }}"
            memoryAvailable: "{{ memoryAvailable }}"
            imagefsInodesFree: "{{ imagefsInodesFree }}"
            imagefsAvailable: "{{ imagefsAvailable }}"
            pidAvailable: "{{ pidAvailable }}"
            nodefsAvailable: "{{ nodefsAvailable }}"
          cpuManagerPolicy: "{{ cpuManagerPolicy }}"
          evictionMaxPodGracePeriodSeconds: {{ evictionMaxPodGracePeriodSeconds }}
          crashLoopBackOff:
            maxContainerRestartPeriod: "{{ maxContainerRestartPeriod }}"
          containerLogMaxSize: "{{ containerLogMaxSize }}"
      etag: "{{ etag }}"
      initialNodeCount: {{ initialNodeCount }}
      upgradeSettings:
        blueGreenSettings:
          nodePoolSoakDuration: "{{ nodePoolSoakDuration }}"
          standardRolloutPolicy:
            batchNodeCount: {{ batchNodeCount }}
            batchPercentage: {{ batchPercentage }}
            batchSoakDuration: "{{ batchSoakDuration }}"
          autoscaledRolloutPolicy:
            waitForDrainDuration: "{{ waitForDrainDuration }}"
        maxSurge: {{ maxSurge }}
        maxUnavailable: {{ maxUnavailable }}
        strategy: "{{ strategy }}"
      placementPolicy:
        policyName: "{{ policyName }}"
        type: "{{ type }}"
        tpuTopology: "{{ tpuTopology }}"
      queuedProvisioning:
        enabled: {{ enabled }}
      autoscaling:
        maxNodeCount: {{ maxNodeCount }}
        totalMaxNodeCount: {{ totalMaxNodeCount }}
        enabled: {{ enabled }}
        minNodeCount: {{ minNodeCount }}
        locationPolicy: "{{ locationPolicy }}"
        totalMinNodeCount: {{ totalMinNodeCount }}
        autoprovisioned: {{ autoprovisioned }}
      conditions:
        - message: "{{ message }}"
          code: "{{ code }}"
          canonicalCode: "{{ canonicalCode }}"
      bestEffortProvisioning:
        enabled: {{ enabled }}
        minProvisionNodes: {{ minProvisionNodes }}
      version: "{{ version }}"
      maxPodsConstraint:
        maxPodsPerNode: "{{ maxPodsPerNode }}"
      autopilotConfig:
        enabled: {{ enabled }}
      name: "{{ name }}"
      locations:
        - "{{ locations }}"
      statusMessage: "{{ statusMessage }}"
      instanceGroupUrls:
        - "{{ instanceGroupUrls }}"
      status: "{{ status }}"
      networkConfig:
        network: "{{ network }}"
        networkTierConfig:
          networkTier: "{{ networkTier }}"
        podCidrOverprovisionConfig:
          disable: {{ disable }}
        additionalPodNetworkConfigs:
          - subnetwork: "{{ subnetwork }}"
            secondaryPodRange: "{{ secondaryPodRange }}"
            maxPodsPerNode:
              maxPodsPerNode: "{{ maxPodsPerNode }}"
            networkAttachment: "{{ networkAttachment }}"
        subnetwork: "{{ subnetwork }}"
        acceleratorNetworkProfile: "{{ acceleratorNetworkProfile }}"
        networkPerformanceConfig:
          totalEgressBandwidthTier: "{{ totalEgressBandwidthTier }}"
        podRange: "{{ podRange }}"
        enablePrivateNodes: {{ enablePrivateNodes }}
        podIpv4RangeUtilization: {{ podIpv4RangeUtilization }}
        createPodRange: {{ createPodRange }}
        podIpv4CidrBlock: "{{ podIpv4CidrBlock }}"
        additionalNodeNetworkConfigs:
          - network: "{{ network }}"
            subnetwork: "{{ subnetwork }}"
      kubeletCertInfo:
        nonTpmBootstrapCertExpireTime: "{{ nonTpmBootstrapCertExpireTime }}"
        tpmBootstrapCertExpireTime: "{{ tpmBootstrapCertExpireTime }}"
      updateInfo:
        blueGreenInfo:
          greenPoolVersion: "{{ greenPoolVersion }}"
          bluePoolDeletionStartTime: "{{ bluePoolDeletionStartTime }}"
          blueInstanceGroupUrls:
            - "{{ blueInstanceGroupUrls }}"
          phase: "{{ phase }}"
          greenInstanceGroupUrls:
            - "{{ greenInstanceGroupUrls }}"
      management:
        upgradeOptions:
          autoUpgradeStartTime: "{{ autoUpgradeStartTime }}"
          description: "{{ description }}"
        autoUpgrade: {{ autoUpgrade }}
        autoRepair: {{ autoRepair }}
      maintenancePolicy:
        exclusionUntilEndOfSupport:
          endTime: "{{ endTime }}"
          enabled: {{ enabled }}
          startTime: "{{ startTime }}"
      podIpv4CidrSize: {{ podIpv4CidrSize }}
      selfLink: "{{ selfLink }}"
      nodeDrainConfig:
        respectPdbDuringNodePoolDeletion: {{ respectPdbDuringNodePoolDeletion }}
        pdbTimeoutDuration: "{{ pdbTimeoutDuration }}"
        graceTerminationDuration: "{{ graceTerminationDuration }}"
  - name: clusterId
    value: "{{ clusterId }}"
    description: |
      Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field.
  - name: parent
    value: "{{ parent }}"
    description: |
      The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`.

UPDATE examples

projects_zones_clusters_node_pools_update

Updates the version and/or image type for the specified node pool.

UPDATE google.container.node_pools
SET 
data__fastSocket = '{{ fastSocket }}',
data__maintenancePolicy = '{{ maintenancePolicy }}',
data__taints = '{{ taints }}',
data__nodeDrainConfig = '{{ nodeDrainConfig }}',
data__nodePoolId = '{{ nodePoolId }}',
data__labels = '{{ labels }}',
data__resourceManagerTags = '{{ resourceManagerTags }}',
data__tags = '{{ tags }}',
data__taintConfig = '{{ taintConfig }}',
data__containerdConfig = '{{ containerdConfig }}',
data__imageType = '{{ imageType }}',
data__maxRunDuration = '{{ maxRunDuration }}',
data__name = '{{ name }}',
data__locations = '{{ locations }}',
data__consolidationDelay = '{{ consolidationDelay }}',
data__nodeVersion = '{{ nodeVersion }}',
data__kubeletConfig = '{{ kubeletConfig }}',
data__flexStart = {{ flexStart }},
data__windowsNodeConfig = '{{ windowsNodeConfig }}',
data__projectId = '{{ projectId }}',
data__diskSizeGb = '{{ diskSizeGb }}',
data__gcfsConfig = '{{ gcfsConfig }}',
data__clusterId = '{{ clusterId }}',
data__machineType = '{{ machineType }}',
data__nodeNetworkConfig = '{{ nodeNetworkConfig }}',
data__zone = '{{ zone }}',
data__linuxNodeConfig = '{{ linuxNodeConfig }}',
data__imageProject = '{{ imageProject }}',
data__confidentialNodes = '{{ confidentialNodes }}',
data__accelerators = '{{ accelerators }}',
data__bootDisk = '{{ bootDisk }}',
data__image = '{{ image }}',
data__workloadMetadataConfig = '{{ workloadMetadataConfig }}',
data__queuedProvisioning = '{{ queuedProvisioning }}',
data__storagePools = '{{ storagePools }}',
data__gvnic = '{{ gvnic }}',
data__etag = '{{ etag }}',
data__diskType = '{{ diskType }}',
data__resourceLabels = '{{ resourceLabels }}',
data__loggingConfig = '{{ loggingConfig }}',
data__upgradeSettings = '{{ upgradeSettings }}'
WHERE 
projectId = '{{ projectId }}' --required
AND zone = '{{ zone }}' --required
AND clusterId = '{{ clusterId }}' --required
AND nodePoolId = '{{ nodePoolId }}' --required
RETURNING
name,
clusterConditions,
detail,
endTime,
error,
location,
nodepoolConditions,
operationType,
progress,
selfLink,
startTime,
status,
statusMessage,
targetLink,
zone;

REPLACE examples

projects_locations_clusters_node_pools_update

Updates the version and/or image type for the specified node pool.

REPLACE google.container.node_pools
SET 
data__fastSocket = '{{ fastSocket }}',
data__maintenancePolicy = '{{ maintenancePolicy }}',
data__taints = '{{ taints }}',
data__nodeDrainConfig = '{{ nodeDrainConfig }}',
data__nodePoolId = '{{ nodePoolId }}',
data__labels = '{{ labels }}',
data__resourceManagerTags = '{{ resourceManagerTags }}',
data__tags = '{{ tags }}',
data__taintConfig = '{{ taintConfig }}',
data__containerdConfig = '{{ containerdConfig }}',
data__imageType = '{{ imageType }}',
data__maxRunDuration = '{{ maxRunDuration }}',
data__name = '{{ name }}',
data__locations = '{{ locations }}',
data__consolidationDelay = '{{ consolidationDelay }}',
data__nodeVersion = '{{ nodeVersion }}',
data__kubeletConfig = '{{ kubeletConfig }}',
data__flexStart = {{ flexStart }},
data__windowsNodeConfig = '{{ windowsNodeConfig }}',
data__projectId = '{{ projectId }}',
data__diskSizeGb = '{{ diskSizeGb }}',
data__gcfsConfig = '{{ gcfsConfig }}',
data__clusterId = '{{ clusterId }}',
data__machineType = '{{ machineType }}',
data__nodeNetworkConfig = '{{ nodeNetworkConfig }}',
data__zone = '{{ zone }}',
data__linuxNodeConfig = '{{ linuxNodeConfig }}',
data__imageProject = '{{ imageProject }}',
data__confidentialNodes = '{{ confidentialNodes }}',
data__accelerators = '{{ accelerators }}',
data__bootDisk = '{{ bootDisk }}',
data__image = '{{ image }}',
data__workloadMetadataConfig = '{{ workloadMetadataConfig }}',
data__queuedProvisioning = '{{ queuedProvisioning }}',
data__storagePools = '{{ storagePools }}',
data__gvnic = '{{ gvnic }}',
data__etag = '{{ etag }}',
data__diskType = '{{ diskType }}',
data__resourceLabels = '{{ resourceLabels }}',
data__loggingConfig = '{{ loggingConfig }}',
data__upgradeSettings = '{{ upgradeSettings }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND nodePoolsId = '{{ nodePoolsId }}' --required
RETURNING
name,
clusterConditions,
detail,
endTime,
error,
location,
nodepoolConditions,
operationType,
progress,
selfLink,
startTime,
status,
statusMessage,
targetLink,
zone;

DELETE examples

projects_zones_clusters_node_pools_delete

Deletes a node pool from a cluster.

DELETE FROM google.container.node_pools
WHERE projectId = '{{ projectId }}' --required
AND zone = '{{ zone }}' --required
AND clusterId = '{{ clusterId }}' --required
AND nodePoolId = '{{ nodePoolId }}' --required
AND name = '{{ name }}'
;

projects_locations_clusters_node_pools_delete

Deletes a node pool from a cluster.

DELETE FROM google.container.node_pools
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND clustersId = '{{ clustersId }}' --required
AND nodePoolsId = '{{ nodePoolsId }}' --required
AND clusterId = '{{ clusterId }}'
AND zone = '{{ zone }}'
AND nodePoolId = '{{ nodePoolId }}'
AND projectId = '{{ projectId }}'
;

Lifecycle Methods

projects_zones_clusters_node_pools_autoscaling

Sets the autoscaling settings for the specified node pool.

EXEC google.container.node_pools.projects_zones_clusters_node_pools_autoscaling 
@projectId='{{ projectId }}' --required, 
@zone='{{ zone }}' --required, 
@clusterId='{{ clusterId }}' --required, 
@nodePoolId='{{ nodePoolId }}' --required 
@@json=
'{
"projectId": "{{ projectId }}", 
"nodePoolId": "{{ nodePoolId }}", 
"zone": "{{ zone }}", 
"clusterId": "{{ clusterId }}", 
"name": "{{ name }}", 
"autoscaling": "{{ autoscaling }}"
}'
;

projects_zones_clusters_node_pools_rollback

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

EXEC google.container.node_pools.projects_zones_clusters_node_pools_rollback 
@projectId='{{ projectId }}' --required, 
@zone='{{ zone }}' --required, 
@clusterId='{{ clusterId }}' --required, 
@nodePoolId='{{ nodePoolId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"clusterId": "{{ clusterId }}", 
"respectPdb": {{ respectPdb }}, 
"projectId": "{{ projectId }}", 
"zone": "{{ zone }}", 
"nodePoolId": "{{ nodePoolId }}"
}'
;

projects_zones_clusters_node_pools_set_management

Sets the NodeManagement options for a node pool.

EXEC google.container.node_pools.projects_zones_clusters_node_pools_set_management 
@projectId='{{ projectId }}' --required, 
@zone='{{ zone }}' --required, 
@clusterId='{{ clusterId }}' --required, 
@nodePoolId='{{ nodePoolId }}' --required 
@@json=
'{
"projectId": "{{ projectId }}", 
"nodePoolId": "{{ nodePoolId }}", 
"zone": "{{ zone }}", 
"clusterId": "{{ clusterId }}", 
"name": "{{ name }}", 
"management": "{{ management }}"
}'
;

projects_zones_clusters_node_pools_set_size

Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

EXEC google.container.node_pools.projects_zones_clusters_node_pools_set_size 
@projectId='{{ projectId }}' --required, 
@zone='{{ zone }}' --required, 
@clusterId='{{ clusterId }}' --required, 
@nodePoolId='{{ nodePoolId }}' --required 
@@json=
'{
"clusterId": "{{ clusterId }}", 
"name": "{{ name }}", 
"projectId": "{{ projectId }}", 
"nodePoolId": "{{ nodePoolId }}", 
"nodeCount": {{ nodeCount }}, 
"zone": "{{ zone }}"
}'
;

projects_locations_clusters_node_pools_set_size

Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.

EXEC google.container.node_pools.projects_locations_clusters_node_pools_set_size 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@clustersId='{{ clustersId }}' --required, 
@nodePoolsId='{{ nodePoolsId }}' --required 
@@json=
'{
"clusterId": "{{ clusterId }}", 
"name": "{{ name }}", 
"projectId": "{{ projectId }}", 
"nodePoolId": "{{ nodePoolId }}", 
"nodeCount": {{ nodeCount }}, 
"zone": "{{ zone }}"
}'
;

projects_locations_clusters_node_pools_rollback

Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.

EXEC google.container.node_pools.projects_locations_clusters_node_pools_rollback 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@clustersId='{{ clustersId }}' --required, 
@nodePoolsId='{{ nodePoolsId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"clusterId": "{{ clusterId }}", 
"respectPdb": {{ respectPdb }}, 
"projectId": "{{ projectId }}", 
"zone": "{{ zone }}", 
"nodePoolId": "{{ nodePoolId }}"
}'
;

projects_locations_clusters_node_pools_set_management

Sets the NodeManagement options for a node pool.

EXEC google.container.node_pools.projects_locations_clusters_node_pools_set_management 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@clustersId='{{ clustersId }}' --required, 
@nodePoolsId='{{ nodePoolsId }}' --required 
@@json=
'{
"projectId": "{{ projectId }}", 
"nodePoolId": "{{ nodePoolId }}", 
"zone": "{{ zone }}", 
"clusterId": "{{ clusterId }}", 
"name": "{{ name }}", 
"management": "{{ management }}"
}'
;

projects_locations_clusters_node_pools_complete_upgrade

CompleteNodePoolUpgrade will signal an on-going node pool upgrade to complete.

EXEC google.container.node_pools.projects_locations_clusters_node_pools_complete_upgrade 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@clustersId='{{ clustersId }}' --required, 
@nodePoolsId='{{ nodePoolsId }}' --required
;

projects_locations_clusters_node_pools_set_autoscaling

Sets the autoscaling settings for the specified node pool.

EXEC google.container.node_pools.projects_locations_clusters_node_pools_set_autoscaling 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@clustersId='{{ clustersId }}' --required, 
@nodePoolsId='{{ nodePoolsId }}' --required 
@@json=
'{
"projectId": "{{ projectId }}", 
"nodePoolId": "{{ nodePoolId }}", 
"zone": "{{ zone }}", 
"clusterId": "{{ clusterId }}", 
"name": "{{ name }}", 
"autoscaling": "{{ autoscaling }}"
}'
;