aws-cdk: aws_eks: error retrieving RESTMappings to prune

For those using python cdk - I was able to get this running with the following:

npm install -s @aws-cdk/lambda-layer-kubectl-v24
pip install aws-cdk.lambda-layer-kubectl-v24

from aws_cdk.lambda_layer_kubectl_v24 import KubectlV24Layer

cluster = aws_eks.Cluster(self, 'cluster',
                          masters_role=self._eks_admin_role,
                          vpc=self._host_vpc,  # private_subnet_ids
                          vpc_subnets=[ec2.SubnetSelection(subnet_filters=[ec2.SubnetFilter.by_ids(private_subnet_ids)])],
                          default_capacity=0,
                          version=aws_eks.KubernetesVersion.V1_24,
                          output_cluster_name=True,
                          output_masters_role_arn=True,
                          role=self._eks_admin_role,
                          kubectl_layer=KubectlV24Layer(self, 'KubectlV24Layer'),
                          )

Not that much different than the typescript version, but took a bit of digging to figure out some of the namespacing as it isn’t explicitly listed in the python package. Hopefully this helps someone else out. Thanks for the original solution @AlyIbrahim!

OK, Digging deeper I found the solution !!!

First you need to import the version of kubectl that matches you current cluster to the CDK project dependencies. If you are using Typescript Project and your Kubernetes Version is 24 you will need to run the following command in your project directory: npm install -s @aws-cdk/lambda-layer-kubectl-v24 You can use other versions though the max I found was 24

Now in your stack you need to import the Kubectl layer as: import { KubectlV24Layer } from '@aws-cdk/lambda-layer-kubectl-v24';

And while creating the cluster you need to specify the Kubectl layer version as a one of the Clusterprops kubectlLayer: new KubectlV24Layer(this, 'Kubectlv24Layer')

As a complete example:

cons myCluster = new eks.Cluster(this, 'my-cluster'.{
clusterName: 'my-cluster',
version: eks.KubernetesVersion.V1_24,
kubectlLayer: new KubectlV24Layer(this, 'Kubectlv24Layer'),
vpc: myVPC,
...
...
})

I tested this solution and it is working fine.

Documentation should be clear and change this prop to a mandatory prop as it can cause breaking problems. Also it’s not clear if AWS will provide versions beyond 24 or will this be left to the community.

@AlyIbrahim

We have a feature request for aws-eks 1.25 support now - https://github.com/aws/aws-cdk/issues/24282

At the same time, if you need the kubectl layer 1.25 assets, please give an upvote on https://github.com/cdklabs/awscdk-asset-kubectl/issues/166

OK, Digging deeper I found the solution !!!

First you need to import the version of kubectl that matches you current cluster to the CDK project dependencies. If you are using Typescript Project and your Kubernetes Version is 24 you will need to run the following command in your project directory: npm install -s @aws-cdk/lambda-layer-kubectl-v24 You can use other versions though the max I found was 24

Now in your stack you need to import the Kubectl layer as: import { KubectlV24Layer } from '@aws-cdk/lambda-layer-kubectl-v24';

And while creating the cluster you need to specify the Kubectl layer version as a one of the Clusterprops kubectlLayer: new KubectlV24Layer(this, 'Kubectlv24Layer')

As a complete example:

cons myCluster = new eks.Cluster(this, 'my-cluster'.{
clusterName: 'my-cluster',
version: eks.KubernetesVersion.V1_24,
kubectlLayer: new KubectlV24Layer(this, 'Kubectlv24Layer'),
vpc: myVPC,
...
...
})

I tested this solution and it is working fine.

Documentation should be clear and change this prop to a mandatory prop as it can cause breaking problems. Also it’s not clear if AWS will provide versions beyond 24 or will this be left to the community.

Thanks @AlyIbrahim , this is really very helpful.

Hello Team. We are impacted as well with kubectl being bundled with old version into the lambda assets. For now, i am importing the kubectl v24 lambda layer and declaring it during the eks cluster creation

@peterwoodworth Thanks for your response …

I suggest the following:

• Add kubectlLayer prop to the main example with the required import and a description on how to add the required layer npm install -s @aws-cdk/lambda-layer-kubectl-v24
• Provide a link to the available lambda-layer-kubectl-vXX packages
• Add a warning for the default behavior if KubeLayer is not specified
• Add a troubleshooting section for this kind of error

I see that you had part of this already with the parameter but it’s down below and the regular user will not realize that this prop is required above v20. so unless the user read all doc for all the props it’s not easy to understand this breaking change …

Another option is to make the option mandatory to force users to know about the prop, but proper documentation can avoid this.