Enterprise Plugin

The Serverless Enterprise Plugin

user  

serverless

Serverless Framework Enterprise Plugin

Build Status license coverage Known Vulnerabilities

To enable the various features of the Serverless Framework Enterprise for a particular Service you must deploy or redeploy that Service, using Serverless Framework open-source CLI version 1.45.1 or later.

  • If you are an existing Serverless Framework Enterprise dashboard user and have a previously deployed Service that you now want to configure to use Serverless Insights, Safeguards, Secrets or other Enteprise features, follow these steps to update an existing Service
  • If you are new to the Serverless Framework open source CLI or Serverless Framework Enterprise simply follow the steps in this new user getting started guide to get up and running

Upon deployment, the Serverless Framwork Enteprise Plugin will automatically wrap and instrument your functions to work with the Serverless Framework Enterprise dashboard.

Dev notes

Install dependencies

npm i
cd sdk-js
npm i
cd -

Build

sdk-js needs to be compile, & tests use the dist build for integration purposes.

npm run build

Test

npm t
cd sdk-js
npm t
cd -
npm run integration-test

Using your checked out version of the plugin for test/dev purposes:

First build & link your plugin globally:

npm run build
npm link

Then clone & link sls & link the plugin into sls:

git clone https://github.com/serverl/serverless
cd serverless
npm i
npm link
npm link @serverless/enterprise-plugin

If you need to work with a development version of the platform SDK too, in the sdk, run:

npm run build
npm link

and then in both serverless & this plugin, run npm link @serverless/platform-sdk

Release process

  • Create a PR updating version in package.json
  • Create a draft release on github with a change log
  • Have it approved & merge
  • Publish the release, Travis CI will publish it to NPM
  • Verify the release is in the versions tab of NPM
view on Github

Latest commit b2f54ec on Sep 24, 2017

New to serverless?

To get started, pop open your terminal & run:

npm install serverless -g