ec2-github-runner

AWS EC2 Manager GitHub Action

This GitHub Action allows you to manage AWS EC2 instances. You can use it to start, execute commands on, and stop EC2 instances.

Inputs | Usage | Example Workflow | Development | Credit

Inputs

Outputs

Usage

Prerequisites

Ensure that the necessary AWS credentials and region are set up in the environment where this action runs. You can set these as environment variables in your GitHub Actions workflow:

env:
  AWS_REGION: your-aws-region
  AWS_ACCESS_KEY_ID: your-access-key-id
  AWS_SECRET_ACCESS_KEY: your-secret-access-key

Or use https://github.com/aws-actions/configure-aws-credentials action.

Example Workflow

name: Manage EC2 Instance

on: [push]

jobs:
  manage-ec2:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Start EC2 instance
      uses: https://github.com/ianb-mp/ec2-github-runner@v2
      id: start_ec2
      with:
        mode: start
        ec2-image-id: ami-0abcdef1234567890
        subnet-id: subnet-12345678
        security-group-id: sg-12345678
        iam-role-name: my-iam-role-name
        ec2-instance-type: t3.micro
        user-data: |
          #!/bin/bash
          echo "Hello, World!" > /var/www/html/index.html
        tag-specifications: '[{"ResourceType":"instance","Tags":[{"Key":"Name","Value":"MyInstance"}]}]'

    - name: Execute command on EC2 instance
      uses: https://github.com/ianb-mp/ec2-github-runner@v2
      with:
        mode: command
        ec2-instance-id: ${{ steps.start_ec2.outputs.ec2-instance-id }}
        command: echo "This is a command executed via SSM"

    - name: Stop EC2 instance
      uses: https://github.com/ianb-mp/ec2-github-runner@v2
      with:
        mode: stop
        ec2-instance-id: ${{ steps.start_ec2.outputs.ec2-instance-id }}

IAM Permissions

To use this GitHub Action, the following IAM permissions are required for each mode:

Credit

Inspired by https://github.com/machulav/ec2-github-runner

With some help from ChatGPT 😉