Skip to content

Commit 85f3293

Browse files
authored
[BE] Add readme for AWS runners (#5319)
1 parent 46c8c1f commit 85f3293

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

terraform-aws-github-runner/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Pytorch Terraform AWS Github Runner
2+
3+
This is a terraform module that sets up self hosted github runners on AWS along with the infra needed to autoscale them
4+
5+
# Directories
6+
7+
```
8+
├── modules
9+
| ├── download-lambda
10+
| ├── runner-binaries-syncer # AWS Lambda func that
11+
| ├── runners # AWS Lambda func that scales runners up and down based
12+
| | # on SQS Events
13+
| ├── runners-instances # Defines how instances hosting new runners will be configured
14+
| ├── setup-iam-permissions # See Readme in the folder
15+
| └── webhook # AWS Lambda func that receives Github
16+
| # webhooks and generates SQS events that
17+
| # trigger scale up requests
18+
├── policies
19+
├── templates
20+
└── terraform_migrations
21+
22+
```
23+
24+
# Runner Architecture diagram
25+
This diagram shows how the runners function once deployed to AWS
26+
![High level runner architecture diagram](architecture-diagram.png)
Loading

0 commit comments

Comments
 (0)