Update Nodegroup Version
eks_update_nodegroup_version | R Documentation |
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group¶
Description¶
Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
You can update a node group using a launch template only if the node group was originally deployed with a launch template. If you need to update a custom AMI in a node group that was deployed with a launch template, then update your custom AMI, specify the new ID in a new version of the launch template, and then update the node group to the new version of the launch template.
If you update without a launch template, then you can update to the latest available AMI version of a node group's current Kubernetes version by not specifying a Kubernetes version in the request. You can update to the latest AMI version of your cluster's current Kubernetes version by specifying your cluster's Kubernetes version in the request. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.
You cannot roll back a node group to an earlier Kubernetes version or AMI version.
When a node in a managed node group is terminated due to a scaling
action or update, every Pod
on that node is drained first. Amazon EKS
attempts to drain the nodes gracefully and will fail if it is unable to
do so. You can force
the update if Amazon EKS is unable to drain the
nodes as a result of a Pod
disruption budget issue.
Usage¶
eks_update_nodegroup_version(clusterName, nodegroupName, version,
releaseVersion, launchTemplate, force, clientRequestToken)
Arguments¶
clusterName
[required] The name of your cluster.
nodegroupName
[required] The name of the managed node group to update.
version
The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster's Kubernetes version. If you specify
launchTemplate
, and your launch template uses a custom AMI, then don't specifyversion
, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.releaseVersion
The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group's Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.
If you specify
launchTemplate
, and your launch template uses a custom AMI, then don't specifyreleaseVersion
, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Customizing managed nodes with launch templates in the Amazon EKS User Guide.launchTemplate
An object representing a node group's launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.
force
Force the update if any
Pod
on the existing node group can't be drained due to aPod
disruption budget issue. If an update fails because all Pods can't be drained, you can force the update after it fails to terminate the old node whether or not anyPod
is running on the node.clientRequestToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Value¶
A list with the following syntax:
list(
update = list(
id = "string",
status = "InProgress"|"Failed"|"Cancelled"|"Successful",
type = "VersionUpdate"|"EndpointAccessUpdate"|"LoggingUpdate"|"ConfigUpdate"|"AssociateIdentityProviderConfig"|"DisassociateIdentityProviderConfig"|"AssociateEncryptionConfig"|"AddonUpdate"|"VpcConfigUpdate"|"AccessConfigUpdate"|"UpgradePolicyUpdate",
params = list(
list(
type = "Version"|"PlatformVersion"|"EndpointPrivateAccess"|"EndpointPublicAccess"|"ClusterLogging"|"DesiredSize"|"LabelsToAdd"|"LabelsToRemove"|"TaintsToAdd"|"TaintsToRemove"|"MaxSize"|"MinSize"|"ReleaseVersion"|"PublicAccessCidrs"|"LaunchTemplateName"|"LaunchTemplateVersion"|"IdentityProviderConfig"|"EncryptionConfig"|"AddonVersion"|"ServiceAccountRoleArn"|"ResolveConflicts"|"MaxUnavailable"|"MaxUnavailablePercentage"|"ConfigurationValues"|"SecurityGroups"|"Subnets"|"AuthenticationMode"|"PodIdentityAssociations"|"UpgradePolicy",
value = "string"
)
),
createdAt = as.POSIXct(
"2015-01-01"
),
errors = list(
list(
errorCode = "SubnetNotFound"|"SecurityGroupNotFound"|"EniLimitReached"|"IpNotAvailable"|"AccessDenied"|"OperationNotPermitted"|"VpcIdNotFound"|"Unknown"|"NodeCreationFailure"|"PodEvictionFailure"|"InsufficientFreeAddresses"|"ClusterUnreachable"|"InsufficientNumberOfReplicas"|"ConfigurationConflict"|"AdmissionRequestDenied"|"UnsupportedAddonModification"|"K8sResourceNotFound",
errorMessage = "string",
resourceIds = list(
"string"
)
)
)
)
)