Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

feat(ssm): seed the EKS optimized AMI parameter paths (#4191)

Simone Primarosa188542e67f93
diff --git a/docs/services/ssm.md b/docs/services/ssm.md
index c2305e183c..01fc36336d 100644
--- a/docs/services/ssm.md
+++ b/docs/services/ssm.md
@@ -98,14 +98,17 @@ aws ssm send-command --endpoint-url $AWS_ENDPOINT_URL \
## Public AMI Parameters
-AWS publishes AMI id lookup parameters under `/aws/service/ami-amazon-linux-latest/` in every
-account, and Terraform modules read them without any setup. Floci answers the documented Amazon
-Linux 2 and Amazon Linux 2023 names from its EC2 image catalog, so `GetParameter`, `GetParameters`
-and `GetParametersByPath` resolve them to the catalog's AMI ids. As on AWS they are read-only and
-belong to no account, so they do not appear in `DescribeParameters`.
+AWS publishes AMI id lookup parameters under `/aws/service/ami-amazon-linux-latest/` and EKS
+optimized node AMI lookup parameters under `/aws/service/eks/optimized-ami/` in every account,
+and tools such as Terraform, Karpenter and eksctl read them without any setup. Floci answers the
+documented Amazon Linux 2 and Amazon Linux 2023 names from its EC2 image catalog across supported
+architectures and Kubernetes versions, so `GetParameter`, `GetParameters` and `GetParametersByPath`
+resolve them to the catalog's AMI ids. As on AWS they are read-only and belong to no account,
+so they do not appear in `DescribeParameters`.
```bash
aws ssm get-parameter --name /aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64
+aws ssm get-parameter --name /aws/service/eks/optimized-ami/1.31/amazon-linux-2023/x86_64/standard/recommended/image_id
```
## Parameter Types
diff --git a/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2ImageCatalog.java b/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2ImageCatalog.java
index bf7821d275..b5dc74b0ce 100644
--- a/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2ImageCatalog.java
+++ b/src/main/java/io/github/hectorvent/floci/services/ec2/Ec2ImageCatalog.java
@@ -5,6 +5,7 @@ import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import io.github.hectorvent.floci.config.EmulatorConfig;
import io.github.hectorvent.floci.services.ec2.model.Image;
+import io.github.hectorvent.floci.services.eks.EksClusterManager;
import io.quarkus.runtime.annotations.RegisterForReflection;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.inject.Inject;
@@ -25,6 +26,8 @@ public class Ec2ImageCatalog {
private static final String CATALOG_RESOURCE_NAME = "ec2/image-catalog.yaml";
private static final ObjectMapper YAML_MAPPER = new ObjectMapper(new YAMLFactory());
+ private static final String K8S_VERSION_PLACEHOLDER = "{k8s-version}";
+ private static final String EKS_AL2_MAX_K8S_VERSION = "1.32";
private final Path catalogPath;
private volatile Loaded loaded;
@@ -221,9 +224,51 @@ public class Ec2ImageCatalog {
/**
* The public SSM parameter names AWS publishes this image under. AWS seeds them in every
* account with no setup, so SSM answers a read of one of these names from the catalog.
+ * Parameter templates containing {@code {k8s-version}} are expanded for each supported
+ * Kubernetes version in {@link EksClusterManager#SUPPORTED_K8S_VERSIONS}. AL2 is capped
+ * at Kubernetes 1.32, matching AWS's deprecation cutoff.
*/
public List<String> publicParameterNames() {
- return publicParameterNames == null ? List.of() : List.copyOf(publicParameterNames);
+ return expandPublicParameterNames(publicParameterNames);
+ }
+
+ private static List<String> expandPublicParameterNames(List<String> templates) {
+ if (templates == null || templates.isEmpty()) {
+ return List.of();
+ }
+ List<String> expanded = new ArrayList<>();
+ for (String template : templates) {
+ if (template != null && template.contains(K8S_VERSION_PLACEHOLDER)) {
+ for (String version : EksClusterManager.SUPPORTED_K8S_VERSIONS.keySet().stream().sorted().toList()) {
+ if (isSupportedK8sVersionForTemplate(template, version)) {
+ expanded.add(template.replace(K8S_VERSION_PLACEHOLDER, version));
+ }
+ }
+ } else if (template != null) {
+ expanded.add(template);
+ }
+ }
+ return Collections.unmodifiableList(expanded);
+ }
+
+ private static boolean isSupportedK8sVersionForTemplate(String template, String version) {
+ if (template.contains("/amazon-linux-2/")) {
+ return compareK8sVersions(version, EKS_AL2_MAX_K8S_VERSION) <= 0;
+ }
+ return true;
+ }
+
+ private static int compareK8sVersions(String v1, String v2) {
+ String[] parts1 = v1.split("\\.");
+ String[] parts2 = v2.split("\\.");
+ int major1 = Integer.parseInt(parts1[0]);
+ int major2 = Integer.parseInt(parts2[0]);
+ if (major1 != major2) {
+ return Integer.compare(major1, major2);
+ }
+ int minor1 = parts1.length > 1 ? Integer.parseInt(parts1[1]) : 0;
+ int minor2 = parts2.length > 1 ? Integer.parseInt(parts2[1]) : 0;
+ return Integer.compare(minor1, minor2);
}
public List<String> idsAndAliases() {
diff --git a/src/main/resources/ec2/image-catalog.yaml b/src/main/resources/ec2/image-catalog.yaml
index 46a74084f4..4705e297c0 100644
--- a/src/main/resources/ec2/image-catalog.yaml
+++ b/src/main/resources/ec2/image-catalog.yaml
@@ -8,6 +8,7 @@ images:
- /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2
- /aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs
- /aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-gp2
+ - /aws/service/eks/optimized-ami/{k8s-version}/amazon-linux-2/recommended/image_id
dockerImage: public.ecr.aws/amazonlinux/amazonlinux:2
name: amzn2-ami-hvm-2.0.20230404.0-x86_64-gp2
description: Amazon Linux 2 AMI
@@ -23,6 +24,7 @@ images:
- /aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64
- /aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64
- /aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-x86_64
+ - /aws/service/eks/optimized-ami/{k8s-version}/amazon-linux-2023/x86_64/standard/recommended/image_id
dockerImage: public.ecr.aws/amazonlinux/amazonlinux:2023
name: al2023-ami-2023.0.20230315.0-kernel-6.1-x86_64
description: Amazon Linux 2023 AMI
@@ -36,6 +38,7 @@ images:
- /aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-arm64
- /aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-arm64
- /aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64
+ - /aws/service/eks/optimized-ami/{k8s-version}/amazon-linux-2023/arm64/standard/recommended/image_id
dockerImage: public.ecr.aws/amazonlinux/amazonlinux:2023
name: al2023-ami-2023.0.20230315.0-kernel-6.1-arm64
description: Amazon Linux 2023 AMI
diff --git a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ImageCatalogTest.java b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ImageCatalogTest.java
index 1211ad8c57..84f896d8c0 100644
--- a/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ImageCatalogTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/ec2/Ec2ImageCatalogTest.java
@@ -59,7 +59,16 @@ class Ec2ImageCatalogTest {
assertEquals(List.of(
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-x86_64",
- "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-x86_64"),
+ "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-x86_64",
+ "/aws/service/eks/optimized-ami/1.28/amazon-linux-2023/x86_64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.29/amazon-linux-2023/x86_64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.30/amazon-linux-2023/x86_64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.31/amazon-linux-2023/x86_64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.32/amazon-linux-2023/x86_64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.33/amazon-linux-2023/x86_64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.34/amazon-linux-2023/x86_64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.35/amazon-linux-2023/x86_64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.36/amazon-linux-2023/x86_64/standard/recommended/image_id"),
x86.publicParameterNames());
Ec2ImageCatalog.CatalogImage arm64 = imageCatalog.findByIdOrAlias("ami-amazonlinux2023-arm64").orElseThrow();
@@ -68,10 +77,35 @@ class Ec2ImageCatalogTest {
assertEquals(List.of(
"/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-arm64",
"/aws/service/ami-amazon-linux-latest/al2023-ami-minimal-kernel-default-arm64",
- "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64"),
+ "/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-6.1-arm64",
+ "/aws/service/eks/optimized-ami/1.28/amazon-linux-2023/arm64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.29/amazon-linux-2023/arm64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.30/amazon-linux-2023/arm64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.31/amazon-linux-2023/arm64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.32/amazon-linux-2023/arm64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.33/amazon-linux-2023/arm64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.34/amazon-linux-2023/arm64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.35/amazon-linux-2023/arm64/standard/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.36/amazon-linux-2023/arm64/standard/recommended/image_id"),
arm64.publicParameterNames());
}
+ @Test
+ void amazonLinux2EntriesCapEksOptimizedAmiAt1_32() {
+ Ec2ImageCatalog.CatalogImage amzn2 = imageCatalog.findByIdOrAlias("ami-0abcdef1234567890").orElseThrow();
+ assertEquals("x86_64", amzn2.architecture);
+ assertEquals(List.of(
+ "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2",
+ "/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs",
+ "/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-gp2",
+ "/aws/service/eks/optimized-ami/1.28/amazon-linux-2/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.29/amazon-linux-2/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.30/amazon-linux-2/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.31/amazon-linux-2/recommended/image_id",
+ "/aws/service/eks/optimized-ami/1.32/amazon-linux-2/recommended/image_id"),
+ amzn2.publicParameterNames());
+ }
+
@Test
void resolverUsesCatalogDockerImagesForIdsAndAliases() {
imageCatalog.images()
diff --git a/src/test/java/io/github/hectorvent/floci/services/ssm/SsmIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/ssm/SsmIntegrationTest.java
index 3ef47200c1..881190c5b3 100644
--- a/src/test/java/io/github/hectorvent/floci/services/ssm/SsmIntegrationTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/ssm/SsmIntegrationTest.java
@@ -1338,6 +1338,24 @@ class SsmIntegrationTest {
.body("Parameters.Name", contains(al2023))
.body("InvalidParameters", contains("/aws/service/ami-amazon-linux-latest/no-such-variant"));
+ String eksOptimizedAmi = "/aws/service/eks/optimized-ami/1.31/amazon-linux-2023/x86_64/standard/recommended/image_id";
+
+ given()
+ .header("X-Amz-Target", "AmazonSSM.GetParameter")
+ .contentType(SSM_CONTENT_TYPE)
+ .body("""
+ { "Name": "%s" }
+ """.formatted(eksOptimizedAmi))
+ .when()
+ .post("/")
+ .then()
+ .statusCode(200)
+ .body("Parameter.Name", equalTo(eksOptimizedAmi))
+ .body("Parameter.Value", equalTo("ami-0abcdef1234567891"))
+ .body("Parameter.Type", equalTo("String"))
+ .body("Parameter.Version", equalTo(1))
+ .body("Parameter.ARN", equalTo("arn:aws:ssm:us-east-1::parameter" + eksOptimizedAmi));
+
given()
.header("X-Amz-Target", "AmazonSSM.GetParametersByPath")
.contentType(SSM_CONTENT_TYPE)
diff --git a/src/test/java/io/github/hectorvent/floci/services/ssm/SsmServicePublicAmiParameterTest.java b/src/test/java/io/github/hectorvent/floci/services/ssm/SsmServicePublicAmiParameterTest.java
index 504012d75a..158d2b63a3 100644
--- a/src/test/java/io/github/hectorvent/floci/services/ssm/SsmServicePublicAmiParameterTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/ssm/SsmServicePublicAmiParameterTest.java
@@ -98,8 +98,68 @@ class SsmServicePublicAmiParameterTest {
assertTrue(names.contains(AL2023_DEFAULT), names.toString());
assertTrue(names.contains(AL2023_ARM64_DEFAULT), names.toString());
assertTrue(names.contains(AMZN2_DEFAULT), names.toString());
+ assertEquals(9, names.size());
assertTrue(ssmService.getParametersByPath("/aws/service", false, REGION).isEmpty());
- assertEquals(names.size(), ssmService.getParametersByPath("/aws/service", true, REGION).size());
+ assertEquals(32, ssmService.getParametersByPath("/aws/service", true, REGION).size());
+ }
+
+ @Test
+ void resolvesEksOptimizedAmiParametersAcrossArchitecturesAndVersions() {
+ String x86Param = "/aws/service/eks/optimized-ami/1.31/amazon-linux-2023/x86_64/standard/recommended/image_id";
+ Parameter x86 = ssmService.getParameter(x86Param, REGION);
+ assertEquals("ami-0abcdef1234567891", x86.getValue());
+ assertEquals("String", x86.getType());
+ assertEquals(1, x86.getVersion());
+ assertEquals("arn:aws:ssm:eu-west-1::parameter" + x86Param, x86.getArn());
+
+ String arm64Param = "/aws/service/eks/optimized-ami/1.31/amazon-linux-2023/arm64/standard/recommended/image_id";
+ Parameter arm64 = ssmService.getParameter(arm64Param, REGION);
+ assertEquals("ami-amazonlinux2023-arm64", arm64.getValue());
+ assertEquals("String", arm64.getType());
+ assertEquals(1, arm64.getVersion());
+ assertEquals("arn:aws:ssm:eu-west-1::parameter" + arm64Param, arm64.getArn());
+
+ String al2Param132 = "/aws/service/eks/optimized-ami/1.32/amazon-linux-2/recommended/image_id";
+ Parameter al2 = ssmService.getParameter(al2Param132, REGION);
+ assertEquals("ami-0abcdef1234567890", al2.getValue());
+ assertEquals("String", al2.getType());
+ assertEquals(1, al2.getVersion());
+ assertEquals("arn:aws:ssm:eu-west-1::parameter" + al2Param132, al2.getArn());
+
+ String al2023Param136 = "/aws/service/eks/optimized-ami/1.36/amazon-linux-2023/x86_64/standard/recommended/image_id";
+ Parameter al2023 = ssmService.getParameter(al2023Param136, REGION);
+ assertEquals("ami-0abcdef1234567891", al2023.getValue());
+ assertEquals("String", al2023.getType());
+ assertEquals(1, al2023.getVersion());
+ assertEquals("arn:aws:ssm:eu-west-1::parameter" + al2023Param136, al2023.getArn());
+ }
+
+ @Test
+ void unseededEksOptimizedAmiVersionThrowsParameterNotFound() {
+ String unseededVersion = "/aws/service/eks/optimized-ami/1.27/amazon-linux-2023/x86_64/standard/recommended/image_id";
+ AwsException ex = assertThrows(AwsException.class, () -> ssmService.getParameter(unseededVersion, REGION));
+ assertEquals("ParameterNotFound", ex.getErrorCode());
+ assertEquals(400, ex.getHttpStatus());
+
+ String al2Deprecated133 = "/aws/service/eks/optimized-ami/1.33/amazon-linux-2/recommended/image_id";
+ AwsException exAl2_133 = assertThrows(AwsException.class, () -> ssmService.getParameter(al2Deprecated133, REGION));
+ assertEquals("ParameterNotFound", exAl2_133.getErrorCode());
+ assertEquals(400, exAl2_133.getHttpStatus());
+
+ String al2Deprecated136 = "/aws/service/eks/optimized-ami/1.36/amazon-linux-2/recommended/image_id";
+ AwsException exAl2_136 = assertThrows(AwsException.class, () -> ssmService.getParameter(al2Deprecated136, REGION));
+ assertEquals("ParameterNotFound", exAl2_136.getErrorCode());
+ assertEquals(400, exAl2_136.getHttpStatus());
+
+ String unseededFutureVersion = "/aws/service/eks/optimized-ami/1.37/amazon-linux-2023/x86_64/standard/recommended/image_id";
+ AwsException exFuture = assertThrows(AwsException.class, () -> ssmService.getParameter(unseededFutureVersion, REGION));
+ assertEquals("ParameterNotFound", exFuture.getErrorCode());
+ assertEquals(400, exFuture.getHttpStatus());
+
+ String unseededArch = "/aws/service/eks/optimized-ami/1.31/amazon-linux-2023/s390x/standard/recommended/image_id";
+ AwsException ex2 = assertThrows(AwsException.class, () -> ssmService.getParameter(unseededArch, REGION));
+ assertEquals("ParameterNotFound", ex2.getErrorCode());
+ assertEquals(400, ex2.getHttpStatus());
}
@Test