serverless-prune-plugin

What is serverless-prune-plugin?

The serverless-prune-plugin is a Serverless Framework plugin that helps manage and clean up old AWS Lambda function versions and their associated artifacts. This is particularly useful for keeping your AWS environment tidy and avoiding hitting AWS limits on the number of Lambda versions.

What are serverless-prune-plugin's main functionalities?

Prune Old Versions

This feature allows you to automatically prune old versions of your Lambda functions, keeping only the most recent versions. In this example, the configuration keeps the last 3 versions of each function.

{
  "plugins": ["serverless-prune-plugin"],
  "custom": {
    "prune": {
      "automatic": true,
      "number": 3
    }
  }
}

Manual Pruning

This feature allows you to manually prune old versions of your Lambda functions. In this example, automatic pruning is disabled, giving you control over when to prune old versions.

{
  "plugins": ["serverless-prune-plugin"],
  "custom": {
    "prune": {
      "automatic": false
    }
  }
}

Custom Prune Command

This feature allows you to define a custom prune command in your package.json scripts. In this example, running `npm run prune` will keep the last 5 versions of each function.

{
  "scripts": {
    "prune": "serverless prune -n 5"
  }
}

Other packages similar to serverless-prune-plugin

serverless-lambda-prune-plugin

The serverless-lambda-prune-plugin is another Serverless Framework plugin that focuses on pruning old Lambda versions. It offers similar functionality to serverless-prune-plugin but may have different configuration options and defaults.

README

Serverless Prune Plugin

Following deployment, the Serverless Framework does not purge previous versions of functions from AWS, so the number of deployed versions can grow out of hand rather quickly. This plugin allows pruning of all but the most recent version(s) of managed functions from AWS. This plugin is compatible with Serverless 1.x and higher.

Installation

Install with npm:

npm install --save-dev serverless-prune-plugin

And then add the plugin to your serverless.yml file:

plugins:
  - serverless-prune-plugin

Alternatively, install with the Serverless plugin command (Serverless Framework 1.22 or higher):

sls plugin install -n serverless-prune-plugin

Usage

In the project root, run:

sls prune -n <number of version to keep>

This will delete all but the n-most recent versions of each function deployed. Versions referenced by an alias are automatically preserved.

Single Function

A single function can be targeted for cleanup:

sls prune -n <number of version to keep> -f helloWorld

Region/Stage

The previous usage examples prune the default stage in the default region. Use --stage and --region to specify:

sls prune -n <number of version to keep> --stage production --region eu-central-1

Automatic Pruning

This plugin can also be configured to run automatically, following a deployment. Configuration of automatic pruning is within the custom property of serverless.yml. For example:

custom:
  prune:
    automatic: true
    number: 3

To run automatically, the automatic property of prune must be set to true and the number of versions to keep must be specified. It is possible to set number to 0. In this case, the plugin will delete all the function versions (except $LATEST); this is useful when disabling function versioning for an already-deployed stack.

Layers

This plugin can also prune Lambda Layers in the same manner that it prunes functions. You can specify a Lambda Layer, or add the flag, includeLayers:

custom:
  prune:
    automatic: true
    includeLayers: true
    number: 3

Dry Run

A dry-run will preview the deletion candidates, without actually performing the pruning operations:

sls prune -n <number of version to keep> --dryRun

Additional Help

See:

sls prune --help

Permissions Required

To run this plugin, the user will need to be allowed the following permissions in AWS:

• lambda:listAliases
• lambda:listVersionsByFunction
• lambda:deleteFunction
• lambda:listLayerVersions
• lambda:deleteLayerVersion

Common Questions

How do I set up different pruning configurations per region/stage?

Several suggestions are available in this thread.

Can I just disable versioning entirely?

Absolutely. While Serverless Framework has it enabled by default, versioning can be disabled.

License

Copyright (c) 2017 Clay Gregory. See the included LICENSE for rights and limitations under the terms of the MIT license.