EC2 bench: Make configuration of AMI more comfortable #2
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: bench-ec2-reusable | ||
| on: | ||
| workflow_call: | ||
| inputs: | ||
| name: | ||
| type: string | ||
| description: Alternative name of instance | ||
| default: Graviton2 | ||
| ec2_instance_type: | ||
| type: string | ||
| description: Type if EC2 instance to benchmark on | ||
| default: t4g.small | ||
| ec2_ami: | ||
| description: AMI | ||
| type: choice | ||
| options: | ||
| - ubuntu-latest (x86_64) | ||
| - ubuntu-latest (aarch64) | ||
| - ubuntu-latest (custom AMI) | ||
| default: "ubuntu-latest (x86_64)" | ||
| ec2_ami_id: | ||
| type: string | ||
| description: AMI ID | ||
| default: ami-096ea6a12ea24a797 | ||
| cflags: | ||
| type: string | ||
| description: Custom CFLAGS for compilation | ||
| default: | ||
| archflags: | ||
| type: string | ||
| description: Custom ARCH flags for compilation | ||
| default: -mcpu=neoverse-n1 -march=armv8.2-a | ||
| store_results: | ||
| type: string | ||
| description: Indicates if results should be pushed to github pages | ||
| default: 'false' | ||
| always_terminate: | ||
| type: string | ||
| description: Indicates if instance should always be terminated, even on failure | ||
| default: 'true' | ||
| bench_extra_args: | ||
| type: string | ||
| description: Additional command line to be appended to `bench` script | ||
| default: '' | ||
| env: | ||
| AWS_ROLE: arn:aws:iam::559050233797:role/mlkem-c-aarch64-gh-action | ||
| AWS_REGION: us-east-1 | ||
| AMI_UBUNTU_LATEST_X86_64=ami-0e86e20dae9224db8 | ||
| AMI_UBUNTU_LATEST_AARCH64=ami-096ea6a12ea24a797 | ||
| jobs: | ||
| start-ec2-runner: | ||
| name: Start ${{ github.event.inputs.name }} (${{ github.event.inputs.ec2_instance_type }}) | ||
| permissions: | ||
| contents: 'read' | ||
| id-token: 'write' | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| label: ${{ steps.start-ec2-runner.outputs.label }} | ||
| ec2-instance-id: ${{ steps.start-ec2-runner.outputs.ec2-instance-id }} | ||
| steps: | ||
| - name: Determine AMI ID | ||
| id: det_ami_id | ||
| run: | | ||
| if [[ "${{ inputs.ec2_ami }}" == "ubuntu-latest (x86_64)" ]]; then | ||
| AMI_ID=${{ env.AMI_UBUNTU_LATEST_X86_64 }} | ||
| fi | ||
| if [[ "${{ inputs.ec2_ami }}" == "ubuntu-latest (aarch64)" ]]; then | ||
| AMI_ID=${{ env.AMI_UBUNTU_LATEST_AARCH64 }} | ||
| fi | ||
| if [[ "${{ inputs.ec2_ami }}" == "ubuntu-latest (custom AMI)" ]]; then | ||
| AMI_ID=${{ inputs.ec2_ami_id }} | ||
| fi | ||
| echo "Using AMI ID: $AMI_ID" | ||
| echo "AMI_ID=$AMI_ID" >> $GITHUB_OUTPUT | ||
| - uses: actions/checkout@v4 | ||
| - name: Clear nix-installer action cache | ||
| uses: ./.github/actions/clear-cache | ||
| with: | ||
| key_prefix: determinatesystem-nix-installer- | ||
| repository: ${{ github.repository }} | ||
| gh_token: ${{ secrets.AWS_GITHUB_TOKEN }} | ||
| - name: Configure AWS credentials | ||
| uses: aws-actions/configure-aws-credentials@v4 | ||
| with: | ||
| role-to-assume: ${{ env.AWS_ROLE }} | ||
| aws-region: ${{ env.AWS_REGION }} | ||
| - name: Start EC2 runner | ||
| id: start-ec2-runner | ||
| needs: det_ami_id | ||
| uses: machulav/ec2-github-runner@v2 | ||
| with: | ||
| mode: start | ||
| github-token: ${{ secrets.AWS_GITHUB_TOKEN }} | ||
| ec2-image-id: ${{ steps.det_ami_id.outputs.AMI_ID }} | ||
| ec2-instance-type: ${{ inputs.ec2_instance_type }} | ||
| subnet-id: subnet-07b2729e5e065962f | ||
| security-group-id: sg-0ab2e297196c8c381 | ||
| bench: | ||
| name: Bench ${{ inputs.name }} | ||
| needs: start-ec2-runner # required to start the main job when the runner is ready | ||
| runs-on: ${{ needs.start-ec2-runner.outputs.label }} # run the job on the newly created runner | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Setup nix | ||
| uses: ./.github/actions/setup-nix | ||
| with: | ||
| devShell: ci | ||
| script: | | ||
| ARCH=$(uname -m) | ||
| cat >> $GITHUB_STEP_SUMMARY <<-EOF | ||
| ## Setup | ||
| Architecture: $ARCH | ||
| - $(uname -a) | ||
| - $(nix --version) | ||
| - $(astyle --version) | ||
| - $(${{ matrix.target.cross_prefix }}gcc --version | grep -m1 "") | ||
| - $(bash --version | grep -m1 "") | ||
| ## CPU Info | ||
| $(cat /proc/cpuinfo) | ||
| EOF | ||
| - name: Run benchmark | ||
| uses: ./.github/actions/bench | ||
| with: | ||
| name: ${{ inputs.name }} | ||
| cflags: ${{ inputs.cflags }} | ||
| archflags: ${{ inputs.archflags }} | ||
| perf: PERF | ||
| store_results: ${{ inputs.store_results }} | ||
| bench_extra_args: ${{ inputs.bench_extra_args }} | ||
| gh_token: ${{ secrets.AWS_GITHUB_TOKEN }} | ||
| stop-ec2-runner: | ||
| name: Stop ${{ github.event.inputs.name }} (${{ github.event.inputs.ec2_instance_type }}) | ||
| permissions: | ||
| contents: 'read' | ||
| id-token: 'write' | ||
| needs: | ||
| - start-ec2-runner | ||
| - bench # required to wait when the main job is done | ||
| runs-on: ubuntu-latest | ||
| if: ${{ (inputs.always_terminate == 'true' && always()) || success() }} # required to stop the runner even if the error happened in the previous jobs | ||
| steps: | ||
| - name: Configure AWS credentials | ||
| uses: aws-actions/configure-aws-credentials@v4 | ||
| with: | ||
| role-to-assume: ${{ env.AWS_ROLE }} | ||
| aws-region: ${{ env.AWS_REGION }} | ||
| - name: Stop EC2 runner | ||
| uses: machulav/ec2-github-runner@v2 | ||
| with: | ||
| mode: stop | ||
| github-token: ${{ secrets.AWS_GITHUB_TOKEN }} | ||
| label: ${{ needs.start-ec2-runner.outputs.label }} | ||
| ec2-instance-id: ${{ needs.start-ec2-runner.outputs.ec2-instance-id }} | ||
