kristallizer/sls-rust

A Serverless framework plugin for Rust applications

🦀 sls-rust

A ⚡ Serverless framework ⚡ plugin for Rust applications

Note: this plugin was inspired on softprops/serverless-rust. Since the serverless-rust plugin is not activelly mantained, I created this one to work with minimal effort as possible: without docker, and probably only run on Linux (not tested on other OS). Great for CI environments.

📦 Install

You should put the serverless.yml file outside the Rust project directory:

.
├── your_rust_project
│   ├── src
│   │   └── main.rs
│   └── Cargo.toml
├── package.json
└── serverless.yml

Install the plugin inside your serverless project with npm.

$ npm i -D sls-rust

💡The -D flag adds it to your development dependencies in npm speak

💡 This plugin assumes you are building Rustlang lambdas targeting the AWS Lambda "provided.al2" runtime. The AWS Lambda Rust Runtime makes this easy.

Add the following to your serverless project's serverless.yml file

service: demo
frameworkVersion: '3'
configValidationMode: error

provider:
  name: aws
  memorySize: 128
  region: us-east-1

plugins:
  # this registers the plugin with serverless
  - sls-rust

# creates one artifact for each function
package:
  individually: true

functions:
  test:
    # handler value syntax is `{rust_project_path}.{project_binary_name}`
    handler: rust_project_path.project_binary_name
    # you must use tags.rust = true to make this plugin works:
    tags:
      rust: true

💡 The Rust Lambda runtime requires a binary named bootstrap. This plugin renames the binary cargo builds to bootstrap for you. You do not need to do this manually in your Cargo.toml configuration file.

In order to use this mode its expected that you install the x86_64-unknown-linux-musl target on all platforms locally with

$ rustup target add x86_64-unknown-linux-musl

On linux platforms, you will need to install musl-tools

$ sudo apt-get update && sudo apt-get install -y musl-tools

On Mac OSX, you will need to install a MUSL cross compilation toolchain

$ brew install filosottile/musl-cross/musl-cross

🤸 usage

Every serverless workflow command should work out of the box.

invoke your lambdas locally

$ npx serverless invoke local -f hello -d '{"hello":"world"}'

deploy your lambdas to the cloud

$ npx serverless deploy

invoke your lambdas in the cloud directly

$ npx serverless invoke -f hello -d '{"hello":"world"}'

view your lambdas logs

$ npx serverless logs -f hello

License

MIT