Add option for custom root volume storage size

[xJonathanLEI]

The default 8GB root volume is too small for certain workflows. This PR adds a storage-size option that overrides the default size. Tested and works.

[Dmitry1987]

nice, good for when vanilla AMI is used. too bad i'm not maintainer, can't merge all these goodies from incoming PRs 😄 , I'm picking useful ones to merge to my fork lol.

[neoReuters]

Perfect. Thank you.

[bss-dmitry-shmakov]

the test pipeline is broken, who can fix? lint-code is 💀

[neoReuters]

@Dmitry1987 it looks like @machulav has disabled automatic actions so the lint code action can only be triggered by him.

Would be good if there were some other maintainers on this.

[bss-dmitry-shmakov]

I saw @Dmitry1987 offered to be a maintainer by the way, in the discussions here, and one other guy too, but they got no response for now https://github.com/machulav/ec2-github-runner/discussions/172

[johannes-hailr]

@machulav Any way this PR can get merged in asap? The changes seem very simple, and I need this desperately! To keep maintenance down to a minimum I use a vanilla AMI and then use pre-runner-script to install minimum requirements, then install additional software as required in my workflow. The only thing standing in my way now is the limited storage space and no way to specify it. I am blocked now because space runs out halfway through my build.

[xJonathanLEI]

You can always use a fork instead.

[bss-dmitry-shmakov]

@machulav Any way this PR can get merged in asap? The changes seem very simple, and I need this desperately! To keep maintenance down to a minimum I use a vanilla AMI and then use pre-runner-script to install minimum requirements, then install additional software as required in my workflow. The only thing standing in my way now is the limited storage space and no way to specify it. I am blocked now because space runs out halfway through my build.

really the best way is to fork and maintain your own version of the plugin so you can control everything easily, it's just aws js sdk so all you need is to keep the src/aws.js parameters of the instance run command the way you need, without even passing them through the YAMLs in case your infra managed by the plugin is more or less the same. so you just pass through the yaml config params options that differ from one pipeline to another, and everything else can be filled in the js code the way you need.

[myz540]

FWIW, I forked the update and while storage-size does successfully mount an additional volume of your specified size, it does not mount it as part of the file system so you will have to do that separately. Additionally, I could not find a way to expand the root volume (still 8 GB with an alinux AMI) to incorporate this new volume as part of the logical file system. Basically I could mount to the new volume to /data for instance, but not to / which was already mounted to the 8 GB volume.

A workaround I found to be easier is to just introduce a step to expand the root volume size in your workflow. The first step in my job that runs on the EC2 is

- name: Expand root volume
        run: |
          TOKEN=$(curl -X PUT "http://169.254.169.254/latest/api/token" -H "X-aws-ec2-metadata-token-ttl-seconds: 21600")
          INSTANCE_ID=$(curl -H "X-aws-ec2-metadata-token: $TOKEN" -v http://169.254.169.254/latest/meta-data/instance-id)
          VOLUME_ID=$(aws ec2 describe-volumes --filters Name=attachment.instance-id,Values=$INSTANCE_ID | jq -r .Volumes[0].Attachments[0].VolumeId)
          echo $INSTANCE_ID
          echo $VOLUME_ID
          aws ec2 modify-volume --volume-id $VOLUME_ID --size 256
          sleep 15  # let it update
          growpart /dev/nvme0n1 1
          lsblk
          xfs_growfs -d /
          df -hT

This successfully resizes the EBS volume to 256 GB, expands the partition, and extends the logical file system to use the new space.

[xJonathanLEI]

@myz540 I believe it depends on your VM image. On the stock Ubuntu image for example this directly changes the root volume. An additional option can be added for specifying the device path tho, which would support such cases where the device name is different. I didn't bother cuz I use the stock Ubuntu image.

[xJonathanLEI]

Just updated to add another option storage-device to allow setting the root volume device name too. The default is just /dev/sda1 which works for Ubuntu AMIs. For Debian images for example this should be set to /dev/xvda.