serverless-config-files

Serverless Config Files Plugin

A Serverless plugin to create config files to be used as variables in serverless.yml

Key features:

• Provides a command to add or append configuration
• Support for structured yml files
• The configuration files can be referenced inside serverless.yml

Table of Contents

• Getting Started
• Commands
• Using as Reference Variables in serverless.yml

Getting Started

1. Install the plugin

npm install serverless-config-files --save-dev

2. Add the plugin to your serverless configuration file

serverless.yml configuration example:

# Add serverless-config-files to your plugins:
plugins:
  - serverless-config-files

# Plugin config goes into custom:
custom:
  configFile: ~/.serverless/serverless.conf.yml

Commands

You can add simple key/value pairs i.e.

sls config-file --set foo:bar

Output

foo:bar

For structured data you can pass it like this:

sls config-file --set global.user.name:foo
sls config-file --set global.user.surname:bar
sls config-file --set environment.stage.build:33

Output

global:
  user:
    name: foo
    surname: bar

Reference Variables

Now you can use the variables from your config file as explained here https://serverless.com/framework/docs/providers/aws/guide/variables#reference-variables-in-other-files

provider:
  name: aws
  stage: stage-${file(~/.serverless/serverless.conf.yml):environment.stage.build}