https://github.com/fdaciuk/sls-rust

A Serverless framework plugin for Rust applications
https://github.com/fdaciuk/sls-rust

aws lambda rust rustlang serverless

Last synced: 2 days ago
JSON representation

A Serverless framework plugin for Rust applications

• Host: GitHub
• URL: https://github.com/fdaciuk/sls-rust
• Owner: fdaciuk
• Created: 2022-06-26T17:51:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-28T21:11:55.000Z (about 1 year ago)
• Last Synced: 2024-09-24T20:18:05.754Z (2 days ago)
• Topics: aws, lambda, rust, rustlang, serverless
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/sls-rust
• Size: 11.7 KB
• Stars: 15
• Watchers: 2
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  🦀 sls-rust





   A ⚡ Serverless framework ⚡ plugin for Rust applications



> Note: this plugin was inspired on [softprops/serverless-rust](https://github.com/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:

```console

.

├── your_rust_project

│   ├── src

│   │   └── main.rs

│   └── Cargo.toml

├── package.json

└── serverless.yml

```

Install the plugin inside your serverless project with npm.

```console

$ 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](https://github.com/awslabs/aws-lambda-rust-runtime) makes this easy.

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

```yaml

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

```sh

$ rustup target add x86_64-unknown-linux-musl

```

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

```sh

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

```

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

```sh

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

```

## 🤸 usage

Every [serverless workflow command](https://serverless.com/framework/docs/providers/aws/guide/workflow/) should work out of the box.

### invoke your lambdas locally

```sh

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

```

### deploy your lambdas to the cloud

```sh

$ npx serverless deploy

```

### invoke your lambdas in the cloud directly

```sh

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

```

### view your lambdas logs

```sh

$ npx serverless logs -f hello

```

## License 

MIT