Home

Welcome

The idea behind this project is to create a small number of JSON & Handlebars (.hbs) files (aka Blueprints) that can be compiled into a larger number of CFN templates. Each project has multiple JSON files describing a particular environment (i.e. Prod, QA, Dev) which is then compiled against a general blueprint which results in a CloudFormation template that can be executed.

Getting Started

The easiest way to get started with cfn-builder is to clone the example project.

$ npm install -g cfn-builder
$ git clone https://github.com/KangarooBox/cfn-builder-example.git
$ cd cfn-builder-example

You are now ready to build your first CFN template. cfn-builder comes with several handy commands that help you build and maintain your Cloudformation environment:

• cfn-build - build all of your templates once
• cfn-watch - automatically build your templates whenever they change
• cfn-update - update the AMIs to the current list according to AWS
• cfn-sync - update the S3 artifacts bucket with the latest templates and user-data

Next Steps

Visit the Blueprints Wiki page to get more information on how to modify the example files and finally, to start creating your own blueprints.