Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update examples/ephemeral/README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Nathaniel McAuliffe <nmcauliffe@expediagroup.com>
npalm and mcaulifn committed Dec 22, 2021

Verified

This commit was signed with the committer’s verified signature.
npalm Niek Palm
1 parent 17dba00 commit ec7af4c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion examples/ephemeral/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Action runners deployment ephemeral example

This example is essential based on the default setup. But shows how you can use runners with the ephemeral flag enabled. Once you enable ephemeral a runner will used once, only for one job. This requires that each job needs a fresh instance. To feature should be used in combination with event `workflow_job`, see your GitHub webhook endpoint configuration. We also suggest to use the feature with a pre-build AMI, to optimize the creation time of a runner.
This example is based on the default setup, but shows how runners can be used with the ephemeral flag enabled. Once enabled, ephemeral runners will be used for one job only. Each job requires a fresh instance. This feature should be used in combination with the `workflow_job` event. See GitHub webhook endpoint configuration(link needed here). It is also suggested to use a pre-build AMI to minimize runner launch times.
## Usages

Steps for the full setup, such as creating a GitHub app can be found in the root module's [README](../../README.md). First download the Lambda releases from GitHub. Alternatively you can build the lambdas locally with Node or Docker, there is a simple build script in `<root>/.ci/build.sh`. In the `main.tf` you can simply remove the location of the lambda zip files, the default location will work in this case.

0 comments on commit ec7af4c

Please sign in to comment.