Skip to content

Commit

Permalink
[BE] Add readme for AWS runners (#5319)
Browse files Browse the repository at this point in the history
  • Loading branch information
ZainRizvi authored Jun 12, 2024
1 parent 46c8c1f commit 85f3293
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions terraform-aws-github-runner/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Pytorch Terraform AWS Github Runner

This is a terraform module that sets up self hosted github runners on AWS along with the infra needed to autoscale them

# Directories

```
├── modules
| ├── download-lambda
| ├── runner-binaries-syncer # AWS Lambda func that
| ├── runners # AWS Lambda func that scales runners up and down based
| | # on SQS Events
| ├── runners-instances # Defines how instances hosting new runners will be configured
| ├── setup-iam-permissions # See Readme in the folder
| └── webhook # AWS Lambda func that receives Github
| # webhooks and generates SQS events that
| # trigger scale up requests
├── policies
├── templates
└── terraform_migrations
```

# Runner Architecture diagram
This diagram shows how the runners function once deployed to AWS
![High level runner architecture diagram](architecture-diagram.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 85f3293

Please sign in to comment.