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

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: container1 --scope <scope> projects locations-clusters-node-pools-update ...

Required Scalar Argument

  • <name> (string)
    • The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

UpdateNodePoolRequest:
  cluster-id: string
  confidential-nodes:
    enabled: boolean
  disk-size-gb: string
  disk-type: string
  etag: string
  fast-socket:
    enabled: boolean
  gcfs-config:
    enabled: boolean
  gvnic:
    enabled: boolean
  image-type: string
  kubelet-config:
    cpu-cfs-quota: boolean
    cpu-cfs-quota-period: string
    cpu-manager-policy: string
    insecure-kubelet-readonly-port-enabled: boolean
    pod-pids-limit: string
  labels:
    labels: { string: string }
  linux-node-config:
    cgroup-mode: string
    sysctls: { string: string }
  locations: [string]
  logging-config:
    variant-config:
      variant: string
  machine-type: string
  name: string
  node-network-config:
    create-pod-range: boolean
    enable-private-nodes: boolean
    network-performance-config:
      total-egress-bandwidth-tier: string
    pod-cidr-overprovision-config:
      disable: boolean
    pod-ipv4-cidr-block: string
    pod-ipv4-range-utilization: number
    pod-range: string
  node-pool-id: string
  node-version: string
  project-id: string
  queued-provisioning:
    enabled: boolean
  resource-labels:
    labels: { string: string }
  resource-manager-tags:
    tags: { string: string }
  tags:
    tags: [string]
  upgrade-settings:
    blue-green-settings:
      node-pool-soak-duration: string
      standard-rollout-policy:
        batch-node-count: integer
        batch-percentage: number
        batch-soak-duration: string
    max-surge: integer
    max-unavailable: integer
    strategy: string
  windows-node-config:
    os-version: string
  workload-metadata-config:
    mode: string
  zone: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . cluster-id=no
    • Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
  • confidential-nodes enabled=true

    • Whether Confidential Nodes feature is enabled.
  • .. disk-size-gb=ipsum

    • Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size.
  • disk-type=sea
    • Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type.
  • etag=sit
    • The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned.
  • fast-socket enabled=true

    • Whether Fast Socket features are enabled in the node pool.
  • ..gcfs-config enabled=true

    • Whether to use GCFS.
  • ..gvnic enabled=false

    • Whether gVNIC features are enabled in the node pool.
  • .. image-type=invidunt

    • Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
  • kubelet-config cpu-cfs-quota=false
    • 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.
  • cpu-cfs-quota-period=gubergren
    • 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.
  • cpu-manager-policy=elitr
    • 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.
  • insecure-kubelet-readonly-port-enabled=true
    • Enable or disable Kubelet read only port.
  • pod-pids-limit=kasd

    • 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.
  • ..labels labels=key=dolore

    • Map of node label keys and node label values.
    • the value will be associated with the given key
  • ..linux-node-config cgroup-mode=lorem

    • cgroup_mode specifies the cgroup mode to be used on the node.
  • sysctls=key=amet

    • 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.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse
    • the value will be associated with the given key
  • .. locations=ipsum

    • The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.
    • Each invocation of this argument appends the given value to the array.
  • logging-config.variant-config variant=lorem

    • Logging variant deployed on nodes.
  • ... machine-type=dolores

    • Optional. The desired Google Compute Engine machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.
  • name=consetetur
    • The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*.
  • node-network-config create-pod-range=true
    • 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.
  • enable-private-nodes=true
    • Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from cluster.privateClusterConfig.enablePrivateNodes
  • network-performance-config total-egress-bandwidth-tier=nonumy

    • Specifies the total network bandwidth tier for the NodePool.
  • ..pod-cidr-overprovision-config disable=true

    • Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
  • .. pod-ipv4-cidr-block=eos

    • 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 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.
  • pod-ipv4-range-utilization=0.5236717061304316
    • Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodesnumZonespodIPsPerNode.
  • pod-range=elitr

    • 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.
  • .. node-pool-id=sed

    • Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
  • node-version=labore
    • Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
  • project-id=et
  • queued-provisioning enabled=false

    • Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
  • ..resource-labels labels=key=sed

    • Map of node label keys and node label values.
    • the value will be associated with the given key
  • ..resource-manager-tags tags=key=at

    • 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}
    • the value will be associated with the given key
  • ..tags tags=stet

    • List of network tags.
    • Each invocation of this argument appends the given value to the array.
  • ..upgrade-settings.blue-green-settings node-pool-soak-duration=sit

    • Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
  • standard-rollout-policy batch-node-count=46
    • Number of blue nodes to drain in a batch.
  • batch-percentage=0.7454899800701926
    • Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
  • batch-soak-duration=amet

    • Soak time after each batch gets drained. Default to zero.
  • ... max-surge=18

    • The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
  • max-unavailable=18
    • 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=invidunt

    • Update strategy of the node pool.
  • ..windows-node-config os-version=et

    • OSVersion specifies the Windows node config to be used on the node
  • ..workload-metadata-config mode=et

    • Mode is the configuration for how to expose metadata to workloads running on the node pool.
  • .. zone=dolor

    • Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.
  • -p access-token=string

    • OAuth access token.
  • -p alt=string

    • Data format for response.
  • -p callback=string

    • JSONP
  • -p fields=string

    • Selector specifying which fields to include in a partial response.
  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  • -p oauth-token=string

    • OAuth 2.0 token for the current user.
  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.
  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").
  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").