Socket
Socket
Sign inDemoInstall

serverless-layers

Package Overview
Dependencies
70
Maintainers
1
Versions
66
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

serverless-layers

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com) [![Issues](https://img.shields.io/github/issues/agutoli/serverless-layers.svg)](https://github.com/agutoli/serverless-layers/issues) [![License](https://img.shields.io/


Version published
Maintainers
1
Weekly downloads
26,241
decreased by-0.04%

Weekly downloads

Readme

Source

serverless-layers

serverless Issues License NPM Build Status PRs Welcome Node.js CI

  • It attaches automatically layers to the provider and for each function
    • it will skip functions with no other layers as they will use the layer(s) we added to the provider
  • It creates a new layer's version when dependencies is updated
  • If dependencies is not changed, it does not publish a new layer
  • It reduces drastically lambda size
  • It reduces deployment time.
  • You can share same layers (libraries) among all lambda functions

Options

Common requirements

  • AWS only (sorry)
  • Serverless >= 1.34.0 (layers support)

Install

npm install -D serverless-layers

or

serverless plugin install --name serverless-layers

Add the plugin to your serverless.yml file:

Single layer config

Example:

plugins:
  - serverless-layers
  
custom:
  serverless-layers:
    functions: # optional
      - my_func2
    dependenciesPath: ./package.json

functions:
  my_func1:
    handler: handler.hello
  my_func2:
    handler: handler.hello

Multiple layers config

Example:

plugins:
  - serverless-layers
  
custom:
  serverless-layers:
    # applies for all lambdas 
    - common:
        dependenciesPath: ./my-folder/package.json
    # apply for foo only
    - foo:
        functions:
          - foo
        dependenciesPath: my-folder/package-foo.json
    - staticArn:
        functions:
          - foo
          - bar
        arn: arn:aws:lambda:us-east-1:<your_account>:layer:node-v13-11-0:5

functions:
  foo:
    handler: handler.hello
  bar:
    handler: handler.hello

Screen Shot 2020-04-05 at 2 04 38 pm

OptionTypeDefaultDescription
compileDirstring.serverlessCompilation directory
layersDeploymentBucketstringYou can specify a bucket to upload lambda layers. Required if deploymentBucket is not defined.
customInstallationCommandstringIt specify a custom command to install deps ex. MY_ENV=1 npm --proxy http://myproxy.com i -P
customHashstringCan specify custom string, that once changed will force a new build of the layer
retainVersionsintnullNumber of layer versions to keep, the rest versions will be removed after deployments

NodeJS

Requirements

  • Node >= v6.10.3
  • NPM >= 3.10.10
  • A valid package.json file

Options

OptionTypeDefaultDescription
packageManagerstringnpmPossible values: npm, yarn
packagePathstringpackage.json(DEPRECATED): Available for <= 1.5.0, for versions >= 2.x please use compatibleRuntimes
dependenciesPathstringpackage.jsonNote: >= 2.x versions. You can specify custom path for your package.json
compatibleRuntimesarray['nodejs']Possible values: nodejs, nodejs10.x, nodejs12.x
layerOptimization.cleanupPatternsarraycheckThe pattern of files to cleanup in the layer artifact before uploading it.

Ruby

Requirements

  • Ruby >= 2.5
  • A valid Gemfile file

Options

OptionTypeDefaultDescription
packageManagerstringbundlePossible values: bundle
dependenciesPathstringGemfileNote: Available for >= 2.x versions. You can specify custom path for your requirements.txt
compatibleRuntimesarray['ruby']Possible values: ruby2.5, ruby2.7
layerOptimization.cleanupPatternsarraycheckThe pattern of files to cleanup in the layer artifact before uploading it.

Python

Requirements

  • Python >= 2.7
  • A valid requirements.txt file

Options

OptionTypeDefaultDescription
packageManagerstringpipPossible values: pip
dependenciesPathstringrequirements.txtNote: Available for >= 2.x versions. You can specify custom path for your requirements.txt
compatibleRuntimesarray['python']Possible values: python2.7, python3.x
layerOptimization.cleanupPatternsarraycheckThe pattern of files to cleanup in the layer artifact before uploading it.

Default Serverless Setup

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

OptionTypeDefault
package.individuallyboolfalse
package.patternsarray['node_modules/**']
package.excludeDevDependenciesboolfalse

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": "*"
      }
   ]
}

License

MIT

Contributors

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.

Made with contributors-img.

Keywords

FAQs

Last updated on 08 Mar 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc