diff --git a/docs/modules/runners.md b/docs/modules/runners.md index 4059305859..daac47a24a 100644 --- a/docs/modules/runners.md +++ b/docs/modules/runners.md @@ -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" diff --git a/mkdocs.yaml b/mkdocs.yaml index 2196433e13..af0ca02f8e 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -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