refactor: move spot requests tag into lambda

Author: pwo3

lambdas/functions/control-plane/src/aws/runners.ts

@@ -9,6 +9,7 @@ import {
   Tag,
   TerminateInstancesCommand,
   _InstanceType,
+  DescribeSpotInstanceRequestsCommand,
 } from '@aws-sdk/client-ec2';
 import { createChildLogger } from '@aws-github-runner/aws-powertools-util';
 import { getTracedAWSV3Client, tracer } from '@aws-github-runner/aws-powertools-util';
@@ -131,6 +132,33 @@ function generateFleetOverrides(
   return result;
 }
 
+async function tagSpotInstanceRequests(ec2Client: EC2Client, fleet: CreateFleetResult, tags: Tag[]) {
+  const instanceIds = fleet.Instances?.flatMap((i) => i.InstanceIds ?? []) ?? [];
+
+  if (!instanceIds.length) {
+    return;
+  }
+
+  const describeReq = await ec2Client.send(
+    new DescribeSpotInstanceRequestsCommand({
+      Filters: [{ Name: 'instance-id', Values: instanceIds }],
+    }),
+  );
+
+  const spotInstanceRequestIds = describeReq.SpotInstanceRequests?.map((req) => req.SpotInstanceRequestId).filter(
+    Boolean,
+  ) as string[];
+
+  if (spotInstanceRequestIds.length > 0) {
+    await ec2Client.send(
+      new CreateTagsCommand({
+        Resources: spotInstanceRequestIds,
+        Tags: tags,
+      }),
+    );
+  }
+}
+
 export async function createRunner(runnerParameters: Runners.RunnerInputParameters): Promise<string[]> {
   logger.debug('Runner configuration.', {
     runner: {
@@ -140,10 +168,26 @@ export async function createRunner(runnerParameters: Runners.RunnerInputParamete
     },
   });
 
+  const tags = [
+    { Key: 'ghr:Application', Value: 'github-action-runner' },
+    { Key: 'ghr:created_by', Value: runnerParameters.numberOfRunners === 1 ? 'scale-up-lambda' : 'pool-lambda' },
+    { Key: 'ghr:Type', Value: runnerParameters.runnerType },
+    { Key: 'ghr:Owner', Value: runnerParameters.runnerOwner },
+  ];
+
+  if (runnerParameters.tracingEnabled) {
+    const traceId = tracer.getRootXrayTraceId();
+    tags.push({ Key: 'ghr:trace_id', Value: traceId! });
+  }
+
   const ec2Client = getTracedAWSV3Client(new EC2Client({ region: process.env.AWS_REGION }));
   const amiIdOverride = await getAmiIdOverride(runnerParameters);
 
-  const fleet: CreateFleetResult = await createInstances(runnerParameters, amiIdOverride, ec2Client);
+  const fleet: CreateFleetResult = await createInstances(runnerParameters, amiIdOverride, ec2Client, tags);
+
+  if (runnerParameters.ec2instanceCriteria.targetCapacityType === 'spot') {
+    await tagSpotInstanceRequests(ec2Client, fleet, tags);
+  }
 
   const instances: string[] = await processFleetResult(fleet, runnerParameters);
 
@@ -231,19 +275,8 @@ async function createInstances(
   runnerParameters: Runners.RunnerInputParameters,
   amiIdOverride: string | undefined,
   ec2Client: EC2Client,
+  tags: Tag[],
 ) {
-  const tags = [
-    { Key: 'ghr:Application', Value: 'github-action-runner' },
-    { Key: 'ghr:created_by', Value: runnerParameters.numberOfRunners === 1 ? 'scale-up-lambda' : 'pool-lambda' },
-    { Key: 'ghr:Type', Value: runnerParameters.runnerType },
-    { Key: 'ghr:Owner', Value: runnerParameters.runnerOwner },
-  ];
-
-  if (runnerParameters.tracingEnabled) {
-    const traceId = tracer.getRootXrayTraceId();
-    tags.push({ Key: 'ghr:trace_id', Value: traceId! });
-  }
-
   let fleet: CreateFleetResult;
   try {
     // see for spec https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html

modules/runners/main.tf

@@ -206,23 +206,6 @@ resource "aws_launch_template" "runner" {
     )
   }
 
-  dynamic "tag_specifications" {
-    for_each = var.instance_target_capacity_type == "spot" && var.enable_on_demand_failover_for_errors == null ? [1] : [] # Include the block only if the value is "spot" and on_demand_failover_for_errors is not enabled
-    content {
-      resource_type = "spot-instances-request"
-      tags = merge(
-        local.tags,
-        {
-          "Name" = format("%s", local.name_runner)
-        },
-        {
-          "ghr:runner_name_prefix" = var.runner_name_prefix
-        },
-        var.runner_ec2_tags
-      )
-    }
-  }
-
   tag_specifications {
     resource_type = "network-interface"
     tags = merge(