Skip to content

Latest commit

 

History

History
187 lines (137 loc) · 5.88 KB

README.md

File metadata and controls

187 lines (137 loc) · 5.88 KB
Raw

vlang / AWS Lambda Custom Runtime Setup

Use V lang for AWS Lambda functions. This template provides a setup to compile, test local and deploy to AWS with the serverless framework which provides easy creation of additional AWS Cloud resources.

Installation

create a project from the template

  mkdir my-project && cd $_
  git init
  git pull --depth 1 https://github.com/aheissenberger/vlang-aws-lambda.git

Requirements

  • V language setup
  • Docker Desktop Hint: This project uses the latest version of Docker Desktop. If your version does not provide docker compose replace all mentioned commands with docker-compose.
  • AWS credentials setup

Usage

Write Lambda functions

add the code for your functions to src/bootstrap.v

Build binary for AWS Lambda

docker compose run --rm build

Test local

A) Docker with AWS Lambda Runtime Emulator

start the AWS Lambda Emulator as background process:

docker compose up -d lambda my-handler

invoke your function with a AWS Event:

curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{"payload":"hello world!"}'

Lambda Logs:

docker compose logs -f lambda

shutdown background process:

docker compose down

Hint: you need to restart if you built new binaries!

B) Native go binary with AWS Lambda Runtime Emulator

This is the option you will use if you need to debug your V function with lldbor gdb.

build requires local golang development environment

git clone git@github.com:aws/aws-lambda-runtime-interface-emulator.git aws-lambda-rie
cd aws-lambda-rie
go build -ldflags "-s -w" -o aws-lambda-rie ./cmd/aws-lambda-rie

run

  1. compile V lang handler
v -prod -gc boehm_full_opt src/lambda_function.v -o build/bootstrap
  1. run AWS Lambda Runtime Interface Emulation
./aws-lambda-rie/aws-lambda-rie --log-level debug ./build/bootstrap myhandler
  1. call the AWS Lambda Runtime Interface on port 8080 (different to docker image)
curl -XPOST "http://localhost:8080/2015-03-31/functions/function/invocations" -d '{"payload":"hello world!"}'

Deploy to AWS Cloud

  1. Modify configuration

check and adapt serverless.yml:

  • service: <project_name> should be short and will be part of the lambda function name
  • region: eu-west-1 adapt region to your location
  • stage: dev for more information check serverless framework documentation

  1. Setup AWS credentials

  2. Deploy

docker compose run --rm deploy

Options

docker compose run build

Check the environment: and args: sections of the docker-compose.yml file for possible options.

docker compose up lambda

Check the entrypoint: sections of the docker-compose.yml file for possible options.

docker compose run deploy

by default this will do: serverless deploy

you can add any valid serverless cli command to the command: docker compose run deploy <serverless command>

remove the whole project from AWS Cloud: docker compose run deploy remove --stage test

deploy to a different stage as defined in serverless.yml: docker compose run deploy deploy --stage test

Bootstrap API

The bootstrap module will handle the communication to the AWS Runtime API. The only information which needs to be provided is a mapping of handler names to handler functions.

fn main() {
	runtime := bootstrap.BootstrapConfig{
		handlers: map{
			'default': my_handler
		}
	}

	runtime.process()
}

fn my_handler(event json2.Any, context bootstrap.Context) string {
  return result
}

If only one function is needed use the name 'default' which is allready used as a default for the local lambda test setup.

Roadmap

  • Build pipeline to create AWS Linux 2 native binaries and bundle shared libraries
  • Local Lambda Testenvironment
  • Integrated AWS Cloud deployment with the serverless framework
  • Encapsulate the V lang custome runtime in a v module
  • Deploy all libraries in an extra layer
  • Include example which uses the AWS C++ SDK

Contribution

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Resources

These are resources which helped to land this project

when extra tools from centos epel required:

RUN yum install -y https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm && \
    yum update -y && \
    yum install -y inotify-tools

License

Distributed under the "bsd-2-clause" License. See LICENSE.txt for more information.