cloudsnorkel.cdk-github-runners 1.0.0__tar.gz → 1.1.0__tar.gz

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 (17) hide show
  1. {cloudsnorkel_cdk_github_runners-1.0.0/src/cloudsnorkel.cdk_github_runners.egg-info → cloudsnorkel_cdk_github_runners-1.1.0}/PKG-INFO +31 -14
  2. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/README.md +29 -12
  3. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/setup.py +3 -3
  4. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/src/cloudsnorkel/cdk_github_runners/__init__.py +952 -65
  5. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/src/cloudsnorkel/cdk_github_runners/_jsii/__init__.py +2 -2
  6. cloudsnorkel_cdk_github_runners-1.1.0/src/cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@1.1.0.jsii.tgz +0 -0
  7. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0/src/cloudsnorkel.cdk_github_runners.egg-info}/PKG-INFO +31 -14
  8. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/src/cloudsnorkel.cdk_github_runners.egg-info/SOURCES.txt +1 -1
  9. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/src/cloudsnorkel.cdk_github_runners.egg-info/requires.txt +1 -1
  10. cloudsnorkel_cdk_github_runners-1.0.0/src/cloudsnorkel/cdk_github_runners/_jsii/cdk-github-runners@1.0.0.jsii.tgz +0 -0
  11. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/LICENSE +0 -0
  12. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/MANIFEST.in +0 -0
  13. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/pyproject.toml +0 -0
  14. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/setup.cfg +0 -0
  15. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/src/cloudsnorkel/cdk_github_runners/py.typed +0 -0
  16. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/src/cloudsnorkel.cdk_github_runners.egg-info/dependency_links.txt +0 -0
  17. {cloudsnorkel_cdk_github_runners-1.0.0 → cloudsnorkel_cdk_github_runners-1.1.0}/src/cloudsnorkel.cdk_github_runners.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: cloudsnorkel.cdk-github-runners
3
- Version: 1.0.0
3
+ Version: 1.1.0
4
4
  Summary: CDK construct to create GitHub Actions self-hosted runners. Creates ephemeral runners on demand. Easy to deploy and highly customizable.
5
5
  Home-page: https://github.com/CloudSnorkel/cdk-github-runners.git
6
6
  Author: Amir Szekely<amir@cloudsnorkel.com>
@@ -21,7 +21,7 @@ Classifier: License :: OSI Approved
21
21
  Requires-Python: >=3.10
22
22
  Description-Content-Type: text/markdown
23
23
  License-File: LICENSE
24
- Requires-Dist: aws-cdk-lib<3.0.0,>=2.239.0
24
+ Requires-Dist: aws-cdk-lib<3.0.0,>=2.261.0
25
25
  Requires-Dist: constructs<11.0.0,>=10.5.1
26
26
  Requires-Dist: jsii<2.0.0,>=1.142.0
27
27
  Requires-Dist: publication>=0.0.3
@@ -67,6 +67,7 @@ Ephemeral (or on-demand) runners are the [recommended way by GitHub](https://doc
67
67
  * [Composite Providers](#composite-providers)
68
68
  * [Custom Provider Selection](#custom-provider-selection)
69
69
  * [Warm Runners](#warm-runners)
70
+ * [Compliance](#compliance)
70
71
  * [Examples](#examples)
71
72
  * [Architecture](#architecture)
72
73
  * [Troubleshooting](#troubleshooting)
@@ -86,24 +87,25 @@ The best way to browse API documentation is on [Constructs Hub](https://construc
86
87
 
87
88
  A runner provider creates compute resources on-demand and uses [actions/runner](https://github.com/actions/runner) to start a runner.
88
89
 
89
- | | EC2 | CodeBuild | Fargate | ECS | Lambda |
90
- |------------------|-------------------|----------------------------|----------------|----------------|---------------|
91
- | **Time limit** | Unlimited | 36 hours (default 1 hour) | Unlimited | Unlimited | 15 minutes |
92
- | **vCPUs** | Unlimited | 2, 4, 8, or 72 | 0.25 to 4 | Unlimited | 1 to 6 |
93
- | **RAM** | Unlimited | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb | Unlimited | 128mb to 10gb |
94
- | **Storage** | Unlimited | 50gb to 824gb | 20gb to 200gb | Unlimited | Up to 10gb |
95
- | **Architecture** | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 |
96
- | **GPU** | ✔ | ✔ | ❌ | ✔ | ❌ |
97
- | **sudo** | ✔ | ✔ | ✔ | ✔ | ❌ |
98
- | **Docker** | ✔ | ✔ (Linux only) | ❌ | ✔ | ❌ |
99
- | **Spot pricing** | ✔ | ❌ | ✔ | ✔ | ❌ |
100
- | **OS** | Linux, Windows | Linux, Windows | Linux, Windows | Linux, Windows | Linux |
90
+ | | EC2 | CodeBuild | Fargate | ECS | Lambda | Lambda MicroVM |
91
+ |------------------|-------------------|----------------------------|----------------|----------------|---------------|----------------|
92
+ | **Time limit** | Unlimited | 36 hours (default 1 hour) | Unlimited | Unlimited | 15 minutes | 8 hours (default 1 hour) |
93
+ | **vCPUs** | Unlimited | 2, 4, 8, or 72 | 0.25 to 4 | Unlimited | 1 to 6 | 0.25 to 4 |
94
+ | **RAM** | Unlimited | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb | Unlimited | 128mb to 10gb | 512mb to 8gb |
95
+ | **Storage** | Unlimited | 50gb to 824gb | 20gb to 200gb | Unlimited | Up to 10gb | Up to 10gb |
96
+ | **Architecture** | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 |
97
+ | **GPU** | ✔ | ✔ | ❌ | ✔ | ❌ | ❌ |
98
+ | **sudo** | ✔ | ✔ | ✔ | ✔ | ❌ | ❌ |
99
+ | **Docker** | ✔ | ✔ (Linux only) | ❌ | ✔ | ❌ | ❌ |
100
+ | **Spot pricing** | ✔ | ❌ | ✔ | ✔ | ❌ | ❌ |
101
+ | **OS** | Linux, Windows | Linux, Windows | Linux, Windows | Linux, Windows | Linux | Linux |
101
102
 
102
103
  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.
103
104
 
104
105
  * EC2 is useful when you want runners to have complete access to the host
105
106
  * ECS is useful when you want to control the infrastructure, like leaving the runner host running for faster startups
106
107
  * Lambda is useful for short jobs that can work within time, size and readonly system constraints
108
+ * Lambda MicroVM is useful when you want Lambda pricing and start-up time, but a real kernel, a writable disk and more than 15 minutes
107
109
 
108
110
  ### Job Isolation
109
111
 
@@ -591,6 +593,20 @@ new ScheduledWarmRunner(this, 'work hours warm', {
591
593
 
592
594
  See the [warm-runners example](examples/typescript/warm-runners/) for a complete setup.
593
595
 
596
+ ### Compliance
597
+
598
+ Compliance frameworks like HIPAA, PCI DSS, and NIST 800-53 often ask for your own encryption keys and limited Lambda concurrency. `Compliance` applies those to everything this library creates in a scope, like a stack or a whole app. Settings of the closest scope win.
599
+
600
+ ```python
601
+ Compliance.of(this).encrypt({ key, logs: logsKey }); // logs get their own key, everything else uses `key`
602
+ Compliance.of(gpuProvider).encrypt({ storage: gpuKey }); // stricter key for one provider
603
+ Compliance.of(this).limitLambdaConcurrency({ maxJobStarts: 50 }); // jobs you expect to start at once
604
+ ```
605
+
606
+ Synth warns about runner resources that no scope covers, like image builders in another stack. The key needs to be in a stack that every other stack can use. Adding a key to an existing deployment rebuilds runner images.
607
+
608
+ See the [compliance example](examples/typescript/compliance/) for a complete setup.
609
+
594
610
  ## Examples
595
611
 
596
612
  We provide comprehensive examples in the [`examples/`](examples/) folder to help you get started quickly:
@@ -619,6 +635,7 @@ We provide comprehensive examples in the [`examples/`](examples/) folder to help
619
635
  * **[IAM Permissions](examples/typescript/iam-permissions/)** - Grant AWS IAM permissions to runners (also available in [Python](examples/python/iam-permissions/))
620
636
  * **[Network Access](examples/typescript/network-access/)** - Configure network access with VPCs and security groups (also available in [Python](examples/python/network-access/))
621
637
  * **[Access Control](examples/typescript/access-control/)** - Configure access control for webhook and setup functions (also available in [Python](examples/python/access-control/))
638
+ * **[Compliance](examples/typescript/compliance/)** - Encrypt with your own KMS keys, limit Lambda concurrency, and log API requests (also available in [Python](examples/python/compliance/))
622
639
 
623
640
  ### Customization
624
641
 
@@ -39,6 +39,7 @@ Ephemeral (or on-demand) runners are the [recommended way by GitHub](https://doc
39
39
  * [Composite Providers](#composite-providers)
40
40
  * [Custom Provider Selection](#custom-provider-selection)
41
41
  * [Warm Runners](#warm-runners)
42
+ * [Compliance](#compliance)
42
43
  * [Examples](#examples)
43
44
  * [Architecture](#architecture)
44
45
  * [Troubleshooting](#troubleshooting)
@@ -58,24 +59,25 @@ The best way to browse API documentation is on [Constructs Hub](https://construc
58
59
 
59
60
  A runner provider creates compute resources on-demand and uses [actions/runner](https://github.com/actions/runner) to start a runner.
60
61
 
61
- | | EC2 | CodeBuild | Fargate | ECS | Lambda |
62
- |------------------|-------------------|----------------------------|----------------|----------------|---------------|
63
- | **Time limit** | Unlimited | 36 hours (default 1 hour) | Unlimited | Unlimited | 15 minutes |
64
- | **vCPUs** | Unlimited | 2, 4, 8, or 72 | 0.25 to 4 | Unlimited | 1 to 6 |
65
- | **RAM** | Unlimited | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb | Unlimited | 128mb to 10gb |
66
- | **Storage** | Unlimited | 50gb to 824gb | 20gb to 200gb | Unlimited | Up to 10gb |
67
- | **Architecture** | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 |
68
- | **GPU** | ✔ | ✔ | ❌ | ✔ | ❌ |
69
- | **sudo** | ✔ | ✔ | ✔ | ✔ | ❌ |
70
- | **Docker** | ✔ | ✔ (Linux only) | ❌ | ✔ | ❌ |
71
- | **Spot pricing** | ✔ | ❌ | ✔ | ✔ | ❌ |
72
- | **OS** | Linux, Windows | Linux, Windows | Linux, Windows | Linux, Windows | Linux |
62
+ | | EC2 | CodeBuild | Fargate | ECS | Lambda | Lambda MicroVM |
63
+ |------------------|-------------------|----------------------------|----------------|----------------|---------------|----------------|
64
+ | **Time limit** | Unlimited | 36 hours (default 1 hour) | Unlimited | Unlimited | 15 minutes | 8 hours (default 1 hour) |
65
+ | **vCPUs** | Unlimited | 2, 4, 8, or 72 | 0.25 to 4 | Unlimited | 1 to 6 | 0.25 to 4 |
66
+ | **RAM** | Unlimited | 3gb, 7gb, 15gb, or 145gb | 512mb to 30gb | Unlimited | 128mb to 10gb | 512mb to 8gb |
67
+ | **Storage** | Unlimited | 50gb to 824gb | 20gb to 200gb | Unlimited | Up to 10gb | Up to 10gb |
68
+ | **Architecture** | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 | x86_64, ARM64 |
69
+ | **GPU** | ✔ | ✔ | ❌ | ✔ | ❌ | ❌ |
70
+ | **sudo** | ✔ | ✔ | ✔ | ✔ | ❌ | ❌ |
71
+ | **Docker** | ✔ | ✔ (Linux only) | ❌ | ✔ | ❌ | ❌ |
72
+ | **Spot pricing** | ✔ | ❌ | ✔ | ✔ | ❌ | ❌ |
73
+ | **OS** | Linux, Windows | Linux, Windows | Linux, Windows | Linux, Windows | Linux | Linux |
73
74
 
74
75
  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.
75
76
 
76
77
  * EC2 is useful when you want runners to have complete access to the host
77
78
  * ECS is useful when you want to control the infrastructure, like leaving the runner host running for faster startups
78
79
  * Lambda is useful for short jobs that can work within time, size and readonly system constraints
80
+ * Lambda MicroVM is useful when you want Lambda pricing and start-up time, but a real kernel, a writable disk and more than 15 minutes
79
81
 
80
82
  ### Job Isolation
81
83
 
@@ -563,6 +565,20 @@ new ScheduledWarmRunner(this, 'work hours warm', {
563
565
 
564
566
  See the [warm-runners example](examples/typescript/warm-runners/) for a complete setup.
565
567
 
568
+ ### Compliance
569
+
570
+ Compliance frameworks like HIPAA, PCI DSS, and NIST 800-53 often ask for your own encryption keys and limited Lambda concurrency. `Compliance` applies those to everything this library creates in a scope, like a stack or a whole app. Settings of the closest scope win.
571
+
572
+ ```python
573
+ Compliance.of(this).encrypt({ key, logs: logsKey }); // logs get their own key, everything else uses `key`
574
+ Compliance.of(gpuProvider).encrypt({ storage: gpuKey }); // stricter key for one provider
575
+ Compliance.of(this).limitLambdaConcurrency({ maxJobStarts: 50 }); // jobs you expect to start at once
576
+ ```
577
+
578
+ Synth warns about runner resources that no scope covers, like image builders in another stack. The key needs to be in a stack that every other stack can use. Adding a key to an existing deployment rebuilds runner images.
579
+
580
+ See the [compliance example](examples/typescript/compliance/) for a complete setup.
581
+
566
582
  ## Examples
567
583
 
568
584
  We provide comprehensive examples in the [`examples/`](examples/) folder to help you get started quickly:
@@ -591,6 +607,7 @@ We provide comprehensive examples in the [`examples/`](examples/) folder to help
591
607
  * **[IAM Permissions](examples/typescript/iam-permissions/)** - Grant AWS IAM permissions to runners (also available in [Python](examples/python/iam-permissions/))
592
608
  * **[Network Access](examples/typescript/network-access/)** - Configure network access with VPCs and security groups (also available in [Python](examples/python/network-access/))
593
609
  * **[Access Control](examples/typescript/access-control/)** - Configure access control for webhook and setup functions (also available in [Python](examples/python/access-control/))
610
+ * **[Compliance](examples/typescript/compliance/)** - Encrypt with your own KMS keys, limit Lambda concurrency, and log API requests (also available in [Python](examples/python/compliance/))
594
611
 
595
612
  ### Customization
596
613
 
@@ -5,7 +5,7 @@ kwargs = json.loads(
5
5
  """
6
6
  {
7
7
  "name": "cloudsnorkel.cdk-github-runners",
8
- "version": "1.0.0",
8
+ "version": "1.1.0",
9
9
  "description": "CDK construct to create GitHub Actions self-hosted runners. Creates ephemeral runners on demand. Easy to deploy and highly customizable.",
10
10
  "license": "Apache-2.0",
11
11
  "url": "https://github.com/CloudSnorkel/cdk-github-runners.git",
@@ -26,7 +26,7 @@ kwargs = json.loads(
26
26
  ],
27
27
  "package_data": {
28
28
  "cloudsnorkel.cdk_github_runners._jsii": [
29
- "cdk-github-runners@1.0.0.jsii.tgz"
29
+ "cdk-github-runners@1.1.0.jsii.tgz"
30
30
  ],
31
31
  "cloudsnorkel.cdk_github_runners": [
32
32
  "py.typed"
@@ -34,7 +34,7 @@ kwargs = json.loads(
34
34
  },
35
35
  "python_requires": ">=3.10",
36
36
  "install_requires": [
37
- "aws-cdk-lib>=2.239.0, <3.0.0",
37
+ "aws-cdk-lib>=2.261.0, <3.0.0",
38
38
  "constructs>=10.5.1, <11.0.0",
39
39
  "jsii>=1.142.0, <2.0.0",
40
40
  "publication>=0.0.3"