StackFormation dev-master Documentation

Lightweight AWS CloudFormation Stack, Template and Parameter Manager and Preprocessor

Deploying CloudFormation stacks to AWS can be done using the AWS Console, AWS Cli or any SDK. While this is perfectly ok it can be a challenge to keep track of what template is used for what stack and manage the input parameters. This is where “StackFormation” comes in.

StackFormation (note the wordplay: CloudFormation / Stacks) will read blueprint.yml files that contains information about stacks, the templates they use and their input parameters. It also allows you to query values for input parameters from other stack’s resources or outputs. In addition to that StackFormation makes it easy to embed scripts into UserData.

If you have any questions please feel free to contact us:

• Fabrizio Branca
• Julian Kleinhans

This version of the documentation covering StackFormation dev-master has been rendered at: Feb 22, 2018

Getting started Documentation

• Getting Started
  • Installation/Usage
    • Via composer
    • Via docker
    • Using the phar
  • Quickstart
    • AWS access keys
    • Create a blueprint
    • Create a CloudFormation template
    • Deploy your stack
  • Kickstart a project
    • Installation
    • Required environment settings
    • Short check
    • Your first blueprint
    • Deploy your stack

StackFormation Documentation

• Blueprints
  • Structuring your blueprints
  • Parameters
    • Adding parameters
    • Parameter values
    • Conditional parameter values
  • Wildcards
  • Effective stackname
  • Reverse blueprint match
  • Forcing ENV vars
• Templates
  • Template merging
    • Prefixed template merging
  • Inject Parameters
  • Include file content
  • Inject raw Json
  • Using composer
  • Comments
  • Port
  • Expand strings with {Ref:…}
• Stack references
• User data
  • Inject user data
• Stack
  • Stackname filter
• Stack policies
  • Using stack policies
• Functions
  • Fn::FileContent
  • Fn::FileContentTrimLines
  • Fn::FileContentMinify
  • Fn::FileContentUnpretty
  • Fn::Split
• File paths
  • Relative file paths
• Shell commands
  • Before
  • After
  • Before and after
• AWS Sdk
• Misc

User Documentation

• Contributing
  • Contributors

License

Open Software License v. 3.0 (OSL-3.0)