@cloudsnorkel/cdk-github-runners 0.3.2 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/.gitattributes +1 -0
  2. package/.jsii +1418 -418
  3. package/API.md +1074 -101
  4. package/README.md +12 -10
  5. package/lib/index.d.ts +2 -1
  6. package/lib/index.js +4 -1
  7. package/lib/lambdas/aws-image-builder-versioner/index.js +2469 -0
  8. package/lib/lambdas/build-image/index.js +77 -43
  9. package/lib/lambdas/delete-runner/index.js +70 -42
  10. package/lib/lambdas/setup/index.html +9 -9
  11. package/lib/lambdas/setup/index.js +27 -12
  12. package/lib/lambdas/status/index.js +103 -45
  13. package/lib/lambdas/token-retriever/index.js +70 -42
  14. package/lib/lambdas/update-lambda/index.js +5 -2
  15. package/lib/lambdas/webhook-handler/index.js +11 -5
  16. package/lib/providers/codebuild.d.ts +5 -1
  17. package/lib/providers/codebuild.js +16 -6
  18. package/lib/providers/common.d.ts +28 -1
  19. package/lib/providers/common.js +4 -4
  20. package/lib/providers/fargate.d.ts +5 -1
  21. package/lib/providers/fargate.js +3 -3
  22. package/lib/providers/image-builders/codebuild.d.ts +2 -2
  23. package/lib/providers/image-builders/codebuild.js +5 -4
  24. package/lib/providers/image-builders/container.d.ts +220 -0
  25. package/lib/providers/image-builders/container.js +508 -0
  26. package/lib/providers/image-builders/static.js +2 -3
  27. package/lib/providers/lambda.d.ts +5 -1
  28. package/lib/providers/lambda.js +19 -8
  29. package/lib/runner.js +29 -13
  30. package/lib/secrets.js +1 -1
  31. package/package.json +14 -12
package/README.md CHANGED
@@ -14,6 +14,7 @@ Use this CDK construct to create ephemeral [self-hosted GitHub runners][1] on-de
14
14
  * Customizable runners with decent defaults
15
15
  * Multiple runner configurations controlled by labels
16
16
  * Everything fully hosted in your account
17
+ * Automatically updated build environment with latest runner version
17
18
 
18
19
  Self-hosted runners in AWS are useful when:
19
20
 
@@ -31,16 +32,17 @@ The best way to browse API documentation is on [Constructs Hub][13]. It is avail
31
32
 
32
33
  A runner provider creates compute resources on-demand and uses [actions/runner][5] to start a runner.
33
34
 
34
- | | CodeBuild | Fargate | Lambda |
35
- |------------------|--------------------------|----------------|----------------|
36
- | **Time limit** | 8 hours | Unlimited | 15 minutes |
37
- | **vCPUs** | 2, 4, 8, or 72 | 0.25 to 4 | 1 to 6 |
38
- | **RAM** | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb | 128mb to 10gb |
39
- | **Storage** | 50gb to 824gb | 20gb to 200gb | Up to 10gb |
40
- | **Architecture** | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 |
41
- | **sudo** | ✔ | ✔ | ❌ |
42
- | **Docker** | ✔ | ❌ | ❌ |
43
- | **Spot pricing** | ❌ | ✔ | ❌ |
35
+ | | CodeBuild | Fargate | Lambda |
36
+ |------------------|----------------------------|---------------|---------------|
37
+ | **Time limit** | 8 hours | Unlimited | 15 minutes |
38
+ | **vCPUs** | 2, 4, 8, or 72 | 0.25 to 4 | 1 to 6 |
39
+ | **RAM** | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb | 128mb to 10gb |
40
+ | **Storage** | 50gb to 824gb | 20gb to 200gb | Up to 10gb |
41
+ | **Architecture** | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 |
42
+ | **sudo** | ✔ | ✔ | ❌ |
43
+ | **Docker** | ✔ (Linux only) | ❌ | ❌ |
44
+ | **Spot pricing** | ❌ | ✔ | ❌ |
45
+ | **OS** | Linux, Windows | Linux | Linux |
44
46
 
45
47
  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.
46
48
 
package/lib/index.d.ts CHANGED
@@ -3,6 +3,7 @@ export { GitHubRunners, GitHubRunnersProps } from './runner';
3
3
  export { CodeBuildRunner, CodeBuildRunnerProps } from './providers/codebuild';
4
4
  export { LambdaRunner, LambdaRunnerProps } from './providers/lambda';
5
5
  export { FargateRunner, FargateRunnerProps } from './providers/fargate';
6
- export { IRunnerProvider, RunnerProviderProps, RunnerVersion, RunnerRuntimeParameters, RunnerImage, IImageBuilder, Architecture, Os } from './providers/common';
6
+ export { IRunnerProvider, RunnerProviderProps, RunnerVersion, RunnerRuntimeParameters, RunnerImage, IImageBuilder, IRunnerImageStatus, Architecture, Os } from './providers/common';
7
7
  export { CodeBuildImageBuilder, CodeBuildImageBuilderProps } from './providers/image-builders/codebuild';
8
+ export { ContainerImageBuilder, ContainerImageBuilderProps, ImageBuilderComponent, ImageBuilderComponentProperties, ImageBuilderAsset } from './providers/image-builders/container';
8
9
  export { StaticRunnerImage } from './providers/image-builders/static';
package/lib/index.js CHANGED
@@ -16,6 +16,9 @@ Object.defineProperty(exports, "Architecture", { enumerable: true, get: function
16
16
  Object.defineProperty(exports, "Os", { enumerable: true, get: function () { return common_1.Os; } });
17
17
  var codebuild_2 = require("./providers/image-builders/codebuild");
18
18
  Object.defineProperty(exports, "CodeBuildImageBuilder", { enumerable: true, get: function () { return codebuild_2.CodeBuildImageBuilder; } });
19
+ var container_1 = require("./providers/image-builders/container");
20
+ Object.defineProperty(exports, "ContainerImageBuilder", { enumerable: true, get: function () { return container_1.ContainerImageBuilder; } });
21
+ Object.defineProperty(exports, "ImageBuilderComponent", { enumerable: true, get: function () { return container_1.ImageBuilderComponent; } });
19
22
  var static_1 = require("./providers/image-builders/static");
20
23
  Object.defineProperty(exports, "StaticRunnerImage", { enumerable: true, get: function () { return static_1.StaticRunnerImage; } });
21
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxxQ0FBb0M7QUFBM0Isa0dBQUEsT0FBTyxPQUFBO0FBQ2hCLG1DQUE2RDtBQUFwRCx1R0FBQSxhQUFhLE9BQUE7QUFDdEIsbURBQThFO0FBQXJFLDRHQUFBLGVBQWUsT0FBQTtBQUN4Qiw2Q0FBcUU7QUFBNUQsc0dBQUEsWUFBWSxPQUFBO0FBQ3JCLCtDQUF3RTtBQUEvRCx3R0FBQSxhQUFhLE9BQUE7QUFDdEIsNkNBQWdLO0FBQWpILHVHQUFBLGFBQWEsT0FBQTtBQUF1RCxzR0FBQSxZQUFZLE9BQUE7QUFBRSw0RkFBQSxFQUFFLE9BQUE7QUFDbkksa0VBQXlHO0FBQWhHLGtIQUFBLHFCQUFxQixPQUFBO0FBQzlCLDREQUFzRTtBQUE3RCwyR0FBQSxpQkFBaUIsT0FBQSIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB7IFNlY3JldHMgfSBmcm9tICcuL3NlY3JldHMnO1xuZXhwb3J0IHsgR2l0SHViUnVubmVycywgR2l0SHViUnVubmVyc1Byb3BzIH0gZnJvbSAnLi9ydW5uZXInO1xuZXhwb3J0IHsgQ29kZUJ1aWxkUnVubmVyLCBDb2RlQnVpbGRSdW5uZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2NvZGVidWlsZCc7XG5leHBvcnQgeyBMYW1iZGFSdW5uZXIsIExhbWJkYVJ1bm5lclByb3BzIH0gZnJvbSAnLi9wcm92aWRlcnMvbGFtYmRhJztcbmV4cG9ydCB7IEZhcmdhdGVSdW5uZXIsIEZhcmdhdGVSdW5uZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2ZhcmdhdGUnO1xuZXhwb3J0IHsgSVJ1bm5lclByb3ZpZGVyLCBSdW5uZXJQcm92aWRlclByb3BzLCBSdW5uZXJWZXJzaW9uLCBSdW5uZXJSdW50aW1lUGFyYW1ldGVycywgUnVubmVySW1hZ2UsIElJbWFnZUJ1aWxkZXIsIEFyY2hpdGVjdHVyZSwgT3MgfSBmcm9tICcuL3Byb3ZpZGVycy9jb21tb24nO1xuZXhwb3J0IHsgQ29kZUJ1aWxkSW1hZ2VCdWlsZGVyLCBDb2RlQnVpbGRJbWFnZUJ1aWxkZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2ltYWdlLWJ1aWxkZXJzL2NvZGVidWlsZCc7XG5leHBvcnQgeyBTdGF0aWNSdW5uZXJJbWFnZSB9IGZyb20gJy4vcHJvdmlkZXJzL2ltYWdlLWJ1aWxkZXJzL3N0YXRpYyc7XG4iXX0=
24
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxxQ0FBb0M7QUFBM0Isa0dBQUEsT0FBTyxPQUFBO0FBQ2hCLG1DQUE2RDtBQUFwRCx1R0FBQSxhQUFhLE9BQUE7QUFDdEIsbURBQThFO0FBQXJFLDRHQUFBLGVBQWUsT0FBQTtBQUN4Qiw2Q0FBcUU7QUFBNUQsc0dBQUEsWUFBWSxPQUFBO0FBQ3JCLCtDQUF3RTtBQUEvRCx3R0FBQSxhQUFhLE9BQUE7QUFDdEIsNkNBQW9MO0FBQXJJLHVHQUFBLGFBQWEsT0FBQTtBQUEyRSxzR0FBQSxZQUFZLE9BQUE7QUFBRSw0RkFBQSxFQUFFLE9BQUE7QUFDdkosa0VBQXlHO0FBQWhHLGtIQUFBLHFCQUFxQixPQUFBO0FBQzlCLGtFQUFvTDtBQUEzSyxrSEFBQSxxQkFBcUIsT0FBQTtBQUE4QixrSEFBQSxxQkFBcUIsT0FBQTtBQUNqRiw0REFBc0U7QUFBN0QsMkdBQUEsaUJBQWlCLE9BQUEiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgeyBTZWNyZXRzIH0gZnJvbSAnLi9zZWNyZXRzJztcbmV4cG9ydCB7IEdpdEh1YlJ1bm5lcnMsIEdpdEh1YlJ1bm5lcnNQcm9wcyB9IGZyb20gJy4vcnVubmVyJztcbmV4cG9ydCB7IENvZGVCdWlsZFJ1bm5lciwgQ29kZUJ1aWxkUnVubmVyUHJvcHMgfSBmcm9tICcuL3Byb3ZpZGVycy9jb2RlYnVpbGQnO1xuZXhwb3J0IHsgTGFtYmRhUnVubmVyLCBMYW1iZGFSdW5uZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2xhbWJkYSc7XG5leHBvcnQgeyBGYXJnYXRlUnVubmVyLCBGYXJnYXRlUnVubmVyUHJvcHMgfSBmcm9tICcuL3Byb3ZpZGVycy9mYXJnYXRlJztcbmV4cG9ydCB7IElSdW5uZXJQcm92aWRlciwgUnVubmVyUHJvdmlkZXJQcm9wcywgUnVubmVyVmVyc2lvbiwgUnVubmVyUnVudGltZVBhcmFtZXRlcnMsIFJ1bm5lckltYWdlLCBJSW1hZ2VCdWlsZGVyLCBJUnVubmVySW1hZ2VTdGF0dXMsIEFyY2hpdGVjdHVyZSwgT3MgfSBmcm9tICcuL3Byb3ZpZGVycy9jb21tb24nO1xuZXhwb3J0IHsgQ29kZUJ1aWxkSW1hZ2VCdWlsZGVyLCBDb2RlQnVpbGRJbWFnZUJ1aWxkZXJQcm9wcyB9IGZyb20gJy4vcHJvdmlkZXJzL2ltYWdlLWJ1aWxkZXJzL2NvZGVidWlsZCc7XG5leHBvcnQgeyBDb250YWluZXJJbWFnZUJ1aWxkZXIsIENvbnRhaW5lckltYWdlQnVpbGRlclByb3BzLCBJbWFnZUJ1aWxkZXJDb21wb25lbnQsIEltYWdlQnVpbGRlckNvbXBvbmVudFByb3BlcnRpZXMsIEltYWdlQnVpbGRlckFzc2V0IH0gZnJvbSAnLi9wcm92aWRlcnMvaW1hZ2UtYnVpbGRlcnMvY29udGFpbmVyJztcbmV4cG9ydCB7IFN0YXRpY1J1bm5lckltYWdlIH0gZnJvbSAnLi9wcm92aWRlcnMvaW1hZ2UtYnVpbGRlcnMvc3RhdGljJztcbiJdfQ==