Add support for resizing root volume (#17)

Author: mahdi-torabi

.env.example

@@ -13,6 +13,8 @@ INPUT_GITHUB_ACTION_RUNNER_VERSION=
 INPUT_GITHUB_ACTION_RUNNER_LABEL=
 INPUT_EC2_INSTANCE_TYPE=
 INPUT_EC2_AMI_ID=
+INPUT_EC2_ROOT_DISK_SIZE_GB=
+INPUT_EC2_ROOT_DISK_EBS_CLASS=
 INPUT_EC2_INSTANCE_IAM_ROLE=
 INPUT_EC2_INSTANCE_TAGS=
 INPUT_EC2_INSTANCE_TTL=

README.md

@@ -40,7 +40,9 @@ Sources:
 - [GH Action Runner Pricing](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#per-minute-rates)
 
 ### Customizable Machine Image
-Users can provide their own custom AMI image pre-loaded with all the necessary tooling of their choice saving time and cost. 
+- Set custom EC2 root volume size 
+- Set custom storage class for root volume
+- Users can provide their own custom AMI image pre-loaded with all the necessary tooling of their choice saving time and cost. 
 
 ### Enhance Security
 - EC2 instances run within your infrastructure
@@ -153,9 +155,11 @@ jobs:
               github_action_runner_version: v2.300.2 # Optional (default is latest release)
               ec2_instance_type: c5.4xlarge
               ec2_ami_id: ami-008fe2fc65df48dac
+              ec2_root_disk_size_gb: "100"                 # Optional - (defaults to AMI settings)
+              ec2_root_disk_ebs_class: "gp2"               # Optional - Only used with custom volume root size (defaults to gp2)
               ec2_subnet_id: "SUBNET_ID_REDACTED"
               ec2_security_group_id: "SECURITY_GROUP_ID_REDACTED"
-              ec2_instance_ttl: 40                          # Optional (default is 60 minutes)
+              ec2_instance_ttl: 40                          # Optional - (default is 60 minutes)
               ec2_spot_instance_strategy: MaxPerformance    # Other options are: None, BestEffort, MaxPerformance 
               ec2_instance_tags: >                          # Required for IAM role resource permission scoping
                 [

action.yaml

@@ -36,6 +36,14 @@ inputs:
   ec2_ami_id:
     description: 'Ec2 ami ID'
     required: true
+  ec2_root_disk_size_gb:
+    description: 'Ec2 root disk size (defaults to AMI setting)'
+    required: false
+    default: "0"
+  ec2_root_disk_ebs_class:
+    description: 'Ec2 root disk storage class (defaults to gp2)'
+    required: false
+    default: "gp2"
   ec2_instance_iam_role:
     description: 'IAM role for to associate with ec2 instance'
     required: false

dist/index.js

@@ -52,6 +52,8 @@ class ActionConfig {
         // Ec2 params
         this.ec2InstanceType = core.getInput("ec2_instance_type");
         this.ec2AmiId = core.getInput("ec2_ami_id");
+        this.ec2InstanceRootDiskSizeGB = core.getInput("ec2_root_disk_size_gb");
+        this.ec2InstanceRootDiskEbsClass = core.getInput("ec2_root_disk_ebs_class");
         this.ec2InstanceIamRole = core.getInput("ec2_instance_iam_role");
         this.ec2InstanceTags = core.getInput("ec2_instance_tags");
         this.ec2InstanceTtl = core.getInput("ec2_instance_ttl");
@@ -353,7 +355,26 @@ class Ec2Instance {
                     },
                 ],
                 UserData: yield userData.getUserData(),
+                BlockDeviceMappings: undefined
             };
+            // Add EBS volume if one was requested
+            const sizeGB = parseInt(this.config.ec2InstanceRootDiskSizeGB.trim(), 10) || 0;
+            if (sizeGB > 0) {
+                const deviceInfo = yield this.getRootDeviceInfo(this.config.ec2AmiId);
+                if (!deviceInfo || !(deviceInfo === null || deviceInfo === void 0 ? void 0 : deviceInfo.isEbs)) {
+                    throw Error(`${this.config.ec2AmiId} must support EBS as volume type`);
+                }
+                params.BlockDeviceMappings = [
+                    {
+                        DeviceName: deviceInfo.deviceName,
+                        Ebs: {
+                            VolumeSize: Number(this.config.ec2InstanceRootDiskSizeGB),
+                            VolumeType: this.config.ec2InstanceRootDiskEbsClass,
+                            DeleteOnTermination: true // Ensure volume is deleted on termination
+                        }
+                    }
+                ];
+            }
             switch (ec2SpotInstanceStrategy.toLowerCase()) {
                 case "spotonly": {
                     params.InstanceMarketOptions = {
@@ -473,6 +494,29 @@ class Ec2Instance {
             }
         });
     }
+    getRootDeviceInfo(amiId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const client = yield this.getEc2Client();
+            try {
+                const command = new client_ec2_1.DescribeImagesCommand({ ImageIds: [amiId.trim()] });
+                const response = yield client.send(command);
+                if (response.Images && response.Images.length > 0) {
+                    const image = response.Images[0];
+                    if (image.RootDeviceName && image.RootDeviceType) {
+                        return {
+                            deviceName: image.RootDeviceName,
+                            isEbs: image.RootDeviceType.includes("ebs")
+                        };
+                    }
+                    return { deviceName: "", isEbs: false };
+                }
+            }
+            catch (error) {
+                core.error("Error querying AMI information:", error);
+                throw error;
+            }
+        });
+    }
 }
 exports.Ec2Instance = Ec2Instance;
 

docs/CrossAccountIAM.md

@@ -20,7 +20,8 @@
                 "ec2:DescribeSubnets",
                 "ec2:describeSpotPriceHistory",
                 "pricing:GetProducts",
-                "pricing:GetAttributeValues"
+                "pricing:GetAttributeValues",
+                "ec2:DescribeImages"
             ],
             "Resource": "*",
             "Effect": "Allow"

src/config/config.ts

@@ -18,6 +18,8 @@ export interface ConfigInterface {
 
   ec2InstanceType: string;
   ec2AmiId: string;
+  ec2InstanceRootDiskSizeGB: string;
+  ec2InstanceRootDiskEbsClass: string;
   ec2InstanceIamRole: string;
   ec2InstanceTags: string;
   ec2InstanceTtl: string;
@@ -43,6 +45,8 @@ export class ActionConfig implements ConfigInterface {
 
   ec2InstanceType: string;
   ec2AmiId: string;
+  ec2InstanceRootDiskSizeGB: string;
+  ec2InstanceRootDiskEbsClass: string;
   ec2InstanceIamRole: string;
   ec2InstanceTags: string;
   ec2InstanceTtl: string;
@@ -72,6 +76,8 @@ export class ActionConfig implements ConfigInterface {
     // Ec2 params
     this.ec2InstanceType = core.getInput("ec2_instance_type");
     this.ec2AmiId = core.getInput("ec2_ami_id");
+    this.ec2InstanceRootDiskSizeGB = core.getInput("ec2_root_disk_size_gb");
+    this.ec2InstanceRootDiskEbsClass = core.getInput("ec2_root_disk_ebs_class");
     this.ec2InstanceIamRole = core.getInput("ec2_instance_iam_role");
     this.ec2InstanceTags = core.getInput("ec2_instance_tags");
     this.ec2InstanceTtl = core.getInput("ec2_instance_ttl");

src/ec2/ec2.ts

@@ -1,11 +1,19 @@
 import { ConfigInterface } from "../config/config";
 import * as _ from "lodash";
 import { AwsCredentialIdentity } from "@smithy/types";
-import { EC2, waitUntilInstanceRunning, DescribeSpotPriceHistoryCommandInput, _InstanceType, RunInstancesCommandInput } from "@aws-sdk/client-ec2";
+import {
+  EC2,
+  waitUntilInstanceRunning,
+  DescribeSpotPriceHistoryCommandInput,
+  _InstanceType,
+  RunInstancesCommandInput,
+  DescribeImagesCommand
+} from "@aws-sdk/client-ec2";
 import { STS } from "@aws-sdk/client-sts";
 import * as core from "@actions/core";
 import { UserData } from "./userdata";
 import { Ec2Pricing } from "./pricing";
+import {VolumeType} from "@aws-sdk/client-ec2/dist-types/models/models_1";
 
 interface Tag {
   Key: string;
@@ -289,8 +297,30 @@ export class Ec2Instance {
         },
       ],
       UserData: await userData.getUserData(),
+      BlockDeviceMappings: undefined
     };
 
+    // Add EBS volume if one was requested
+    const sizeGB = parseInt(this.config.ec2InstanceRootDiskSizeGB.trim(), 10) || 0;
+    if (sizeGB > 0) {
+      const deviceInfo = await this.getRootDeviceInfo(this.config.ec2AmiId);
+
+      if (!deviceInfo || !deviceInfo?.isEbs) {
+        throw Error(`${this.config.ec2AmiId} must support EBS as volume type`);
+      }
+
+      params.BlockDeviceMappings = [
+        {
+          DeviceName: deviceInfo.deviceName,
+          Ebs: {
+            VolumeSize: Number(this.config.ec2InstanceRootDiskSizeGB),
+            VolumeType: this.config.ec2InstanceRootDiskEbsClass as VolumeType,
+            DeleteOnTermination: true  // Ensure volume is deleted on termination
+          }
+        }
+      ]
+    }
+
     switch (ec2SpotInstanceStrategy.toLowerCase()) {
       case "spotonly": {
         params.InstanceMarketOptions = {
@@ -406,12 +436,35 @@ export class Ec2Instance {
   async terminateInstances(instanceId: string) {
     const client = await this.getEc2Client();
     try {
-      await client.terminateInstances({ InstanceIds: [instanceId] });
+      await client.terminateInstances({InstanceIds: [instanceId]});
       core.info(`AWS EC2 instance ${instanceId} is terminated`);
       return;
     } catch (error) {
       core.error(`Failed terminate instance ${instanceId}`);
       throw error;
     }
   }
+
+  async getRootDeviceInfo(amiId: string): Promise<{ deviceName: string, isEbs: boolean } | undefined> {
+    const client = await this.getEc2Client();
+
+    try {
+      const command = new DescribeImagesCommand({ImageIds: [amiId.trim()]});
+      const response = await client.send(command);
+
+      if (response.Images && response.Images.length > 0) {
+        const image = response.Images[0];
+        if (image.RootDeviceName && image.RootDeviceType) {
+          return {
+            deviceName: image.RootDeviceName,
+            isEbs: image.RootDeviceType.includes("ebs")
+          }
+        }
+        return {deviceName: "", isEbs: false}
+      }
+    } catch (error) {
+      core.error("Error querying AMI information:", error);
+      throw error;
+    }
+  }
 }

tests/ec2/ec2.ts

@@ -32,5 +32,30 @@ describe('EC2 lib tests', () => {
         expect(nextInstanceType).to.include("c5")
     });
 
+    it('get root volume device name for AMI', async () => {
+
+        for (const amiID of
+            ["ami-0e30b3388d74cee6d",    // Ubuntu
+                "ami-0c2644caf041bb6de", // Debian
+                "ami-089d88d106dd8e9b5"]// Amazon Linux
+            ) {
+            // Get device info
+            let deviceInfo = await ec2.getRootDeviceInfo(amiID);
+            expect(deviceInfo).is.not.undefined
+            expect(deviceInfo!.isEbs).is.not.false
+            expect(deviceInfo!.deviceName).is.not.undefined
+            expect(deviceInfo!.deviceName).is.string
+            expect(deviceInfo!.deviceName).to.include("/dev/xvda")
+        }
+
+
+        // Windows
+        let deviceInfo = await ec2.getRootDeviceInfo("ami-0a335fb413d7589ee ");
+        expect(deviceInfo).is.not.undefined
+        expect(deviceInfo!.isEbs).is.not.false
+        expect(deviceInfo!.deviceName).is.not.undefined
+        expect(deviceInfo!.deviceName).is.string
+        expect(deviceInfo!.deviceName).to.include("/dev/sda1")
+    });
 
 });