Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
npalm committed Oct 24, 2024
1 parent c3ea002 commit 8279322
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To be able to support a number of use-cases, the module has quite a lot of confi

- 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.
- 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).
- 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.
- 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.
- Linux vs Windows. You can configure the OS types linux and win. Linux will be used by default.
- 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.
- 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.
Expand Down Expand Up @@ -261,7 +261,7 @@ Below an example of the the log messages created.

### EventBridge

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.
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.

Example to use the EventBridge:

Expand Down
4 changes: 0 additions & 4 deletions examples/default/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,3 @@ module "webhook_github_app" {
# name = "alias/github/action-runners"
# target_key_id = aws_kms_key.github.key_id
# }
# moved {
# from = module.runners.module.webhook.aws_lambda_function.webhook
# to = module.runners.module.webhook.module.webhook.aws_lambda_function.webhook
# }
2 changes: 1 addition & 1 deletion modules/multi-runner/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,7 @@ variable "pool_lambda_reserved_concurrent_executions" {
}

variable "enable_workflow_job_events_queue" {
description = "Enabling this experimental feature will create a secondary sqs queue to which a copy of the workflow_job event will be delivered."
description = "Enabling this experimental feature will create a secondary SQS queue to which a copy of the workflow_job event will be delivered."
type = bool
default = false
}
Expand Down
2 changes: 1 addition & 1 deletion variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -724,7 +724,7 @@ variable "lambda_architecture" {
}

variable "enable_workflow_job_events_queue" {
description = "Enabling this experimental feature will create a secondary sqs queue to which a copy of the workflow_job event will be delivered."
description = "Enabling this experimental feature will create a secondary SQS queue to which a copy of the workflow_job event will be delivered."
type = bool
default = false
}
Expand Down

0 comments on commit 8279322

Please sign in to comment.