Repository files navigation

Serverless Plugin to support running againstLocalstack.

This plugin allows Serverless applications to be deployed and tested on your local machine. Any requests to AWS to be redirected to a running LocalStack instance.

Pre-requisites:

• LocalStack

The easiest way to get started is to install via npm.

npm install -g serverlessnpm install --save-dev serverless-localstack

The plugin can be configured viaserverless.yml, or alternatively via environment variables.

There are two supported methods for configuring the endpoints, globally via thehost property, or individually. These properties may be mixed, allowing forglobal override support while also override specific endpoints.

Ahost or individual endpoints must be configured, or this plugin will be deactivated.

Please refer to the example configuration template below. (Please note that most configurationsin the sample are optional and need not be specified.)

service: myServiceplugins:  - serverless-localstackcustom:  localstack:    stages:      # list of stages for which the plugin should be enabled      - local    host: http://localhost  # optional - LocalStack host to connect to    edgePort: 4566  # optional - LocalStack edge port to connect to    autostart: true  # optional - Start LocalStack in Docker on Serverless deploy    networks: #optional - attaches the list of networks to the localstack docker container after startup      - host      - overlay      - my_custom_network    lambda:      # Enable this flag to improve performance      mountCode: true  # specify either "true", or a relative path to the root Lambda mount path    docker:      # Enable this flag to run "docker ..." commands as sudo      sudo: False      compose_file: /home/localstack_compose.yml # optional to use docker compose instead of docker or localstack cli  stages:    local:      ...

The following environment variables can be configured (taking precedence over the values inserverless.yml):

• AWS_ENDPOINT_URL: LocalStack endpoint URL to connect to (default:http://localhost:4566). This is the recommended configuration, and replaces the deprecated config options (EDGE_PORT/LOCALSTACK_HOSTNAME/USE_SSL) below.
• EDGE_PORT: LocalStack edge port to connect to (deprecated; default:4566)
• LOCALSTACK_HOSTNAME: LocalStack host name to connect to (deprecated; default:localhost)
• USE_SSL: Whether to use SSL/HTTPS when connecting to the LocalStack endpoint (deprecated)

Note thestages attribute in the config above. Theserverless-localstack plugin gets activated if either:

1. the serverless stage (explicitly defined or default stage "dev") is included in thestages config; or
2. serverless is invoked without a--stage flag (default stage "dev") and nostages config is provided

Note that thelocalstack.lambda.mountCode flag above will mount the local directory intothe Docker container that runs the Lambda code in LocalStack. You can either specify the booleanvaluetrue (to mount the project root folder), or a relative path to the root Lambda mount pathwithin your project (e.g.,./functions).

If you remove this flag, your Lambda code is deployed in the traditional way which is more inline with how things work in AWS, but also comes with a performance penalty: packaging the code,uploading it to the local S3 service, downloading it in the local Lambda API, extractingit, and finally copying/mounting it into a Docker container to run the Lambda. Mounting codefrom multiple projects is not supported with simple configuration, and you must use theautostart feature, as your code will be mounted in docker at start up. If you do need tomount code from multiple serverless projects, manually launchlocalstack with volumes specified. For example:

localstack start --docker -d \  -v /path/to/project-a:/path/to/project-a \  -v /path/to/project-b:/path/to/project-b

If you use eitherserverless-webpack,serverless-plugin-typescript, orserverless-esbuild,serverless-localstackwill detect it and modify the mount paths to point to your output directory. You will need to invokethe build command in order for the mounted code to be updated. (eg:serverless webpack). There is no--watch support for this out of the box, but could be accomplished using nodemon:

npm i --save-dev nodemon

Webpack example'spackage.json:

"scripts": {"build":"serverless webpack --stage local","deploy":"serverless deploy --stage local","watch":"nodemon -w src -e '.*' -x 'npm run build'","start":"npm run deploy && npm run watch"  },

npm run start

serverless-webpack is supported, with code mounting. However, there are some assumptionsand configuration requirements. First, your output directory must be.webpack. Second, you must retainyour output directory contents. You can do this by modifying thecustom > webpack portion of yourserverless configuration file.

custom:webpack:webpackConfig:webpack.config.jsincludeModules:truekeepOutputDirectory:truelocalstack:stages:      -locallambda:mountCode:trueautostart:true

• LAMBDA_MOUNT_CWD: Allow users to define a custom working directory for Lambda mounts.For example, when deploying a Serverless app in a Linux VM (that runs Docker) on aWindows host where the-v <local_dir>:<cont_dir> flag todocker run requires usto specify alocal_dir relative to the Windows host file system that is mountedinto the VM (e.g.,"c:/users/guest/...").
• LAMBDA_EXECUTOR: Executor type to use for running Lambda functions (defaultdocker) -seeLocalStack repo
• LAMBDA_REMOTE_DOCKER: Whether to assume that we're running Lambda containers againsta remote Docker daemon (defaultfalse) - seeLocalStack repo
• BUCKET_MARKER_LOCAL: Magic S3 bucket name for Lambda mount andHot Reloading.

• serverless deploy --stage local would deploy to LocalStack.
• serverless deploy --stage production would deploy to aws.

service: myServiceplugins:  - serverless-localstackcustom:  localstack:    stages:      - local      - dev    endpointFile: path/to/file.json

For full documentation, please refer tohttps://github.com/localstack/localstack

Setting up a development environment is easy using Serverless' plugin framework.

git clone https://github.com/localstack/serverless-localstack

cd /path/to/serverless-localstacknpm linkcd myprojectnpm link serverless-localstack

An optional debug flag is supported viaserverless.yml that will enable additional debug logs.

custom:  localstack:    debug: true

• v1.3.1: prevent the mounting of code if the Lambda uses an ECR Image
• v1.3.0: add support for built-in Esbuild in Serverless Framework v4 #267
• v1.2.1: Fix custom-resource bucket compatibility with serverless >3.39.0, continue improving support forAWS_ENDPOINT_URL
• v1.2.0: Add docker-compose config and fix autostart when plugin is not active
• v1.1.3: Fix replacing host from environment variableAWS_ENDPOINT_URL
• v1.1.2: Unify construction of target endpoint URL, add support for configuringAWS_ENDPOINT_URL
• v1.1.1: Fix layer deployment ifmountCode is enabled by always packaging and deploying
• v1.1.0: Fix SSM environment variables resolving issues with serverless v3, change default forBUCKET_MARKER_LOCAL tohot-reload
• v1.0.6: AddBUCKET_MARKER_LOCAL configuration for customizing S3 bucket for lambda mount andHot Reloading.
• v1.0.5: Fix S3 Bucket LocationConstraint issue when the provider region isus-east-1
• v1.0.4: Fix IPv4 fallback check to prevent IPv6 connection issue withlocalhost on macOS
• v1.0.3: Set S3 Path addressing for internal Serverless Custom Resources - allow configuring S3 Events Notification for functions
• v1.0.2: Add check to prevent IPv6 connection issue withlocalhost on MacOS
• v1.0.1: Add support for Serverless projects with esbuild source config; enable config via environment variables
• v1.0.0: Allow specifying path for mountCode, to point to a relative Lambda mount path
• v0.4.36: Add patch to avoid "TypeError" in AwsDeploy plugin on Serverless v3.4.0+
• v0.4.35: Add config option to connect to additional Docker networks
• v0.4.33: Fix parsing StepFunctions endpoint if the endpointInfo isn't defined
• v0.4.32: Add endpoint to AWS credentials for compatibility with serverless-domain-manager plugin
• v0.4.31: Fix format of API GW endpoints printed in stack output
• v0.4.30: Fix plugin for use with Serverless version 2.30+
• v0.4.29: Add missing service endpoints to config
• v0.4.28: Fix plugin activation for variable refs in profile names
• v0.4.27: Fix loading of endpoints file with variable references to be resolved
• v0.4.26: Fix resolution of template variables during plugin initialization
• v0.4.25: Use single edge port instead of deprecated service-specific ports
• v0.4.24: Fix resolving of stage/profiles via variable expansion
• v0.4.23: Fix config loading to enable file imports; fix output of API endpoints if plugin is not activated; enable SSM and CF output refs by performing early plugin loading
• v0.4.21: Fix integration withserverless-plugin-typescript whenmountCode is enabled
• v0.4.20: UseLAMBDA_EXECUTOR/LAMBDA_REMOTE_DOCKER configurations from environment
• v0.4.19: Fix populating local test credentials in AWS provider
• v0.4.18: Fix output of API Gateway endpoints; add port mappings; fix config init code
• v0.4.17: Enable configuration of$START_WEB
• v0.4.16: Add option for running Docker as sudo; add fix for downloadPackageArtifacts
• v0.4.15: Enable plugin on aws:common:validate events
• v0.4.14: Initialize LocalStack using hooks for each "before:" event
• v0.4.13: Add endpoint for SSM; patch serverless-secrets plugin; allow customizing $DOCKER_FLAGS
• v0.4.12: Fix Lambda packaging formountCode:false
• v0.4.11: Add polling loop for starting LocalStack in Docker
• v0.4.8: Auto-create deployment bucket; autostart LocalStack in Docker
• v0.4.7: Set S3 path addressing; add eslint to CI config
• v0.4.6: Fix port mapping for service endpoints
• v0.4.5: Fix config to activate or deactivate the plugin for certain stages
• v0.4.4: AddLAMBDA_MOUNT_CWD configuration for customizing Lambda mount dir
• v0.4.3: Support local mounting of Lambda code to improve performance
• v0.4.0: Add support for local STS