cfn-flow 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8a7c12f98182c07a7961ddca970637d6454275a
-  data.tar.gz: 4af32ae281b4a00f55eb9a7263d56eb40fefb678
+  metadata.gz: 8e00390b3fd3c7698003efd85d99fc576e885ba3
+  data.tar.gz: 881bb3936515feb3db9801637767c13db1b2ab9e
 SHA512:
-  metadata.gz: 012e7d1fd2c3d517ef83725ef4a29ed4165669cf235a744be0481ac09cb18479b5a5e77b350b76e810b6e2eb52daa2264c0999f784bd57dcb0a2d2b59d1fb0a6
-  data.tar.gz: 1f6bfd0cb3466afa28c054dcd7c03a3dae04bc729578fb475af346f18ecb699dbf258ec306caf8c657088b09c48a3db1dcc02edd400f910d896c8a19a1749106
+  metadata.gz: 511ada328d1a675b712cb20ad14d94e01a1940fedfb5da0e196609d9dfd2845a155c09932115c1858a13c831684d1f03d316106d2bdb87ccc28f8b0c906c6eed
+  data.tar.gz: b3e5baf4a020bc72e6ada19e6e16ae758a678e3c3aded9973ced8bd6bc84b71d3ee576035cd9f35ee8d1c3bdfea1da4a44dd91f65f53b09d450a62ef5c2d43a3

data/README.md

@@ -1,7 +1,7 @@
 # cfn-flow
 An opinionated command-line workflow for developing [AWS CloudFormation](https://aws.amazon.com/cloudformation/) templates and deploying stacks.
 
-Track template changes in git and upload versioned releases to AWS S3.
+Track template changes in git and publish versioned releases to AWS S3.
 
 Deploy stacks using a standard, reliable process with extensible
 configuration in git.
@@ -10,7 +10,7 @@ configuration in git.
 
 1. *Optimize for onboarding.* The workflow should be simple to learn & understand.
 2. *Optimize for happiness.* The workflow should be easy and enjoyable to use.
-3. *Auditable history.* Know who changed what when. Leverage git for auditing.
+3. *Auditable changes.* Know who changed what when. Leverage git change history.
 4. *Immutable releases.* The code in a release never changes.
 
 ## Installation
@@ -27,6 +27,81 @@ The `git` command is also needed.
 Poke around:
 ```
 cfn-flow help
+
+cfn-flow help COMMAND
+# E.g.:
+cfn-flow help deploy
+```
+
+Launching a CloudFormation stack:
+```
+cfn-flow deploy production
+```
+
+## Configuration
+
+`cfn-flow` looks for `./cfn-flow.yml` for stack and template configuration.
+You can override this path by setting the `CFN_FLOW_CONFIG_PATH` environment
+variable to another path.
+
+Here's a minimal `cfn-flow.yml` config file:
+
+```yaml
+# Required service name
+service: MyService
+
+# Minimal configuration for launching the stack.
+stack:
+  # Stack name uses embedded ruby to support dynamic values
+  stack_name: MyService-<%= Time.now.to_i %>
+  # Required: *either* template_url or template_body
+  template_body: path/to/template.json
+  # Alternatively:
+  # template_url: https://MyS3Bucket.s3.amazonaws.com/MyPrefix/release/abc123/template.json
+```
+
+And here's a maximal config file:
+
+```yaml
+---
+# Example cfn-flow.yml
+
+service: MyService
+
+# Set the AWS region here to override or avoid setting the AWS_REGION env var
+region: us-east-1
+
+##
+# Templates
+#
+# These define where templates will get published.
+#   $ cfn-flow publish --release my-cfn-template.json
+#   Published url: https://MyS3Bucket.s3.amazonaws.com/My/S3/Prefix/<git sha>/my-cfn-template.json
+templates:
+  bucket: MyS3Bucket
+  s3_prefix: 'My/S3/Prefix'
+
+stack:
+  stack_name: MyService-<%= Time.now.to_i %>
+    template_body: path/to/template.yml
+    template_url: http://...
+    parameters:
+      # Your parameters, e.g.:
+      vpcid: vpc-1234
+      ami: ami-abcd
+    disable_rollback: true,
+    timeout_in_minutes: 1,
+    notification_arns: ["NotificationARN"],
+    capabilities: ["CAPABILITY_IAM"], # This stack does IAM stuff
+    on_failure: "DO_NOTHING", # either DO_NOTHING, ROLLBACK, DELETE
+    stack_policy_body: "StackPolicyBody",
+    stack_policy_url: "StackPolicyURL",
+    tags:
+      TagKey: TagValue
+      # Who launched this stack
+      Deployer: <%= ENV['USER'] %>
+      # Tag production and development environments for accounting
+      BillingType: <%= ENV['CFN_FLOW_ENVIRONMENT'] == 'production' ?  'production' : 'development' %>
 ```
 
 #### Dev mode (default)

data/lib/cfn-flow/cli.rb

@@ -54,6 +54,8 @@ module CfnFlow
     desc 'deploy ENVIRONMENT', 'Launch a stack'
     method_option :cleanup, type: :boolean, desc: 'Prompt to shutdown other stacks in ENVIRONMENT after launching'
     def deploy(environment)
+      # Export environment as an env var so it can be interpolated in config
+      ENV['CFN_FLOW_ENVIRONMENT'] = environment
 
       begin
         params = CfnFlow.stack_params(environment)

data/lib/cfn-flow/version.rb

@@ -1,3 +1,3 @@
 module CfnFlow
-  VERSION = '0.5.0'
+  VERSION = '0.7.0'
 end

data/spec/cfn-flow/cli_spec.rb

@@ -117,6 +117,17 @@ describe 'CfnFlow::CLI' do
       err.must_equal ''
     end
 
+    it 'exposes the environmont as an env var' do
+       Aws.config[:cloudformation]= {
+        stub_responses: {
+          describe_stacks: { stacks: [ stub_stack_data(stack_name: 'cfn-flow-spec-stack') ] },
+          describe_stack_events: { stack_events: [ stub_event_data ] },
+        }
+      }
+      _ = capture_io { cli.start [:deploy, 'test-env'] }
+      ENV['CFN_FLOW_ENVIRONMENT'].must_equal 'test-env'
+    end
+
     it 'can fail with a validation error' do
       Aws.config[:cloudformation]= {
         stub_responses: { create_stack: 'ValidationError' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfn-flow
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Aaron Suggs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk