@cloudsnorkel/cdk-github-runners 0.2.0 → 0.3.2

package/README.md

@@ -1,7 +1,7 @@
 # GitHub Self-Hosted Runners CDK Constructs
 
-[![NPM](https://img.shields.io/npm/v/@cloudsnorkel/cdk-github-runners?label=npm&logo=npm)][6]
-[![PyPI](https://img.shields.io/pypi/v/cloudsnorkel.cdk-github-runners?label=pypi&logo=pypi)][7]
+[![NPM](https://img.shields.io/npm/v/@cloudsnorkel/cdk-github-runners?label=npm&logo=npm)][7]
+[![PyPI](https://img.shields.io/pypi/v/cloudsnorkel.cdk-github-runners?label=pypi&logo=pypi)][6]
 [![Maven Central](https://img.shields.io/maven-central/v/com.cloudsnorkel/cdk.github.runners.svg?label=Maven%20Central&logo=java)][8]
 [![Go](https://img.shields.io/github/v/tag/CloudSnorkel/cdk-github-runners?color=red&label=go&logo=go)][11]
 [![Nuget](https://img.shields.io/nuget/v/CloudSnorkel.Cdk.Github.Runners?color=red&&logo=nuget)][12]
@@ -31,15 +31,16 @@ The best way to browse API documentation is on [Constructs Hub][13]. It is avail
 
 A runner provider creates compute resources on-demand and uses [actions/runner][5] to start a runner.
 
-|                | CodeBuild                | Fargate       | Lambda        |
-|----------------|--------------------------|---------------|---------------|
-| **Time limit** | 8 hours                  | Unlimited     | 15 minutes    |
-| **vCPUs**      | 2, 4, 8, or 72           | 0.25 to 4     | 1 to 6        |
-| **RAM**        | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb | 128mb to 10gb |
-| **Storage**    | 50gb to 824gb            | 20gb to 200gb | Up to 10gb    |
-| **sudo**       | ✔                        | ✔             | ❌             |
-| **Docker**     | ✔                        | ❌             | ❌             |
-| **Spot**       | ❌                        | ✔             | ❌             |
+|                  | CodeBuild                | Fargate        | Lambda         |
+|------------------|--------------------------|----------------|----------------|
+| **Time limit**   | 8 hours                  | Unlimited      | 15 minutes     |
+| **vCPUs**        | 2, 4, 8, or 72           | 0.25 to 4      | 1 to 6         |
+| **RAM**          | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb  | 128mb to 10gb  |
+| **Storage**      | 50gb to 824gb            | 20gb to 200gb  | Up to 10gb     |
+| **Architecture** | x86_64, ARM64            | x86_64, ARM64  | x86_64, ARM64  |
+| **sudo**         | ✔                        | ✔              | ❌              |
+| **Docker**       | ✔                        | ❌              | ❌              |
+| **Spot pricing** | ❌                        | ✔              | ❌              |
 
 The 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.
 
@@ -90,50 +91,59 @@ The default providers configured by `GitHubRunners` are useful for testing but p
 For example:
 
 ```typescript
-import * as cdk from 'aws-cdk-lib';
-import { aws_ec2 as ec2, aws_s3 as s3 } from 'aws-cdk-lib';
-import { GitHubRunners, CodeBuildRunner } from '@cloudsnorkel/cdk-github-runners';
-
-const app = new cdk.App();
-const stack = new cdk.Stack(
-  app,
-  'github-runners-test',
-  {
-     env: {
-        account: process.env.CDK_DEFAULT_ACCOUNT,
-        region: process.env.CDK_DEFAULT_REGION,
-     },
-  },
-);
-
-const vpc = ec2.Vpc.fromLookup(stack, 'vpc', { vpcId: 'vpc-1234567' });
-const runnerSg = new ec2.SecurityGroup(stack, 'runner security group', { vpc: vpc });
-const dbSg = ec2.SecurityGroup.fromSecurityGroupId(stack, 'database security group', 'sg-1234567');
-const bucket = new s3.Bucket(stack, 'runner bucket');
+let vpc: ec2.Vpc;
+let runnerSg: ec2.SecurityGroup;
+let dbSg: ec2.SecurityGroup;
+let bucket: s3.Bucket;
 
 // create a custom CodeBuild provider
-const myProvider = new CodeBuildRunner(
-  stack, 'codebuild runner',
-  {
-     label: 'my-codebuild',
-     vpc: vpc,
-     securityGroup: runnerSg,
-  },
-);
+const myProvider = new CodeBuildRunner(this, 'codebuild runner', { 
+    label: 'my-codebuild',
+    vpc: vpc,
+    securityGroup: runnerSg,
+});
 // grant some permissions to the provider
 bucket.grantReadWrite(myProvider);
 dbSg.connections.allowFrom(runnerSg, ec2.Port.tcp(3306), 'allow runners to connect to MySQL database');
 
 // create the runner infrastructure
-new GitHubRunners(
-  stack,
-  'runners',
-  {
+new GitHubRunners(this, 'runners', {
     providers: [myProvider],
-  }
-);
+});
+```
+
+Another 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.
+
+```typescript
+const myBuilder = new CodeBuildImageBuilder(this, 'image builder', {
+   dockerfilePath: FargateProvider.LINUX_X64_DOCKERFILE_PATH,
+   runnerVersion: RunnerVersion.specific('2.291.0'),
+   rebuildInterval: Duration.days(14),    
+});
+myBuilder.setBuildArg('EXTRA_PACKAGES', 'nginx xz-utils');
+
+const myProvider = new FargateProvider(this, 'fargate runner', {
+   label: 'customized-fargate',
+   vpc: vpc,
+   securityGroup: runnerSg,
+});
+
+// create the runner infrastructure
+new GitHubRunners(stack, 'runners', {
+   providers: [myProvider],
+});
+```
+
+Your workflow will then look like:
 
-app.synth();
+```yaml
+name: self-hosted example
+on: push
+jobs:
+  self-hosted:
+    runs-on: [self-hosted, customized-fargate]
+    steps:
+      - run: echo hello world
 ```
 
 ## Architecture
@@ -162,12 +172,12 @@ app.synth();
 [3]: https://github.com/philips-labs/terraform-aws-github-runner
 [4]: https://github.com/actions-runner-controller/actions-runner-controller
 [5]: https://github.com/actions/runner
-[6]: https://www.npmjs.com/package/@cloudsnorkel/cdk-github-runners
-[7]: https://pypi.org/project/cloudsnorkel.cdk-github-runners
+[6]: https://pypi.org/project/cloudsnorkel.cdk-github-runners
+[7]: https://www.npmjs.com/package/@cloudsnorkel/cdk-github-runners
 [8]: https://search.maven.org/search?q=g:%22com.cloudsnorkel%22%20AND%20a:%22cdk.github.runners%22
 [9]: https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps
 [10]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
 [11]: https://pkg.go.dev/github.com/CloudSnorkel/cdk-github-runners-go/cloudsnorkelcdkgithubrunners
 [12]: https://www.nuget.org/packages/CloudSnorkel.Cdk.Github.Runners/
 [13]: https://constructs.dev/packages/@cloudsnorkel/cdk-github-runners/
-[14]: https://docs.github.com/en/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#using-ephemeral-runners-for-autoscaling
+[14]: https://docs.github.com/en/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners#using-ephemeral-runners-for-autoscaling

package/lib/index.d.ts

@@ -3,4 +3,6 @@ export { GitHubRunners, GitHubRunnersProps } from './runner';
 export { CodeBuildRunner, CodeBuildRunnerProps } from './providers/codebuild';
 export { LambdaRunner, LambdaRunnerProps } from './providers/lambda';
 export { FargateRunner, FargateRunnerProps } from './providers/fargate';
-export { IRunnerProvider, RunnerProviderProps, RunnerVersion, RunnerRuntimeParameters } from './providers/common';
+export { IRunnerProvider, RunnerProviderProps, RunnerVersion, RunnerRuntimeParameters, RunnerImage, IImageBuilder, Architecture, Os } from './providers/common';
+export { CodeBuildImageBuilder, CodeBuildImageBuilderProps } from './providers/image-builders/codebuild';
+export { StaticRunnerImage } from './providers/image-builders/static';

package/lib/index.js

@@ -12,4 +12,10 @@ var fargate_1 = require("./providers/fargate");
 Object.defineProperty(exports, "FargateRunner", { enumerable: true, get: function () { return fargate_1.FargateRunner; } });
 var common_1 = require("./providers/common");
 Object.defineProperty(exports, "RunnerVersion", { enumerable: true, get: function () { return common_1.RunnerVersion; } });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxxQ0FBb0M7QUFBM0Isa0dBQUEsT0FBTyxPQUFBO0FBQ2hCLG1DQUE2RDtBQUFwRCx1R0FBQSxhQUFhLE9BQUE7QUFDdEIsbURBQThFO0FBQXJFLDRHQUFBLGVBQWUsT0FBQTtBQUN4Qiw2Q0FBcUU7QUFBNUQsc0dBQUEsWUFBWSxPQUFBO0FBQ3JCLCtDQUF3RTtBQUEvRCx3R0FBQSxhQUFhLE9BQUE7QUFDdEIsNkNBQWtIO0FBQW5FLHVHQUFBLGFBQWEsT0FBQSIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB7IFNlY3JldHMgfSBmcm9tICcuL3NlY3JldHMnO1xuZXhwb3J0IHsgR2l0SHViUnVubmVycywgR2l0SHViUnVubmVyc1Byb3BzIH0gZnJvbSAnLi9ydW5uZXInO1xuZXhwb3J0IHsgQ29kZUJ1aWxkUnVubmVyLCBDb2RlQnVpbGRSdW5uZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2NvZGVidWlsZCc7XG5leHBvcnQgeyBMYW1iZGFSdW5uZXIsIExhbWJkYVJ1bm5lclByb3BzIH0gZnJvbSAnLi9wcm92aWRlcnMvbGFtYmRhJztcbmV4cG9ydCB7IEZhcmdhdGVSdW5uZXIsIEZhcmdhdGVSdW5uZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2ZhcmdhdGUnO1xuZXhwb3J0IHsgSVJ1bm5lclByb3ZpZGVyLCBSdW5uZXJQcm92aWRlclByb3BzLCBSdW5uZXJWZXJzaW9uLCBSdW5uZXJSdW50aW1lUGFyYW1ldGVycyB9IGZyb20gJy4vcHJvdmlkZXJzL2NvbW1vbic7XG4iXX0=
+Object.defineProperty(exports, "Architecture", { enumerable: true, get: function () { return common_1.Architecture; } });
+Object.defineProperty(exports, "Os", { enumerable: true, get: function () { return common_1.Os; } });
+var codebuild_2 = require("./providers/image-builders/codebuild");
+Object.defineProperty(exports, "CodeBuildImageBuilder", { enumerable: true, get: function () { return codebuild_2.CodeBuildImageBuilder; } });
+var static_1 = require("./providers/image-builders/static");
+Object.defineProperty(exports, "StaticRunnerImage", { enumerable: true, get: function () { return static_1.StaticRunnerImage; } });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxxQ0FBb0M7QUFBM0Isa0dBQUEsT0FBTyxPQUFBO0FBQ2hCLG1DQUE2RDtBQUFwRCx1R0FBQSxhQUFhLE9BQUE7QUFDdEIsbURBQThFO0FBQXJFLDRHQUFBLGVBQWUsT0FBQTtBQUN4Qiw2Q0FBcUU7QUFBNUQsc0dBQUEsWUFBWSxPQUFBO0FBQ3JCLCtDQUF3RTtBQUEvRCx3R0FBQSxhQUFhLE9BQUE7QUFDdEIsNkNBQWdLO0FBQWpILHVHQUFBLGFBQWEsT0FBQTtBQUF1RCxzR0FBQSxZQUFZLE9BQUE7QUFBRSw0RkFBQSxFQUFFLE9BQUE7QUFDbkksa0VBQXlHO0FBQWhHLGtIQUFBLHFCQUFxQixPQUFBO0FBQzlCLDREQUFzRTtBQUE3RCwyR0FBQSxpQkFBaUIsT0FBQSIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB7IFNlY3JldHMgfSBmcm9tICcuL3NlY3JldHMnO1xuZXhwb3J0IHsgR2l0SHViUnVubmVycywgR2l0SHViUnVubmVyc1Byb3BzIH0gZnJvbSAnLi9ydW5uZXInO1xuZXhwb3J0IHsgQ29kZUJ1aWxkUnVubmVyLCBDb2RlQnVpbGRSdW5uZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2NvZGVidWlsZCc7XG5leHBvcnQgeyBMYW1iZGFSdW5uZXIsIExhbWJkYVJ1bm5lclByb3BzIH0gZnJvbSAnLi9wcm92aWRlcnMvbGFtYmRhJztcbmV4cG9ydCB7IEZhcmdhdGVSdW5uZXIsIEZhcmdhdGVSdW5uZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2ZhcmdhdGUnO1xuZXhwb3J0IHsgSVJ1bm5lclByb3ZpZGVyLCBSdW5uZXJQcm92aWRlclByb3BzLCBSdW5uZXJWZXJzaW9uLCBSdW5uZXJSdW50aW1lUGFyYW1ldGVycywgUnVubmVySW1hZ2UsIElJbWFnZUJ1aWxkZXIsIEFyY2hpdGVjdHVyZSwgT3MgfSBmcm9tICcuL3Byb3ZpZGVycy9jb21tb24nO1xuZXhwb3J0IHsgQ29kZUJ1aWxkSW1hZ2VCdWlsZGVyLCBDb2RlQnVpbGRJbWFnZUJ1aWxkZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2ltYWdlLWJ1aWxkZXJzL2NvZGVidWlsZCc7XG5leHBvcnQgeyBTdGF0aWNSdW5uZXJJbWFnZSB9IGZyb20gJy4vcHJvdmlkZXJzL2ltYWdlLWJ1aWxkZXJzL3N0YXRpYyc7XG4iXX0=

package/lib/lambdas/build-image/index.js

@@ -0,0 +1,121 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/lambdas/build-image/index.ts
+var build_image_exports = {};
+__export(build_image_exports, {
+  handler: () => handler
+});
+module.exports = __toCommonJS(build_image_exports);
+var AWS = __toESM(require("aws-sdk"));
+var codebuild = new AWS.CodeBuild();
+var ecr = new AWS.ECR();
+async function handler(event, context) {
+  try {
+    console.log(JSON.stringify(event));
+    const repoName = event.ResourceProperties.RepoName;
+    const projectName = event.ResourceProperties.ProjectName;
+    switch (event.RequestType) {
+      case "Create":
+      case "Update":
+        console.log(`Starting CodeBuild project ${projectName}`);
+        await codebuild.startBuild({
+          projectName,
+          environmentVariablesOverride: [
+            {
+              type: "PLAINTEXT",
+              name: "STACK_ID",
+              value: event.StackId
+            },
+            {
+              type: "PLAINTEXT",
+              name: "REQUEST_ID",
+              value: event.RequestId
+            },
+            {
+              type: "PLAINTEXT",
+              name: "LOGICAL_RESOURCE_ID",
+              value: event.LogicalResourceId
+            },
+            {
+              type: "PLAINTEXT",
+              name: "RESPONSE_URL",
+              value: event.ResponseURL
+            }
+          ]
+        }).promise();
+        break;
+      case "Delete":
+        const images = await ecr.listImages({ repositoryName: repoName, maxResults: 100 }).promise();
+        if (images.imageIds && images.imageIds.length > 0) {
+          await ecr.batchDeleteImage({
+            imageIds: images.imageIds.map((i) => {
+              return { imageDigest: i.imageDigest };
+            }),
+            repositoryName: repoName
+          }).promise();
+        }
+        await respond("SUCCESS", "OK", event.PhysicalResourceId, {});
+        break;
+    }
+  } catch (e) {
+    console.log(e);
+    await respond("FAILED", e.message || "Internal Error", context.logStreamName, {});
+  }
+  function respond(responseStatus, reason, physicalResourceId, data) {
+    const responseBody = JSON.stringify({
+      Status: responseStatus,
+      Reason: reason,
+      PhysicalResourceId: physicalResourceId,
+      StackId: event.StackId,
+      RequestId: event.RequestId,
+      LogicalResourceId: event.LogicalResourceId,
+      NoEcho: false,
+      Data: data
+    });
+    console.log("Responding", responseBody);
+    const parsedUrl = require("url").parse(event.ResponseURL);
+    const requestOptions = {
+      hostname: parsedUrl.hostname,
+      path: parsedUrl.path,
+      method: "PUT",
+      headers: {
+        "content-type": "",
+        "content-length": responseBody.length
+      }
+    };
+    return new Promise((resolve, reject) => {
+      try {
+        const request = require("https").request(requestOptions, resolve);
+        request.on("error", reject);
+        request.write(responseBody);
+        request.end();
+      } catch (e) {
+        reject(e);
+      }
+    });
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  handler
+});