@cloudsnorkel/cdk-github-runners 0.10.8 → 0.11.1

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 (35) hide show
  1. package/.jsii +337 -26
  2. package/API.md +16 -2
  3. package/README.md +10 -0
  4. package/assets/delete-failed-runner.lambda/index.js +472 -5527
  5. package/assets/idle-runner-repear.lambda/index.js +472 -5527
  6. package/assets/setup.lambda/index.js +1 -0
  7. package/assets/status.lambda/index.js +478 -5527
  8. package/assets/token-retriever.lambda/index.js +472 -5527
  9. package/assets/webhook-handler.lambda/index.js +17590 -17
  10. package/lib/access.js +1 -1
  11. package/lib/image-builders/api.js +1 -1
  12. package/lib/image-builders/aws-image-builder/builder.js +1 -1
  13. package/lib/image-builders/aws-image-builder/deprecated/ami.js +1 -1
  14. package/lib/image-builders/aws-image-builder/deprecated/container.js +1 -1
  15. package/lib/image-builders/aws-image-builder/deprecated/linux-components.js +1 -1
  16. package/lib/image-builders/aws-image-builder/deprecated/windows-components.js +1 -1
  17. package/lib/image-builders/codebuild-deprecated.js +1 -1
  18. package/lib/image-builders/components.js +1 -1
  19. package/lib/image-builders/static.js +1 -1
  20. package/lib/providers/codebuild.js +2 -2
  21. package/lib/providers/common.js +3 -3
  22. package/lib/providers/ec2.js +4 -4
  23. package/lib/providers/ecs.d.ts +1 -1
  24. package/lib/providers/ecs.js +11 -6
  25. package/lib/providers/fargate.js +2 -2
  26. package/lib/providers/lambda.d.ts +1 -1
  27. package/lib/providers/lambda.js +10 -6
  28. package/lib/runner.d.ts +9 -0
  29. package/lib/runner.js +73 -3
  30. package/lib/secrets.js +1 -1
  31. package/lib/status.lambda.js +7 -1
  32. package/lib/webhook-handler.lambda.js +44 -8
  33. package/lib/webhook.d.ts +14 -1
  34. package/lib/webhook.js +7 -2
  35. package/package.json +11 -11
package/.jsii CHANGED
@@ -7,10 +7,88 @@
7
7
  ]
8
8
  },
9
9
  "dependencies": {
10
- "aws-cdk-lib": "^2.50.0",
10
+ "aws-cdk-lib": "^2.77.0",
11
11
  "constructs": "^10.0.5"
12
12
  },
13
13
  "dependencyClosure": {
14
+ "@aws-cdk/asset-awscli-v1": {
15
+ "targets": {
16
+ "dotnet": {
17
+ "namespace": "Amazon.CDK.Asset.AwsCliV1",
18
+ "packageId": "Amazon.CDK.Asset.AwsCliV1"
19
+ },
20
+ "go": {
21
+ "moduleName": "github.com/cdklabs/awscdk-asset-awscli-go",
22
+ "packageName": "awscliv1"
23
+ },
24
+ "java": {
25
+ "maven": {
26
+ "artifactId": "cdk-asset-awscli-v1",
27
+ "groupId": "software.amazon.awscdk"
28
+ },
29
+ "package": "software.amazon.awscdk.cdk.asset.awscli.v1"
30
+ },
31
+ "js": {
32
+ "npm": "@aws-cdk/asset-awscli-v1"
33
+ },
34
+ "python": {
35
+ "distName": "aws-cdk.asset-awscli-v1",
36
+ "module": "aws_cdk.asset_awscli_v1"
37
+ }
38
+ }
39
+ },
40
+ "@aws-cdk/asset-kubectl-v20": {
41
+ "targets": {
42
+ "dotnet": {
43
+ "namespace": "Amazon.CDK.Asset.KubectlV20",
44
+ "packageId": "Amazon.CDK.Asset.KubectlV20"
45
+ },
46
+ "go": {
47
+ "moduleName": "github.com/cdklabs/awscdk-asset-kubectl-go",
48
+ "packageName": "kubectlv20"
49
+ },
50
+ "java": {
51
+ "maven": {
52
+ "artifactId": "cdk-asset-kubectl-v20",
53
+ "groupId": "software.amazon.awscdk"
54
+ },
55
+ "package": "software.amazon.awscdk.cdk.asset.kubectl.v20"
56
+ },
57
+ "js": {
58
+ "npm": "@aws-cdk/asset-kubectl-v20"
59
+ },
60
+ "python": {
61
+ "distName": "aws-cdk.asset-kubectl-v20",
62
+ "module": "aws_cdk.asset_kubectl_v20"
63
+ }
64
+ }
65
+ },
66
+ "@aws-cdk/asset-node-proxy-agent-v5": {
67
+ "targets": {
68
+ "dotnet": {
69
+ "namespace": "Amazon.CDK.Asset.NodeProxyAgentV5",
70
+ "packageId": "Amazon.CDK.Asset.NodeProxyAgentV5"
71
+ },
72
+ "go": {
73
+ "moduleName": "github.com/cdklabs/awscdk-asset-node-proxy-agent-go",
74
+ "packageName": "nodeproxyagentv5"
75
+ },
76
+ "java": {
77
+ "maven": {
78
+ "artifactId": "cdk-asset-node-proxy-agent-v5",
79
+ "groupId": "software.amazon.awscdk"
80
+ },
81
+ "package": "software.amazon.awscdk.cdk.asset.node.proxy.agent.v5"
82
+ },
83
+ "js": {
84
+ "npm": "@aws-cdk/asset-node-proxy-agent-v5"
85
+ },
86
+ "python": {
87
+ "distName": "aws-cdk.asset-node-proxy-agent-v5",
88
+ "module": "aws_cdk.asset_node_proxy_agent_v5"
89
+ }
90
+ }
91
+ },
14
92
  "aws-cdk-lib": {
15
93
  "submodules": {
16
94
  "aws-cdk-lib.alexa_ask": {
@@ -703,6 +781,19 @@
703
781
  }
704
782
  }
705
783
  },
784
+ "aws-cdk-lib.aws_comprehend": {
785
+ "targets": {
786
+ "dotnet": {
787
+ "namespace": "Amazon.CDK.AWS.Comprehend"
788
+ },
789
+ "java": {
790
+ "package": "software.amazon.awscdk.services.comprehend"
791
+ },
792
+ "python": {
793
+ "module": "aws_cdk.aws_comprehend"
794
+ }
795
+ }
796
+ },
706
797
  "aws-cdk-lib.aws_config": {
707
798
  "targets": {
708
799
  "dotnet": {
@@ -846,6 +937,19 @@
846
937
  }
847
938
  }
848
939
  },
940
+ "aws-cdk-lib.aws_devicefarm": {
941
+ "targets": {
942
+ "dotnet": {
943
+ "namespace": "Amazon.CDK.AWS.DeviceFarm"
944
+ },
945
+ "java": {
946
+ "package": "software.amazon.awscdk.services.devicefarm"
947
+ },
948
+ "python": {
949
+ "module": "aws_cdk.aws_devicefarm"
950
+ }
951
+ }
952
+ },
849
953
  "aws-cdk-lib.aws_devopsguru": {
850
954
  "targets": {
851
955
  "dotnet": {
@@ -911,6 +1015,19 @@
911
1015
  }
912
1016
  }
913
1017
  },
1018
+ "aws-cdk-lib.aws_docdbelastic": {
1019
+ "targets": {
1020
+ "dotnet": {
1021
+ "namespace": "Amazon.CDK.AWS.DocDBElastic"
1022
+ },
1023
+ "java": {
1024
+ "package": "software.amazon.awscdk.services.docdbelastic"
1025
+ },
1026
+ "python": {
1027
+ "module": "aws_cdk.aws_docdbelastic"
1028
+ }
1029
+ }
1030
+ },
914
1031
  "aws-cdk-lib.aws_dynamodb": {
915
1032
  "targets": {
916
1033
  "dotnet": {
@@ -1327,6 +1444,19 @@
1327
1444
  }
1328
1445
  }
1329
1446
  },
1447
+ "aws-cdk-lib.aws_grafana": {
1448
+ "targets": {
1449
+ "dotnet": {
1450
+ "namespace": "Amazon.CDK.AWS.Grafana"
1451
+ },
1452
+ "java": {
1453
+ "package": "software.amazon.awscdk.services.grafana"
1454
+ },
1455
+ "python": {
1456
+ "module": "aws_cdk.aws_grafana"
1457
+ }
1458
+ }
1459
+ },
1330
1460
  "aws-cdk-lib.aws_greengrass": {
1331
1461
  "targets": {
1332
1462
  "dotnet": {
@@ -1457,6 +1587,19 @@
1457
1587
  }
1458
1588
  }
1459
1589
  },
1590
+ "aws-cdk-lib.aws_internetmonitor": {
1591
+ "targets": {
1592
+ "dotnet": {
1593
+ "namespace": "Amazon.CDK.AWS.InternetMonitor"
1594
+ },
1595
+ "java": {
1596
+ "package": "software.amazon.awscdk.services.internetmonitor"
1597
+ },
1598
+ "python": {
1599
+ "module": "aws_cdk.aws_internetmonitor"
1600
+ }
1601
+ }
1602
+ },
1460
1603
  "aws-cdk-lib.aws_iot": {
1461
1604
  "targets": {
1462
1605
  "dotnet": {
@@ -1613,6 +1756,19 @@
1613
1756
  }
1614
1757
  }
1615
1758
  },
1759
+ "aws-cdk-lib.aws_ivschat": {
1760
+ "targets": {
1761
+ "dotnet": {
1762
+ "namespace": "Amazon.CDK.AWS.IVSChat"
1763
+ },
1764
+ "java": {
1765
+ "package": "software.amazon.awscdk.services.ivschat"
1766
+ },
1767
+ "python": {
1768
+ "module": "aws_cdk.aws_ivschat"
1769
+ }
1770
+ }
1771
+ },
1616
1772
  "aws-cdk-lib.aws_kafkaconnect": {
1617
1773
  "targets": {
1618
1774
  "dotnet": {
@@ -1639,6 +1795,19 @@
1639
1795
  }
1640
1796
  }
1641
1797
  },
1798
+ "aws-cdk-lib.aws_kendraranking": {
1799
+ "targets": {
1800
+ "dotnet": {
1801
+ "namespace": "Amazon.CDK.AWS.KendraRanking"
1802
+ },
1803
+ "java": {
1804
+ "package": "software.amazon.awscdk.services.kendraranking"
1805
+ },
1806
+ "python": {
1807
+ "module": "aws_cdk.aws_kendraranking"
1808
+ }
1809
+ }
1810
+ },
1642
1811
  "aws-cdk-lib.aws_kinesis": {
1643
1812
  "targets": {
1644
1813
  "dotnet": {
@@ -2107,6 +2276,45 @@
2107
2276
  }
2108
2277
  }
2109
2278
  },
2279
+ "aws-cdk-lib.aws_oam": {
2280
+ "targets": {
2281
+ "dotnet": {
2282
+ "namespace": "Amazon.CDK.AWS.Oam"
2283
+ },
2284
+ "java": {
2285
+ "package": "software.amazon.awscdk.services.oam"
2286
+ },
2287
+ "python": {
2288
+ "module": "aws_cdk.aws_oam"
2289
+ }
2290
+ }
2291
+ },
2292
+ "aws-cdk-lib.aws_omics": {
2293
+ "targets": {
2294
+ "dotnet": {
2295
+ "namespace": "Amazon.CDK.AWS.Omics"
2296
+ },
2297
+ "java": {
2298
+ "package": "software.amazon.awscdk.services.omics"
2299
+ },
2300
+ "python": {
2301
+ "module": "aws_cdk.aws_omics"
2302
+ }
2303
+ }
2304
+ },
2305
+ "aws-cdk-lib.aws_opensearchserverless": {
2306
+ "targets": {
2307
+ "dotnet": {
2308
+ "namespace": "Amazon.CDK.AWS.OpenSearchServerless"
2309
+ },
2310
+ "java": {
2311
+ "package": "software.amazon.awscdk.services.opensearchserverless"
2312
+ },
2313
+ "python": {
2314
+ "module": "aws_cdk.aws_opensearchserverless"
2315
+ }
2316
+ }
2317
+ },
2110
2318
  "aws-cdk-lib.aws_opensearchservice": {
2111
2319
  "targets": {
2112
2320
  "dotnet": {
@@ -2146,6 +2354,19 @@
2146
2354
  }
2147
2355
  }
2148
2356
  },
2357
+ "aws-cdk-lib.aws_organizations": {
2358
+ "targets": {
2359
+ "dotnet": {
2360
+ "namespace": "Amazon.CDK.AWS.Organizations"
2361
+ },
2362
+ "java": {
2363
+ "package": "software.amazon.awscdk.services.organizations"
2364
+ },
2365
+ "python": {
2366
+ "module": "aws_cdk.aws_organizations"
2367
+ }
2368
+ }
2369
+ },
2149
2370
  "aws-cdk-lib.aws_panorama": {
2150
2371
  "targets": {
2151
2372
  "dotnet": {
@@ -2198,6 +2419,19 @@
2198
2419
  }
2199
2420
  }
2200
2421
  },
2422
+ "aws-cdk-lib.aws_pipes": {
2423
+ "targets": {
2424
+ "dotnet": {
2425
+ "namespace": "Amazon.CDK.AWS.Pipes"
2426
+ },
2427
+ "java": {
2428
+ "package": "software.amazon.awscdk.services.pipes"
2429
+ },
2430
+ "python": {
2431
+ "module": "aws_cdk.aws_pipes"
2432
+ }
2433
+ }
2434
+ },
2201
2435
  "aws-cdk-lib.aws_qldb": {
2202
2436
  "targets": {
2203
2437
  "dotnet": {
@@ -2315,6 +2549,19 @@
2315
2549
  }
2316
2550
  }
2317
2551
  },
2552
+ "aws-cdk-lib.aws_resourceexplorer2": {
2553
+ "targets": {
2554
+ "dotnet": {
2555
+ "namespace": "Amazon.CDK.AWS.ResourceExplorer2"
2556
+ },
2557
+ "java": {
2558
+ "package": "software.amazon.awscdk.services.resourceexplorer2"
2559
+ },
2560
+ "python": {
2561
+ "module": "aws_cdk.aws_resourceexplorer2"
2562
+ }
2563
+ }
2564
+ },
2318
2565
  "aws-cdk-lib.aws_resourcegroups": {
2319
2566
  "targets": {
2320
2567
  "dotnet": {
@@ -2549,6 +2796,19 @@
2549
2796
  }
2550
2797
  }
2551
2798
  },
2799
+ "aws-cdk-lib.aws_scheduler": {
2800
+ "targets": {
2801
+ "dotnet": {
2802
+ "namespace": "Amazon.CDK.AWS.Scheduler"
2803
+ },
2804
+ "java": {
2805
+ "package": "software.amazon.awscdk.services.scheduler"
2806
+ },
2807
+ "python": {
2808
+ "module": "aws_cdk.aws_scheduler"
2809
+ }
2810
+ }
2811
+ },
2552
2812
  "aws-cdk-lib.aws_sdb": {
2553
2813
  "targets": {
2554
2814
  "dotnet": {
@@ -2666,6 +2926,19 @@
2666
2926
  }
2667
2927
  }
2668
2928
  },
2929
+ "aws-cdk-lib.aws_simspaceweaver": {
2930
+ "targets": {
2931
+ "dotnet": {
2932
+ "namespace": "Amazon.CDK.AWS.SimSpaceWeaver"
2933
+ },
2934
+ "java": {
2935
+ "package": "software.amazon.awscdk.services.simspaceweaver"
2936
+ },
2937
+ "python": {
2938
+ "module": "aws_cdk.aws_simspaceweaver"
2939
+ }
2940
+ }
2941
+ },
2669
2942
  "aws-cdk-lib.aws_sns": {
2670
2943
  "targets": {
2671
2944
  "dotnet": {
@@ -2809,6 +3082,19 @@
2809
3082
  }
2810
3083
  }
2811
3084
  },
3085
+ "aws-cdk-lib.aws_systemsmanagersap": {
3086
+ "targets": {
3087
+ "dotnet": {
3088
+ "namespace": "Amazon.CDK.AWS.SystemsManagerSAP"
3089
+ },
3090
+ "java": {
3091
+ "package": "software.amazon.awscdk.services.systemsmanagersap"
3092
+ },
3093
+ "python": {
3094
+ "module": "aws_cdk.aws_systemsmanagersap"
3095
+ }
3096
+ }
3097
+ },
2812
3098
  "aws-cdk-lib.aws_timestream": {
2813
3099
  "targets": {
2814
3100
  "dotnet": {
@@ -2848,6 +3134,19 @@
2848
3134
  }
2849
3135
  }
2850
3136
  },
3137
+ "aws-cdk-lib.aws_vpclattice": {
3138
+ "targets": {
3139
+ "dotnet": {
3140
+ "namespace": "Amazon.CDK.AWS.VpcLattice"
3141
+ },
3142
+ "java": {
3143
+ "package": "software.amazon.awscdk.services.vpclattice"
3144
+ },
3145
+ "python": {
3146
+ "module": "aws_cdk.aws_vpclattice"
3147
+ }
3148
+ }
3149
+ },
2851
3150
  "aws-cdk-lib.aws_waf": {
2852
3151
  "targets": {
2853
3152
  "dotnet": {
@@ -3138,7 +3437,7 @@
3138
3437
  },
3139
3438
  "name": "@cloudsnorkel/cdk-github-runners",
3140
3439
  "readme": {
3141
- "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 imageBuilder: 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 imageBuilder: 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-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"
3440
+ "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 imageBuilder: 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 imageBuilder: 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\nAll logs are saved in CloudWatch.\n* Log group names can be found in `status.json` for each provider, image builder, and other parts of the system\n* Some useful Logs Insights queries can be enabled with `GitHubRunners.createLogsInsightsQueries()`\n\nTo get `status.json`, check out the CloudFormation stack output for a command that generates it. The command looks like:\n\n```\naws --region us-east-1 lambda invoke --function-name status-XYZ123 status.json\n```\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-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"
3142
3441
  },
3143
3442
  "repository": {
3144
3443
  "type": "git",
@@ -6732,7 +7031,7 @@
6732
7031
  },
6733
7032
  "locationInModule": {
6734
7033
  "filename": "src/providers/ecs.ts",
6735
- "line": 518
7034
+ "line": 526
6736
7035
  },
6737
7036
  "name": "getStepFunctionTask",
6738
7037
  "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6761,7 +7060,7 @@
6761
7060
  },
6762
7061
  "locationInModule": {
6763
7062
  "filename": "src/providers/ecs.ts",
6764
- "line": 566
7063
+ "line": 574
6765
7064
  },
6766
7065
  "name": "grantStateMachine",
6767
7066
  "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -6830,7 +7129,7 @@
6830
7129
  },
6831
7130
  "locationInModule": {
6832
7131
  "filename": "src/providers/ecs.ts",
6833
- "line": 569
7132
+ "line": 577
6834
7133
  },
6835
7134
  "name": "status",
6836
7135
  "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -8128,6 +8427,18 @@
8128
8427
  "line": 234
8129
8428
  },
8130
8429
  "methods": [
8430
+ {
8431
+ "docs": {
8432
+ "remarks": "* \"Webhook errors\" helps diagnose configuration issues with GitHub integration\n* \"Ignored webhook\" helps understand why runners aren't started\n* \"Ignored jobs based on labels\" helps debug label matching issues\n* \"Webhook started runners\" helps understand which runners were started",
8433
+ "stability": "experimental",
8434
+ "summary": "Creates CloudWatch Logs Insights saved queries that can be used to debug issues with the runners."
8435
+ },
8436
+ "locationInModule": {
8437
+ "filename": "src/runner.ts",
8438
+ "line": 766
8439
+ },
8440
+ "name": "createLogsInsightsQueries"
8441
+ },
8131
8442
  {
8132
8443
  "docs": {
8133
8444
  "remarks": "Runner images are rebuilt every week by default. This provides the latest GitHub Runner version and software updates.\n\nIf you want to be sure you are using the latest runner version, you can use this topic to be notified when a build fails.",
@@ -8136,7 +8447,7 @@
8136
8447
  },
8137
8448
  "locationInModule": {
8138
8449
  "filename": "src/runner.ts",
8139
- "line": 742
8450
+ "line": 746
8140
8451
  },
8141
8452
  "name": "failedImageBuildsTopic",
8142
8453
  "returns": {
@@ -8153,7 +8464,7 @@
8153
8464
  },
8154
8465
  "locationInModule": {
8155
8466
  "filename": "src/runner.ts",
8156
- "line": 724
8467
+ "line": 728
8157
8468
  },
8158
8469
  "name": "metricFailed",
8159
8470
  "parameters": [
@@ -8179,7 +8490,7 @@
8179
8490
  },
8180
8491
  "locationInModule": {
8181
8492
  "filename": "src/runner.ts",
8182
- "line": 669
8493
+ "line": 673
8183
8494
  },
8184
8495
  "name": "metricJobCompleted",
8185
8496
  "parameters": [
@@ -8205,7 +8516,7 @@
8205
8516
  },
8206
8517
  "locationInModule": {
8207
8518
  "filename": "src/runner.ts",
8208
- "line": 715
8519
+ "line": 719
8209
8520
  },
8210
8521
  "name": "metricSucceeded",
8211
8522
  "parameters": [
@@ -8231,7 +8542,7 @@
8231
8542
  },
8232
8543
  "locationInModule": {
8233
8544
  "filename": "src/runner.ts",
8234
- "line": 731
8545
+ "line": 735
8235
8546
  },
8236
8547
  "name": "metricTime",
8237
8548
  "parameters": [
@@ -9607,7 +9918,7 @@
9607
9918
  },
9608
9919
  "locationInModule": {
9609
9920
  "filename": "src/providers/lambda.ts",
9610
- "line": 224
9921
+ "line": 229
9611
9922
  },
9612
9923
  "parameters": [
9613
9924
  {
@@ -9634,7 +9945,7 @@
9634
9945
  "kind": "class",
9635
9946
  "locationInModule": {
9636
9947
  "filename": "src/providers/lambda.ts",
9637
- "line": 456
9948
+ "line": 461
9638
9949
  },
9639
9950
  "name": "LambdaRunner",
9640
9951
  "symbolId": "src/providers/lambda:LambdaRunner"
@@ -9654,7 +9965,7 @@
9654
9965
  },
9655
9966
  "locationInModule": {
9656
9967
  "filename": "src/providers/lambda.ts",
9657
- "line": 224
9968
+ "line": 229
9658
9969
  },
9659
9970
  "parameters": [
9660
9971
  {
@@ -9689,7 +10000,7 @@
9689
10000
  "methods": [
9690
10001
  {
9691
10002
  "docs": {
9692
- "remarks": "Included components:\n * `RunnerImageComponent.requiredPackages()`\n * `RunnerImageComponent.runnerUser()`\n * `RunnerImageComponent.git()`\n * `RunnerImageComponent.githubCli()`\n * `RunnerImageComponent.awsCli()`\n * `RunnerImageComponent.githubRunner()`\n * `RunnerImageComponent.lambdaEntrypoint()`\n\n Base Docker image: `public.ecr.aws/lambda/nodejs:14-x86_64` or `public.ecr.aws/lambda/nodejs:14-arm64`",
10003
+ "remarks": "Included components:\n * `RunnerImageComponent.requiredPackages()`\n * `RunnerImageComponent.runnerUser()`\n * `RunnerImageComponent.git()`\n * `RunnerImageComponent.githubCli()`\n * `RunnerImageComponent.awsCli()`\n * `RunnerImageComponent.githubRunner()`\n * `RunnerImageComponent.lambdaEntrypoint()`\n\n Base Docker image: `public.ecr.aws/lambda/nodejs:16-x86_64` or `public.ecr.aws/lambda/nodejs:16-arm64`",
9693
10004
  "stability": "experimental",
9694
10005
  "summary": "Create new image builder that builds Lambda specific runner images using Amazon Linux 2."
9695
10006
  },
@@ -9734,7 +10045,7 @@
9734
10045
  },
9735
10046
  "locationInModule": {
9736
10047
  "filename": "src/providers/lambda.ts",
9737
- "line": 312
10048
+ "line": 317
9738
10049
  },
9739
10050
  "name": "getStepFunctionTask",
9740
10051
  "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -9763,7 +10074,7 @@
9763
10074
  },
9764
10075
  "locationInModule": {
9765
10076
  "filename": "src/providers/lambda.ts",
9766
- "line": 373
10077
+ "line": 378
9767
10078
  },
9768
10079
  "name": "grantStateMachine",
9769
10080
  "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -9832,7 +10143,7 @@
9832
10143
  },
9833
10144
  "locationInModule": {
9834
10145
  "filename": "src/providers/lambda.ts",
9835
- "line": 376
10146
+ "line": 381
9836
10147
  },
9837
10148
  "name": "status",
9838
10149
  "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -9899,7 +10210,7 @@
9899
10210
  "immutable": true,
9900
10211
  "locationInModule": {
9901
10212
  "filename": "src/providers/lambda.ts",
9902
- "line": 301
10213
+ "line": 306
9903
10214
  },
9904
10215
  "name": "connections",
9905
10216
  "overrides": "aws-cdk-lib.aws_ec2.IConnectable",
@@ -9915,7 +10226,7 @@
9915
10226
  "immutable": true,
9916
10227
  "locationInModule": {
9917
10228
  "filename": "src/providers/lambda.ts",
9918
- "line": 189
10229
+ "line": 194
9919
10230
  },
9920
10231
  "name": "function",
9921
10232
  "type": {
@@ -9930,7 +10241,7 @@
9930
10241
  "immutable": true,
9931
10242
  "locationInModule": {
9932
10243
  "filename": "src/providers/lambda.ts",
9933
- "line": 199
10244
+ "line": 204
9934
10245
  },
9935
10246
  "name": "grantPrincipal",
9936
10247
  "overrides": "aws-cdk-lib.aws_iam.IGrantable",
@@ -9947,7 +10258,7 @@
9947
10258
  "immutable": true,
9948
10259
  "locationInModule": {
9949
10260
  "filename": "src/providers/lambda.ts",
9950
- "line": 204
10261
+ "line": 209
9951
10262
  },
9952
10263
  "name": "image",
9953
10264
  "type": {
@@ -9962,7 +10273,7 @@
9962
10273
  "immutable": true,
9963
10274
  "locationInModule": {
9964
10275
  "filename": "src/providers/lambda.ts",
9965
- "line": 194
10276
+ "line": 199
9966
10277
  },
9967
10278
  "name": "labels",
9968
10279
  "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -9984,7 +10295,7 @@
9984
10295
  "immutable": true,
9985
10296
  "locationInModule": {
9986
10297
  "filename": "src/providers/lambda.ts",
9987
- "line": 211
10298
+ "line": 216
9988
10299
  },
9989
10300
  "name": "logGroup",
9990
10301
  "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -10000,7 +10311,7 @@
10000
10311
  "immutable": true,
10001
10312
  "locationInModule": {
10002
10313
  "filename": "src/providers/lambda.ts",
10003
- "line": 213
10314
+ "line": 218
10004
10315
  },
10005
10316
  "name": "retryableErrors",
10006
10317
  "overrides": "@cloudsnorkel/cdk-github-runners.IRunnerProvider",
@@ -13013,6 +13324,6 @@
13013
13324
  "symbolId": "src/image-builders/aws-image-builder/deprecated/windows-components:WindowsComponents"
13014
13325
  }
13015
13326
  },
13016
- "version": "0.10.8",
13017
- "fingerprint": "SoYttWw0/tJxiKE+DkHUA119xVuOUNQWSxOSmV5lGoc="
13327
+ "version": "0.11.1",
13328
+ "fingerprint": "mTC5uTa9W4WUsRC7U4/9pMkGsZF1IjnX7GFhUnpMLgM="
13018
13329
  }