serverless-localstack
Serverless Plugin to support running against Atlassian Labs Localstack.
This plugin allows any requests to AWS to be redirected to a running Localstack instance.
WARNING: This plugin is very much WIP
Pre-requisites:
- Localstack
Installation
The easiest way to get started is to install via npm.
npm install -g serverless
npm install --save-dev serverless-localstack
Installation (without npm)
If you'd like to install serverless-localstack via source:
Clone the repository
git clone https://github.com/temyers/serverless-localstack
cd serverless-localstack
npm link
Install the plugin
Use npm link
to reference the plugin
cd project-path/
npm link serverless-localstack
Configuring
There are two ways to configure the plugin, via a JSON file or via serverless.yml. There are two supported methods for configuring the endpoints, globally via the "host" property, or individually. These properties may be mixed, allowing for global override support while also override specific endpoints.
A "host" or individual endpoints must be configured or this plugin will be deactivated.
Configuring endpoints via serverless.yml
service: myService
plugins:
- serverless-localstack
custom:
localstack:
host: http://localhost
endpoints:
S3: http://localhost:4572
DynamoDB: http://localhost:4570
CloudFormation: http://localhost:4581
Elasticsearch: http://localhost:4571
ES: http://localhost:4578
SNS: http://localhost:4575
SQS: http://localhost:4576
Lambda: http://localhost:4574
Kinesis: http://localhost:4568
Configuring endpoints via JSON
service: myService
plugins:
- serverless-localstack
custom:
localstack:
endpointFile: path/to/file.json
Only enable serverless-plugin-localstack for the listed stages
serverless deploy --stage local
would deploy to localstack.serverless deploy --stage production
would deploy to aws.
service: myService
plugins:
- serverless-localstack
custom:
localstack:
stages:
- local
- dev
endpointFile: path/to/file.json
Localstack
For full documentation, see https://bitbucket.org/atlassian/localstack
Installing via PIP
The easiest way to get started with Localstack is to install it via Python's pip.
pip install localstack
Installing via Source
Clone the repository
git clone git@bitbucket.org:atlassian/localstack.git
Running Localstack
There are multiple ways to run Localstack.
Starting Localstack via Docker
If Localstack is installed via pip
localstack start --docker
If Localstack is installed via source
make docker-run
Starting Localstack without Docker
If Localstack is installed via pip
localstack start
If Localstack is installed via source
make infra
Contributing
Setting up a development environment is easy using Serverless' plugin framework.
Clone the Repo
git clone https://github.com/temyers/serverless-localstack
Setup your project
cd /path/to/serverless-localstack
npm link
cd myproject
npm link serverless-localstack
Optional Debug Flag
An optional debug flag is supported via serverless.yml that will enable additional debug logs.
custom:
localstack:
debug: true
Publishing to NPM
yarn install
yarn version
npm login
npm publish
git push --tags