Skip to content

Commit 358e768

Browse files
committed
Add documentation changes for ARM64.
1 parent d120c49 commit 358e768

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ Permission are managed on several places. Below the most important ones. For det
5858

5959
Besides these permissions, the lambdas also need permission to CloudWatch (for logging and scheduling), SSM and S3. For more details about the required permissions see the [documentation](./modules/setup-iam-permissions/README.md) of the IAM module which uses permission boundaries.
6060

61+
### ARM64 support via Graviton/Graviton2 instance-types
62+
63+
When using the default example or top-level module, specifying an `instance_type` that matches a Graviton/Graviton 2 (ARM64) architecture (e.g. a1 or any 6th-gen `g` or `gd` type), the sub-modules will be automatically configured to provision with ARM64 AMIs and leverage GitHub's ARM64 action runner. See below for more details.
64+
6165
## Usages
6266

6367
Examples are provided in [the example directory](examples/). Please ensure you have installed the following tools.
@@ -151,6 +155,8 @@ module "github-runner" {
151155
}
152156
```
153157

158+
**ARM64** support: Specify an `a1` or `*6g*` (6th-gen Graviton2) instance type to stand up an ARM64 runner, otherwise the default is x86_64.
159+
154160
2. Run terraform by using the following commands
155161

156162
```bash
@@ -223,6 +229,18 @@ The following sub modules are optional and are provided as example or utility:
223229
- _[download-lambda](./modules/download-lambda/README.md)_ - Utility module to download lambda artifacts from GitHub Release
224230
- _[setup-iam-permissions](./modules/setup-iam-permissions/README.md)_ - Example module to setup permission boundaries
225231

232+
### ARM64 configuration for submodules
233+
234+
When not using the top-level module and specifying an `a1` or `*6g*` (6th-gen Graviton2) `instance_type`, the `runner-binaries-syncer` and `runners` submodules need to be configured appropriately for pulling the ARM64 GitHub action runner binary and leveraging the arm64 AMI for the runners.
235+
236+
When configuring `runner-binaries-syncer`
237+
238+
- _runner_architecture_ - set to `arm64`, defaults to `x64`
239+
240+
When configuring `runners`
241+
242+
- _ami_filter_ - set to `["amzn2-ami-hvm-2*-arm64-gp2"]`, defaults to `["amzn2-ami-hvm-2.*-x86_64-ebs"]`
243+
226244
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
227245
## Requirements
228246

0 commit comments

Comments
 (0)