Verify Amazon EKS add-on version compatibility with a cluster - Amazon EKS
Add-on compatibility with compute types

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.

Verify 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 compatible 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.

  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.31.

  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.31

    An example output is as follows.

    {
    "addons": [
        {
            "addonName": "amazon-cloudwatch-observability",
            "type": "observability",
            "addonVersions": [
                {
                    "addonVersion": "vX.X.X-eksbuild.X",
                    "architecture": [
                        "amd64",
                        "arm64"
                    ],
                    "computeTypes": [
                        "ec2",
                        "auto",
                        "hybrid"
                    ],
                    "compatibilities": [
                        {
                            "clusterVersion": "1.31",
                            "platformVersions": [
                                "*"
                            ],
                            "defaultVersion": true
                        }
                    ],
                }
            ]
        }
    ]
}

    This output shows that addon version vX.X.X-eksbuild.X is compatible with Kubernetes cluster version 1.31.

Add-on compatibility with compute types

The computeTypes field in the describe-addon-versions output indicates an add-on’s compatibility with EKS Auto Mode Managed Nodes or Hybrid Nodes. Add-ons marked auto work with EKS Auto Mode’s cloud-based, AWS-managed infrastructure, while those marked hybrid can run on on-premises nodes connected to the EKS cloud control plane.

For more information, see Considerations for Amazon EKS Auto Mode.