Verifying Amazon EKS add-on version compatibility with a cluster - Amazon EKS

Help improve this page

Want to contribute to this user guide? Scroll to the bottom of this page and select Edit this page on GitHub. Your contributions will help make our user guide better for everyone.

Verifying Amazon EKS add-on version compatibility with a cluster

Before you create an Amazon EKS add-on you need to verify that the Amazon EKS add-on version is compatable with your cluster.

Use the describe-addon-verisions API to list the available versions of EKS add-ons, and which Kubernetes versions each addon version supports.

Verify add-on compatability (AWS CLI)

  1. Verify the AWS CLI is installed and working with aws sts get-caller-identity. If this command doesn't work, learn how to Get started with the AWS CLI.

  2. Determine the name of the add-on you want to retrieve version compatibility information for, such as amazon-cloudwatch-observability.

  3. Determine the Kubernetes version of your cluster, such as 1.28.

  4. Use the AWS CLI to retrieve the addon versions that are compatible with the Kubernetes version of your cluster. 

    aws eks describe-addon-versions --addon-name amazon-cloudwatch-observability --kubernetes-version 1.29

    An example output is as follows. 

    {
    "addons": [
        {
            "addonName": "amazon-cloudwatch-observability",
            "type": "observability",
            "addonVersions": [
                {
                    "addonVersion": "v1.5.0-eksbuild.1",
                    "architecture": [
                        "amd64",
                        "arm64"
                    ],
                    "compatibilities": [
                        {
                            "clusterVersion": "1.28",
                            "platformVersions": [
                                "*"
                            ],
                            "defaultVersion": true
                        }
                    ],
[...]

    This output shows that addon version v1.5.0-eksbuild.1 is compatible with Kubernetes cluster version 1.28.