Skip to content

Commit 8279322

Browse files
committed
typos
1 parent c3ea002 commit 8279322

File tree

4 files changed

+4
-8
lines changed

4 files changed

+4
-8
lines changed

docs/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ To be able to support a number of use-cases, the module has quite a lot of confi
66

77
- Org vs Repo level. You can configure the module to connect the runners in GitHub on an org level and share the runners in your org, or set the runners on repo level and the module will install the runner to the repo. There can be multiple repos but runners are not shared between repos.
88
- Multi-Runner module. This modules allows you to create multiple runner configurations with a single webhook and single GitHub App to simplify deployment of different types of runners. Check the detailed module [documentation](modules/public/multi-runner.md) for more information or checkout the [multi-runner example](examples/multi-runner.md).
9-
- Webhook mode, the module can be deployed in `direct` mode or `eventbridge` (Experimental) mode. The `direct` mode is the default and will directly distribute to SQS for the scale-up lambda. The `eventbridge` mode will publish the events to a eventbus, the rule then directs the received events to a dispatch lambda. The dispatch lambda will send the event to the SQS queue. The `eventbridge` mode is useful when you want to have more control over the events and potentially filter them. The `eventbridge` mode is disabled by default. An example of what the `eventbridge` mode could be used for is building a data lake, build metrics, act on `workflow_job` job started events, etc.
9+
- Webhook mode, the module can be deployed in `direct` mode or `EventBridge` (Experimental) mode. The `direct` mode is the default and will directly distribute to SQS for the scale-up lambda. The `EventBridge` mode will publish the events to a eventbus, the rule then directs the received events to a dispatch lambda. The dispatch lambda will send the event to the SQS queue. The `EventBridge` mode is useful when you want to have more control over the events and potentially filter them. The `EventBridge` mode is disabled by default. An example of what the `EventBridge` mode could be used for is building a data lake, build metrics, act on `workflow_job` job started events, etc.
1010
- Linux vs Windows. You can configure the OS types linux and win. Linux will be used by default.
1111
- Re-use vs Ephemeral. By default runners are re-used, until detected idle. Once idle they will be removed from the pool. To improve security we are introducing ephemeral runners. Those runners are only used for one job. Ephemeral runners only work in combination with the workflow job event. For ephemeral runners the lambda requests a JIT (just in time) configuration via the GitHub API to register the runner. [JIT configuration](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-just-in-time-runners) is limited to ephemeral runners (and currently not supported by GHES). For non-ephemeral runners, a registration token is always requested. In both cases the configuration is made available to the instance via the same SSM parameter. To disable JIT configuration for ephemeral runners set `enable_jit_config` to `false`. We also suggest using a pre-build AMI to improve the start time of jobs for ephemeral runners.
1212
- Job retry (**Beta**). By default the scale-up lambda will discard the message when it is handled. Meaning in the ephemeral use-case an instance is created. The created runner will ask GitHub for a job, no guarantee it will run the job for which it was scaling. Result could be that with small system hick-up the job is keeping waiting for a runner. Enable a pool (org runners) is one option to avoid this problem. Another option is to enable the job retry function. Which will retry the job after a delay for a configured number of times.
@@ -261,7 +261,7 @@ Below an example of the the log messages created.
261261

262262
### EventBridge
263263

264-
This module can be deployed in using the mode `eventbridge` (Experimental). The `eventbridge` mode will publish an event to a eventbus. Within the eventbus, there is a target rule set, sending events to the dispatch lambda. The `eventbridge` mode is disabled by default.
264+
This module can be deployed in using the mode `EventBridge` (Experimental). The `EventBridge` mode will publish an event to a eventbus. Within the eventbus, there is a target rule set, sending events to the dispatch lambda. The `EventBridge` mode is disabled by default.
265265

266266
Example to use the EventBridge:
267267

examples/default/main.tf

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,3 @@ module "webhook_github_app" {
171171
# name = "alias/github/action-runners"
172172
# target_key_id = aws_kms_key.github.key_id
173173
# }
174-
# moved {
175-
# from = module.runners.module.webhook.aws_lambda_function.webhook
176-
# to = module.runners.module.webhook.module.webhook.aws_lambda_function.webhook
177-
# }

modules/multi-runner/variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -551,7 +551,7 @@ variable "pool_lambda_reserved_concurrent_executions" {
551551
}
552552

553553
variable "enable_workflow_job_events_queue" {
554-
description = "Enabling this experimental feature will create a secondary sqs queue to which a copy of the workflow_job event will be delivered."
554+
description = "Enabling this experimental feature will create a secondary SQS queue to which a copy of the workflow_job event will be delivered."
555555
type = bool
556556
default = false
557557
}

variables.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -724,7 +724,7 @@ variable "lambda_architecture" {
724724
}
725725

726726
variable "enable_workflow_job_events_queue" {
727-
description = "Enabling this experimental feature will create a secondary sqs queue to which a copy of the workflow_job event will be delivered."
727+
description = "Enabling this experimental feature will create a secondary SQS queue to which a copy of the workflow_job event will be delivered."
728728
type = bool
729729
default = false
730730
}

0 commit comments

Comments
 (0)