Need help with serverless-prune-plugin?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

claygregory
224 Stars 9 Forks MIT License 66 Commits 1 Opened issues

Description

Serverless 1.x plugin to reap unused versions of deployed functions from AWS

Services available

!
?

Need anything else?

Contributors list

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 targets Serverless 1.x.

Serverless Build Status Coverage Status

Installation

Install with npm:

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

And then add the plugin to your

serverless.yml
file:
yaml
plugins:
  - serverless-prune-plugin

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

sh
sls plugin install -n serverless-prune-plugin

Usage

In the project root, run:

sh
sls prune -n 

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:

sh
sls prune -n  -f helloWorld

Region/Stage

The previous usage examples prune the default stage in the default region. Use

--stage
and
--region
to specify:
sh
sls prune -n  --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.

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:

sh
sls prune -n  --dryRun

Additional Help

See:

sh
sls prune --help

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.