Git Product home page Git Product logo

serverless-layers's Introduction

serverless-layers

serverless Issues License NPM Build Status PRs Welcome

  • Automatically attach layers for each lambda function
  • Creates a new layer version when package.json was updated
  • If package.json was not changed, it does not publish a new layer
  • Reduces drastically lambda size
  • It reduces deployment time.
  • Share same layers (libraries) with all lambda functions

Requirements

  • Serverless >= 1.34.0 (layers support)
  • Node >= v6.10.3
  • NPM >= 3.10.10
  • AWS only (sorry)
  • A valid package.json file

Install

npm install -D serverless-layers

or

serverless plugin install --name serverless-layers

Add the plugin to your serverless.yml file:

Simple usage

provider:
  ...
  deploymentBucket:
    name: 'your_bucket'

plugins:
  - serverless-layers

Plugin Options

Example:

custom:
  serverless-layers:
    packageManager: npm
Option Type Default Description
packageManager string npm Possible values: npm, yarn
compileDir string .serverless Compilation directory
packagePath string package.json You can specify custom path for you package.json
compatibleRuntimes array ['nodejs'] Possible values: nodejs, nodejs8.10, nodejs10.x
layersDeploymentBucket string You can specify a bucket to upload lambda layers. Required if deploymentBucket is not defined.
customInstallationCommand string It specify a custom command to install deps ex. MY_ENV=1 npm --proxy http://myproxy.com i -P

Default Serverless Setup

This plugin will setup follow options automatically if not specified at serverless.yml.

Option Type Default
package.individually bool false
package.exclude array ['node_modules/**']
package.excludeDevDependencies bool false

Mininal Policy permissions for CI/CD IAM users

serverless-layers-policy.json

{
   "Version":"2012-10-17",
   "Statement":[
      {
         "Effect":"Allow",
         "Action":[
            "s3:PutObject",
            "s3:GetObject"
         ],
         "Resource": "arn:aws:s3:::examplebucket"
      },
      {
         "Effect":"Allow",
         "Action":[
            "cloudformation:DescribeStacks"
         ],
         "Resource": "*"
      },
      {
         "Effect":"Allow",
         "Action":[
            "lambda:PublishLayerVersion"
         ],
         "Resource": "*"
      }
   ]
}

Contributing

Yes, thank you! This plugin is community-driven, most of its features are from different authors. Please update the docs and tests and add your name to the package.json file. We try to follow Airbnb's JavaScript Style Guide.

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.