Serverless Plugin Boilerplate
This project was adapted from CFVIZ. Serverless Graph outputs your serverless architecture and resources as a Graphviz dot compatible output. Currently only supports the AWS provider.
Note: Serverless v1.x.x or higher is required.
Get Started
- cd into serverless-graph and run:
npm link
- cd into your Serverless Project's root folder and run:
npm link serverless-graph
- Install graphviz
- Homebrew - brew install graphviz
- Add serverless-graph to the plugins section of your serverless.yml
Run
If you have any commandline params that don't have defaults you will have to pass in any opt variables as this plugin hooks into the package step and then reads the output
sls graph {--opts}
- Output SVG
cat graph.out | dot -Tsvg -oexample.svg
- Output PNG
cat graph.out | dot -Tpng -oexample.png
- See Graphviz for more information.
TODO: Getting started - make npm package
npm install --save serverless-graph
- Add serverless-graph to the plugins section of your serverless.yml
- Install graphviz
- Homebrew - brew install graphviz
sls graph {--opts} | dot -Tsvg -oexample.svg