Serverless Vpc Discovery

homepage icon https://github.com/amplify-education/serverless-vpc-discovery

Tracked

NPM Downloads Last Month
331
Issues
0
Stars
8
Forks
2
Watchers
8

Repo README Contents:

serverless-vpc-discovery

serverless Build Status npm version MIT licensed Codacy Badge npm downloads

The vpc discovery plugin takes the given vpc, subnet, and security group names in the serverless file to setup the vpc configuration for the lambda.

About Amplify

Amplify builds innovative and compelling digital educational products that empower teachers and students across the country. We have a long history as the leading innovator in K-12 education - and have been described as the best tech company in education and the best education company in tech. While others try to shrink the learning experience into the technology, we use technology to expand what is possible in real classrooms with real students and teachers.

Learn more at https://www.amplify.com

Getting Started

Prerequisites

Make sure you have the following installed before starting:

Also allow the lambda to have the following IAM permissions:

Installation

Run:

# From npm (recommended)
npm install serverless-vpc-discovery

# From github
npm install https://github.com/amplify-education/serverless-vpc-discovery.git

Then make the following edits to your serverless.yaml file:

plugins:
  - serverless-vpc-discovery

custom:
  vpc:
    vpcName: '${opt:env}'
    subnetNames:
      - '${opt:env}_NAME OF SUBNET'
    securityGroupNames:
      - '${opt:env}_NAME OF SECURITY GROUP'

NOTE: The naming pattern we used here was building off the vpc name for the subnet and security group by extending it with the the subnet and security group name. This makes it easier to switch to different vpcs by changing the environment variable in the command line

Running Tests

To run the test:

npm test

All tests should pass.

If there is an error update the node_module inside the serverless-vpc-discovery folder:

npm install

Deploying with the plugin

When deploying run:

serverless deploy --env 'VPC Name'

And that should be it! Good Luck!

How it Works

The vpc, subnets, and security groups are found by filtering based on a specified tag name. Vpc and subnets are found under the tag name tag:Name. Security groups are found by the name of the group under group-name.

The vpc is found first as it is used to find the subnets and security groups. Once all of the subnets and security groups are found the serverless service provider creates a vpc object and stores the subnets and security groups.

Responsible Disclosure

If you have any security issue to report, contact project maintainers privately. You can reach us at github@amplify.com

Contributing

We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you:

  1. For any sizable change, first open a GitHub issue to discuss your idea.
  2. Create a pull request. Explain why you want to make the change and what it’s for. We’ll try to answer any PR’s promptly.