Managing Amazon EKS add-ons

View the names of add-ons available for a cluster version. Replace 1.25 with the version of your cluster.

eksctl utils describe-addon-versions --kubernetes-version 1.25 | grep AddonName

The example output is as follows.

"AddonName": "aws-ebs-csi-driver",
                        "AddonName": "coredns",
                        "AddonName": "kube-proxy",
                        "AddonName": "vpc-cni",
                        "AddonName": "adot",
                        "AddonName": "dynatrace_dynatrace-operator",
                        "AddonName": "upbound_universal-crossplane",
                        "AddonName": "teleport_teleport",
                        "AddonName": "factorhouse_kpow",
                        ...

View the versions available for the add-on that you would like to create. Replace 1.25 with the version of your cluster. Replace name-of-addon with the name of the add-on you want to view the versions for. The name must be one of the names returned in the previous steps.

eksctl utils describe-addon-versions --kubernetes-version 1.25 --name name-of-addon | grep AddonVersion

The following output is an example of what is returned for the add-on named vpc-cni. You can see that the add-on has several available versions.

"AddonVersions": [
    "AddonVersion": "v1.12.0-eksbuild.1",
    "AddonVersion": "v1.11.4-eksbuild.1",
    "AddonVersion": "v1.10.4-eksbuild.1",
    "AddonVersion": "v1.9.3-eksbuild.1",

Create an Amazon EKS add-on. Copy the command that follows to your device. Make the following modifications to the command as needed and then run the modified command:

Open the Amazon EKS console at https://console.amazonaws.cn/eks/home#/clusters.

In the left navigation pane, select Clusters, and then select the name of the cluster that you want to create the add-on for.

Choose the Add-ons tab.

Select Get more add-ons.

Choose the add-ons that you want to add to your cluster. You can add as many add-ons as you require. Once you've selected the add-ons that you want to install, choose Next.

On the Configure selected add-ons settings page:

On the Review and add screen, choose Create. After the add-on installation is complete, you see your installed add-ons.

Determine which add-ons are available. You can see all available add-ons, their type, and their publisher. Replace 1.25 with the version of your cluster.

aws eks describe-addon-versions --kubernetes-version 1.25 \
    --query 'addons[].{Name: addonName, Type: type}' --output table

The example output is as follows.

-------------------------------------------------------
|                DescribeAddonVersions                |
+-------------------------------+---------------------+
|             Name              |        Type         |
+-------------------------------+---------------------+
|  aws-ebs-csi-driver           |  storage            |
|  coredns                      |  networking         |
|  kube-proxy                   |  networking         |
|  vpc-cni                      |  networking         |
|  adot                         |  observability      |
|  ...                          |  ...                |
+-------------------------------+---------------------+

Your output might be different. In this example output, there are three different add-ons available of type networking and five add-ons with a publisher of type eks.

You can see which versions are available for each add-on. Replace 1.25 with the version of your cluster and replace vpc-cni with the name of an add-on returned in the previous step.

aws eks describe-addon-versions --kubernetes-version 1.25 --addon-name vpc-cni \
    --query 'addons[].addonVersions[].{Version: addonVersion, Defaultversion: compatibilities[0].defaultVersion}' --output table

The example output is as follows.

------------------------------------------
|          DescribeAddonVersions         |
+-----------------+----------------------+
| Defaultversion  |       Version        |
+-----------------+----------------------+
|  False          |  v1.12.0-eksbuild.1  |
|  True           |  v1.11.4-eksbuild.1  |
|  False          |  v1.10.4-eksbuild.1  |
|  False          |  v1.9.3-eksbuild.1   |
+-----------------+----------------------+

The version with True in the Defaultversion column is the version that the add-on is created with, by default.

(Optional) Find the configuration options for your chosen add-on by running the following command:

aws eks describe-addon-configuration --addon-name vpc-cni --addon-version v1.12.0-eksbuild.1

{
    "addonName": "vpc-cni",
    "addonVersion": "v1.12.0-eksbuild.1",
    "configurationSchema": "{\"$ref\":\"#/definitions/VpcCni\",\"$schema\":\"http://json-schema.org/draft-06/schema#\",\"definitions\":{\"Cri\":{\"additionalProperties\":false,\"properties\":{\"hostPath\":{\"$ref\":\"#/definitions/HostPath\"}},\"title\":\"Cri\",\"type\":\"object\"},\"Env\":{\"additionalProperties\":false,\"properties\":{\"ADDITIONAL_ENI_TAGS\":{\"type\":\"string\"},\"AWS_VPC_CNI_NODE_PORT_SUPPORT\":{\"format\":\"boolean\",\"type\":\"string\"},\"AWS_VPC_ENI_MTU\":{\"format\":\"integer\",\"type\":\"string\"},\"AWS_VPC_K8S_CNI_CONFIGURE_RPFILTER\":{\"format\":\"boolean\",\"type\":\"string\"},\"AWS_VPC_K8S_CNI_CUSTOM_NETWORK_CFG\":{\"format\":\"boolean\",\"type\":\"string\"},\"AWS_VPC_K8S_CNI_EXTERNALSNAT\":{\"format\":\"boolean\",\"type\":\"string\"},\"AWS_VPC_K8S_CNI_LOGLEVEL\":{\"type\":\"string\"},\"AWS_VPC_K8S_CNI_LOG_FILE\":{\"type\":\"string\"},\"AWS_VPC_K8S_CNI_RANDOMIZESNAT\":{\"type\":\"string\"},\"AWS_VPC_K8S_CNI_VETHPREFIX\":{\"type\":\"string\"},\"AWS_VPC_K8S_PLUGIN_LOG_FILE\":{\"type\":\"string\"},\"AWS_VPC_K8S_PLUGIN_LOG_LEVEL\":{\"type\":\"string\"},\"DISABLE_INTROSPECTION\":{\"format\":\"boolean\",\"type\":\"string\"},\"DISABLE_METRICS\":{\"format\":\"boolean\",\"type\":\"string\"},\"DISABLE_NETWORK_RESOURCE_PROVISIONING\":{\"format\":\"boolean\",\"type\":\"string\"},\"ENABLE_POD_ENI\":{\"format\":\"boolean\",\"type\":\"string\"},\"ENABLE_PREFIX_DELEGATION\":{\"format\":\"boolean\",\"type\":\"string\"},\"WARM_ENI_TARGET\":{\"format\":\"integer\",\"type\":\"string\"},\"WARM_PREFIX_TARGET\":{\"format\":\"integer\",\"type\":\"string\"}},\"title\":\"Env\",\"type\":\"object\"},\"HostPath\":{\"additionalProperties\":false,\"properties\":{\"path\":{\"type\":\"string\"}},\"title\":\"HostPath\",\"type\":\"object\"},\"Limits\":{\"additionalProperties\":false,\"properties\":{\"cpu\":{\"type\":\"string\"},\"memory\":{\"type\":\"string\"}},\"title\":\"Limits\",\"type\":\"object\"},\"Resources\":{\"additionalProperties\":false,\"properties\":{\"limits\":{\"$ref\":\"#/definitions/Limits\"},\"requests\":{\"$ref\":\"#/definitions/Limits\"}},\"title\":\"Resources\",\"type\":\"object\"},\"VpcCni\":{\"additionalProperties\":false,\"properties\":{\"cri\":{\"$ref\":\"#/definitions/Cri\"},\"env\":{\"$ref\":\"#/definitions/Env\"},\"resources\":{\"$ref\":\"#/definitions/Resources\"}},\"title\":\"VpcCni\",\"type\":\"object\"}}}"
}

The output is a standard JSON schema.

Here is an example of valid configuration values, in JSON format, that works with the schema above.

{
  "resources": {
    "limits": {
      "cpu": "100m"
    }
  }
}

Here is an example of valid configuration values, in YAML format, that works with the schema above.

  resources: 
    limits: 
      cpu: 100m    

Create an Amazon EKS add-on. Copy the command that follows to your device. Make the following modifications to the command as needed and then run the modified command:

aws eks describe-addon-configuration --addon-name vpc-cni --addon-version v1.12.0-eksbuild.1

These example commands provide configuration values using the --configuration-values option. Replace this with the desired configuration values, such as a string or a file input. If you don't want to provide configuration values, then delete the --configuration-values option.

aws eks create-addon --cluster-name my-cluster --addon-name vpc-cni --addon-version version-number \
    --service-account-role-arn arn:aws-cn:iam::111122223333:role/role-name --configuration-values '{"resources":{"limits":{"cpu":"100m"}}}' --resolve-conflicts OVERWRITE

aws eks create-addon --cluster-name my-cluster --addon-name vpc-cni --addon-version version-number \
    --service-account-role-arn arn:aws-cn:iam::111122223333:role/role-name --configuration-values 'file://example.yaml' --resolve-conflicts OVERWRITE

For a full list of available options, see create-addon in the Amazon EKS Command Line Reference.

Determine the current add-ons and add-on versions installed on your cluster. Replace my-cluster with the name of your cluster.

eksctl get addon --cluster my-cluster

The example output is as follows.

NAME        VERSION              STATUS  ISSUES  IAMROLE  UPDATE AVAILABLE
coredns     v1.8.7-eksbuild.2    ACTIVE  0
kube-proxy  v1.23.7-eksbuild.1   ACTIVE  0                v1.23.8-eksbuild.2
vpc-cni     v1.10.4-eksbuild.1   ACTIVE  0                v1.12.0-eksbuild.1,v1.11.4-eksbuild.1,v1.11.3-eksbuild.1,v1.11.2-eksbuild.1,v1.11.0-eksbuild.1

Your output might look different, depending on which add-ons and versions that you have on your cluster. You can see that in the previous example output, two existing add-ons on the cluster have newer versions available in the UPDATE AVAILABLE column.

Update the add-on.

For more information about updating add-ons, see Addons in the eksctl documentation.

Open the Amazon EKS console at https://console.amazonaws.cn/eks/home#/clusters.

In the left navigation pane, select Clusters, and then select the name of the cluster that you want to configure the add-on for.

Choose the Add-ons tab.

Select the box in the top right of the add-on box and then choose Edit.

On the Configure name of addon page:

Choose Update.

See a list of installed add-ons. Replace my-cluster with the name of your cluster.

aws eks list-addons --cluster-name my-cluster

The example output is as follows.

{
    "addons": [
        "coredns",
        "kube-proxy",
        "vpc-cni"
    ]
}

View the current version of the add-on that you want to update. Replace my-cluster with your cluster name and vpc-cni with the name of the add-on that you want to update.

aws eks describe-addon --cluster-name my-cluster --addon-name vpc-cni --query "addon.addonVersion" --output text

The example output is as follows.

v1.10.4-eksbuild.1

You can see which versions of the add-on are available for your cluster's version. Replace 1.25 with your cluster's version and vpc-cni with the name of the add-on that you want to update.

aws eks describe-addon-versions --kubernetes-version 1.25 --addon-name vpc-cni \
    --query 'addons[].addonVersions[].{Version: addonVersion, Defaultversion: compatibilities[0].defaultVersion}' --output table

The example output is as follows.

------------------------------------------
|          DescribeAddonVersions         |
+-----------------+----------------------+
| Defaultversion  |       Version        |
+-----------------+----------------------+
|  False          |  v1.12.0-eksbuild.1  |
|  True           |  v1.11.4-eksbuild.1  |
|  False          |  v1.10.4-eksbuild.1  |
|  False          |  v1.9.3-eksbuild.1   |
+-----------------+----------------------+

The version with True in the Defaultversion column is the version that the add-on is created with, by default.

Update your add-on. Copy the command that follows to your device. Make the following modifications to the command, as needed, and then run the modified command.

aws eks update-addon --cluster-name my-cluster --addon-name vpc-cni --addon-version version-number \
    --service-account-role-arn arn:aws-cn:iam::111122223333:role/role-name --configuration-values '{}' --resolve-conflicts PRESERVE

Check the status of the update. Replace my-cluster with the name of your cluster and vpc-cni with the name of the add-on you're updating.

aws eks describe-addon --cluster-name my-cluster --addon-name vpc-cni

The example output is as follows.

{
    "addon": {
        "addonName": "vpc-cni",
        "clusterName": "my-cluster",
        "status": "UPDATING",
...

The update is complete when the status is ACTIVE.