imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-09 19:06:53 +00:00
Code Activity
gcloud-help/gcloud/alpha/container/node-pools/update
Automated aaff695a08 gcloud: Wed Feb 11 11:28:24 UTC 2026
2026-02-11 11:28:25 +00:00

1110 lines
58 KiB
Text
Raw Blame History

NAME
gcloud alpha container node-pools update - updates a node pool in a running
cluster
SYNOPSIS
gcloud alpha container node-pools update NAME
(--accelerator=[type=TYPE,[count=COUNT,
gpu-driver-version=GPU_DRIVER_VERSION,
gpu-partition-size=GPU_PARTITION_SIZE,
gpu-sharing-strategy=GPU_SHARING_STRATEGY,
max-shared-clients-per-gpu=MAX_SHARED_CLIENTS_PER_GPU],...]
| --confidential-node-type=CONFIDENTIAL_NODE_TYPE
| --containerd-config-from-file=PATH_TO_FILE
| --enable-confidential-nodes | --enable-gvnic
| --enable-image-streaming | --enable-insecure-kubelet-readonly-port
| --enable-kernel-module-signature-enforcement
| --enable-private-nodes | --enable-queued-provisioning
| --flex-start | --labels=[KEY=VALUE,...]
| --logging-variant=LOGGING_VARIANT
| --max-run-duration=MAX_RUN_DURATION
| --network-performance-configs=[PROPERTY=VALUE,...]
| --node-labels=[NODE_LABEL,...] | --node-locations=ZONE,[ZONE,...]
| --node-taints=[NODE_TAINT,...]
| --resource-manager-tags=[KEY=VALUE,...]
| --storage-pools=STORAGE_POOL,[...]
| --system-config-from-file=PATH_TO_FILE | --tags=[TAG,...]
| --windows-os-version=WINDOWS_OS_VERSION
| --workload-metadata=WORKLOAD_METADATA
| --autoscaled-rollout-policy=[wait-for-drain-duration=WAIT-FOR-DRAIN-DURATION] --enable-blue-green-upgrade --enable-surge-upgrade --max-surge-upgrade=MAX_SURGE_UPGRADE --max-unavailable-upgrade=MAX_UNAVAILABLE_UPGRADE --node-pool-soak-duration=NODE_POOL_SOAK_DURATION --standard-rollout-policy=[batch-node-count=BATCH_NODE_COUNT,
batch-percent=BATCH_NODE_PERCENTAGE,
batch-soak-duration=BATCH_SOAK_DURATION,...]
| --boot-disk-provisioned-iops=BOOT_DISK_PROVISIONED_IOPS
--boot-disk-provisioned-throughput=BOOT_DISK_PROVISIONED_THROUGHPUT
--disk-size=DISK_SIZE
--disk-type=DISK_TYPE --machine-type=MACHINE_TYPE
| --enable-autoprovisioning --enable-autoscaling
--location-policy=LOCATION_POLICY --max-nodes=MAX_NODES
--min-nodes=MIN_NODES
--total-max-nodes=TOTAL_MAX_NODES --total-min-nodes=TOTAL_MIN_NODES
| --enable-autorepair --enable-autoupgrade
| --node-drain-grace-period-seconds=NODE_DRAIN_GRACE_PERIOD_SECONDS
--node-drain-pdb-timeout-seconds=NODE_DRAIN_PDB_TIMEOUT_SECONDS
--respect-pdb-during-node-pool-deletion) [--async]
[--cluster=CLUSTER]
[--location=LOCATION | --region=REGION | --zone=ZONE, -z ZONE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) gcloud alpha container node-pools update updates a node pool in a
Google Kubernetes Engine cluster.
EXAMPLES
To turn on node autoupgrade in "node-pool-1" in the cluster
"sample-cluster", run:
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=sample-cluster --enable-autoupgrade
POSITIONAL ARGUMENTS
NAME
The name of the node pool.
REQUIRED FLAGS
Exactly one of these must be specified:
--accelerator=[type=TYPE,[count=COUNT,gpu-driver-version=GPU_DRIVER_VERSION,gpu-partition-size=GPU_PARTITION_SIZE,gpu-sharing-strategy=GPU_SHARING_STRATEGY,max-shared-clients-per-gpu=MAX_SHARED_CLIENTS_PER_GPU],...]
Attaches accelerators (e.g. GPUs) to all nodes.
type
(Required) The specific type (e.g. nvidia-tesla-t4 for NVIDIA T4)
of accelerator to attach to the instances. Use gcloud compute
accelerator-types list to learn about all available accelerator
types.
count
(Optional) The number of accelerators to attach to the instances.
The default value is 1.
gpu-driver-version
(Optional) The NVIDIA driver version to install.
GPU_DRIVER_VERSION must be one of:
`default`: Install the default driver version for this GKE version. For GKE version 1.30.1-gke.1156000 and later, this is the default option.
`latest`: Install the latest driver version available for this GKE version.
Can only be used for nodes that use Container-Optimized OS.
`disabled`: Skip automatic driver installation. You must manually install a
driver after you create the cluster. For GKE version 1.30.1-gke.1156000 and earlier, this is the default option.
To manually install the GPU driver, refer to https://cloud.google.com/kubernetes-engine/docs/how-to/gpus#installing_drivers.
gpu-partition-size
(Optional) The GPU partition size used when running
multi-instance GPUs. For information about multi-instance GPUs,
refer to:
https://cloud.google.com/kubernetes-engine/docs/how-to/gpus-multi
gpu-sharing-strategy
(Optional) The GPU sharing strategy (e.g. time-sharing) to use.
For information about GPU sharing, refer to:
https://cloud.google.com/kubernetes-engine/docs/concepts/timesharing-gpus
max-shared-clients-per-gpu
(Optional) The max number of containers allowed to share each GPU
on the node. This field is used together with
gpu-sharing-strategy.
--confidential-node-type=CONFIDENTIAL_NODE_TYPE
Recreate all the nodes in the node pool to be confidential VM
https://docs.cloud.google.com/compute/docs/about-confidential-vm.
CONFIDENTIAL_NODE_TYPE must be one of: sev, sev_snp, tdx, disabled.
--containerd-config-from-file=PATH_TO_FILE
Path of the YAML file that contains containerd configuration entries
like configuring access to private image registries.
For detailed information on the configuration usage, please refer to
https://cloud.google.com/kubernetes-engine/docs/how-to/customize-containerd-configuration.
Note: Updating the containerd configuration of an existing cluster or
node pool requires recreation of the existing nodes, which might
cause disruptions in running workloads.
Use a full or relative path to a local file containing the value of
containerd_config.
--enable-confidential-nodes
Recreate all the nodes in the node pool to be confidential VM
https://docs.cloud.google.com/compute/docs/about-confidential-vm.
--enable-gvnic
Enable the use of GVNIC for this cluster. Requires re-creation of
nodes using either a node-pool upgrade or node-pool creation.
--enable-image-streaming
Enable Image Streaming for the node pool, allowing nodes to stream
container image data from Artifact Registry on demand to reduce
container start times. This setting overrides the cluster-level Image
Streaming default for this specific node pool.
See Image Streaming documentation
(https://cloud.google.com/kubernetes-engine/docs/how-to/image-streaming)
for full requirements (including version, API enablement and Artifact
Registry usage). To disable Image Streaming for the node pool, use
--no-enable-image-streaming.
--enable-insecure-kubelet-readonly-port
Enables the Kubelet's insecure read only port.
To disable the readonly port on a cluster or node-pool set the flag
to --no-enable-insecure-kubelet-readonly-port.
--enable-kernel-module-signature-enforcement
Enforces that kernel modules are signed on all nodes in the node
pool. This setting overrides the cluster-level setting. For example,
if the cluster disables enforcement, you can enable enforcement only
for a specific node pool. When the policy is modified on an existing
node pool, nodes will be immediately recreated to use the new policy.
Use --no-enable-kernel-module-signature-enforcement to disable.
Examples:
$ gcloud alpha container node-pools update node-pool-1 \
--enable-kernel-module-signature-enforcement
--enable-private-nodes
Enables provisioning nodes with private IP addresses only.
The control plane still communicates with all nodes through private
IP addresses only, regardless of whether private nodes are enabled or
disabled.
--enable-queued-provisioning
Mark the nodepool as Queued only. This means that all new nodes can
be obtained only through queuing via ProvisioningRequest API.
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --enable-queued-provisioning
... and other required parameters, for more details see:
https://cloud.google.com/kubernetes-engine/docs/how-to/provisioningrequest
--flex-start
Start the node pool with Flex Start provisioning model.
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --flex-start
and other required parameters, for more details see:
https://cloud.google.com/kubernetes-engine/docs/how-to/provisioningrequest
--labels=[KEY=VALUE,...]
Labels to apply to the Google Cloud resources of node pools in the
Kubernetes Engine cluster. These are unrelated to Kubernetes labels.
Warning: Updating this label will causes the node(s) to be recreated.
Examples:
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --labels=label1=value1,label2=value2
--logging-variant=LOGGING_VARIANT
Specifies the logging variant that will be deployed on all the nodes
in the node pool. If the node pool doesn't specify a logging variant,
then the logging variant specified for the cluster will be deployed
on all the nodes in the node pool. Valid logging variants are
MAX_THROUGHPUT, DEFAULT. LOGGING_VARIANT must be one of:
DEFAULT
'DEFAULT' variant requests minimal resources but may not
guarantee high throughput.
MAX_THROUGHPUT
'MAX_THROUGHPUT' variant requests more node resources and is able
to achieve logging throughput up to 10MB per sec.
--max-run-duration=MAX_RUN_DURATION
Limit the runtime of each node in the node pool to the specified
duration.
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --max-run-duration=3600s
--network-performance-configs=[PROPERTY=VALUE,...]
Configures network performance settings for the node pool. If this
flag is not specified, the pool will be created with its default
network performance configuration.
total-egress-bandwidth-tier
Total egress bandwidth is the available outbound bandwidth from a
VM, regardless of whether the traffic is going to internal IP or
external IP destinations. The following tier values are allowed:
[TIER_UNSPECIFIED,TIER_1]
--node-labels=[NODE_LABEL,...]
Replaces all the user specified Kubernetes labels on all nodes in an
existing node pool with the given labels.
Examples:
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster \
--node-labels=label1=value1,label2=value2
Updating the node pool's --node-labels flag applies the labels to the
Kubernetes Node objects for existing nodes in-place; it does not
re-create or replace nodes. New nodes, including ones created by
resizing or re-creating nodes, will have these labels on the
Kubernetes API Node object. The labels can be used in the
nodeSelector field. See
https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
for examples.
Note that Kubernetes labels, intended to associate cluster components
and resources with one another and manage resource lifecycles, are
different from Google Kubernetes Engine labels that are used for the
purpose of tracking billing and usage information.
--node-locations=ZONE,[ZONE,...]
Set of 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.
Multiple locations can be specified, separated by commas. For
example:
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=sample-cluster \
--node-locations=us-central1-a,us-central1-b
--node-taints=[NODE_TAINT,...]
Replaces all the user specified Kubernetes taints on all nodes in an
existing node pool, which can be used with tolerations for pod
scheduling.
Examples:
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster \
--node-taints=key1=val1:NoSchedule,key2=val2:PreferNoSchedule
To read more about node-taints, see
https://cloud.google.com/kubernetes-engine/docs/node-taints.
--resource-manager-tags=[KEY=VALUE,...]
Replaces all the user specified resource manager tags on all nodes in
an existing node pool in a Standard cluster with the given
comma-separated resource manager tags that has the GCE_FIREWALL
purpose.
Examples:
$ gcloud alpha container node-pools update example-node-pool \
--resource-manager-tags=tagKeys/1234=tagValues/2345
$ gcloud alpha container node-pools update example-node-pool \
--resource-manager-tags=my-project/key1=value1
$ gcloud alpha container node-pools update example-node-pool \
--resource-manager-tags=12345/key1=value1,23456/key2=value2
$ gcloud alpha container node-pools update example-node-pool \
--resource-manager-tags=
All nodes, including nodes that are resized or re-created, will have
the specified tags on the corresponding Instance object in the
Compute Engine API. You can reference these tags in network firewall
policy rules. For instructions, see
https://cloud.google.com/firewall/docs/use-tags-for-firewalls.
--storage-pools=STORAGE_POOL,[...]
A list of storage pools where the node pool's boot disks will be
provisioned. Replaces all the current storage pools of an existing
node pool, with the specified storage pools.
STORAGE_POOL must be in the format
projects/project/zones/zone/storagePools/storagePool
--system-config-from-file=PATH_TO_FILE
Path of the YAML/JSON file that contains the node configuration,
including Linux kernel parameters (sysctls) and kubelet configs.
Examples:
kubeletConfig:
cpuManagerPolicy: static
memoryManager:
policy: Static
topologyManager:
policy: BestEffort
scope: pod
linuxConfig:
sysctl:
net.core.somaxconn: '2048'
net.ipv4.tcp_rmem: '4096 87380 6291456'
hugepageConfig:
hugepage_size2m: '1024'
hugepage_size1g: '2'
swapConfig:
enabled: true
bootDiskProfile:
swapSizeGib: 8
cgroupMode: 'CGROUP_MODE_V2'
nodeKernelModuleLoading:
policy: 'ENFORCE_SIGNED_MODULES'
List of supported kubelet configs in 'kubeletConfig'.
KEY VALUE
cpuManagerPolicy either 'static' or 'none'
cpuCFSQuota true or false (enabled by
default)
cpuCFSQuotaPeriod interval (e.g., '100ms'. The
value must be between 1ms
and 1 second, inclusive.)
memoryManager specify memory manager
policy
topologyManager specify topology manager
policy and scope
podPidsLimit integer (The value must be
greater than or equal to
1024 and less than 4194304.)
containerLogMaxSize positive number plus unit
suffix (e.g., '100Mi',
'0.2Gi'. The value must be
between 10Mi and 500Mi,
inclusive.)
containerLogMaxFiles integer (The value must be
between [2, 10].)
imageGcLowThresholdPercent integer (The value must be
between [10, 85], and lower
than
imageGcHighThresholdPercent.
)
imageGcHighThresholdPercent integer (The value must be
between [10, 85], and
greater than
imageGcLowThresholdPercent.)
imageMinimumGcAge interval (e.g., '100s',
'1m'. The value must be less
than '2m'.)
imageMaximumGcAge interval (e.g., '100s',
'1m'. The value must be
greater than
imageMinimumGcAge.)
evictionSoft specify eviction soft
thresholds
evictionSoftGracePeriod specify eviction soft grace
period
evictionMinimumReclaim specify eviction minimum
reclaim thresholds
evictionMaxPodGracePeriodSeconds integer (Max grace period
for pod termination during
eviction, in seconds. The
value must be between [0,
300].)
shutdownGracePeriodSeconds integer (Grace period for
pods terminating on node
shutdown, in seconds.
Allowed values: 0, 30, 120.)
shutdownGracePeriodCriticalPodsSeconds integer (Grace period for
critical pods terminating on
node shutdown, in seconds.
The value must be between
[0, 120] and less than
shutdownGracePeriodSeconds.)
allowedUnsafeSysctls list of sysctls (Allowlisted
groups: 'kernel.shm*',
'kernel.msg*', 'kernel.sem',
'fs.mqueue.*', and 'net.*',
and sysctls under the
groups.)
singleProcessOomKill true or false
maxParallelImagePulls integer (The value must be
between [2, 5].)
List of supported keys in memoryManager in 'kubeletConfig'.
KEY VALUE
policy either 'Static' or
'None'
List of supported keys in topologyManager in 'kubeletConfig'.
KEY VALUE
policy either 'none' or
'best-effort' or
'single-numa-node' or
'restricted'
scope either 'pod' or
'container'
List of supported keys in evictionSoft in 'kubeletConfig'.
KEY VALUE
memoryAvailable quantity (e.g., '100Mi', '1Gi'.
Represents the amount of memory available
before soft eviction. The value must be
at least 100Mi and less than 50% of the
node's memory.)
nodefsAvailable percentage (e.g., '20%'. Represents the
nodefs available before soft eviction.
The value must be between 10% and 50%,
inclusive.)
nodefsInodesFree percentage (e.g., '20%'. Represents the
nodefs inodes free before soft eviction.
The value must be between 5% and 50%,
inclusive.)
imagefsAvailable percentage (e.g., '20%'. Represents the
imagefs available before soft eviction.
The value must be between 15% and 50%,
inclusive.)
imagefsInodesFree percentage (e.g., '20%'. Represents the
imagefs inodes free before soft eviction.
The value must be between 5% and 50%,
inclusive.)
pidAvailable percentage (e.g., '20%'. Represents the
pid available before soft eviction. The
value must be between 10% and 50%,
inclusive.)
List of supported keys in evictionSoftGracePeriod in 'kubeletConfig'.
KEY VALUE
memoryAvailable duration (e.g., '30s', '1m'. The grace
period for soft eviction for this
resource. The value must be positive and
no more than '5m'.)
nodefsAvailable duration (e.g., '30s', '1m'. The grace
period for soft eviction for this
resource. The value must be positive and
no more than '5m'.)
nodefsInodesFree duration (e.g., '30s', '1m'. The grace
period for soft eviction for this
resource. The value must be positive and
no more than '5m'.)
imagefsAvailable duration (e.g., '30s', '1m'. The grace
period for soft eviction for this
resource. The value must be positive and
no more than '5m'.)
imagefsInodesFree duration (e.g., '30s', '1m'. The grace
period for soft eviction for this
resource. The value must be positive and
no more than '5m'.)
pidAvailable duration (e.g., '30s', '1m'. The grace
period for soft eviction for this
resource. The value must be positive and
no more than '5m'.)
List of supported keys in evictionMinimumReclaim in 'kubeletConfig'.
KEY VALUE
memoryAvailable percentage (e.g., '5%'. Represents the
minimum reclaim threshold for memory
available. The value must be positive and
no more than 10%.)
nodefsAvailable percentage (e.g., '5%'. Represents the
minimum reclaim threshold for nodefs
available. The value must be positive and
no more than 10%.)
nodefsInodesFree percentage (e.g., '5%'. Represents the
minimum reclaim threshold for nodefs
inodes free. The value must be positive
and no more than 10%.)
imagefsAvailable percentage (e.g., '5%'. Represents the
minimum reclaim threshold for imagefs
available. The value must be positive and
no more than 10%.)
imagefsInodesFree percentage (e.g., '5%'. Represents the
minimum reclaim threshold for imagefs
inodes free. The value must be positive
and no more than 10%.)
pidAvailable percentage (e.g., '5%'. Represents the
minimum reclaim threshold for pid
available. The value must be positive and
no more than 10%.)
List of supported sysctls in 'linuxConfig'.
KEY VALUE
net.core.netdev_max_backlog Any positive
integer, less
than 2147483647
net.core.rmem_default Must be between
[2304,
2147483647]
net.core.rmem_max Must be between
[2304,
2147483647]
net.core.wmem_default Must be between
[4608,
2147483647]
net.core.wmem_max Must be between
[4608,
2147483647]
net.core.optmem_max Any positive
integer, less
than 2147483647
net.core.somaxconn Must be between
[128,
2147483647]
net.ipv4.tcp_rmem Any positive
integer tuple
net.ipv4.tcp_wmem Any positive
integer tuple
net.ipv4.tcp_tw_reuse Must be {0, 1,
2}
net.ipv4.tcp_mtu_probing Must be {0, 1,
2}
net.ipv4.tcp_max_orphans Must be between
[16384, 262144]
net.ipv4.tcp_max_tw_buckets Must be between
[4096,
2147483647]
net.ipv4.tcp_syn_retries Must be between
[1, 127]
net.ipv4.tcp_ecn Must be {0, 1,
2}
net.ipv4.tcp_congestion_control Supported values
for COS: 'reno',
'cubic', 'bbr',
'lp', 'htcp'.
Supported values
for Ubuntu:
'reno', 'cubic',
'bbr', 'lp',
'htcp', 'vegas',
'dctcp', 'bic',
'cdg',
'highspeed',
'hybla',
'illinois',
'nv',
'scalable',
'veno',
'westwood',
'yeah'.
net.netfilter.nf_conntrack_max Must be between
[65536, 4194304]
net.netfilter.nf_conntrack_buckets Must be between
[65536, 524288].
Recommend
setting:
nf_conntrack_max
=
nf_conntrack_buc
kets * 4
net.netfilter.nf_conntrack_tcp_timeout_close_wait Must be between
[60, 3600]
net.netfilter.nf_conntrack_tcp_timeout_time_wait Must be between
[1, 600]
net.netfilter.nf_conntrack_tcp_timeout_established Must be between
[600, 86400]
net.netfilter.nf_conntrack_acct Must be {0, 1}
kernel.shmmni Must be between
[4096, 32768]
kernel.shmmax Must be between
[0,
1844674407369277
4399]
kernel.shmall Must be between
[0,
1844674407369277
4399]
kernel.perf_event_paranoid Must be {-1, 0,
1, 2, 3}
kernel.sched_rt_runtime_us Must be [-1,
1000000]
kernel.softlockup_panic Must be {0, 1}
kernel.yama.ptrace_scope Must be {0, 1,
2, 3}
kernel.kptr_restrict Must be {0, 1,
2}
kernel.dmesg_restrict Must be {0, 1}
kernel.sysrq Must be [0, 511]
fs.aio-max-nr Must be between
[65536, 4194304]
fs.file-max Must be between
[104857,
67108864]
fs.inotify.max_user_instances Must be between
[8192, 1048576]
fs.inotify.max_user_watches Must be between
[8192, 1048576]
fs.nr_open Must be between
[1048576,
2147483584]
vm.dirty_background_ratio Must be between
[1, 100]
vm.dirty_background_bytes Must be between
[0, 68719476736]
vm.dirty_expire_centisecs Must be between
[0, 6000]
vm.dirty_ratio Must be between
[1, 100]
vm.dirty_bytes Must be between
[0, 68719476736]
vm.dirty_writeback_centisecs Must be between
[0, 1000]
vm.max_map_count Must be between
[65536,
2147483647]
vm.overcommit_memory Must be one of
{0, 1, 2}. Not
supported on
machines with
less than 15 GB
memory.
vm.overcommit_ratio Must be between
[0, 100]
vm.vfs_cache_pressure Must be between
[0, 100]
vm.swappiness Must be between
[0, 200]
vm.watermark_scale_factor Must be between
[10, 3000]
vm.min_free_kbytes Must be between
[67584, 1048576]
List of supported hugepage size in 'hugepageConfig'.
KEY VALUE
hugepage_size2m Number of 2M huge pages, any positive integer
hugepage_size1g Number of 1G huge pages, any positive integer
List of supported keys in 'swapConfig' under 'linuxConfig'.
KEY VALUE
enabled boolean
encryptionConfig specify encryption
settings for the swap
space
bootDiskProfile specify swap on the
node's boot disk
ephemeralLocalSsdProfile specify swap on the
local SSD shared with
pod ephemeral storage
dedicatedLocalSsdProfile specify swap on a new,
separate local NVMe SSD
exclusively for swap
List of supported keys in 'encryptionConfig' under 'swapConfig'.
KEY VALUE
disabled boolean
List of supported keys in 'bootDiskProfile' under 'swapConfig'.
KEY VALUE
swapSizeGib integer
swapSizePercent integer
List of supported keys in 'ephemeralLocalSsdProfile' under
'swapConfig'.
KEY VALUE
swapSizeGib integer
swapSizePercent integer
List of supported keys in 'dedicatedLocalSsdProfile' under
'swapConfig'.
KEY VALUE
diskCount integer
List of supported keys in 'nodeKernelModuleLoading'.
KEY VALUE
policy ENFORCE_SIGNED_MODULES,
DO_NOT_ENFORCE_SIGNED_MO
DULES,
POLICY_UNSPECIFIED
The upper limit for total allocated hugepage size differs based upon
machine size.
▸ On machines with less than 30 GB memory: 60% of the total memory.
For example, on e2-standard-2 machine with 8 GB of memory, you
can't allocate more than 4.8 GB for hugepages.
▸ On machines with more than 30 GB memory: 80% of the total memory.
For example, on c4a-standard-8 machines with 32 GB of memory,
hugepages cannot exceed 25.6 GB.
1G hugepages are only available in following machine familes: c3, m2,
c2d, c3d, h3, m3, a2, a3, g2.
Supported values for 'cgroupMode' under 'linuxConfig'.
▸ CGROUP_MODE_V1: Use cgroupv1 on the node pool.
▸ CGROUP_MODE_V2: Use cgroupv2 on the node pool.
▸ CGROUP_MODE_UNSPECIFIED: Use the default GKE cgroup
configuration.
Supported values for 'transparentHugepageEnabled' under 'linuxConfig'
which controls transparent hugepage support for anonymous memory.
▸ TRANSPARENT_HUGEPAGE_ENABLED_ALWAYS: Transparent hugepage is
enabled system wide.
▸ TRANSPARENT_HUGEPAGE_ENABLED_MADVISE: Transparent hugepage is
enabled inside MADV_HUGEPAGE regions. This is the default kernel
configuration.
▸ TRANSPARENT_HUGEPAGE_ENABLED_NEVER: Transparent hugepage is
disabled.
▸ TRANSPARENT_HUGEPAGE_ENABLED_UNSPECIFIED: Default value. GKE will
not modify the kernel configuration.
Supported values for 'transparentHugepageDefrag' under 'linuxConfig'
which defines the transparent hugepage defrag configuration on the
node.
▸ TRANSPARENT_HUGEPAGE_DEFRAG_ALWAYS: It means that an application
requesting THP will stall on allocation failure and directly
reclaim pages and compact memory in an effort to allocate a THP
immediately.
▸ TRANSPARENT_HUGEPAGE_DEFRAG_DEFER: It means that an application
will wake kswapd in the background to reclaim pages and wake
kcompactd to compact memory so that THP is available in the near
future. It is the responsibility of khugepaged to then install the
THP pages later.
▸ TRANSPARENT_HUGEPAGE_DEFRAG_DEFER_WITH_MADVISE: It means that an
application will enter direct reclaim and compaction like always,
but only for regions that have used madvise(MADV_HUGEPAGE); all
other regions will wake kswapd in the background to reclaim pages
and wake kcompactd to compact memory so that THP is available in
the near future.
▸ TRANSPARENT_HUGEPAGE_DEFRAG_MADVISE: It means that an application
will enter direct reclaim and compaction like always, but only for
regions that have used madvise(MADV_HUGEPAGE); all other regions
will wake kswapd in the background to reclaim pages and wake
kcompactd to compact memory so that THP is available in the near
future.
▸ TRANSPARENT_HUGEPAGE_DEFRAG_NEVER: It means that an application
will never enter direct reclaim or compaction.
▸ TRANSPARENT_HUGEPAGE_DEFRAG_UNSPECIFIED: Default value. GKE will
not modify the kernel configuration.
Supported values for 'policy' under 'nodeKernelModuleLoading'.
▸ POLICY_UNSPECIFIED: Default behavior. GKE selects the image based
on node type. For CPU and TPU nodes, the image will not allow
loading external kernel modules. For GPU nodes, the image will
allow loading any module, whether it is signed or not.
▸ ENFORCE_SIGNED_MODULES: Enforced signature verification: Node
pools will use a Container-Optimized OS image configured to allow
loading of Google-signed external kernel modules. Loadpin is
enabled but configured to exclude modules, and kernel module
signature checking is enforced.
▸ DO_NOT_ENFORCE_SIGNED_MODULES: Do not enforce kernel module
signature enforcement. Mirrors existing DEFAULT behavior.
Note, updating the system configuration of an existing node pool
requires recreation of the nodes which which might cause a
disruption.
Use a full or relative path to a local file containing the value of
system_config.
--tags=[TAG,...]
Replaces all the user specified Compute Engine tags on all nodes in
an existing node pool with the given tags (comma separated).
Examples:
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --tags=tag1,tag2
New nodes, including ones created by resize or recreate, will have
these tags on the Compute Engine API instance object and these tags
can be used in firewall rules. See
https://cloud.google.com/sdk/gcloud/reference/compute/firewall-rules/create
for examples.
--windows-os-version=WINDOWS_OS_VERSION
Specifies the Windows Server Image to use when creating a Windows
node pool. Valid variants can be "ltsc2019", "ltsc2022". It means
using LTSC2019 server image or LTSC2022 server image. If the node
pool doesn't specify a Windows Server Image Os version, then Ltsc2019
will be the default one to use. WINDOWS_OS_VERSION must be one of:
ltsc2019, ltsc2022.
--workload-metadata=WORKLOAD_METADATA
Type of metadata server available to pods running in the node pool.
WORKLOAD_METADATA must be one of:
EXPOSED
[DEPRECATED] Pods running in this node pool have access to the
node's underlying Compute Engine Metadata Server.
GCE_METADATA
Pods running in this node pool have access to the node's
underlying Compute Engine Metadata Server.
GKE_METADATA
Run the Kubernetes Engine Metadata Server on this node. The
Kubernetes Engine Metadata Server exposes a metadata API to
workloads that is compatible with the V1 Compute Metadata APIs
exposed by the Compute Engine and App Engine Metadata Servers.
This feature can only be enabled if Workload Identity is enabled
at the cluster level.
GKE_METADATA_SERVER
[DEPRECATED] Run the Kubernetes Engine Metadata Server on this
node. The Kubernetes Engine Metadata Server exposes a metadata
API to workloads that is compatible with the V1 Compute Metadata
APIs exposed by the Compute Engine and App Engine Metadata
Servers. This feature can only be enabled if Workload Identity is
enabled at the cluster level.
SECURE
[DEPRECATED] Prevents pods not in hostNetwork from accessing
certain VM metadata, specifically kube-env, which contains
Kubelet credentials, and the instance identity token. This is a
temporary security solution available while the bootstrapping
process for cluster nodes is being redesigned with significant
security improvements. This feature is scheduled to be deprecated
in the future and later removed.
Or at least one of these can be specified:
Upgrade settings
--autoscaled-rollout-policy=[wait-for-drain-duration=WAIT-FOR-DRAIN-DURATION]
Autoscaled rollout policy options for blue-green upgrade.
wait-for-drain-duration
(Optional) Time in seconds to wait after cordoning the blue
pool before draining the nodes.
Examples:
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --enable-blue-green-upgrade \
--autoscaled-rollout-policy=""
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --enable-blue-green-upgrade \
--autoscaled-rollout-policy=wait-for-drain-duration=7200s
--enable-blue-green-upgrade
Changes node pool upgrade strategy to blue-green upgrade.
--enable-surge-upgrade
Changes node pool upgrade strategy to surge upgrade.
--max-surge-upgrade=MAX_SURGE_UPGRADE
Number of extra (surge) nodes to be created on each upgrade of the
node pool.
Specifies the number of extra (surge) nodes to be created during
this node pool's upgrades. For example, running the following
command will result in creating an extra node each time the node
pool is upgraded:
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --max-surge-upgrade=1 \
--max-unavailable-upgrade=0
Must be used in conjunction with '--max-unavailable-upgrade'.
--max-unavailable-upgrade=MAX_UNAVAILABLE_UPGRADE
Number of nodes that can be unavailable at the same time on each
upgrade of the node pool.
Specifies the number of nodes that can be unavailable at the same
time during this node pool's upgrades. For example, assume the node
pool has 5 nodes, running the following command will result in
having 3 nodes being upgraded in parallel (1 + 2), but keeping
always at least 3 (5 - 2) available each time the node pool is
upgraded:
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --max-surge-upgrade=1 \
--max-unavailable-upgrade=2
Must be used in conjunction with '--max-surge-upgrade'.
--node-pool-soak-duration=NODE_POOL_SOAK_DURATION
Time in seconds to be spent waiting during blue-green upgrade
before deleting the blue pool and completing the upgrade.
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --node-pool-soak-duration=600s
--standard-rollout-policy=[batch-node-count=BATCH_NODE_COUNT,batch-percent=BATCH_NODE_PERCENTAGE,batch-soak-duration=BATCH_SOAK_DURATION,...]
Standard rollout policy options for blue-green upgrade.
Batch sizes are specified by one of, batch-node-count or
batch-percent. The duration between batches is specified by
batch-soak-duration.
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster \
--standard-rollout-policy=batch-node-count=3,\
batch-soak-duration=60s
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster \
--standard-rollout-policy=batch-percent=0.3,\
batch-soak-duration=60s
Or at least one of these can be specified:
Node config
--boot-disk-provisioned-iops=BOOT_DISK_PROVISIONED_IOPS
Configure the Provisioned IOPS for the node pool boot disks. Only
valid for hyperdisk-balanced boot disks.
--boot-disk-provisioned-throughput=BOOT_DISK_PROVISIONED_THROUGHPUT
Configure the Provisioned Throughput for the node pool boot disks.
Only valid for hyperdisk-balanced boot disks.
--disk-size=DISK_SIZE
Size for node VM boot disks in GB. Defaults to 100GB.
--disk-type=DISK_TYPE
Type of the node VM boot disk. For version 1.24 and later, defaults
to pd-balanced. For versions earlier than 1.24, defaults to
pd-standard. DISK_TYPE must be one of: pd-standard, pd-ssd,
pd-balanced, hyperdisk-balanced, hyperdisk-extreme,
hyperdisk-throughput.
--machine-type=MACHINE_TYPE
The type of machine to use for nodes. Defaults to e2-medium. The
list of predefined machine types is available using the following
command:
$ gcloud compute machine-types list
You can also specify custom machine types by providing a string
with the format "custom-CPUS-RAM" where "CPUS" is the number of
virtual CPUs and "RAM" is the amount of RAM in MiB.
For example, to create a node pool using custom machines with 2
vCPUs and 12 GB of RAM:
$ gcloud alpha container node-pools update high-mem-pool \
--machine-type=custom-2-12288
Or at least one of these can be specified:
Cluster autoscaling
--enable-autoprovisioning
Enables Cluster Autoscaler to treat the node pool as if it was
autoprovisioned.
Cluster Autoscaler will be able to delete the node pool if it's
unneeded.
--enable-autoscaling
Enables autoscaling for a node pool.
Enables autoscaling in the node pool specified by --node-pool or
the default node pool if --node-pool is not provided. If not
already, --max-nodes or --total-max-nodes must also be set.
--location-policy=LOCATION_POLICY
Location policy specifies the algorithm used when scaling-up the
node pool.
▫ BALANCED - Is a best effort policy that aims to balance the
sizes of available zones.
▫ ANY - Instructs the cluster autoscaler to prioritize
utilization of unused reservations, and reduces preemption risk
for Spot VMs.
LOCATION_POLICY must be one of: BALANCED, ANY.
--max-nodes=MAX_NODES
Maximum number of nodes per zone in the node pool.
Maximum number of nodes per zone to which the node pool specified
by --node-pool (or default node pool if unspecified) can scale.
Ignored unless --enable-autoscaling is also specified.
--min-nodes=MIN_NODES
Minimum number of nodes per zone in the node pool.
Minimum number of nodes per zone to which the node pool specified
by --node-pool (or default node pool if unspecified) can scale.
Ignored unless --enable-autoscaling is also specified.
--total-max-nodes=TOTAL_MAX_NODES
Maximum number of all nodes in the node pool.
Maximum number of all nodes to which the node pool specified by
--node-pool (or default node pool if unspecified) can scale.
Ignored unless --enable-autoscaling is also specified.
--total-min-nodes=TOTAL_MIN_NODES
Minimum number of all nodes in the node pool.
Minimum number of all nodes to which the node pool specified by
--node-pool (or default node pool if unspecified) can scale.
Ignored unless --enable-autoscaling is also specified.
Or at least one of these can be specified:
Node management
--enable-autorepair
Enable node autorepair feature for a node pool.
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --enable-autorepair
See
https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair
for more info.
--enable-autoupgrade
Sets autoupgrade feature for a node pool.
$ gcloud alpha container node-pools update node-pool-1 \
--cluster=example-cluster --enable-autoupgrade
See
https://cloud.google.com/kubernetes-engine/docs/node-auto-upgrades
for more info.
Or at least one of these can be specified:
Node drain settings
--node-drain-grace-period-seconds=NODE_DRAIN_GRACE_PERIOD_SECONDS
The grace period in seconds for nodes to drain before being
forcefully removed.
--node-drain-pdb-timeout-seconds=NODE_DRAIN_PDB_TIMEOUT_SECONDS
The timeout in seconds for the node pool to be drained.
--respect-pdb-during-node-pool-deletion
Whether to respect PDBs when deleting nodes in the node pool.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--cluster=CLUSTER
The name of the cluster. Overrides the default container/cluster
property value for this command invocation.
At most one of these can be specified:
--location=LOCATION
Compute zone or region (e.g. us-central1-a or us-central1) for the
cluster. Overrides the default compute/region or compute/zone value
for this command invocation. Prefer using this flag over the --region
or --zone flags.
--region=REGION
Compute region (e.g. us-central1) for a regional cluster. Overrides
the default compute/region property value for this command
invocation.
--zone=ZONE, -z ZONE
Compute zone (e.g. us-central1-a) for a zonal cluster. Overrides the
default compute/zone property value for this command invocation.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist. These variants are also available:
$ gcloud container node-pools update
$ gcloud beta container node-pools update
View git blame Copy permalink