serverless-prune-plugin

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

Github星跟蹤圖

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:

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.

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

See Also

The Serverless Autoprune Plugin by arabold performs a similar role, but targets Serverless 0.5.x projects.

License

See the included LICENSE for rights and limitations under the terms of the MIT license.

主要指標

概覽
名稱與所有者claygregory/serverless-prune-plugin
主編程語言JavaScript
編程語言JavaScript (語言數: 1)
平台
許可證MIT License
所有者活动
創建於2017-01-14 02:05:36
推送於2025-02-18 01:04:17
最后一次提交2024-10-16 00:54:12
發布數27
最新版本名稱v.2.1.0 (發布於 )
第一版名稱v1.0.0 (發布於 )
用户参与
星數365
關注者數9
派生數34
提交數117
已啟用問題?
問題數38
打開的問題數9
拉請求數34
打開的拉請求數4
關閉的拉請求數3
项目设置
已啟用Wiki?
已存檔?
是復刻?
已鎖定?
是鏡像?
是私有?