Creating the Amazon EKS add-on Updating the Amazon EKS add-on Updating the self-managed add-on

Working with the CoreDNS Amazon EKS add-on

CoreDNS is a flexible, extensible DNS server that can serve as the Kubernetes cluster DNS. When you launch an Amazon EKS cluster with at least one node, two replicas of the CoreDNS image are deployed by default, regardless of the number of nodes deployed in your cluster. The CoreDNS pods provide name resolution for all pods in the cluster. The CoreDNS pods can be deployed to Fargate nodes if your cluster includes an Amazon Fargate profile with a namespace that matches the namespace for the CoreDNS deployment. For more information about CoreDNS, see Using CoreDNS for Service Discovery in the Kubernetes documentation.

The following table lists the latest version of the Amazon EKS add-on type for each Kubernetes version.

Kubernetes version	`1.25`	`1.24`	`1.23`	`1.22`	`1.21`	`1.20`
	`v1.9.3-eksbuild.2`	`v1.8.7-eksbuild.4`	`v1.8.7-eksbuild.4`	`v1.8.7-eksbuild.4`	`v1.8.4-eksbuild.2`	`v1.8.3-eksbuild.1`

Important

If you're self-managing this add-on, the versions in the table might not be the same as the available self-managed versions. For more information about updating the self-managed type of this add-on, see Updating the self-managed add-on.

Prerequisites

An existing Amazon EKS cluster. To deploy one, see Getting started with Amazon EKS.
If your cluster is 1.21 or later, make sure that your Amazon VPC CNI plugin for Kubernetes and kube-proxy add-ons are at the minimum versions listed in Cluster add-ons.

Creating the Amazon EKS add-on

Create the Amazon EKS type of the add-on.

See which version of the add-on is installed on your cluster.


kubectl describe deployment coredns --namespace kube-system | grep coredns: | cut -d : -f 3

The example output is as follows.


v1.8.7-eksbuild.4

See which type of the add-on is installed on your cluster. Depending on the tool that you created your cluster with, you might not currently have the Amazon EKS add-on type installed on your cluster. Replace my-cluster with the name of your cluster.
```
aws eks describe-addon --cluster-name my-cluster --addon-name coredns --query addon.addonVersion --output text
```
If a version number is returned, you have the Amazon EKS type of the add-on installed on your cluster and don't need to complete the remaining steps in this procedure. If an error is returned, you don't have the Amazon EKS type of the add-on installed on your cluster. Complete the remaining steps of this procedure to install it.

Save the configuration of your currently installed add-on.


kubectl get deployment coredns -n kube-system -o yaml > aws-k8s-coredns-old.yaml

Create the add-on using the Amazon CLI. If you want to use the Amazon Web Services Management Console or eksctl to create the add-on, see Creating an add-on and specify coredns for the add-on name. Copy the command that follows to your device. Make the following modifications to the command, as needed, and then run the modified command.
- Replace my-cluster with the name of your cluster.
- Replace v1.9.3-eksbuild.2 with the latest version listed in the latest version table for your cluster version.
```
aws eks create-addon --cluster-name my-cluster --addon-name coredns --addon-version v1.9.3-eksbuild.2
```
If you've applied custom settings to your current add-on that conflict with the default settings of the Amazon EKS add-on, creation might fail. If creation fails, you receive an error that can help you resolve the issue. Alternatively, you can add --resolve-conflicts OVERWRITE to the previous command. This allows the add-on to overwrite any existing custom settings. Once you've created the add-on, you can update it with your custom settings.
Confirm that the latest version of the add-on for your cluster's Kubernetes version was added to your cluster. Replace my-cluster with the name of your cluster.
```
aws eks describe-addon --cluster-name my-cluster --addon-name coredns --query addon.addonVersion --output text
```
It might take several seconds for add-on creation to complete.

The example output is as follows.
```
v1.9.3-eksbuild.2
```
If you made custom settings to your original add-on, before you created the Amazon EKS add-on, use the configuration that you saved in a previous step to update the Amazon EKS add-on with your custom settings.

Updating the Amazon EKS add-on

Update the Amazon EKS type of the add-on. If you haven't added the Amazon EKS type of the add-on to your cluster, either add it or see Updating the self-managed add-on, instead of completing this procedure.

See which version of the add-on is installed on your cluster. Replace my-cluster with your cluster name.
```
aws eks describe-addon --cluster-name my-cluster --addon-name coredns --query "addon.addonVersion" --output text
```
The example output is as follows.
```
v1.8.7-eksbuild.4
```
If the version returned is the same as the version for your cluster's Kubernetes version in the latest version table, then you already have the latest version installed on your cluster and don't need to complete the rest of this procedure. If you receive an error, instead of a version number in your output, then you don't have the Amazon EKS type of the add-on installed on your cluster. You need to create the add-on before you can update it with this procedure.

Save the configuration of your currently installed add-on.


kubectl get deployment coredns -n kube-system -o yaml > aws-k8s-coredns-old.yaml

Update your add-on using the Amazon CLI. If you want to use the Amazon Web Services Management Console or eksctl to update the add-on, see Updating an 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.
- Replace my-cluster with the name of your cluster.
- Replace v1.9.3-eksbuild.2 with the latest version listed in the latest version table for your cluster version.
- The --resolve-conflicts PRESERVE option preserves existing configuration values for the add-on. If you've set custom values for add-on settings, and you don't use this option, Amazon EKS overwrites your values with its default values. If you use this option, then we recommend testing any field and value changes on a non-production cluster before updating the add-on on your production cluster. If you change this value to OVERWRITE, all settings are changed to Amazon EKS default values. If you've set custom values for any settings, they might be overwritten with Amazon EKS default values. If you change this value to none, Amazon EKS doesn't change the value of any settings, but the update might fail. If the update fails, you receive an error message to help you resolve the conflict.
- If you're not updating a configuration setting, remove --configuration-values '{"replicaCount":3}' from the command. If you're updating a configuration setting, replace "replicaCount":3 with the setting that you want to set. In this example, the number of replicas of CoreDNS is set to 3. The value that you specify must be valid for the configuration schema. If you don't know the configuration schema, run aws eks describe-addon-configuration --addon-name coredns --addon-version v1.9.3-eksbuild.2, replacing v1.9.3-eksbuild.2 with the version number of the add-on that you want to see the configuration for. The schema is returned in the output. If you have any existing custom configuration, want to remove it all, and set the values for all settings back to Amazon EKS defaults, remove "replicaCount":3 from the command, so that you have empty {}. For more information about CoreDNS settings, see Customizing DNS Service in the Kubernetes documentation.
```
aws eks update-addon --cluster-name my-cluster --addon-name coredns --addon-version v1.9.3-eksbuild.2 \
    --resolve-conflicts PRESERVE --configuration-values '{"replicaCount":3}'
```
  It might take several seconds for the update to complete.

Confirm that the add-on version was updated. Replace my-cluster with the name of your cluster.


aws eks describe-addon --cluster-name my-cluster --addon-name coredns

It might take several seconds for the update to complete.

The example output is as follows.


{
    "addon": {
        "addonName": "coredns",
        "clusterName": "my-cluster",
        "status": "ACTIVE",
        "addonVersion": "v1.9.3-eksbuild.2",
        "health": {
            "issues": []
        },
        "addonArn": "arn:aws-cn:eks:region:111122223333:addon/my-cluster/coredns/d2c34f06-1111-2222-1eb0-24f64ce37fa4",
        "createdAt": "2023-03-01T16:41:32.442000+00:00",
        "modifiedAt": "2023-03-01T18:16:54.332000+00:00",
        "tags": {},
        "configurationValues": "{\"replicaCount\":3}"
    }
}

Updating the self-managed add-on

Important

This procedure will be removed from this guide on July 1, 2023. We recommend adding the Amazon EKS type of the add-on to your cluster instead of self-managing the add-on. To add the Amazon EKS add-on to your cluster, see Creating the Amazon EKS add-on.

Confirm that you have the self-managed type of the add-on installed on your cluster. Replace my-cluster with the name of your cluster.
```
aws eks describe-addon --cluster-name my-cluster --addon-name coredns --query addon.addonVersion --output text
```
If an error message is returned, you have the self-managed type of the add-on installed on your cluster. Complete the remaining steps in this procedure. If a version number is returned, you have the Amazon EKS type of the add-on installed on your cluster. To update the Amazon EKS type of the add-on, use the procedure in Updating the Amazon EKS add-on, rather than using this procedure. If you're not familiar with the differences between the add-on types, see Amazon EKS add-ons.
See which version of the container image is currently installed on your cluster.
```
kubectl describe deployment coredns -n kube-system | grep Image | cut -d ":" -f 3
```
The example output is as follows.
```
v1.8.7-eksbuild.2
```
If your current CoreDNS version is v1.5.0 or later, but earlier than the version listed in the CoreDNS versions table, then skip this step. If your current version is earlier than 1.5.0, then you need to modify the ConfigMap for CoreDNS to use the forward add-on, rather than the proxy add-on.
1. Open the configmap with the following command.
```
kubectl edit configmap coredns -n kube-system
```
2. Replace proxy in the following line with forward. Save the file and exit the editor.
```
proxy . /etc/resolv.conf
```
If you originally deployed your cluster on Kubernetes 1.17 or earlier, then you may need to remove a discontinued line from your CoreDNS manifest.

Important
You must complete this step before updating to CoreDNS version 1.7.0, but it's recommended that you complete this step even if you're updating to an earlier version.
1. Check to see if your CoreDNS manifest has the line.
```
kubectl get configmap coredns -n kube-system -o jsonpath='{$.data.Corefile}' | grep upstream
```
  If no output is returned, your manifest doesn't have the line and you can skip to the next step to update CoreDNS. If output is returned, then you need to remove the line.
2. Edit the ConfigMap with the following command, removing the line in the file that has the word upstream in it. Do not change anything else in the file. Once the line is removed, save the changes.
```
kubectl edit configmap coredns -n kube-system -o yaml
```

Retrieve your current CoreDNS image version:


kubectl describe deployment coredns -n kube-system | grep Image

The example output is as follows.


918309763551.dkr.ecr.region-code.amazonaws.com.cn/eks/coredns:v1.8.7-eksbuild.2

If you're updating to CoreDNS 1.8.3 or later, then you need to add the endpointslices permission to the system:coredns Kubernetes clusterrole.
```
kubectl edit clusterrole system:coredns -n kube-system
```
Add the following lines under the existing permissions lines in the rules section of the file.
```
...
- apiGroups:
  - discovery.k8s.io
  resources:
  - endpointslices
  verbs:
  - list
  - watch
...
```
Update the CoreDNS add-on by replacing 918309763551 and region-code with the values from the output returned in a previous step. Replace v1.9.3-eksbuild.2 with the CoreDNS version listed in the latest versions table for your Kubernetes version.
```
kubectl set image deployment.apps/coredns -n kube-system  coredns=918309763551.dkr.ecr.region-code.amazonaws.com.cn/eks/coredns:v1.9.3-eksbuild.2
```
The example output is as follows.
```
deployment.apps/coredns image updated
```
Check the container image version again to confirm that it was updated to the version that you specified in the previous step.
```
kubectl describe deployment coredns -n kube-system | grep Image | cut -d ":" -f 3
```
The example output is as follows.
```
v1.9.3-eksbuild.2
```

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Amazon Load Balancer Controller

kube-proxy