@cloudsnorkel/cdk-github-runners 0.14.19 → 0.14.21

package/API.md

@@ -797,7 +797,7 @@ Grant principal used to add permissions to the runner role.
 
 ##### ~~`image`~~<sup>Required</sup> <a name="image" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunner.property.image"></a>
 
-- *Deprecated:* use {@link CodeBuildRunnerProvider }
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly image: RunnerImage;
@@ -1175,7 +1175,9 @@ Grant principal used to add permissions to the runner role.
 
 ---
 
-##### `image`<sup>Required</sup> <a name="image" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.property.image"></a>
+##### ~~`image`~~<sup>Required</sup> <a name="image" id="@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProvider.property.image"></a>
+
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly image: RunnerImage;
@@ -2318,6 +2320,7 @@ Included components:
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.property.capacityProvider">capacityProvider</a></code> | <code>aws-cdk-lib.aws_ecs.AsgCapacityProvider</code> | Capacity provider used to scale the cluster. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.property.connections">connections</a></code> | <code>aws-cdk-lib.aws_ec2.Connections</code> | The network connections associated with this resource. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.property.grantPrincipal">grantPrincipal</a></code> | <code>aws-cdk-lib.aws_iam.IPrincipal</code> | Grant principal used to add permissions to the runner role. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.property.labels">labels</a></code> | <code>string[]</code> | Labels associated with this provider. |
@@ -2338,6 +2341,20 @@ The tree node.
 
 ---
 
+##### `capacityProvider`<sup>Required</sup> <a name="capacityProvider" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.property.capacityProvider"></a>
+
+```typescript
+public readonly capacityProvider: AsgCapacityProvider;
+```
+
+- *Type:* aws-cdk-lib.aws_ecs.AsgCapacityProvider
+
+Capacity provider used to scale the cluster.
+
+Use capacityProvider.autoScalingGroup to access the auto scaling group. This can help set up custom scaling policies.
+
+---
+
 ##### `connections`<sup>Required</sup> <a name="connections" id="@cloudsnorkel/cdk-github-runners.EcsRunnerProvider.property.connections"></a>
 
 ```typescript
@@ -2627,7 +2644,7 @@ The tree node.
 
 ##### ~~`assignPublicIp`~~<sup>Required</sup> <a name="assignPublicIp" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.assignPublicIp"></a>
 
-- *Deprecated:* use {@link FargateRunnerProvider }
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly assignPublicIp: boolean;
@@ -2669,7 +2686,7 @@ The network connections associated with this resource.
 
 ##### ~~`container`~~<sup>Required</sup> <a name="container" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.container"></a>
 
-- *Deprecated:* use {@link FargateRunnerProvider }
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly container: ContainerDefinition;
@@ -2697,7 +2714,7 @@ Grant principal used to add permissions to the runner role.
 
 ##### ~~`image`~~<sup>Required</sup> <a name="image" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.image"></a>
 
-- *Deprecated:* use {@link FargateRunnerProvider }
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly image: RunnerImage;
@@ -2757,7 +2774,7 @@ List of step functions errors that should be retried.
 
 ##### ~~`spot`~~<sup>Required</sup> <a name="spot" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.spot"></a>
 
-- *Deprecated:* use {@link FargateRunnerProvider }
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly spot: boolean;
@@ -2771,7 +2788,7 @@ Use spot pricing for Fargate tasks.
 
 ##### ~~`task`~~<sup>Required</sup> <a name="task" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.task"></a>
 
-- *Deprecated:* use {@link FargateRunnerProvider }
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly task: FargateTaskDefinition;
@@ -2785,7 +2802,7 @@ Fargate task hosting the runner.
 
 ##### ~~`subnetSelection`~~<sup>Optional</sup> <a name="subnetSelection" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.subnetSelection"></a>
 
-- *Deprecated:* use {@link FargateRunnerProvider }
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly subnetSelection: SubnetSelection;
@@ -2799,7 +2816,7 @@ Subnets used for hosting the runner task.
 
 ##### ~~`vpc`~~<sup>Optional</sup> <a name="vpc" id="@cloudsnorkel/cdk-github-runners.FargateRunner.property.vpc"></a>
 
-- *Deprecated:* use {@link FargateRunnerProvider }
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly vpc: IVpc;
@@ -3090,7 +3107,9 @@ The tree node.
 
 ---
 
-##### `assignPublicIp`<sup>Required</sup> <a name="assignPublicIp" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.assignPublicIp"></a>
+##### ~~`assignPublicIp`~~<sup>Required</sup> <a name="assignPublicIp" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.assignPublicIp"></a>
+
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly assignPublicIp: boolean;
@@ -3126,7 +3145,9 @@ The network connections associated with this resource.
 
 ---
 
-##### `container`<sup>Required</sup> <a name="container" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.container"></a>
+##### ~~`container`~~<sup>Required</sup> <a name="container" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.container"></a>
+
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly container: ContainerDefinition;
@@ -3150,7 +3171,9 @@ Grant principal used to add permissions to the runner role.
 
 ---
 
-##### `image`<sup>Required</sup> <a name="image" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.image"></a>
+##### ~~`image`~~<sup>Required</sup> <a name="image" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.image"></a>
+
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly image: RunnerImage;
@@ -3202,7 +3225,9 @@ List of step functions errors that should be retried.
 
 ---
 
-##### `spot`<sup>Required</sup> <a name="spot" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.spot"></a>
+##### ~~`spot`~~<sup>Required</sup> <a name="spot" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.spot"></a>
+
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly spot: boolean;
@@ -3214,7 +3239,9 @@ Use spot pricing for Fargate tasks.
 
 ---
 
-##### `task`<sup>Required</sup> <a name="task" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.task"></a>
+##### ~~`task`~~<sup>Required</sup> <a name="task" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.task"></a>
+
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly task: FargateTaskDefinition;
@@ -3226,7 +3253,9 @@ Fargate task hosting the runner.
 
 ---
 
-##### `subnetSelection`<sup>Optional</sup> <a name="subnetSelection" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.subnetSelection"></a>
+##### ~~`subnetSelection`~~<sup>Optional</sup> <a name="subnetSelection" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.subnetSelection"></a>
+
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly subnetSelection: SubnetSelection;
@@ -3238,7 +3267,9 @@ Subnets used for hosting the runner task.
 
 ---
 
-##### `vpc`<sup>Optional</sup> <a name="vpc" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.vpc"></a>
+##### ~~`vpc`~~<sup>Optional</sup> <a name="vpc" id="@cloudsnorkel/cdk-github-runners.FargateRunnerProvider.property.vpc"></a>
+
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly vpc: IVpc;
@@ -4162,7 +4193,7 @@ Grant principal used to add permissions to the runner role.
 
 ##### ~~`image`~~<sup>Required</sup> <a name="image" id="@cloudsnorkel/cdk-github-runners.LambdaRunner.property.image"></a>
 
-- *Deprecated:* use {@link LambdaRunnerProvider }
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly image: RunnerImage;
@@ -4530,7 +4561,9 @@ Grant principal used to add permissions to the runner role.
 
 ---
 
-##### `image`<sup>Required</sup> <a name="image" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.property.image"></a>
+##### ~~`image`~~<sup>Required</sup> <a name="image" id="@cloudsnorkel/cdk-github-runners.LambdaRunnerProvider.property.image"></a>
+
+- *Deprecated:* This field is internal and should not be accessed directly.
 
 ```typescript
 public readonly image: RunnerImage;
@@ -5627,7 +5660,7 @@ const codeBuildRunnerImageBuilderProps: CodeBuildRunnerImageBuilderProps = { ...
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerImageBuilderProps.property.buildImage">buildImage</a></code> | <code>aws-cdk-lib.aws_codebuild.IBuildImage</code> | Build image to use in CodeBuild. |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerImageBuilderProps.property.computeType">computeType</a></code> | <code>aws-cdk-lib.aws_codebuild.ComputeType</code> | The type of compute to use for this build. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerImageBuilderProps.property.computeType">computeType</a></code> | <code>aws-cdk-lib.aws_codebuild.ComputeType</code> | The type of compute to use for this build. See the {@link ComputeType} enum for the possible values. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerImageBuilderProps.property.timeout">timeout</a></code> | <code>aws-cdk-lib.Duration</code> | The number of minutes after which AWS CodeBuild stops the build if it's not complete. |
 
 ---
@@ -5658,9 +5691,17 @@ public readonly computeType: ComputeType;
 - *Type:* aws-cdk-lib.aws_codebuild.ComputeType
 - *Default:* {@link ComputeType#SMALL }
 
-The type of compute to use for this build.
+The type of compute to use for this build. See the {@link ComputeType} enum for the possible values.
 
-See the {@link ComputeType} enum for the possible values.
+The compute type determines CPU, memory, and disk space:
+- SMALL: 2 vCPU, 3 GB RAM, 64 GB disk
+- MEDIUM: 4 vCPU, 7 GB RAM, 128 GB disk
+- LARGE: 8 vCPU, 15 GB RAM, 128 GB disk
+- X2_LARGE: 72 vCPU, 145 GB RAM, 256 GB disk (Linux) or 824 GB disk (Windows)
+
+Use a larger compute type when you need more disk space for building larger Docker images.
+
+For more details, see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types
 
 ---
 
@@ -5697,7 +5738,7 @@ const codeBuildRunnerProviderProps: CodeBuildRunnerProviderProps = { ... }
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.defaultLabels">defaultLabels</a></code> | <code>boolean</code> | Add default labels based on OS and architecture of the runner. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.logRetention">logRetention</a></code> | <code>aws-cdk-lib.aws_logs.RetentionDays</code> | The number of days log events are kept in CloudWatch Logs. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.retryOptions">retryOptions</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.ProviderRetryOptions">ProviderRetryOptions</a></code> | *No description.* |
-| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.computeType">computeType</a></code> | <code>aws-cdk-lib.aws_codebuild.ComputeType</code> | The type of compute to use for this build. |
+| <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.computeType">computeType</a></code> | <code>aws-cdk-lib.aws_codebuild.ComputeType</code> | The type of compute to use for this build. See the {@link ComputeType} enum for the possible values. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.dockerInDocker">dockerInDocker</a></code> | <code>boolean</code> | Support building and running Docker images by enabling Docker-in-Docker (dind) and the required CodeBuild privileged mode. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.group">group</a></code> | <code>string</code> | GitHub Actions runner group name. |
 | <code><a href="#@cloudsnorkel/cdk-github-runners.CodeBuildRunnerProviderProps.property.imageBuilder">imageBuilder</a></code> | <code><a href="#@cloudsnorkel/cdk-github-runners.IRunnerImageBuilder">IRunnerImageBuilder</a></code> | Runner image builder used to build Docker images containing GitHub Runner and all requirements. |
@@ -5764,9 +5805,17 @@ public readonly computeType: ComputeType;
 - *Type:* aws-cdk-lib.aws_codebuild.ComputeType
 - *Default:* {@link ComputeType#SMALL }
 
-The type of compute to use for this build.
+The type of compute to use for this build. See the {@link ComputeType} enum for the possible values.
 
-See the {@link ComputeType} enum for the possible values.
+The compute type determines CPU, memory, and disk space:
+- SMALL: 2 vCPU, 3 GB RAM, 64 GB disk
+- MEDIUM: 4 vCPU, 7 GB RAM, 128 GB disk
+- LARGE: 8 vCPU, 15 GB RAM, 128 GB disk
+- X2_LARGE: 72 vCPU, 145 GB RAM, 256 GB disk (Linux) or 824 GB disk (Windows)
+
+Use a larger compute type when you need more disk space for building larger Docker images.
+
+For more details, see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types
 
 ---
 

package/README.md

@@ -456,6 +456,7 @@ We provide comprehensive examples in the [`examples/`](examples/) folder to help
 - **[Composite Provider](examples/typescript/composite-provider/)** - Fallback and weighted distribution strategies (also available in [Python](examples/python/composite-provider/))
 - **[Provider Selector](examples/typescript/provider-selector/)** - Custom provider selection with Lambda function (also available in [Python](examples/python/provider-selector/))
 - **[EC2 Windows Provider](examples/typescript/ec2-windows-provider/)** - EC2 configuration for Windows runners (also available in [Python](examples/python/ec2-windows-provider/))
+- **[Split Stacks](examples/typescript/split-stacks/)** - Split image builders and providers across multiple stacks (also available in [Python](examples/python/split-stacks/))
 
 ### Compute & Performance
 - **[Compute Options](examples/typescript/compute-options/)** - Configure CPU, memory, and instance types for different providers (also available in [Python](examples/python/compute-options/))
@@ -536,13 +537,13 @@ If you use and love this project, please consider contributing.
 
 ## Other Options
 
-1. [philips-labs/terraform-aws-github-runner][3] if you're using Terraform
+1. [github-aws-runners/terraform-aws-github-runner][3] if you're using Terraform
 2. [actions/actions-runner-controller][4] if you're using Kubernetes
 
 
 [1]: https://docs.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners
 [2]: https://github.com/marketplace/actions/configure-aws-credentials-action-for-github-actions
-[3]: https://github.com/philips-labs/terraform-aws-github-runner
+[3]: https://github.com/github-aws-runners/terraform-aws-github-runner
 [4]: https://github.com/actions/actions-runner-controller
 [5]: https://github.com/actions/runner
 [6]: https://pypi.org/project/cloudsnorkel.cdk-github-runners