Serverless-ruby-layer
A Serverless Plugin which bundles ruby gems from Gemfile and deploys them to the lambda layer automatically while running serverless deploy
.
It auto-configures the AWS lambda layer and RUBY_PATH to all the functions.
Install ⚡️ serverless. Refer here for serverless installation instructions.
Navigate to your serverless project and install the plugin
sls plugin install -n serverless-ruby-layer
This will add the plugin to package.json
and the plugins section of serverless.yml
.
Check out the documentation here for,
serverless.yml
service: basic
plugins:
- serverless-ruby-layer
provider:
name: aws
runtime: ruby3.2
functions:
hello:
handler: handler.hello
Gemfile
source 'https://rubygems.org'
gem 'httparty'
Running sls deploy
automatically deploys the required gems as in Gemfile to AWS lambda layer and make the gems available to the RUBY_PATH
of the functions hello.handler
Refer example amd docs for more details
The plugin operation can be customized by specifying the custom
configuration under rubyLayer
.
For example, to use docker environment for packing gem, the below configuration is added to serverless.yml
custom:
rubyLayer:
use_docker: true
For more detailse refer the docs here
Using the custom configuration, the plugin can be utilized for below cases,
http
, Nokogiri
- Example - Docspg
, mysql
, RMagick
- PG Example - DocsBundler.require(:default)
to require all gems in handler.rb by respecting Gemfile.lock - Example - DocsPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update the tests as appropriate.
Refer Guidelines for more information.
Author: Navarasu
Source Code: https://github.com/navarasu/serverless-ruby-layer
License: MIT