Skip to content

docs: explicit naming submodules #4175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 9, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/modules/runners.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Runner module (root)
# Runner module (main))

!!! note
This is the top-level module located in the root of the repository. The directory [`modules/runners`](../internal/runners/) contains an internal Terraform sub-module used by this and the [mult-runner module](../public/multi-runner/)

This module creates resources in your AWS infrastructure, and EC2 instances for hosting the self-hosted runners on-demand. IAM permissions are set to a minimal level, and could be further limited by using permission boundaries. Instances permissions are limited to retrieve and delete the registration token, access the instance's own tags, and terminate the instance itself. By nature instances are short-lived, we strongly suggest to use ephemeral runners to ensure a safe build environment for each workflow job execution.

Example usages:

- [Basic example](../../examples/default/)
- [Ephemeral example](../../examples/ephemeral/)

--8<-- "README.md:mkdocsrunners"
13 changes: 7 additions & 6 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,13 @@ nav:
- Getting started: getting-started.md
- Security: security.md
- Modules:
- Runners (root): modules/runners.md
- Multi Runners: modules/public/multi-runner.md
- AMI Housekeeper: modules/public/ami-housekeeper.md
- Lambda Downloader: modules/public/download-lambda.md
- Setup IAM permissions: modules/public/setup-iam-permissions.md
- Internal:
- Runners (main): modules/runners.md
- Submodules (public):
- Multi Runners: modules/public/multi-runner.md
- AMI Housekeeper: modules/public/ami-housekeeper.md
- Lambda Downloader: modules/public/download-lambda.md
- Setup IAM permissions: modules/public/setup-iam-permissions.md
- Submodules (internal):
- Runners: modules/internal/runners.md
- Syncer: modules/internal/runner-binaries-syncer.md
- SSM: modules/internal/ssm.md
Expand Down