microvm-ctl 0.1.0__tar.gz

microvm_ctl-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

microvm_ctl-0.1.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: microvm-ctl
+Version: 0.1.0
+Summary: Control and execution plane for AWS Lambda MicroVMs: build images, launch Firecracker microVMs, scale fleets inside your quotas, call into them securely, and watch it all live.
+Author: Vivek Raja P S
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Vivek0712/microvm-ctl
+Project-URL: Repository, https://github.com/Vivek0712/microvm-ctl
+Project-URL: Documentation, https://github.com/Vivek0712/microvm-ctl/tree/main/docs
+Project-URL: Changelog, https://github.com/Vivek0712/microvm-ctl/blob/main/CHANGELOG.md
+Project-URL: Examples, https://github.com/Vivek0712/awesome-microvm
+Keywords: aws,lambda,microvm,firecracker,sandbox,serverless,fleet,orchestrator
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3>=1.34
+Requires-Dist: requests>=2.31
+Requires-Dist: rich>=13.7
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Dynamic: license-file
+
+# microvm-ctl
+
+**The control and execution plane for [AWS Lambda MicroVMs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-microvms-guide.html).** Build a snapshot image from a Dockerfile, launch Firecracker microVMs in seconds, scale a fleet inside the quotas your account actually has, call into every VM over its authenticated endpoint, and watch the whole thing live. One Python SDK, one `mvm` command.
+
+[![ci](https://github.com/Vivek0712/microvm-ctl/actions/workflows/ci.yml/badge.svg)](https://github.com/Vivek0712/microvm-ctl/actions/workflows/ci.yml)
+[![pypi](https://img.shields.io/pypi/v/microvm-ctl)](https://pypi.org/project/microvm-ctl/)
+![python](https://img.shields.io/badge/python-3.9%20to%203.12-blue)
+![license](https://img.shields.io/badge/license-Apache--2.0-green)
+
+```console
+pip install microvm-ctl
+
+mvm bootstrap                              # one time: S3 artifact bucket + build/execution IAM roles
+mvm image build my-sandbox ./my-app        # Dockerfile at ./my-app root -> runnable snapshot
+mvm run my-sandbox --wait                  # RunMicrovm, then poll to RUNNING
+mvm call <microvm-id> /execute -X POST -d '{"code":"print(2+2)"}'
+mvm scale my-sandbox 10                    # converge the fleet, throttled to your applied quota
+mvm top --watch                            # live state table
+```
+
+## Why this exists
+
+Lambda MicroVMs exposes the primitive under Lambda itself: a Firecracker VM with a full AL2023 userland, a dedicated HTTPS endpoint, and a lifecycle you control (run, suspend, resume, terminate). The service deliberately stops there. There is no load balancer (one endpoint per VM), no fleet abstraction, no token management, no dashboard, and a fresh account runs quotas far below the published defaults. microvm-ctl fills that gap.
+
+| Concern | What the plane does | Module |
+|---|---|---|
+| Image factory | app directory to zip, to S3, to `CreateMicrovmImage`, to an ACTIVE version; injects the hook runtime into every image | `microvm/images.py` |
+| Lifecycle and fleets | run, suspend, resume, terminate, `Fleet.scale_to(n)`, drain, reap | `microvm/fleet.py` |
+| Quota-aware throttling | reads the quotas *applied* to your account, not the published defaults, and token-buckets every mutating call at 80% of them | `microvm/fleet.py`, `microvm/throttle.py` |
+| Execution plane | mints and caches port-scoped JWE tokens, sets `X-aws-proxy-auth`, backs off on 429, waits out a 502 while a suspended VM auto-resumes | `microvm/endpoint.py` |
+| In-VM hook runtime | zero-dependency server for `/ready`, `/validate`, `/run`, `/resume`, `/suspend`, `/terminate` plus your own routes | `microvm/hooks/server.py` |
+| Observability and cost | live fleet table, CloudWatch tail, a cost model that prices a session shape before you commit to it | `microvm/monitor.py` |
+| Account bootstrap | artifact bucket plus separate build and execution roles | `microvm/bootstrap.py` |
+
+The `lambda-microvms` botocore service model ships inside the package, so the plane works on whatever boto3 you already have.
+
+![architecture](docs/img/architecture.png)
+
+## Measured, not quoted
+
+Every number in this repo comes from the live service in `us-east-1`. The harness that produced them is [`benchmarks/benchmark.py`](benchmarks/benchmark.py); run it against your own account.
+
+| What | Measured |
+|---|---|
+| Image build, Dockerfile to runnable snapshot | 123 to 145 s |
+| `RunMicrovm` to serving authenticated traffic | **p50 3.54 s**, p95 4.49 s |
+| Warm authenticated request (real Python execution inside the VM) | **p50 111 ms** |
+| Explicit suspend / resume | 2.5 s / 2.6 s, same PID, state intact |
+| First request to a suspended VM (auto-resume) | **200 OK in 0.7 s** |
+| Fleet scale-out, 0 to 6 running VMs, on a 1 launch/s quota | **9.7 s** wall |
+| 30 min active + 8 h suspended session vs always-on | **93.8% cheaper** |
+
+![benchmark transcript](docs/img/benchmark.png)
+
+## The SDK in 20 lines
+
+```python
+from microvm import PlaneConfig, FleetManager, EndpointClient, Fleet
+from microvm.fleet import IdlePolicy
+
+cfg = PlaneConfig()                      # region, profile, bucket, roles from MVM_* env vars
+fm = FleetManager(cfg)                   # throttled to your account's applied TPS
+
+vm = fm.run("my-sandbox",
+            idle_policy=IdlePolicy(max_idle=300, suspended_for=3600, auto_resume=True),
+            run_payload='{"tenant_id": "acme"}')
+
+client = EndpointClient(cfg, vm.microvm_id)
+print(client.post("/execute", json={"code": "print(41+1)"}).json())
+
+fleet = Fleet(fm, "my-sandbox")
+fleet.scale_to(20, wait_running=True)    # one call, token-bucketed, jittered retries
+fleet.suspend_all()                      # park the fleet: snapshot storage billing only
+fleet.drain()                            # terminate every member
+```
+
+Inside the VM, declare the lifecycle with the injected hook runtime. There is nothing to install in the image.
+
+```python
+from microvm_hooks import HookApp
+app = HookApp()
+
+@app.on_ready
+def ready(ctx):
+    warm_caches()
+    return True                          # 200 means "snapshot me now"
+
+@app.on_run
+def run(ctx):                            # every clone, before traffic; RNG is reseeded for you
+    load_tenant(ctx.get("runHookPayload"))
+
+@app.route("POST", "/execute")
+def execute(body, headers):
+    return 200, {"out": sandbox_exec(body["code"])}
+
+app.serve(port=8080)
+```
+
+## What the CLI looks like
+
+`mvm quotas` shows the difference between the published defaults and what your account can actually do. This is a fresh account: one launch per second and 8 GB of total microVM memory.
+
+![mvm quotas](docs/img/mvm-quotas.png)
+
+`mvm image ls` after building the eight example images from the companion repo.
+
+![mvm image ls](docs/img/mvm-image-ls.png)
+
+`mvm cost` prices a session shape from the published rates. This is the 30 minutes active plus 8 hours suspended shape on a 2 GB VM with the measured 0.61 GB snapshot.
+
+![mvm cost](docs/img/mvm-cost.png)
+
+## Documentation
+
+- [Quickstart](docs/quickstart.md): from an empty account to a serving VM, with the environment variables explained.
+- [CLI reference](docs/cli.md): every `mvm` command and flag.
+- [SDK reference](docs/sdk.md): `PlaneConfig`, `ImageBuilder`, `FleetManager`, `Fleet`, `EndpointClient`, `FleetMonitor`, `CostModel`.
+- [Architecture](docs/architecture.md): the two planes, the lifecycle state machine, the fleet design decisions, and the security model.
+- [The hook contract](docs/hooks.md): what each hook is for and what breaks when you ignore it.
+- [Quotas and cost](docs/quotas-and-cost.md): the quota walls, what counts against them, and the cost model with worked examples.
+- [Troubleshooting](docs/troubleshooting.md): the errors we hit on the live service and what each one meant.
+
+## Examples and the article series
+
+Eight production-shaped apps run on this plane: a code execution sandbox, an AI code runner with a self-repair loop, an agent evaluation fleet, a stateful notebook kernel, sandboxed DuckDB analytics, an ephemeral CI runner, an HTML to PDF service, and multi-tenant AI agents. Each has a Dockerfile, a single-file app, a recorded live transcript, and an article in the series **Building on AWS Lambda MicroVMs**. They live in the companion repo [awesome-microvm](https://github.com/Vivek0712/awesome-microvm).
+
+## Requirements and regions
+
+Python 3.9 or newer on the machine running the plane. The VMs themselves are ARM64 (Graviton) only, so audit binary wheels before you build an image. The service is available in `us-east-1`, `us-east-2`, `us-west-2`, `eu-west-1`, and `ap-northeast-1`.
+
+## Credits and inspiration
+
+This project grew out of [lambda-microvm-starter](https://github.com/vidanov/lambda-microvm-starter) by [Alexey Vidanov](https://github.com/vidanov), the one-command on-ramp that deploys any Dockerfile to a Lambda MicroVM behind a public CloudFront URL. His starter kit and its troubleshooting notes were the first working map of the service we had, and several of the gotchas documented here were first written down there. microvm-ctl takes the next step from one deployed app to fleets, tokens, quotas, and cost, and we are grateful for the ground he covered first.
+
+## Contributing
+
+Issues and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the local test loop (no AWS account needed for the unit tests) and the conventions used in this repo.
+
+## License
+
+Apache-2.0

microvm_ctl-0.1.0/README.md

@@ -0,0 +1,141 @@
+# microvm-ctl
+
+**The control and execution plane for [AWS Lambda MicroVMs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-microvms-guide.html).** Build a snapshot image from a Dockerfile, launch Firecracker microVMs in seconds, scale a fleet inside the quotas your account actually has, call into every VM over its authenticated endpoint, and watch the whole thing live. One Python SDK, one `mvm` command.
+
+[![ci](https://github.com/Vivek0712/microvm-ctl/actions/workflows/ci.yml/badge.svg)](https://github.com/Vivek0712/microvm-ctl/actions/workflows/ci.yml)
+[![pypi](https://img.shields.io/pypi/v/microvm-ctl)](https://pypi.org/project/microvm-ctl/)
+![python](https://img.shields.io/badge/python-3.9%20to%203.12-blue)
+![license](https://img.shields.io/badge/license-Apache--2.0-green)
+
+```console
+pip install microvm-ctl
+
+mvm bootstrap                              # one time: S3 artifact bucket + build/execution IAM roles
+mvm image build my-sandbox ./my-app        # Dockerfile at ./my-app root -> runnable snapshot
+mvm run my-sandbox --wait                  # RunMicrovm, then poll to RUNNING
+mvm call <microvm-id> /execute -X POST -d '{"code":"print(2+2)"}'
+mvm scale my-sandbox 10                    # converge the fleet, throttled to your applied quota
+mvm top --watch                            # live state table
+```
+
+## Why this exists
+
+Lambda MicroVMs exposes the primitive under Lambda itself: a Firecracker VM with a full AL2023 userland, a dedicated HTTPS endpoint, and a lifecycle you control (run, suspend, resume, terminate). The service deliberately stops there. There is no load balancer (one endpoint per VM), no fleet abstraction, no token management, no dashboard, and a fresh account runs quotas far below the published defaults. microvm-ctl fills that gap.
+
+| Concern | What the plane does | Module |
+|---|---|---|
+| Image factory | app directory to zip, to S3, to `CreateMicrovmImage`, to an ACTIVE version; injects the hook runtime into every image | `microvm/images.py` |
+| Lifecycle and fleets | run, suspend, resume, terminate, `Fleet.scale_to(n)`, drain, reap | `microvm/fleet.py` |
+| Quota-aware throttling | reads the quotas *applied* to your account, not the published defaults, and token-buckets every mutating call at 80% of them | `microvm/fleet.py`, `microvm/throttle.py` |
+| Execution plane | mints and caches port-scoped JWE tokens, sets `X-aws-proxy-auth`, backs off on 429, waits out a 502 while a suspended VM auto-resumes | `microvm/endpoint.py` |
+| In-VM hook runtime | zero-dependency server for `/ready`, `/validate`, `/run`, `/resume`, `/suspend`, `/terminate` plus your own routes | `microvm/hooks/server.py` |
+| Observability and cost | live fleet table, CloudWatch tail, a cost model that prices a session shape before you commit to it | `microvm/monitor.py` |
+| Account bootstrap | artifact bucket plus separate build and execution roles | `microvm/bootstrap.py` |
+
+The `lambda-microvms` botocore service model ships inside the package, so the plane works on whatever boto3 you already have.
+
+![architecture](docs/img/architecture.png)
+
+## Measured, not quoted
+
+Every number in this repo comes from the live service in `us-east-1`. The harness that produced them is [`benchmarks/benchmark.py`](benchmarks/benchmark.py); run it against your own account.
+
+| What | Measured |
+|---|---|
+| Image build, Dockerfile to runnable snapshot | 123 to 145 s |
+| `RunMicrovm` to serving authenticated traffic | **p50 3.54 s**, p95 4.49 s |
+| Warm authenticated request (real Python execution inside the VM) | **p50 111 ms** |
+| Explicit suspend / resume | 2.5 s / 2.6 s, same PID, state intact |
+| First request to a suspended VM (auto-resume) | **200 OK in 0.7 s** |
+| Fleet scale-out, 0 to 6 running VMs, on a 1 launch/s quota | **9.7 s** wall |
+| 30 min active + 8 h suspended session vs always-on | **93.8% cheaper** |
+
+![benchmark transcript](docs/img/benchmark.png)
+
+## The SDK in 20 lines
+
+```python
+from microvm import PlaneConfig, FleetManager, EndpointClient, Fleet
+from microvm.fleet import IdlePolicy
+
+cfg = PlaneConfig()                      # region, profile, bucket, roles from MVM_* env vars
+fm = FleetManager(cfg)                   # throttled to your account's applied TPS
+
+vm = fm.run("my-sandbox",
+            idle_policy=IdlePolicy(max_idle=300, suspended_for=3600, auto_resume=True),
+            run_payload='{"tenant_id": "acme"}')
+
+client = EndpointClient(cfg, vm.microvm_id)
+print(client.post("/execute", json={"code": "print(41+1)"}).json())
+
+fleet = Fleet(fm, "my-sandbox")
+fleet.scale_to(20, wait_running=True)    # one call, token-bucketed, jittered retries
+fleet.suspend_all()                      # park the fleet: snapshot storage billing only
+fleet.drain()                            # terminate every member
+```
+
+Inside the VM, declare the lifecycle with the injected hook runtime. There is nothing to install in the image.
+
+```python
+from microvm_hooks import HookApp
+app = HookApp()
+
+@app.on_ready
+def ready(ctx):
+    warm_caches()
+    return True                          # 200 means "snapshot me now"
+
+@app.on_run
+def run(ctx):                            # every clone, before traffic; RNG is reseeded for you
+    load_tenant(ctx.get("runHookPayload"))
+
+@app.route("POST", "/execute")
+def execute(body, headers):
+    return 200, {"out": sandbox_exec(body["code"])}
+
+app.serve(port=8080)
+```
+
+## What the CLI looks like
+
+`mvm quotas` shows the difference between the published defaults and what your account can actually do. This is a fresh account: one launch per second and 8 GB of total microVM memory.
+
+![mvm quotas](docs/img/mvm-quotas.png)
+
+`mvm image ls` after building the eight example images from the companion repo.
+
+![mvm image ls](docs/img/mvm-image-ls.png)
+
+`mvm cost` prices a session shape from the published rates. This is the 30 minutes active plus 8 hours suspended shape on a 2 GB VM with the measured 0.61 GB snapshot.
+
+![mvm cost](docs/img/mvm-cost.png)
+
+## Documentation
+
+- [Quickstart](docs/quickstart.md): from an empty account to a serving VM, with the environment variables explained.
+- [CLI reference](docs/cli.md): every `mvm` command and flag.
+- [SDK reference](docs/sdk.md): `PlaneConfig`, `ImageBuilder`, `FleetManager`, `Fleet`, `EndpointClient`, `FleetMonitor`, `CostModel`.
+- [Architecture](docs/architecture.md): the two planes, the lifecycle state machine, the fleet design decisions, and the security model.
+- [The hook contract](docs/hooks.md): what each hook is for and what breaks when you ignore it.
+- [Quotas and cost](docs/quotas-and-cost.md): the quota walls, what counts against them, and the cost model with worked examples.
+- [Troubleshooting](docs/troubleshooting.md): the errors we hit on the live service and what each one meant.
+
+## Examples and the article series
+
+Eight production-shaped apps run on this plane: a code execution sandbox, an AI code runner with a self-repair loop, an agent evaluation fleet, a stateful notebook kernel, sandboxed DuckDB analytics, an ephemeral CI runner, an HTML to PDF service, and multi-tenant AI agents. Each has a Dockerfile, a single-file app, a recorded live transcript, and an article in the series **Building on AWS Lambda MicroVMs**. They live in the companion repo [awesome-microvm](https://github.com/Vivek0712/awesome-microvm).
+
+## Requirements and regions
+
+Python 3.9 or newer on the machine running the plane. The VMs themselves are ARM64 (Graviton) only, so audit binary wheels before you build an image. The service is available in `us-east-1`, `us-east-2`, `us-west-2`, `eu-west-1`, and `ap-northeast-1`.
+
+## Credits and inspiration
+
+This project grew out of [lambda-microvm-starter](https://github.com/vidanov/lambda-microvm-starter) by [Alexey Vidanov](https://github.com/vidanov), the one-command on-ramp that deploys any Dockerfile to a Lambda MicroVM behind a public CloudFront URL. His starter kit and its troubleshooting notes were the first working map of the service we had, and several of the gotchas documented here were first written down there. microvm-ctl takes the next step from one deployed app to fleets, tokens, quotas, and cost, and we are grateful for the ground he covered first.
+
+## Contributing
+
+Issues and pull requests are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the local test loop (no AWS account needed for the unit tests) and the conventions used in this repo.
+
+## License
+
+Apache-2.0

microvm_ctl-0.1.0/microvm/__init__.py

@@ -0,0 +1,28 @@
+"""microvm-ctl: control and execution plane for AWS Lambda MicroVMs.
+
+Control plane  : build images, run/suspend/resume/terminate, scale fleets.
+Execution plane: authenticated calls into the microVM endpoint, in-VM hook server.
+"""
+
+from microvm.client import lambda_client, microvm_client
+from microvm.config import PlaneConfig
+from microvm.endpoint import EndpointClient, EndpointError
+from microvm.fleet import Fleet, FleetManager
+from microvm.images import ImageBuilder, ImageBuildError
+from microvm.monitor import CostModel, FleetMonitor
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "microvm_client",
+    "lambda_client",
+    "PlaneConfig",
+    "ImageBuilder",
+    "ImageBuildError",
+    "Fleet",
+    "FleetManager",
+    "EndpointClient",
+    "EndpointError",
+    "FleetMonitor",
+    "CostModel",
+]

microvm_ctl-0.1.0/microvm/bootstrap.py

@@ -0,0 +1,99 @@
+"""One-time account bootstrap: artifact bucket + build/execution IAM roles.
+
+Build role  — assumed by the image build infrastructure: reads the code
+              artifact zip from S3 and writes build logs.
+Execution   — assumed by the running microVM (credentials are vended inside
+role          the VM): runtime logs plus whatever your workload needs.
+              Build vs execution role separation is deliberate — never let
+              the sandbox role read your artifact bucket.
+"""
+
+from __future__ import annotations
+
+import json
+import time
+
+from microvm.client import lambda_client
+from microvm.config import PlaneConfig
+
+TRUST = {
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Effect": "Allow",
+            "Principal": {"Service": "lambda.amazonaws.com"},
+            "Action": ["sts:AssumeRole", "sts:TagSession"],
+        }
+    ],
+}
+
+
+def _ensure_role(iam, name: str, policy_doc: dict) -> str:
+    try:
+        arn = iam.get_role(RoleName=name)["Role"]["Arn"]
+    except iam.exceptions.NoSuchEntityException:
+        arn = iam.create_role(
+            RoleName=name,
+            AssumeRolePolicyDocument=json.dumps(TRUST),
+            Description="microvm-ctl control plane",
+        )["Role"]["Arn"]
+        time.sleep(8)  # IAM eventual consistency before first use
+    iam.put_role_policy(
+        RoleName=name, PolicyName=f"{name}-inline", PolicyDocument=json.dumps(policy_doc)
+    )
+    return arn
+
+
+def bootstrap(cfg: PlaneConfig, prefix: str = "microvm-ctl") -> dict:
+    """Create (idempotently) the artifact bucket and the two IAM roles.
+
+    Returns the three values the rest of the plane needs, ready to export as
+    MVM_ARTIFACT_BUCKET / MVM_BUILD_ROLE_ARN / MVM_EXECUTION_ROLE_ARN.
+    """
+    sts = lambda_client("sts", cfg.region, cfg.profile)
+    account = sts.get_caller_identity()["Account"]
+    bucket = cfg.artifact_bucket or f"{prefix}-artifacts-{account}-{cfg.region}"
+
+    s3 = lambda_client("s3", cfg.region, cfg.profile)
+    try:
+        s3.head_bucket(Bucket=bucket)
+    except Exception:
+        params = {"Bucket": bucket}
+        if cfg.region != "us-east-1":
+            params["CreateBucketConfiguration"] = {"LocationConstraint": cfg.region}
+        s3.create_bucket(**params)
+        s3.put_public_access_block(
+            Bucket=bucket,
+            PublicAccessBlockConfiguration={
+                "BlockPublicAcls": True, "IgnorePublicAcls": True,
+                "BlockPublicPolicy": True, "RestrictPublicBuckets": True,
+            },
+        )
+
+    iam = lambda_client("iam", cfg.region, cfg.profile)
+    logs_stmt = {
+        "Effect": "Allow",
+        "Action": ["logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents"],
+        "Resource": f"arn:aws:logs:{cfg.region}:{account}:log-group:/aws/lambda/microvms/*",
+    }
+    build_role = _ensure_role(
+        iam,
+        f"{prefix}-build-role",
+        {
+            "Version": "2012-10-17",
+            "Statement": [
+                {"Effect": "Allow", "Action": "s3:GetObject", "Resource": f"arn:aws:s3:::{bucket}/*"},
+                logs_stmt,
+            ],
+        },
+    )
+    execution_role = _ensure_role(
+        iam,
+        f"{prefix}-execution-role",
+        {"Version": "2012-10-17", "Statement": [logs_stmt]},
+    )
+    return {
+        "artifact_bucket": bucket,
+        "build_role_arn": build_role,
+        "execution_role_arn": execution_role,
+    }