Aws Eks Addon Datasource¶

Table of values¶

Name	Value	Notes
Identifier	`aws-eks-addon`
Default versioning	`aws-eks-addon`
Custom registry support	Yes
Release timestamp support	No
Source URL support	No

Description¶

This datasource returns the addon versions available for use on AWS EKS via the AWS API.

AWS API configuration

See Calling AWS Services from Renovate for how to configure your credentials.

You can also provide credentials specifically for this datasource with a hostRules entry. Set hostType to aws-eks-addon, username to the access key ID, password to the secret access key, and optionally token to the session token:

{
  "hostRules": [
    {
      "hostType": "aws-eks-addon",
      "username": "access-key-id",
      "password": "secret-access-key",
      "token": "session-token"
    }
  ]
}

These credentials only apply to AWS EKS Addon lookups. When this host rule is absent or incomplete, Renovate uses the default AWS credential provider chain.

You can also specify different region and profile for each addon.

The minimal IAM privileges required for this datasource are:

{
  "Sid": "AllowDescribeEKSAddonVersions",
  "Effect": "Allow",
  "Action": ["eks:DescribeAddonVersions"],
  "Resource": "*"
}

Read the AWS EKS IAM reference for more information.

Usage

Because Renovate has no manager for the AWS EKS Addon datasource, you need to help Renovate by configuring the custom manager to identify the AWS EKS Addons you want updated.

When configuring the custom manager, you have to pass in the Kubernetes version and addon names as a minified JSON object as the packageName For example:

# Getting the vpc-cni version for Kubernetes 1.30
{
   "kubernetesVersion": "1.30",
   "addonName": "vpc-cni"
}

# In order to use it with this datasource, you have to minify it:
{"kubernetesVersion":"1.30","addonName":"vpc-cni"}

Although it's unlikely that EKS might support different addon versions across regions, you can optionally specify the region and/or profile in the minified JSON object to discover the addon versions specific to this region.

# discover kube-proxy addon versions without specifying a cluster version.
renovate: eksAddonsFilter={"addonName":"kube-proxy"}

# discover kube-proxy default addon versions
renovate: eksAddonsFilter={"addonName":"kube-proxy", "default":true}

# discover vpc-cni addon versions on Kubernetes 1.30 in us-east-1 region using environmental AWS credentials.
renovate: eksAddonsFilter={"kubernetesVersion":"1.30","addonName":"vpc-cni","region":"eu-west-1"}

# discover vpc-cni addon versions on Kubernetes 1.30 in us-east-1 region using AWS credentials from `renovate-east` profile.
renovate: eksAddonsFilter={"kubernetesVersion":"1.30","addonName":"vpc-cni","region":"us-east-1","profile":"renovate-east"}

Here's an example of using the custom manager to configure this datasource:

{
  "packageRules": [
    {
      "matchDatasources": ["aws-eks-addon"],
      "overrideDepName": "{{replace '.*\"addonName\":\"([^\"]+)\".*' '$1' depName}}"
    }
  ],
  "customManagers": [
    {
      "customType": "regex",
      "managerFilePatterns": ["/.*\\.tf/"],
      "matchStrings": [
        ".*# renovate: eksAddonsFilter=(?<packageName>.*?)\n.*?[a-zA-Z0-9-_:]*[ ]*?[:|=][ ]*?[\"|']?(?<currentValue>[a-zA-Z0-9-_.]+)[\"|']?.*"
      ],
      "datasourceTemplate": "aws-eks-addon",
      "versioningTemplate": "aws-eks-addon" // Optional. Default value is 'aws-eks-addon'
    }
  ]
}

The configuration above matches every terraform file, and recognizes these lines:

variable "vpc_cni_version" {
  type        = string
  description = "EKS vpc-cni add-on version"
  # kubernetesVersion and addonName provided
  # renovate: eksAddonsFilter={"kubernetesVersion":"1.30","addonName":"vpc-cni"}
  default     = "v1.18.1-eksbuild.3"
}

or

addons:
  - name: vpc-cni
    # only addon name and the supported default version
    # renovate: eksAddonsFilter={"addonName":"vpc-cni", "default":true}
    version: v1.18.5-eksbuild.1