Working with the Amazon VPC CNI plugin for Kubernetes Amazon EKS add-on

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

kubectl describe daemonset aws-node --namespace kube-system | grep amazon-k8s-cni: | cut -d : -f 3

The example output is as follows.

v1.12.5-eksbuild.2

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 vpc-cni --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 daemonset aws-node -n kube-system -o yaml > aws-k8s-cni-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 vpc-cni 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.

aws eks create-addon --cluster-name my-cluster --addon-name vpc-cni --addon-version  v1.12.6-eksbuild.2 \
    --service-account-role-arn arn:aws-cn:iam::111122223333:role/AmazonEKSVPCCNIRole

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 vpc-cni --query addon.addonVersion --output text

It might take several seconds for add-on creation to complete.

The example output is as follows.

 v1.12.6-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.

(Optional) Install the cni-metrics-helper to your cluster. It scrapes elastic network interface and IP address information, aggregates it at a cluster level, and publishes the metrics to Amazon CloudWatch. For more information, see cni-metrics-helper on GitHub.

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 vpc-cni --query "addon.addonVersion" --output text

The example output is as follows.

v1.12.5-eksbuild.2

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 daemonset aws-node -n kube-system -o yaml > aws-k8s-cni-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.

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 vpc-cni

It might take several seconds for the update to complete.

The example output is as follows.

{
    "addon": {
        "addonName": "vpc-cni",
        "clusterName": "my-cluster",
        "status": "ACTIVE",
        "addonVersion": " v1.12.6-eksbuild.2",
        "health": {
            "issues": []
        },
        "addonArn": "arn:aws-cn:eks:region:111122223333:addon/my-cluster/vpc-cni/74c33d2f-b4dc-8718-56e7-9fdfa65d14a9",
        "createdAt": "2023-04-12T18:25:19.319000+00:00",
        "modifiedAt": "2023-04-12T18:40:28.683000+00:00",
        "serviceAccountRoleArn": "arn:aws-cn:iam::111122223333:role/AmazonEKSVPCCNIRole",
        "tags": {},
        "configurationValues": "{\"env\":{\"AWS_VPC_K8S_CNI_EXTERNALSNAT\":\"true\"}}"
    }
}

Confirm that you don't have the Amazon EKS 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 vpc-cni --query addon.addonVersion --output text

If an error message is returned, you don't have the Amazon EKS type of the add-on installed on your cluster. To self-manage the add-on, complete the remaining steps in this procedure to update the add-on. If a version number is returned, you have the Amazon EKS type of the add-on installed on your cluster. To update it, use the procedure in Updating an 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 daemonset aws-node --namespace kube-system | grep amazon-k8s-cni: | cut -d : -f 3

The example output is as follows.

v1.12.5-eksbuild.2

Your output might not include the build number.

Backup your current settings so you can configure the same settings once you've updated your version.

kubectl get daemonset aws-node -n kube-system -o yaml > aws-k8s-cni-old.yaml

To review the available versions and familiarize yourself with the changes in the version that you want to update to, see releases on GitHub. We recommend updating to the same major.minor.patch version listed in the latest available versions table, even if later versions are available on GitHub. The build versions listed in the table aren't specified in the self-managed versions listed on GitHub. Update your version by completing the tasks in one of the following options:

Confirm that the new version is now installed on your cluster.

kubectl describe daemonset aws-node --namespace kube-system | grep amazon-k8s-cni: | cut -d : -f 3

The example output is as follows.

v1.12.6

(Optional) Install the cni-metrics-helper to your cluster. It scrapes elastic network interface and IP address information, aggregates it at a cluster level, and publishes the metrics to Amazon CloudWatch. For more information, see cni-metrics-helper on GitHub.