cdk-github-microvm-runners 0.1.1__tar.gz

cdk_github_microvm_runners-0.1.1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cdk_github_microvm_runners-0.1.1/MANIFEST.in

@@ -0,0 +1 @@
+include pyproject.toml

cdk_github_microvm_runners-0.1.1/PKG-INFO

@@ -0,0 +1,301 @@
+Metadata-Version: 2.1
+Name: cdk-github-microvm-runners
+Version: 0.1.1
+Summary: CDK construct for running GitHub Actions jobs on AWS Lambda MicroVMs, with one ephemeral runner per job.
+Home-page: https://runnerset.dev
+Author: Court Schuett
+License: Apache-2.0
+Project-URL: Source, https://github.com/schuettc/cdk-github-microvm-runners.git
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: JavaScript
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aws-cdk-lib<3.0.0,>=2.261.0
+Requires-Dist: constructs<11.0.0,>=10.5.1
+Requires-Dist: jsii<2.0.0,>=1.139.0
+Requires-Dist: publication>=0.0.3
+
+# cdk-github-microvm-runners
+
+[![npm](https://img.shields.io/npm/v/cdk-github-microvm-runners?logo=npm&label=npm)](https://www.npmjs.com/package/cdk-github-microvm-runners) [![PyPI](https://img.shields.io/pypi/v/cdk-github-microvm-runners?logo=pypi&logoColor=white&label=PyPI)](https://pypi.org/project/cdk-github-microvm-runners/) [![CI](https://img.shields.io/github/actions/workflow/status/schuettc/cdk-github-microvm-runners/ci.yml?branch=main&logo=githubactions&logoColor=white&label=CI)](https://github.com/schuettc/cdk-github-microvm-runners/actions/workflows/ci.yml) [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+A CDK construct library that runs GitHub Actions jobs on
+[AWS Lambda MicroVMs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-microvms-guide.html).
+Each job runs on its own MicroVM in your AWS account, created when the job
+starts and removed once it finishes.
+
+## Why this exists
+
+AWS Lambda MicroVMs provides the ability to launch a MicroVM, but nothing that
+connects one to GitHub Actions: there is no runner registration, no path from
+an incoming job to a running VM, and no cleanup when a VM or a runner is left
+behind. AWS CDK provides the individual building blocks — Lambda functions, a
+queue, a table, IAM roles — but not an assembled system. This construct is that
+system. It receives GitHub's `workflow_job` events, launches a MicroVM for each
+job, registers a single-use runner, and reconciles the result afterward, so
+that adopting per-job MicroVM runners is a matter of configuring a construct
+rather than building and operating the surrounding machinery yourself.
+
+Two design decisions shape the rest of the library. The runner VMs hold no AWS
+credentials by default, because a MicroVM's instance metadata service would
+otherwise return any attached role's credentials to the code running in the
+job; a job that needs AWS obtains its own short-lived credentials through GitHub
+OIDC instead. Routing is per job: a workflow job opts in by naming the runner's
+label in its `runs-on`, and every other job continues to run on GitHub-hosted
+runners, so a repository can be moved across one job at a time.
+
+## How it works
+
+A single runner set — one `GithubMicrovmRunners` in a stack — serves a GitHub
+organization or a set of repositories. It is configured with two required
+properties: how it authenticates to GitHub, and which organization or
+repositories it serves.
+
+A runner class pairs a `runs-on` label with the MicroVM size and image that
+jobs carrying that label run on, and a runner set can define more than one.
+Each class builds its own image and runs at its own size, so a workflow can
+send small jobs to one class and memory-heavy jobs to a larger one by choosing
+the matching label. The runner VMs are ARM64, so the tools and container images
+a job pulls need arm64 builds.
+
+<!-- sync:begin lifecycle-diagram -->
+
+```mermaid
+flowchart TD
+    GH["GitHub Actions — workflow_job event"] --> WH["Webhook Lambda — verifies the signature"]
+    WH --> Q["SQS job queue — launch and terminate intents"]
+    Q --> LN["Launcher Lambda — claims the job, obtains a MicroVM"]
+    LN --> VM["MicroVM — runs one job"]
+    LN -.->|registers a single-use runner| GH
+    LN <--> DB[("DynamoDB runner table")]
+    JAN["Janitor Lambda — scheduled sweep"] -.->|reaps stranded VMs, reconciles state| VM
+    JAN <--> DB
+```
+
+<!-- sync:end lifecycle-diagram -->
+
+When GitHub sends a `workflow_job` event, the webhook handler verifies its
+signature and places the job on an SQS queue. The launcher reads the queue,
+records a claim so that a given job is only ever launched once, starts a
+MicroVM (or resumes one from a warm pool, if the runner class keeps one), and
+registers a single-use runner with GitHub. The VM runs that one job and is then
+removed. A janitor runs on a schedule to reconcile the runner set against the
+running VMs and GitHub's view of its runners, terminating anything that was
+stranded and cleaning up records that are no longer needed. The
+[architecture guide](docs/architecture.md) describes the lifecycle, the
+idempotency model, and the checks that keep the janitor from terminating a
+runner that is still working.
+
+## Install
+
+One source, compiled by jsii into two packages. The API is the same in each,
+with names rendered in the target language's conventions.
+
+```bash
+npm install cdk-github-microvm-runners
+```
+
+```bash
+pip install cdk-github-microvm-runners
+```
+
+## Getting started
+
+To deploy, you need an AWS account, a GitHub App connected to the runner set,
+and the App's private key and webhook secret stored in AWS Secrets Manager. The
+[getting-started guide](docs/getting-started.md) walks through all three, and
+includes a helper that performs the GitHub App setup for you.
+
+The example below is TypeScript; [API.md](API.md) carries the same surface for
+every language.
+
+```python
+from aws_cdk import Environment
+from aws_cdk import App, CfnOutput, Stack
+from aws_cdk.aws_secretsmanager import Secret
+from cdk_github_microvm_runners import GithubMicrovmRunners, GithubAppId, GithubAppKey, GithubAuth, RunnerScope, MicrovmSize
+
+app = App()
+stack = Stack(app, "Runners", env=Environment(region="us-east-1"))
+
+# The GitHub App's ID, private key, and webhook secret are read from Secrets
+# Manager at run time, so this stack deploys before the App is created.
+app_id = Secret.from_secret_name_v2(stack, "AppId", "microvm-runner/dev/app-id")
+private_key = Secret.from_secret_name_v2(stack, "AppKey", "microvm-runner/dev/app-private-key")
+webhook_secret = Secret.from_secret_name_v2(stack, "WebhookSecret", "microvm-runner/dev/webhook-secret")
+
+runners = GithubMicrovmRunners(stack, "Runners",
+    github=GithubAuth.app(
+        app_id=GithubAppId.from_secret(app_id),
+        private_key=GithubAppKey.from_secret(private_key),
+        webhook_secret=webhook_secret
+    ),
+    scope=RunnerScope.org("my-org")
+)
+
+# A runner class pairs a label with the MicroVM size it runs on. Workflows
+# reach it through `runs-on: [self-hosted, microvm]`.
+runners.add_runner_class("microvm", size=MicrovmSize.GB4)
+
+CfnOutput(stack, "WebhookUrl", value=runners.webhook_url)
+```
+
+Once the stack is deployed, point the GitHub App's webhook at the stack's
+`WebhookUrl` output — the setup helper reads it from the stack and wires it for
+you, or you can set it by hand — and change a workflow job's `runs-on` to
+`[self-hosted, microvm]`.
+
+## Examples
+
+The samples below extend the runner set above, and each shows only the part it
+adds.
+
+### A runner class with its own image
+
+A runner class that names no image builds from the base image, which carries
+the operating system, the Actions runner, Docker, and the AWS CLI.
+`RunnerImage.fromOptions` describes what to add to that base: system packages,
+setup commands, environment variables, and files.
+
+```python
+runners.add_runner_class("build",
+    size=MicrovmSize.GB8,
+    image=RunnerImage.from_options(
+        system_packages=["jq", "ripgrep"],
+        setup_commands=["npm install -g pnpm@10"]
+    )
+)
+```
+
+Images are built when the stack deploys, so a job that arrives later boots an
+image that already exists. [Runner images](docs/images.md) covers the three
+ways to describe one, including supplying a Dockerfile of your own.
+
+### Language versions baked into the image
+
+`actions/setup-python` and `actions/setup-node` resolve the version a job asks
+for from the image's tool cache. A toolchain is a language runtime placed in
+that cache when the image is built.
+
+```python
+runners.add_runner_class("test",
+    size=MicrovmSize.GB4,
+    image=RunnerImage.from_options(
+        toolchains=[
+            RunnerToolchain.python("3.12.7"),
+            RunnerToolchain.node("22.11.0")
+        ]
+    )
+)
+```
+
+Each toolchain pins a full three-part version, because that version names the
+cache directory it is baked into. A workflow targeting the class then writes
+`actions/setup-python` as it would on a GitHub-hosted runner, and
+[Toolchains](docs/toolchains.md) covers the rest.
+
+### Runners in your own VPC
+
+Network egress belongs to the runner set rather than to a class, and every
+runner class shares it. `RunnerNetwork.vpc` has the construct build a Lambda
+runtime connector from a VPC you pass, so the VMs follow that VPC's subnets,
+security groups, and route tables.
+
+```python
+GithubMicrovmRunners(stack, "Runners",
+    github=github,
+    scope=RunnerScope.org("my-org"),
+    network=RunnerNetwork.vpc(vpc,
+        subnets=ec2.SubnetSelection(subnet_type=ec2.SubnetType.PRIVATE_WITH_EGRESS)
+    )
+)
+```
+
+The connector's network interfaces land in the VPC's private-with-egress
+subnets and get a new security group unless you pass your own. The
+[security guide](docs/security.md) covers attaching a connector you already
+manage, and what the VPC's routing then decides for a job.
+
+## Security
+
+The runner VMs carry no AWS identity by default, so a compromised or malicious
+workflow step has no credentials to read from the instance metadata service. A
+job that needs AWS assumes a role scoped to that job through GitHub OIDC. The
+[security guide](docs/security.md) covers the whole model, including the OIDC
+trust-policy setup and the details that are easy to get wrong.
+
+The webhook is served from a public Lambda Function URL, because GitHub cannot
+sign its webhook deliveries with SigV4. The handler verifies GitHub's
+HMAC-SHA256 signature on every request.
+
+A single property attaches an execution role to the VMs — `vmExecutionRole` —
+for a runner set whose jobs need a standing AWS identity. Because that role's
+credentials become readable from inside the job, it is off by default, and the
+construct never creates a VM identity on your behalf. Runtime console capture
+(`consoleLogs: ConsoleLogs.enabled()`) writes its logs through that same role,
+so it too requires `vmExecutionRole`, and you grant the role the log-write
+actions yourself.
+
+## Documentation
+
+| Guide                                                                                        | What it covers                                                                                 |
+| -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| [Getting started](docs/getting-started.md)                                                   | Prerequisites, GitHub App setup, deploying, and running a first job                            |
+| [Onboarding a repo](docs/onboarding.md)                                                      | Moving an existing repository's CI onto the runners                                            |
+| [Runner images](docs/images.md)                                                              | What an image contains, when it is built, how it changes, and the disk each size allows        |
+| [Toolchains](docs/toolchains.md)                                                             | Baking the Python and Node versions your workflows use into the image                          |
+| [Security](docs/security.md)                                                                 | The security model, per-job AWS access through GitHub OIDC, and the control plane              |
+| [Service quotas](docs/service-quotas.md)                                                     | Sizing for concurrency, and what to do when a quota cannot be raised                           |
+| [Monitoring](docs/monitoring.md)                                                             | Opt-in CloudWatch metrics and the ready-made alarms                                            |
+| [Logging](docs/logging.md)                                                                   | Image build logs and runtime VM console output, and the tradeoff console capture involves      |
+| [Architecture](docs/architecture.md)                                                         | The lifecycle, the idempotency model, and the checks that prevent terminating an active runner |
+| [API reference](API.md)                                                                      | Every construct, property, and default, generated from the source                              |
+| [Security policy](SECURITY.md) · [Contributing](CONTRIBUTING.md) · [Changelog](CHANGELOG.md) | Reporting and project information                                                              |
+
+## Configuration
+
+Beyond the two required properties, every option is optional and has a
+conservative default, so the example above deploys as written. The available
+options include a customer-managed KMS key applied to the
+DynamoDB table, the SQS queues, and the log groups (`encryptionKey`); a
+permissions boundary applied to every role the construct creates
+(`permissionsBoundary`); the removal policy, DynamoDB point-in-time recovery,
+log retention, dead-letter retention, dead-letter redrive count, and Lambda
+memory; and control over the VMs' network egress through `RunnerNetwork`.
+
+## Development
+
+Quality checks run through [`just`](https://github.com/casey/just) and are
+enforced by [lefthook](https://github.com/evilmartians/lefthook) git hooks; CI
+runs the same `just verify`.
+
+```bash
+brew install just lefthook
+pnpm install
+lefthook install
+just verify
+```
+
+<!-- sync:begin branch-model -->
+
+Feature pull requests target `dev`, which is promoted to `main` by pull
+request.
+
+<!-- sync:end branch-model -->
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup and the full workflow.
+
+## License
+
+Released under the [Apache-2.0](LICENSE) license.