1.4.6 • Published 4 years ago

serverless-lambda-layers v1.4.6

Weekly downloads
18
License
MIT
Repository
github
Last release
4 years ago

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
OptionTypeDefaultDescription
packageManagerstringnpmPossible values: npm, yarn
compileDirstring.serverlessCompilation directory
packagePathstringpackage.jsonYou can specify custom path for your package.json
compatibleRuntimesarray['nodejs']Possible values: nodejs, nodejs8.10, nodejs10.x
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

Default Serverless Setup

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

OptionTypeDefault
package.individuallyboolfalse
package.excludearray['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": "*"
      }
   ]
}

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