https://github.com/kanutocd/lambda-microvms
Ruby resource objects, waiters, endpoint helpers, project scaffolding, packaging, and deployment ergonomics built on top of aws-sdk-lambda.
https://github.com/kanutocd/lambda-microvms
aws aws-lambda aws-lambda-runtime aws-sdk cloud-native developer-tools docker firecracker lambda microvm ruby serverless toolkit
Last synced: 8 days ago
JSON representation
Ruby resource objects, waiters, endpoint helpers, project scaffolding, packaging, and deployment ergonomics built on top of aws-sdk-lambda.
- Host: GitHub
- URL: https://github.com/kanutocd/lambda-microvms
- Owner: kanutocd
- License: mit
- Created: 2026-06-26T13:39:59.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-06-26T18:35:16.000Z (about 1 month ago)
- Last Synced: 2026-07-20T23:37:46.163Z (8 days ago)
- Topics: aws, aws-lambda, aws-lambda-runtime, aws-sdk, cloud-native, developer-tools, docker, firecracker, lambda, microvm, ruby, serverless, toolkit
- Language: Ruby
- Homepage: https://kanutocd.github.io/lambda-microvms/
- Size: 74.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# lambda-microvms
[](https://badge.fury.io/rb/lambda-microvms)
[](https://github.com/kanutocd/lambda-microvms/actions)
[](https://www.ruby-lang.org/en/)
[](https://opensource.org/licenses/MIT)
A Ruby development kit for AWS Lambda MicroVM experiments and standard Lambda function workflows.
`lambda-microvms` builds on the official `aws-sdk-lambda` gem. It provides Ruby resource objects, lifecycle helpers, endpoint calls, project scaffolding, packaging, experimental MicroVM deployment commands, and a supported Lambda function client for APIs that exist today.
It gives Ruby developers a higher-level workflow:
```text
scaffold
↓
develop
↓
package
↓
deploy image
↓
run / suspend / resume / terminate
```
## Why `aws_lambda_ric` appears in generated projects
Ruby MicroVM applications need a runtime inside the image. For non-AWS or OS-only Ruby container images, AWS documents the Ruby Runtime Interface Client (`aws_lambda_ric`) as the component that lets Ruby code interact with the Lambda Runtime API.
`lambda-microvms` uses `aws_lambda_ric` as a **generated project dependency**, not as a host-side SDK dependency.
```text
Host side:
lambda-microvms
aws-sdk-lambda
aws-sdk-s3
Guest side / inside generated image:
aws_lambda_ric
your Ruby handler
```
## Installation
```ruby
gem "lambda-microvms"
```
## Scaffold a Ruby MicroVM project
```bash
lambda-microvms new hello-worker
cd hello-worker
```
Generated project:
```text
hello-worker/
Dockerfile
Gemfile
app.rb
microvm.yml
README.md
.env.example
```
The generated `Gemfile` includes:
```ruby
gem "aws_lambda_ric"
```
## Check readiness
```bash
lambda-microvms doctor
```
Checks Ruby, Docker, AWS CLI, project config, Dockerfile, deployment bucket, runtime role, `aws_lambda_ric` presence, and whether the installed `aws-sdk-lambda` exposes the experimental MicroVM operation contract.
## Check the MicroVM SDK contract
```bash
lambda-microvms sdk-contract
```
The public `aws-sdk-lambda` gem may not expose MicroVM lifecycle operations such as `create_microvm_image` or `run_microvm`. When those methods are missing, MicroVM `deploy` and `run` fail before packaging or uploading artifacts.
## Package
```bash
lambda-microvms package
```
Creates the source artifact configured by `microvm.yml`.
## Deploy
```bash
lambda-microvms deploy
```
Deployment flow:
```text
zip project
↓
upload to S3
↓
create MicroVM image through aws-sdk-lambda
```
The exact AWS Lambda MicroVM API parameter names are still kept close to AWS naming. Put API-specific values under `image.create` in `microvm.yml`.
## Run
```bash
lambda-microvms run
```
Runs the configured image ARN with the configured role ARN and runtime payload.
## Standard Lambda function APIs
The gem also includes a supported path for regular Lambda function APIs available in `aws-sdk-lambda` today.
```ruby
client = Lambda::MicroVMs::FunctionClient.new(region: "us-east-1")
client.create_function(
name: "ruby-worker",
role_arn: "arn:aws:iam::123456789012:role/lambda-runtime",
handler: "app.Handler.process",
runtime: "ruby3.4",
zip_file: "tmp/function.zip"
)
result = client.invoke(function_name: "ruby-worker", payload: { hello: "world" })
```
You can also invoke an existing function from the CLI:
```bash
lambda-microvms function-invoke ruby-worker '{"hello":"world"}'
```
## Ruby SDK usage
```ruby
require "lambda/microvms"
client = Lambda::MicroVMs::Client.new(region: "us-east-1")
image = client.image("arn:aws:lambda:us-east-1:123456789012:microvm-image:ruby-sandbox")
vm = image.run(
role_arn: "arn:aws:iam::123456789012:role/lambda-microvm-runtime",
payload: { tenant_id: "tenant_123" }
)
vm.wait_until_running
response = vm.post("/process", json: { hello: "world" })
vm.suspend
vm.resume
vm.terminate
```
## Session helper
```ruby
Lambda::MicroVMs.session(
image_arn: "arn:aws:lambda:us-east-1:123456789012:microvm-image:ruby-sandbox",
role_arn: "arn:aws:iam::123456789012:role/lambda-microvm-runtime",
after: :suspend,
payload: { tenant_id: "tenant_123" }
) do |vm|
vm.post("/process", json: { event_id: "evt_1" })
end
```
Supported cleanup policies:
```ruby
after: :keep
after: :suspend
after: :terminate
```
## Architecture
```text
aws-sdk-lambda
│
▼
Lambda::MicroVMs::Client
│
├── Image
├── MicroVM
├── Endpoint
├── Session
├── FunctionClient
├── Scaffold
├── Packager
└── Deployer
```
## Status
MicroVM lifecycle support is experimental and contract-gated. The current public `aws-sdk-lambda` may not expose the MicroVM methods this gem wraps. Use `lambda-microvms sdk-contract` to verify your installed SDK.
Standard Lambda function operations are available through `Lambda::MicroVMs::FunctionClient`.