@cloudsnorkel/cdk-github-runners 0.9.7 → 0.10.0

package/.jsii

@@ -3138,7 +3138,7 @@
   },
   "name": "@cloudsnorkel/cdk-github-runners",
   "readme": {
-    "markdown": "# GitHub Self-Hosted Runners CDK Constructs\n\n[![NPM](https://img.shields.io/npm/v/@cloudsnorkel/cdk-github-runners?label=npm&logo=npm)][7]\n[![PyPI](https://img.shields.io/pypi/v/cloudsnorkel.cdk-github-runners?label=pypi&logo=pypi)][6]\n[![Maven Central](https://img.shields.io/maven-central/v/com.cloudsnorkel/cdk.github.runners.svg?label=Maven%20Central&logo=apachemaven)][8]\n[![Go](https://img.shields.io/github/v/tag/CloudSnorkel/cdk-github-runners?color=red&label=go&logo=go)][11]\n[![Nuget](https://img.shields.io/nuget/v/CloudSnorkel.Cdk.Github.Runners?color=red&&logo=nuget)][12]\n[![Release](https://github.com/CloudSnorkel/cdk-github-runners/actions/workflows/release.yml/badge.svg)](https://github.com/CloudSnorkel/cdk-github-runners/actions/workflows/release.yml)\n[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/LICENSE)\n\nUse this CDK construct to create ephemeral [self-hosted GitHub runners][1] on-demand inside your AWS account.\n\n* Easy to configure GitHub integration with a web-based interface\n* Customizable runners with decent defaults\n* Multiple runner configurations controlled by labels\n* Everything fully hosted in your account\n* Automatically updated build environment with latest runner version\n\nSelf-hosted runners in AWS are useful when:\n\n* You need easy access to internal resources in your actions\n* You want to pre-install some software for your actions\n* You want to provide some basic AWS API access (but [aws-actions/configure-aws-credentials][2] has more security controls)\n* You are using GitHub Enterprise Server\n\nEphemeral (or on-demand) runners are the [recommended way by GitHub][14] for auto-scaling, and they make sure all jobs run with a clean image. Runners are started on-demand. You don't pay unless a job is running.\n\n## API\n\nThe best way to browse API documentation is on [Constructs Hub][13]. It is available in all supported programming languages.\n\n## Providers\n\nA runner provider creates compute resources on-demand and uses [actions/runner][5] to start a runner.\n\n|                  | EC2               | CodeBuild                  | Fargate        | ECS            | Lambda        |\n|------------------|-------------------|----------------------------|----------------|----------------|---------------|\n| **Time limit**   | Unlimited         | 8 hours                    | Unlimited      | Unlimited      | 15 minutes    |\n| **vCPUs**        | Unlimited         | 2, 4, 8, or 72             | 0.25 to 4      | Unlimited      | 1 to 6        |\n| **RAM**          | Unlimited         | 3gb, 7gb, 15gb, or 145gb   | 512mb to 30gb  | Unlimited      | 128mb to 10gb |\n| **Storage**      | Unlimited         | 50gb to 824gb              | 20gb to 200gb  | Unlimited      | Up to 10gb    |\n| **Architecture** | x86_64, ARM64     | x86_64, ARM64              | x86_64, ARM64  | x86_64, ARM64  | x86_64, ARM64 |\n| **sudo**         | ✔                 | ✔                         | ✔              | ✔              | ❌           |\n| **Docker**       | ✔                 | ✔ (Linux only)            | ❌              | ✔              | ❌           |\n| **Spot pricing** | ✔                 | ❌                         | ✔              | ✔              | ❌           |\n| **OS**           | Linux, Windows    | Linux, Windows             | Linux, Windows | Linux, Windows | Linux         |\n\nThe best provider to use mostly depends on your current infrastructure. When in doubt, CodeBuild is always a good choice. Execution history and logs are easy to view, and it has no restrictive limits unless you need to run for more than 8 hours.\n\n* EC2 is useful when you want runners to have complete access to the host\n* ECS is useful when you want to control the infrastructure, like leaving the runner host running for faster startups\n* Lambda is useful for short jobs that can work within time, size and readonly system constraints\n\nYou can also create your own provider by implementing `IRunnerProvider`.\n\n## Installation\n\n1. Install and use the appropriate package\n   <details><summary>Python</summary>\n\n   ### Install\n   Available on [PyPI][6].\n   ```bash\n   pip install cloudsnorkel.cdk-github-runners\n   ```\n   ### Use\n   ```python\n   from cloudsnorkel.cdk_github_runners import GitHubRunners\n\n   GitHubRunners(self, \"runners\")\n   ```\n   </details>\n   <details><summary>TypeScript or JavaScript</summary>\n\n   ### Install\n   Available on [npm][7].\n   ```bash\n   npm i @cloudsnorkel/cdk-github-runners\n   ```\n   ### Use\n   ```typescript\n   import { GitHubRunners } from '@cloudsnorkel/cdk-github-runners';\n\n   new GitHubRunners(this, \"runners\");\n   ```\n   </details>\n   <details><summary>Java</summary>\n\n   ### Install\n   Available on [Maven][8].\n   ```xml\n   <dependency>\n      <groupId>com.cloudsnorkel</groupId>\n      <artifactId>cdk.github.runners</artifactId>\n   </dependency>\n   ```\n   ### Use\n   ```java\n   import com.cloudsnorkel.cdk.github.runners.GitHubRunners;\n\n   GitHubRunners.Builder.create(this, \"runners\").build();\n   ```\n   </details>\n   <details><summary>Go</summary>\n\n   ### Install\n   Available on [GitHub][11].\n   ```bash\n   go get github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\n   ```\n   ### Use\n   ```go\n   import \"github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\"\n\n   NewGitHubRunners(this, jsii.String(\"runners\"))\n   ```\n   </details>\n   <details><summary>.NET</summary>\n\n   ### Install\n   Available on [Nuget][12].\n   ```bash\n   dotnet add package CloudSnorkel.Cdk.Github.Runners\n   ```\n   ### Use\n   ```csharp\n   using CloudSnorkel;\n\n   new GitHubRunners(this, \"runners\");\n   ```\n   </details>\n2. Use `GitHubRunners` construct in your code (starting with default arguments is fine)\n3. Deploy your stack\n4. Look for the status command output similar to `aws --region us-east-1 lambda invoke --function-name status-XYZ123 status.json`\n   ```\n    ✅  github-runners-test\n\n   ✨  Deployment time: 260.01s\n\n   Outputs:\n   github-runners-test.runnersstatuscommand4A30F0F5 = aws --region us-east-1 lambda invoke --function-name github-runners-test-runnersstatus1A5771C0-mvttg8oPQnQS status.json\n   ```\n5. Execute the status command (you may need to specify `--profile` too) and open the resulting `status.json` file\n6. Open the URL in `github.setup.url` from `status.json` or [manually setup GitHub](SETUP_GITHUB.md) integration as an app or with personal access token\n7. Run status command again to confirm `github.auth.status` and `github.webhook.status` are OK\n8. Trigger a GitHub action that has a `self-hosted` label with `runs-on: [self-hosted, linux, codebuild]` or similar\n9. If the action is not successful, see [troubleshooting](#Troubleshooting)\n\n[![Demo](demo-thumbnail.jpg)](https://youtu.be/wlyv_3V8lIw)\n\n## Customizing\n\nThe default providers configured by `GitHubRunners` are useful for testing but probably not too much for actual production work. They run in the default VPC or no VPC and have no added IAM permissions. You would usually want to configure the providers yourself.\n\nFor example:\n\n```typescript\nlet vpc: ec2.Vpc;\nlet runnerSg: ec2.SecurityGroup;\nlet dbSg: ec2.SecurityGroup;\nlet bucket: s3.Bucket;\n\n// create a custom CodeBuild provider\nconst myProvider = new CodeBuildRunnerProvider(this, 'codebuild runner', {\n   labels: ['my-codebuild'],\n   vpc: vpc,\n   securityGroups: [runnerSg],\n});\n// grant some permissions to the provider\nbucket.grantReadWrite(myProvider);\ndbSg.connections.allowFrom(runnerSg, ec2.Port.tcp(3306), 'allow runners to connect to MySQL database');\n\n// create the runner infrastructure\nnew GitHubRunners(this, 'runners', {\n   providers: [myProvider],\n});\n```\n\nAnother way to customize runners is by modifying the image used to spin them up. The image contains the [runner][5], any required dependencies, and integration code with the provider. You may choose to customize this image by adding more packages, for example.\n\n```typescript\nconst myBuilder = CodeBuildRunnerProvider.imageBuilder(this, 'image builder', {\n   dockerfilePath: FargateRunner.LINUX_X64_DOCKERFILE_PATH,\n   runnerVersion: RunnerVersion.specific('2.291.0'),\n   rebuildInterval: Duration.days(14),\n});\nmyBuilder.addComponent(\n  RunnerImageComponent.custom({ commands: ['apt install -y nginx xz-utils'] })\n);\n\nconst myProvider = new FargateRunnerProvider(this, 'fargate runner', {\n   labels: ['customized-fargate'],\n   vpc: vpc,\n   securityGroups: [runnerSg],\n   imageBuilder: myBuilder,\n});\n\n// create the runner infrastructure\nnew GitHubRunners(this, 'runners', {\n   providers: [myProvider],\n});\n```\n\nYour workflow will then look like:\n\n```yaml\nname: self-hosted example\non: push\njobs:\n  self-hosted:\n    runs-on: [self-hosted, customized-fargate]\n    steps:\n      - run: echo hello world\n```\n\nWindows images can also be customized the same way.\n\n```typescript\nconst myWindowsBuilder = FargateRunnerProvider.imageBuilder(this, 'Windows image builder', {\n   architecture: Architecture.X86_64,\n   os: Os.WINDOWS,\n   runnerVersion: RunnerVersion.specific('2.291.0'),\n   rebuildInterval: Duration.days(14),\n});\nmyWindowsBuilder.addComponent(\n        RunnerImageComponent.custom({\n           name: 'Ninja',\n           commands: [\n              'Invoke-WebRequest -UseBasicParsing -Uri \"https://github.com/ninja-build/ninja/releases/download/v1.11.1/ninja-win.zip\" -OutFile ninja.zip',\n              'Expand-Archive ninja.zip -DestinationPath C:\\\\actions',\n              'del ninja.zip',\n           ],\n        })\n);\n\nconst myProvider = new FargateRunnerProvider(this, 'fargate runner', {\n   labels: ['customized-windows-fargate'],\n   vpc: vpc,\n   securityGroups: [runnerSg],\n   imageBuidler: myWindowsBuilder,\n});\n\nnew GitHubRunners(this, 'runners', {\n   providers: [myProvider],\n});\n```\n\nThe runner OS and architecture is determined by the image it is set to use. For example, to create a Fargate runner provider for ARM64 set the `architecture` property for the image builder to `Architecture.ARM64` in the image builder properties.\n\n```typescript\nnew GitHubRunners(this, 'runners', {\n   providers: [\n      new FargateRunnerProvider(this, 'fargate runner', {\n         labels: ['arm64', 'fargate'],\n         imageBuidler: FargateRunnerProvider.imageBuilder(this, 'image builder', {\n            architecture: Architecture.ARM64,\n            os: Os.LINUX_UBUNTU,\n         }),\n      }),\n   ],\n});\n```\n\n## Architecture\n\n![Architecture diagram](architecture.svg)\n\n## Troubleshooting\n\n1. Always start with the status function, make sure no errors are reported, and confirm all status codes are OK\n2. If jobs are stuck on pending:\n   1. Make sure `runs-on` in the workflow matches the expected labels set in the runner provider\n   2. If jobs get stuck often and take a long time to start, cancel the pending jobs and start them again\n4. Confirm the webhook Lambda was called by visiting the URL in `troubleshooting.webhookHandlerUrl` from `status.json`\n   1. If it's not called or logs errors, confirm the webhook settings on the GitHub side\n   2. If you see too many errors, make sure you're only sending `workflow_job` events\n5. When using GitHub app, make sure there are active installation in `github.auth.app.installations`\n6. Check execution details of the orchestrator step function by visiting the URL in `troubleshooting.stepFunctionUrl` from `status.json`\n   1. Use the details tab to find the specific execution of the provider (Lambda, CodeBuild, Fargate, etc.)\n   2. Every step function execution should be successful, even if the runner action inside it failed\n\n## Monitoring\n\nThere are two important ways to monitor your runners:\n\n1. Make sure runners don't fail to start. When that happens, jobs may sit and wait. Use `GitHubRunners.metricFailed()` to get a metric for the number of failed runner starts. You should use this metric to trigger an alarm.\n2. Make sure runner images don't fail to build. Failed runner image builds mean you will get stuck with out-of-date software on your runners. It may lead to security vulnerabilities, or it may lead to slower runner start-ups as the runner software itself needs to be updated. Use `GitHubRunners.failedImageBuildsTopic()` to get SNS topic that gets notified of failed runner image builds. You should subscribe to this topic.\n\nOther useful metrics to track:\n\n1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.\n2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.\n\n## Other Options\n\n1. [philips-labs/terraform-aws-github-runner][3] if you're using Terraform\n2. [actions/actions-runner-controller][4] if you're using Kubernetes\n\n\n[1]: https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners\n[2]: https://github.com/marketplace/actions/configure-aws-credentials-action-for-github-actions\n[3]: https://github.com/philips-labs/terraform-aws-github-runner\n[4]: https://github.com/actions/actions-runner-controller\n[5]: https://github.com/actions/runner\n[6]: https://pypi.org/project/cloudsnorkel.cdk-github-runners\n[7]: https://www.npmjs.com/package/@cloudsnorkel/cdk-github-runners\n[8]: https://central.sonatype.com/artifact/com.cloudsnorkel/cdk.github.runners/\n[9]: https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps\n[10]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\n[11]: https://pkg.go.dev/github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\n[12]: https://www.nuget.org/packages/CloudSnorkel.Cdk.Github.Runners/\n[13]: https://constructs.dev/packages/@cloudsnorkel/cdk-github-runners/\n[14]: https://docs.github.com/en/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#using-ephemeral-runners-for-autoscaling\n"
+    "markdown": "# GitHub Self-Hosted Runners CDK Constructs\n\n[![NPM](https://img.shields.io/npm/v/@cloudsnorkel/cdk-github-runners?label=npm&logo=npm)][7]\n[![PyPI](https://img.shields.io/pypi/v/cloudsnorkel.cdk-github-runners?label=pypi&logo=pypi)][6]\n[![Maven Central](https://img.shields.io/maven-central/v/com.cloudsnorkel/cdk.github.runners.svg?label=Maven%20Central&logo=apachemaven)][8]\n[![Go](https://img.shields.io/github/v/tag/CloudSnorkel/cdk-github-runners?color=red&label=go&logo=go)][11]\n[![Nuget](https://img.shields.io/nuget/v/CloudSnorkel.Cdk.Github.Runners?color=red&&logo=nuget)][12]\n[![Release](https://github.com/CloudSnorkel/cdk-github-runners/actions/workflows/release.yml/badge.svg)](https://github.com/CloudSnorkel/cdk-github-runners/actions/workflows/release.yml)\n[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/CloudSnorkel/cdk-github-runners/blob/main/LICENSE)\n\nUse this CDK construct to create ephemeral [self-hosted GitHub runners][1] on-demand inside your AWS account.\n\n* Easy to configure GitHub integration with a web-based interface\n* Customizable runners with decent defaults\n* Multiple runner configurations controlled by labels\n* Everything fully hosted in your account\n* Automatically updated build environment with latest runner version\n\nSelf-hosted runners in AWS are useful when:\n\n* You need easy access to internal resources in your actions\n* You want to pre-install some software for your actions\n* You want to provide some basic AWS API access (but [aws-actions/configure-aws-credentials][2] has more security controls)\n* You are using GitHub Enterprise Server\n\nEphemeral (or on-demand) runners are the [recommended way by GitHub][14] for auto-scaling, and they make sure all jobs run with a clean image. Runners are started on-demand. You don't pay unless a job is running.\n\n## API\n\nThe best way to browse API documentation is on [Constructs Hub][13]. It is available in all supported programming languages.\n\n## Providers\n\nA runner provider creates compute resources on-demand and uses [actions/runner][5] to start a runner.\n\n|                  | EC2               | CodeBuild                  | Fargate        | ECS            | Lambda        |\n|------------------|-------------------|----------------------------|----------------|----------------|---------------|\n| **Time limit**   | Unlimited         | 8 hours                    | Unlimited      | Unlimited      | 15 minutes    |\n| **vCPUs**        | Unlimited         | 2, 4, 8, or 72             | 0.25 to 4      | Unlimited      | 1 to 6        |\n| **RAM**          | Unlimited         | 3gb, 7gb, 15gb, or 145gb   | 512mb to 30gb  | Unlimited      | 128mb to 10gb |\n| **Storage**      | Unlimited         | 50gb to 824gb              | 20gb to 200gb  | Unlimited      | Up to 10gb    |\n| **Architecture** | x86_64, ARM64     | x86_64, ARM64              | x86_64, ARM64  | x86_64, ARM64  | x86_64, ARM64 |\n| **sudo**         | ✔                 | ✔                         | ✔              | ✔              | ❌           |\n| **Docker**       | ✔                 | ✔ (Linux only)            | ❌              | ✔              | ❌           |\n| **Spot pricing** | ✔                 | ❌                         | ✔              | ✔              | ❌           |\n| **OS**           | Linux, Windows    | Linux, Windows             | Linux, Windows | Linux, Windows | Linux         |\n\nThe best provider to use mostly depends on your current infrastructure. When in doubt, CodeBuild is always a good choice. Execution history and logs are easy to view, and it has no restrictive limits unless you need to run for more than 8 hours.\n\n* EC2 is useful when you want runners to have complete access to the host\n* ECS is useful when you want to control the infrastructure, like leaving the runner host running for faster startups\n* Lambda is useful for short jobs that can work within time, size and readonly system constraints\n\nYou can also create your own provider by implementing `IRunnerProvider`.\n\n## Installation\n\n1. Install and use the appropriate package\n   <details><summary>Python</summary>\n\n   ### Install\n   Available on [PyPI][6].\n   ```bash\n   pip install cloudsnorkel.cdk-github-runners\n   ```\n   ### Use\n   ```python\n   from cloudsnorkel.cdk_github_runners import GitHubRunners\n\n   GitHubRunners(self, \"runners\")\n   ```\n   </details>\n   <details><summary>TypeScript or JavaScript</summary>\n\n   ### Install\n   Available on [npm][7].\n   ```bash\n   npm i @cloudsnorkel/cdk-github-runners\n   ```\n   ### Use\n   ```typescript\n   import { GitHubRunners } from '@cloudsnorkel/cdk-github-runners';\n\n   new GitHubRunners(this, \"runners\");\n   ```\n   </details>\n   <details><summary>Java</summary>\n\n   ### Install\n   Available on [Maven][8].\n   ```xml\n   <dependency>\n      <groupId>com.cloudsnorkel</groupId>\n      <artifactId>cdk.github.runners</artifactId>\n   </dependency>\n   ```\n   ### Use\n   ```java\n   import com.cloudsnorkel.cdk.github.runners.GitHubRunners;\n\n   GitHubRunners.Builder.create(this, \"runners\").build();\n   ```\n   </details>\n   <details><summary>Go</summary>\n\n   ### Install\n   Available on [GitHub][11].\n   ```bash\n   go get github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\n   ```\n   ### Use\n   ```go\n   import \"github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\"\n\n   NewGitHubRunners(this, jsii.String(\"runners\"))\n   ```\n   </details>\n   <details><summary>.NET</summary>\n\n   ### Install\n   Available on [Nuget][12].\n   ```bash\n   dotnet add package CloudSnorkel.Cdk.Github.Runners\n   ```\n   ### Use\n   ```csharp\n   using CloudSnorkel;\n\n   new GitHubRunners(this, \"runners\");\n   ```\n   </details>\n2. Use `GitHubRunners` construct in your code (starting with default arguments is fine)\n3. Deploy your stack\n4. Look for the status command output similar to `aws --region us-east-1 lambda invoke --function-name status-XYZ123 status.json`\n   ```\n    ✅  github-runners-test\n\n   ✨  Deployment time: 260.01s\n\n   Outputs:\n   github-runners-test.runnersstatuscommand4A30F0F5 = aws --region us-east-1 lambda invoke --function-name github-runners-test-runnersstatus1A5771C0-mvttg8oPQnQS status.json\n   ```\n5. Execute the status command (you may need to specify `--profile` too) and open the resulting `status.json` file\n6. Open the URL in `github.setup.url` from `status.json` or [manually setup GitHub](SETUP_GITHUB.md) integration as an app or with personal access token\n7. Run status command again to confirm `github.auth.status` and `github.webhook.status` are OK\n8. Trigger a GitHub action that has a `self-hosted` label with `runs-on: [self-hosted, linux, codebuild]` or similar\n9. If the action is not successful, see [troubleshooting](#Troubleshooting)\n\n[![Demo](demo-thumbnail.jpg)](https://youtu.be/wlyv_3V8lIw)\n\n## Customizing\n\nThe default providers configured by `GitHubRunners` are useful for testing but probably not too much for actual production work. They run in the default VPC or no VPC and have no added IAM permissions. You would usually want to configure the providers yourself.\n\nFor example:\n\n```typescript\nlet vpc: ec2.Vpc;\nlet runnerSg: ec2.SecurityGroup;\nlet dbSg: ec2.SecurityGroup;\nlet bucket: s3.Bucket;\n\n// create a custom CodeBuild provider\nconst myProvider = new CodeBuildRunnerProvider(this, 'codebuild runner', {\n   labels: ['my-codebuild'],\n   vpc: vpc,\n   securityGroups: [runnerSg],\n});\n// grant some permissions to the provider\nbucket.grantReadWrite(myProvider);\ndbSg.connections.allowFrom(runnerSg, ec2.Port.tcp(3306), 'allow runners to connect to MySQL database');\n\n// create the runner infrastructure\nnew GitHubRunners(this, 'runners', {\n   providers: [myProvider],\n});\n```\n\nAnother way to customize runners is by modifying the image used to spin them up. The image contains the [runner][5], any required dependencies, and integration code with the provider. You may choose to customize this image by adding more packages, for example.\n\n```typescript\nconst myBuilder = CodeBuildRunnerProvider.imageBuilder(this, 'image builder', {\n   dockerfilePath: FargateRunner.LINUX_X64_DOCKERFILE_PATH,\n   runnerVersion: RunnerVersion.specific('2.291.0'),\n   rebuildInterval: Duration.days(14),\n});\nmyBuilder.addComponent(\n  RunnerImageComponent.custom({ commands: ['apt install -y nginx xz-utils'] })\n);\n\nconst myProvider = new FargateRunnerProvider(this, 'fargate runner', {\n   labels: ['customized-fargate'],\n   vpc: vpc,\n   securityGroups: [runnerSg],\n   imageBuilder: myBuilder,\n});\n\n// create the runner infrastructure\nnew GitHubRunners(this, 'runners', {\n   providers: [myProvider],\n});\n```\n\nYour workflow will then look like:\n\n```yaml\nname: self-hosted example\non: push\njobs:\n  self-hosted:\n    runs-on: [self-hosted, customized-fargate]\n    steps:\n      - run: echo hello world\n```\n\nWindows images can also be customized the same way.\n\n```typescript\nconst myWindowsBuilder = FargateRunnerProvider.imageBuilder(this, 'Windows image builder', {\n   architecture: Architecture.X86_64,\n   os: Os.WINDOWS,\n   runnerVersion: RunnerVersion.specific('2.291.0'),\n   rebuildInterval: Duration.days(14),\n});\nmyWindowsBuilder.addComponent(\n        RunnerImageComponent.custom({\n           name: 'Ninja',\n           commands: [\n              'Invoke-WebRequest -UseBasicParsing -Uri \"https://github.com/ninja-build/ninja/releases/download/v1.11.1/ninja-win.zip\" -OutFile ninja.zip',\n              'Expand-Archive ninja.zip -DestinationPath C:\\\\actions',\n              'del ninja.zip',\n           ],\n        })\n);\n\nconst myProvider = new FargateRunnerProvider(this, 'fargate runner', {\n   labels: ['customized-windows-fargate'],\n   vpc: vpc,\n   securityGroups: [runnerSg],\n   imageBuidler: myWindowsBuilder,\n});\n\nnew GitHubRunners(this, 'runners', {\n   providers: [myProvider],\n});\n```\n\nThe runner OS and architecture is determined by the image it is set to use. For example, to create a Fargate runner provider for ARM64 set the `architecture` property for the image builder to `Architecture.ARM64` in the image builder properties.\n\n```typescript\nnew GitHubRunners(this, 'runners', {\n   providers: [\n      new FargateRunnerProvider(this, 'fargate runner', {\n         labels: ['arm64', 'fargate'],\n         imageBuidler: FargateRunnerProvider.imageBuilder(this, 'image builder', {\n            architecture: Architecture.ARM64,\n            os: Os.LINUX_UBUNTU,\n         }),\n      }),\n   ],\n});\n```\n\n## Architecture\n\n![Architecture diagram](architecture.svg)\n\n## Troubleshooting\n\nRunners are started in response to a webhook coming in from GitHub. If there are any issues starting the runner like missing capacity or transient API issues, the provider will keep retrying for 24 hours. Configuration issue related errors like pointing to a missing AMI will not be retried. GitHub itself will cancel the job if it can't find a runner for 24 hours. If your jobs don't start, follow the steps below to examine all parts of this workflow.\n\n1. Always start with the status function, make sure no errors are reported, and confirm all status codes are OK\n2. Make sure `runs-on` in the workflow matches the expected labels set in the runner provider\n3. Diagnose relevant executions of the orchestrator step function by visiting the URL in `troubleshooting.stepFunctionUrl` from `status.json`\n   1. If the execution failed, check your runner provider configuration for errors\n   2. If the execution is still running for a long time, check the execution events to see why runner starting is being retried\n   3. If there are no relevant executions, move to the next step\n4. Confirm the webhook Lambda was called by visiting the URL in `troubleshooting.webhookHandlerUrl` from `status.json`\n   1. If it's not called or logs errors, confirm the webhook settings on the GitHub side\n   2. If you see too many errors, make sure you're only sending `workflow_job` events\n5. When using GitHub app, make sure there are active installations in `github.auth.app.installations`\n\n## Monitoring\n\nThere are two important ways to monitor your runners:\n\n1. Make sure runners don't fail to start. When that happens, jobs may sit and wait. Use `GitHubRunners.metricFailed()` to get a metric for the number of failed runner starts. You should use this metric to trigger an alarm.\n2. Make sure runner images don't fail to build. Failed runner image builds mean you will get stuck with out-of-date software on your runners. It may lead to security vulnerabilities, or it may lead to slower runner start-ups as the runner software itself needs to be updated. Use `GitHubRunners.failedImageBuildsTopic()` to get SNS topic that gets notified of failed runner image builds. You should subscribe to this topic.\n\nOther useful metrics to track:\n\n1. Use `GitHubRunners.metricJobCompleted()` to get a metric for the number of completed jobs broken down by labels and job success.\n2. Use `GitHubRunners.metricTime()` to get a metric for the total time a runner is running. This includes the overhead of starting the runner.\n\n## Other Options\n\n1. [philips-labs/terraform-aws-github-runner][3] if you're using Terraform\n2. [actions/actions-runner-controller][4] if you're using Kubernetes\n\n\n[1]: https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners\n[2]: https://github.com/marketplace/actions/configure-aws-credentials-action-for-github-actions\n[3]: https://github.com/philips-labs/terraform-aws-github-runner\n[4]: https://github.com/actions/actions-runner-controller\n[5]: https://github.com/actions/runner\n[6]: https://pypi.org/project/cloudsnorkel.cdk-github-runners\n[7]: https://www.npmjs.com/package/@cloudsnorkel/cdk-github-runners\n[8]: https://central.sonatype.com/artifact/com.cloudsnorkel/cdk.github.runners/\n[9]: https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps\n[10]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\n[11]: https://pkg.go.dev/github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners\n[12]: https://www.nuget.org/packages/CloudSnorkel.Cdk.Github.Runners/\n[13]: https://constructs.dev/packages/@cloudsnorkel/cdk-github-runners/\n[14]: https://docs.github.com/en/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#using-ephemeral-runners-for-autoscaling\n"
   },
   "repository": {
     "type": "git",
@@ -3851,7 +3851,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/access.ts",
-            "line": 17
+            "line": 28
           },
           "name": "allowedIps",
           "optional": true,
@@ -3874,7 +3874,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/access.ts",
-            "line": 29
+            "line": 40
           },
           "name": "allowedSecurityGroups",
           "optional": true,
@@ -3891,18 +3891,41 @@
           "abstract": true,
           "docs": {
             "stability": "experimental",
-            "summary": "Creates a private API Gateway and allows access from the specified VPC."
+            "summary": "Create a private API Gateway and allow access from the specified VPC."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/access.ts",
-            "line": 22
+            "line": 33
           },
           "name": "allowedVpc",
           "optional": true,
           "type": {
             "fqn": "aws-cdk-lib.aws_ec2.IVpc"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Use this to make use of existing VPC endpoints or to share an endpoint between multiple functions. The VPC endpoint must point to `ec2.InterfaceVpcEndpointAwsService.APIGATEWAY`.\n\nNo other settings are supported when using this option.\n\nAll endpoints will be allowed access, but only the first one will be used as the URL by the runner system for setting up the webhook, and as setup URL.",
+            "stability": "experimental",
+            "summary": "Create a private API Gateway and allow access from the specified VPC endpoints."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/access.ts",
+            "line": 19
+          },
+          "name": "allowedVpcEndpoints",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "aws-cdk-lib.aws_ec2.IVpcEndpoint"
+              },
+              "kind": "array"
+            }
+          }
         }
       ],
       "symbolId": "src/access:ApiGatewayAccessProps"
@@ -4635,7 +4658,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/codebuild.ts",
-          "line": 215
+          "line": 220
         },
         "parameters": [
           {
@@ -4662,7 +4685,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/providers/codebuild.ts",
-        "line": 416
+        "line": 419
       },
       "name": "CodeBuildRunner",
       "symbolId": "src/providers/codebuild:CodeBuildRunner"
@@ -4756,7 +4779,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/codebuild.ts",
-          "line": 215
+          "line": 220
         },
         "parameters": [
           {
@@ -4828,45 +4851,6 @@
           },
           "static": true
         },
-        {
-          "docs": {
-            "stability": "experimental"
-          },
-          "locationInModule": {
-            "filename": "src/providers/common.ts",
-            "line": 474
-          },
-          "name": "addRetry",
-          "parameters": [
-            {
-              "name": "task",
-              "type": {
-                "union": {
-                  "types": [
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
-                    },
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
-                    }
-                  ]
-                }
-              }
-            },
-            {
-              "name": "errors",
-              "type": {
-                "collection": {
-                  "elementtype": {
-                    "primitive": "string"
-                  },
-                  "kind": "array"
-                }
-              }
-            }
-          ],
-          "protected": true
-        },
         {
           "docs": {
             "remarks": "Called by GithubRunners and shouldn't be called manually.",
@@ -4875,7 +4859,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 343
+            "line": 348
           },
           "name": "getStepFunctionTask",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -4904,7 +4888,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 384
+            "line": 387
           },
           "name": "grantStateMachine",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -4973,7 +4957,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 387
+            "line": 390
           },
           "name": "status",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -5040,7 +5024,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/codebuild.ts",
-            "line": 408
+            "line": 411
           },
           "name": "connections",
           "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
@@ -5132,6 +5116,27 @@
           "type": {
             "fqn": "aws-cdk-lib.aws_codebuild.Project"
           }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "List of step functions errors that should be retried."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/codebuild.ts",
+            "line": 211
+          },
+          "name": "retryableErrors",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
         }
       ],
       "symbolId": "src/providers/codebuild:CodeBuildRunnerProvider"
@@ -6039,7 +6044,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/ec2.ts",
-          "line": 292
+          "line": 297
         },
         "parameters": [
           {
@@ -6066,7 +6071,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/providers/ec2.ts",
-        "line": 508
+        "line": 506
       },
       "name": "Ec2Runner",
       "symbolId": "src/providers/ec2:Ec2Runner"
@@ -6086,7 +6091,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/ec2.ts",
-          "line": 292
+          "line": 297
         },
         "parameters": [
           {
@@ -6158,45 +6163,6 @@
           },
           "static": true
         },
-        {
-          "docs": {
-            "stability": "experimental"
-          },
-          "locationInModule": {
-            "filename": "src/providers/common.ts",
-            "line": 474
-          },
-          "name": "addRetry",
-          "parameters": [
-            {
-              "name": "task",
-              "type": {
-                "union": {
-                  "types": [
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
-                    },
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
-                    }
-                  ]
-                }
-              }
-            },
-            {
-              "name": "errors",
-              "type": {
-                "collection": {
-                  "elementtype": {
-                    "primitive": "string"
-                  },
-                  "kind": "array"
-                }
-              }
-            }
-          ],
-          "protected": true
-        },
         {
           "docs": {
             "remarks": "Called by GithubRunners and shouldn't be called manually.",
@@ -6205,7 +6171,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ec2.ts",
-            "line": 344
+            "line": 349
           },
           "name": "getStepFunctionTask",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6234,7 +6200,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ec2.ts",
-            "line": 448
+            "line": 446
           },
           "name": "grantStateMachine",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6303,7 +6269,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ec2.ts",
-            "line": 478
+            "line": 476
           },
           "name": "status",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6332,7 +6298,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/ec2.ts",
-            "line": 500
+            "line": 498
           },
           "name": "connections",
           "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
@@ -6393,6 +6359,27 @@
           "type": {
             "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
           }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "List of step functions errors that should be retried."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ec2.ts",
+            "line": 282
+          },
+          "name": "retryableErrors",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
         }
       ],
       "symbolId": "src/providers/ec2:Ec2RunnerProvider"
@@ -6665,7 +6652,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/ecs.ts",
-          "line": 301
+          "line": 307
         },
         "parameters": [
           {
@@ -6737,45 +6724,6 @@
           },
           "static": true
         },
-        {
-          "docs": {
-            "stability": "experimental"
-          },
-          "locationInModule": {
-            "filename": "src/providers/common.ts",
-            "line": 474
-          },
-          "name": "addRetry",
-          "parameters": [
-            {
-              "name": "task",
-              "type": {
-                "union": {
-                  "types": [
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
-                    },
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
-                    }
-                  ]
-                }
-              }
-            },
-            {
-              "name": "errors",
-              "type": {
-                "collection": {
-                  "elementtype": {
-                    "primitive": "string"
-                  },
-                  "kind": "array"
-                }
-              }
-            }
-          ],
-          "protected": true
-        },
         {
           "docs": {
             "remarks": "Called by GithubRunners and shouldn't be called manually.",
@@ -6784,7 +6732,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ecs.ts",
-            "line": 497
+            "line": 503
           },
           "name": "getStepFunctionTask",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6813,7 +6761,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ecs.ts",
-            "line": 546
+            "line": 550
           },
           "name": "grantStateMachine",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6882,7 +6830,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/ecs.ts",
-            "line": 549
+            "line": 553
           },
           "name": "status",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6972,6 +6920,27 @@
           "type": {
             "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
           }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "List of step functions errors that should be retried."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/ecs.ts",
+            "line": 301
+          },
+          "name": "retryableErrors",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
         }
       ],
       "symbolId": "src/providers/ecs:EcsRunnerProvider"
@@ -7335,7 +7304,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/fargate.ts",
-          "line": 356
+          "line": 362
         },
         "parameters": [
           {
@@ -7362,7 +7331,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/providers/fargate.ts",
-        "line": 519
+        "line": 523
       },
       "name": "FargateRunner",
       "symbolId": "src/providers/fargate:FargateRunner"
@@ -7382,7 +7351,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/fargate.ts",
-          "line": 356
+          "line": 362
         },
         "parameters": [
           {
@@ -7454,45 +7423,6 @@
           },
           "static": true
         },
-        {
-          "docs": {
-            "stability": "experimental"
-          },
-          "locationInModule": {
-            "filename": "src/providers/common.ts",
-            "line": 474
-          },
-          "name": "addRetry",
-          "parameters": [
-            {
-              "name": "task",
-              "type": {
-                "union": {
-                  "types": [
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
-                    },
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
-                    }
-                  ]
-                }
-              }
-            },
-            {
-              "name": "errors",
-              "type": {
-                "collection": {
-                  "elementtype": {
-                    "primitive": "string"
-                  },
-                  "kind": "array"
-                }
-              }
-            }
-          ],
-          "protected": true
-        },
         {
           "docs": {
             "remarks": "Called by GithubRunners and shouldn't be called manually.",
@@ -7501,7 +7431,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/fargate.ts",
-            "line": 440
+            "line": 446
           },
           "name": "getStepFunctionTask",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -7530,7 +7460,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/fargate.ts",
-            "line": 494
+            "line": 498
           },
           "name": "grantStateMachine",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -7599,7 +7529,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/fargate.ts",
-            "line": 497
+            "line": 501
           },
           "name": "status",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -7789,6 +7719,27 @@
             "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
           }
         },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "List of step functions errors that should be retried."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/fargate.ts",
+            "line": 354
+          },
+          "name": "retryableErrors",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
         {
           "docs": {
             "stability": "experimental",
@@ -8143,7 +8094,7 @@
         },
         "locationInModule": {
           "filename": "src/runner.ts",
-          "line": 223
+          "line": 246
         },
         "parameters": [
           {
@@ -8170,7 +8121,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 204
+        "line": 227
       },
       "methods": [
         {
@@ -8181,7 +8132,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 630
+            "line": 696
           },
           "name": "failedImageBuildsTopic",
           "returns": {
@@ -8198,7 +8149,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 612
+            "line": 678
           },
           "name": "metricFailed",
           "parameters": [
@@ -8224,7 +8175,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 557
+            "line": 623
           },
           "name": "metricJobCompleted",
           "parameters": [
@@ -8250,7 +8201,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 603
+            "line": 669
           },
           "name": "metricSucceeded",
           "parameters": [
@@ -8276,7 +8227,7 @@
           },
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 619
+            "line": 685
           },
           "name": "metricTime",
           "parameters": [
@@ -8305,7 +8256,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 208
+            "line": 231
           },
           "name": "providers",
           "type": {
@@ -8325,7 +8276,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 213
+            "line": 236
           },
           "name": "secrets",
           "type": {
@@ -8339,7 +8290,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 223
+            "line": 246
           },
           "name": "props",
           "optional": true,
@@ -8361,7 +8312,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 35
+        "line": 38
       },
       "name": "GitHubRunnersProps",
       "properties": [
@@ -8376,7 +8327,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 58
+            "line": 70
           },
           "name": "allowPublicSubnet",
           "optional": true,
@@ -8394,7 +8345,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 88
+            "line": 100
           },
           "name": "extraCertificates",
           "optional": true,
@@ -8405,7 +8356,7 @@
         {
           "abstract": true,
           "docs": {
-            "default": "10 minutes",
+            "default": "5 minutes",
             "remarks": "If the user cancelled the job, or if another runner stole it, this stops the runner to avoid wasting resources.",
             "stability": "experimental",
             "summary": "Time to wait before stopping a runner that remains idle."
@@ -8413,7 +8364,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 95
+            "line": 107
           },
           "name": "idleTimeout",
           "optional": true,
@@ -8431,7 +8382,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 102
+            "line": 114
           },
           "name": "logOptions",
           "optional": true,
@@ -8450,7 +8401,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 41
+            "line": 44
           },
           "name": "providers",
           "optional": true,
@@ -8463,6 +8414,25 @@
             }
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "retry 23 times up to about 24 hours",
+            "remarks": "GitHub jobs time out after not being able to get a runner for 24 hours. You should not retry for more than 24 hours.\n\nTotal time spent waiting can be calculated with interval * (backoffRate ^ maxAttempts) / (backoffRate - 1).",
+            "stability": "experimental",
+            "summary": "Options to retry operation in case of failure like missing capacity, or API quota issues."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/runner.ts",
+            "line": 151
+          },
+          "name": "retryOptions",
+          "optional": true,
+          "type": {
+            "fqn": "@cloudsnorkel/cdk-github-runners.ProviderRetryOptions"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -8473,7 +8443,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 63
+            "line": 75
           },
           "name": "securityGroup",
           "optional": true,
@@ -8492,7 +8462,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 109
+            "line": 121
           },
           "name": "setupAccess",
           "optional": true,
@@ -8511,7 +8481,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 128
+            "line": 140
           },
           "name": "statusAccess",
           "optional": true,
@@ -8522,14 +8492,14 @@
         {
           "abstract": true,
           "docs": {
-            "remarks": "Use this with GitHub Enterprise Server hosted that's inaccessible from outside the VPC.",
+            "remarks": "Make sure the selected VPC and subnets have access to the following with either NAT Gateway or VPC Endpoints:\n* GitHub Enterprise Server\n* Secrets Manager\n* SQS\n* Step Functions\n* CloudFormation (status function only)\n* EC2 (status function only)\n* ECR (status function only)",
             "stability": "experimental",
-            "summary": "VPC used for all management functions."
+            "summary": "VPC used for all management functions. Use this with GitHub Enterprise Server hosted that's inaccessible from outside the VPC."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 46
+            "line": 58
           },
           "name": "vpc",
           "optional": true,
@@ -8547,7 +8517,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 51
+            "line": 63
           },
           "name": "vpcSubnets",
           "optional": true,
@@ -8559,14 +8529,14 @@
           "abstract": true,
           "docs": {
             "default": "LambdaAccess.lambdaUrl()",
-            "remarks": "This function is called by GitHub when a new workflow job is scheduled. For an extra layer of security, you can set this to `LambdaAccess.apiGateway({ allowedIps: LambdaAccess.githubWebhookIps() })`.\n\nYou can also set this to `LambdaAccess.privateApiGateway()` if your GitHub Enterprise Server is hosted in a VPC. This will create an API Gateway endpoint that's only accessible from within the VPC.\n\n*WARNING*: changing access type may change the URL. When the URL changes, you must update GitHub as well.",
+            "remarks": "This function is called by GitHub when a new workflow job is scheduled. For an extra layer of security, you can set this to `LambdaAccess.apiGateway({ allowedIps: LambdaAccess.githubWebhookIps() })`.\n\nYou can also set this to `LambdaAccess.apiGateway({allowedVpc: vpc, allowedIps: ['GHES.IP.ADDRESS/32']})` if your GitHub Enterprise Server is hosted in a VPC. This will create an API Gateway endpoint that's only accessible from within the VPC.\n\n*WARNING*: changing access type may change the URL. When the URL changes, you must update GitHub as well.",
             "stability": "experimental",
             "summary": "Access configuration for the webhook function."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 121
+            "line": 133
           },
           "name": "webhookAccess",
           "optional": true,
@@ -8587,7 +8557,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/common.ts",
-        "line": 345
+        "line": 343
       },
       "name": "IRunnerAmiStatus",
       "properties": [
@@ -8600,7 +8570,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 349
+            "line": 347
           },
           "name": "launchTemplate",
           "type": {
@@ -8616,7 +8586,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 354
+            "line": 352
           },
           "name": "amiBuilderLogGroup",
           "optional": true,
@@ -8691,7 +8661,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/common.ts",
-        "line": 325
+        "line": 323
       },
       "name": "IRunnerImageStatus",
       "properties": [
@@ -8704,7 +8674,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 329
+            "line": 327
           },
           "name": "imageRepository",
           "type": {
@@ -8720,7 +8690,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 334
+            "line": 332
           },
           "name": "imageTag",
           "type": {
@@ -8736,7 +8706,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 339
+            "line": 337
           },
           "name": "imageBuilderLogGroup",
           "optional": true,
@@ -8763,7 +8733,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/common.ts",
-        "line": 405
+        "line": 403
       },
       "methods": [
         {
@@ -8775,7 +8745,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 429
+            "line": 432
           },
           "name": "getStepFunctionTask",
           "parameters": [
@@ -8804,7 +8774,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 437
+            "line": 440
           },
           "name": "grantStateMachine",
           "parameters": [
@@ -8828,7 +8798,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 444
+            "line": 447
           },
           "name": "status",
           "parameters": [
@@ -8861,7 +8831,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 413
+            "line": 411
           },
           "name": "labels",
           "type": {
@@ -8883,12 +8853,33 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 420
+            "line": 418
           },
           "name": "logGroup",
           "type": {
             "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "List of step functions errors that should be retried."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/common.ts",
+            "line": 423
+          },
+          "name": "retryableErrors",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
         }
       ],
       "symbolId": "src/providers/common:IRunnerProvider"
@@ -8903,7 +8894,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/common.ts",
-        "line": 360
+        "line": 358
       },
       "name": "IRunnerProviderStatus",
       "properties": [
@@ -8916,7 +8907,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 369
+            "line": 367
           },
           "name": "labels",
           "type": {
@@ -8937,7 +8928,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 364
+            "line": 362
           },
           "name": "type",
           "type": {
@@ -8953,7 +8944,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 394
+            "line": 392
           },
           "name": "ami",
           "optional": true,
@@ -8970,7 +8961,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 389
+            "line": 387
           },
           "name": "image",
           "optional": true,
@@ -8987,7 +8978,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 399
+            "line": 397
           },
           "name": "logGroup",
           "optional": true,
@@ -9004,7 +8995,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 384
+            "line": 382
           },
           "name": "roleArn",
           "optional": true,
@@ -9021,7 +9012,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 379
+            "line": 377
           },
           "name": "securityGroups",
           "optional": true,
@@ -9043,7 +9034,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 374
+            "line": 372
           },
           "name": "vpcArn",
           "optional": true,
@@ -9425,7 +9416,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/access.ts",
-        "line": 35
+        "line": 46
       },
       "methods": [
         {
@@ -9436,7 +9427,7 @@
           },
           "locationInModule": {
             "filename": "src/access.ts",
-            "line": 67
+            "line": 78
           },
           "name": "apiGateway",
           "parameters": [
@@ -9463,7 +9454,7 @@
           },
           "locationInModule": {
             "filename": "src/access.ts",
-            "line": 76
+            "line": 87
           },
           "name": "githubWebhookIps",
           "returns": {
@@ -9486,7 +9477,7 @@
           },
           "locationInModule": {
             "filename": "src/access.ts",
-            "line": 46
+            "line": 57
           },
           "name": "lambdaUrl",
           "returns": {
@@ -9504,7 +9495,7 @@
           },
           "locationInModule": {
             "filename": "src/access.ts",
-            "line": 39
+            "line": 50
           },
           "name": "noAccess",
           "returns": {
@@ -9532,7 +9523,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/lambda.ts",
-          "line": 216
+          "line": 224
         },
         "parameters": [
           {
@@ -9559,7 +9550,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/providers/lambda.ts",
-        "line": 450
+        "line": 456
       },
       "name": "LambdaRunner",
       "symbolId": "src/providers/lambda:LambdaRunner"
@@ -9579,7 +9570,7 @@
         },
         "locationInModule": {
           "filename": "src/providers/lambda.ts",
-          "line": 216
+          "line": 224
         },
         "parameters": [
           {
@@ -9651,45 +9642,6 @@
           },
           "static": true
         },
-        {
-          "docs": {
-            "stability": "experimental"
-          },
-          "locationInModule": {
-            "filename": "src/providers/common.ts",
-            "line": 474
-          },
-          "name": "addRetry",
-          "parameters": [
-            {
-              "name": "task",
-              "type": {
-                "union": {
-                  "types": [
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.TaskStateBase"
-                    },
-                    {
-                      "fqn": "aws-cdk-lib.aws_stepfunctions.Parallel"
-                    }
-                  ]
-                }
-              }
-            },
-            {
-              "name": "errors",
-              "type": {
-                "collection": {
-                  "elementtype": {
-                    "primitive": "string"
-                  },
-                  "kind": "array"
-                }
-              }
-            }
-          ],
-          "protected": true
-        },
         {
           "docs": {
             "remarks": "Called by GithubRunners and shouldn't be called manually.",
@@ -9698,7 +9650,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/lambda.ts",
-            "line": 304
+            "line": 312
           },
           "name": "getStepFunctionTask",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -9727,7 +9679,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/lambda.ts",
-            "line": 367
+            "line": 373
           },
           "name": "grantStateMachine",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -9796,7 +9748,7 @@
           },
           "locationInModule": {
             "filename": "src/providers/lambda.ts",
-            "line": 370
+            "line": 376
           },
           "name": "status",
           "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -9863,7 +9815,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/lambda.ts",
-            "line": 293
+            "line": 301
           },
           "name": "connections",
           "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
@@ -9955,6 +9907,27 @@
           "type": {
             "fqn": "aws-cdk-lib.aws_logs.ILogGroup"
           }
+        },
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "List of step functions errors that should be retried."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/providers/lambda.ts",
+            "line": 213
+          },
+          "name": "retryableErrors",
+          "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
         }
       ],
       "symbolId": "src/providers/lambda:LambdaRunnerProvider"
@@ -10504,7 +10477,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/runner.ts",
-        "line": 134
+        "line": 157
       },
       "name": "LogOptions",
       "properties": [
@@ -10518,7 +10491,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 145
+            "line": 168
           },
           "name": "includeExecutionData",
           "optional": true,
@@ -10536,7 +10509,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 152
+            "line": 175
           },
           "name": "level",
           "optional": true,
@@ -10553,7 +10526,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 138
+            "line": 161
           },
           "name": "logGroupName",
           "optional": true,
@@ -10572,7 +10545,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/runner.ts",
-            "line": 161
+            "line": 184
           },
           "name": "logRetention",
           "optional": true,
@@ -10748,7 +10721,7 @@
       "assembly": "@cloudsnorkel/cdk-github-runners",
       "datatype": true,
       "docs": {
-        "remarks": "The default is to retry 10 times for about 45 minutes with increasing interval.",
+        "remarks": "The default is to retry 23 times for about 24 hours with increasing interval.",
         "stability": "experimental",
         "summary": "Retry options for providers."
       },
@@ -10800,7 +10773,7 @@
         {
           "abstract": true,
           "docs": {
-            "default": "10",
+            "default": "23",
             "stability": "experimental",
             "summary": "How many times to retry."
           },
@@ -12221,14 +12194,13 @@
         {
           "abstract": true,
           "docs": {
-            "default": "retry 10 times up to about 45 minutes",
-            "stability": "experimental",
-            "summary": "Options to retry operation in case of failure like missing capacity, or API quota issues."
+            "deprecated": "use {@link retryOptions } on {@link GitHubRunners } instead",
+            "stability": "deprecated"
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 283
+            "line": 281
           },
           "name": "retryOptions",
           "optional": true,
@@ -12251,7 +12223,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/providers/common.ts",
-        "line": 295
+        "line": 293
       },
       "name": "RunnerRuntimeParameters",
       "properties": [
@@ -12265,7 +12237,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 309
+            "line": 307
           },
           "name": "githubDomainPath",
           "type": {
@@ -12281,7 +12253,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 314
+            "line": 312
           },
           "name": "ownerPath",
           "type": {
@@ -12297,7 +12269,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 319
+            "line": 317
           },
           "name": "repoPath",
           "type": {
@@ -12314,7 +12286,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 304
+            "line": 302
           },
           "name": "runnerNamePath",
           "type": {
@@ -12330,7 +12302,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/providers/common.ts",
-            "line": 299
+            "line": 297
           },
           "name": "runnerTokenPath",
           "type": {
@@ -12957,6 +12929,6 @@
       "symbolId": "src/image-builders/aws-image-builder/deprecated/windows-components:WindowsComponents"
     }
   },
-  "version": "0.9.7",
-  "fingerprint": "WvNV3e021YDh9bxgjpR92gFXUW/VDrTfwOfAn6GsGO8="
+  "version": "0.10.0",
+  "fingerprint": "+crE0rwqfHuHDyIaCsPdd6LVAkwDEKdQQuNNDM7LL50="
 }