Merge pull request #119 from caktus/support-custom-eks-nodegroup-ami-images

Support Custom EKS Nodegroup AMI Images

Author: HusnaHariz

.github/workflows/pre-commit.yaml

@@ -9,6 +9,6 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-python@v2
-    - uses: pre-commit/action@v2.0.0
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/action@v3.0.1

CHANGELOG.rst

@@ -1,7 +1,41 @@
 Change Log
 ==========
 
-`X.Y.Z`_ (TBD-DD-DD)
+`2.4.0`_ (2025-09-08)
+---------------------
+
+**Backwards-incompatible changes:**
+
+* EBS volume type for worker nodes has been changed from ``gp2`` to ``gp3``. This will result in node replacement. Workload migration should still be managed by AWS.
+
+**What's new in 2.4.0 (#119):**
+
+* **Custom AMI Support**:
+
+  * Added support for conditionally specifying custom AMIs for EKS node groups.
+  * New parameters:
+
+    - ``CustomAMIImageType``: Corresponding image type (e.g., ``AL2023_x86_64_STANDARD``, ``AL2_x86_64``).
+    - ``CustomEKSAMI``: AMI ID to use for worker nodes. If ``CustomAMIImageType`` is set, one isn't required to set ``CustomEKSAMI``.
+
+  * Conditional logic ensures that these settings are only applied when explicitly provided.
+
+* **Cluster Version Parameterization**:
+
+  * Introduced ``EksClusterVersion`` parameter to allow template users to control the Kubernetes version.
+  * If this parameter is not set, AWS will default to the version already in place.
+
+* **Launch Template Enhancements**:
+
+  * Node group now uses a versioned launch template reference. This will support inplace changes rather than entire nodegroup replacement where possible.
+  * Custom AMI ID is injected into the launch template conditionally, based on user input.
+
+* **EBS Improvements**:
+
+  * Changed block storage type from ``gp2`` to ``gp3`` in the launch template for better performance and cost optimization.
+
+
+`2.3.0`_ (2024-11-21)
 ---------------------
 
 
@@ -234,6 +268,8 @@ Backwards-incompatible changes:
 * Initial public release
 
 
+.. _2.4.0: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.4.0/
+.. _2.3.0: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.3.0/
 .. _2.2.0: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.2.0/
 .. _2.1.2: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.1.2/
 .. _2.1.1: https://aws-web-stacks.s3.amazonaws.com/index.html?prefix=2.1.1/

stack/database.py

@@ -199,6 +199,9 @@
             "postgres12",
             "postgres13",
             "postgres14",
+            "postgres15",
+            "postgres16",
+            "postgres17",
             "sqlserver-ee-11.0",
             "sqlserver-ee-12.0",
             "sqlserver-ee-13.0",

stack/eks.py

@@ -105,10 +105,62 @@
     label="Cluster name",
 ))
 
+custom_eks_ami = Ref(template.add_parameter(
+    Parameter(
+        "CustomEKSAMI",
+        Description="Custom AMI ID for the EKS node group. It is recommended not to set this value, as AWS will automatically select the most optimized image when CustomAMIImageType is specified.", # noqa
+        Type="String",
+        Default="",
+    ),
+    group="Elastic Kubernetes Service (EKS)",
+    label="Custom EKS AMI",
+))
+
+use_custom_ami = "UseCustomAMI"
+template.add_condition(
+    use_custom_ami,
+    Not(Equals(custom_eks_ami, ""))
+)
+
+custom_ami_image_type = Ref(template.add_parameter(
+    Parameter(
+        "CustomAMIImageType",
+        Description="The image type to match the custom AMI. E.g., AL2023_x86_64_STANDARD, AL2_x86_64",
+        Type="String",
+        Default="",
+    ),
+    group="Elastic Kubernetes Service (EKS)",
+    label="Custom AMI Image Type",
+))
+
+use_custom_ami_type = "UseCustomAMIType"
+template.add_condition(
+    use_custom_ami_type,
+    Not(Equals(custom_ami_image_type, ""))
+)
+
+cluster_version = Ref(template.add_parameter(
+    Parameter(
+        "EksClusterVersion",
+        Description="The version of Kubernetes to use for the EKS cluster",
+        Type="String",
+        Default="",
+    ),
+    group="Elastic Kubernetes Service (EKS)",
+    label="Kubernetes Cluster Version",
+))
+
+use_cluster_version = "UseEksClusterVersion"
+template.add_condition(
+    use_cluster_version,
+    Not(Equals(cluster_version, ""))
+)
+
 cluster = eks.Cluster(
     "EksCluster",
     template=template,
     Name=cluster_name,
+    Version=If(use_cluster_version, cluster_version, Ref("AWS::NoValue")),
     Logging=eks.Logging(
         ClusterLogging=eks.ClusterLogging(
             EnabledTypes=[
@@ -145,14 +197,15 @@
     "NodegroupLaunchTemplate",
     template=template,
     LaunchTemplateData=ec2.LaunchTemplateData(
+        ImageId=If(use_custom_ami, custom_eks_ami, Ref("AWS::NoValue")),
         BlockDeviceMappings=[
             ec2.LaunchTemplateBlockDeviceMapping(
                 DeviceName="/dev/xvda",
                 Ebs=ec2.EBSBlockDevice(
                     DeleteOnTermination=True,
                     Encrypted=use_aes256_encryption,
                     KmsKeyId=If(use_cmk_arn, Ref(cmk_arn), Ref("AWS::NoValue")),
-                    VolumeType="gp2",
+                    VolumeType="gp3",
                     VolumeSize=container_volume_size,
                 ),
             ),
@@ -179,6 +232,7 @@
     NodeRole=GetAtt(container_instance_role, "Arn"),
     LaunchTemplate=eks.LaunchTemplateSpecification(
         Id=Ref(nodegroup_launch_template),
+        Version=GetAtt(nodegroup_launch_template, "LatestVersionNumber"),
     ),
     # The rest are optional.
     ScalingConfig=eks.ScalingConfig(
@@ -187,6 +241,7 @@
         MinSize=2,
     ),
     Subnets=[Ref(private_subnet_a), Ref(private_subnet_b)],
+    AmiType=If(use_custom_ami_type, custom_ami_image_type, Ref("AWS::NoValue"))
 )
 
 # OUTPUTS