cf_deployer 1.2.8 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2678998aaac0ea19f9aa0694359f9a54b92331a5
-  data.tar.gz: 62266fe192f394c3f1abc15c0002742a09add738
+  metadata.gz: 4084bea273ad75869cd75c03ba6c6eb98496b2dc
+  data.tar.gz: ce1a68d375d5058e6b1c4d7cb8566542c7499bab
 SHA512:
-  metadata.gz: 65bc63a0d516b1aa7a77c94d8cb4269a1231f81c062ea0716c5d737e703eed7cd862c6b04a9dd9a51b38fda39552886161a194602a83defe7436ad9e5e7edd02
-  data.tar.gz: 0150e15aa2782cb98d65d7da9439c63724224810eb8eb8b186dbff765157b717b6bd750bceb6a3d18f933f862d5bcec2c0f13fabfb3f01fbf9a38be3d61a0a42
+  metadata.gz: 0227d848398efd43b2a8a007e159ff1cbbce34172f0fa592ca1b7d49e3bc8c0cdc01291946c09439541ab6d50b9efa49b5ca658188df0c71c00ef32f494cf1f7
+  data.tar.gz: 78932f8530e973d070eaa01565b0fd457db7718720a21ac2bd0390147ac7266d9e0ecc4589cfd6a4b30a6abf7a63aba788151bd62b8512ae5cb25493b2ab653f

data/ChangeLog.md

@@ -14,3 +14,12 @@ version 1.2.7
 
 version 1.2.8
   - Removed configure option validion at root level. Now users can have their own options at the root level in cf_deployer.yml file.
+
+version 1.2.9
+  - Support notify option in cf_deployer.yml, which can be set to ARNs of AWS topics to get notification of events of cloud-formation stacks.
+
+version 1.2.10
+  - Update DETAILS.md
+
+version 1.2.11
+  - Remove record set in R53 when stacks are deployed 

data/DETAILS.md

@@ -50,7 +50,7 @@ in the examples below
 
 For Blue/Green deployments keep-previous-stack is defaulted to true.
 This means that after a deployment, the previous deployed stack will be kept.
-For non-production environment, you may set it to false to delete the previous stack 
+For non-production environment, you may set it to false to delete the previous stack
 after a deployment for saving cost.
 
 If the CloudFormation template has the output named 'AutoScalingGroupName'
@@ -78,22 +78,56 @@ There are 3 strategies for deploying with cf_deployer:
 Used by the gem for blue/green deployments and naming conventions
 
   * **For all deploys - These are the settings you can use**
-    * application
-    * component
-    * environment
     * dns-driver (defaults to CfDeployer::Driver::Route53)
     * keep-previous-stack (True/False: for Cname-Swap and Auto Scaling Group Swap, previous stack will be kept after new stack is created by default. Set it to false to delete the previous stack)
     * raise-error-for-unused-inputs (True/False: it is false by default. If it is set to true, errors will be thrown if there are any inputs which are not used as parameters of CloudFormation json templates. If it is set to false or the setting does not exist, warnings will be printed in the console if there are un-used inputs.)
-    * auto-scaling-group-swap-name-output
+    * auto-scaling-group-name-output
   * **For Components Using the Cname-Swap Deployment Strategy**
-    * dns-fqdn
-    * dns-zone
+    * dns-fqdn (DNS record set name, for example, myApp.api.abc.com)
+    * dns-zone (DNS hosted zone, for example, api.abc.com)
     * elb-name-output
 
 ##### Inputs:
 Used by CloudFormation in the JSON template (Note: Settings can be used as inputs, but inputs are not used as settings).  These can be almost anything.  They are defined in the **Parameters** block in the CF template.
 
 
+
+=================
+### Tagging Your Stacks
+
+You can use tags option to tag your application. The root level tags will be applied to all the components.
+The component level tags will be only applied to that component. When a component with tags is deploying, the co-responding cloud-formation stack and auto-scaling groups and ec2 instances within the stack will be tagged with the tags of the component.
+
+```
+tags:
+  project: my-project
+  environment: <%= environment %>
+  ownerEmail: awesome@domain.com
+components:
+  web:
+    capabilities:
+      - CAPABILITY_IAM
+    tags:
+      component: web
+
+```
+
+=================
+### Get notification of events of cloud-formation stacks
+
+You can create ASW SNS topics and set the notify option to the ARNs of the topics to get notification of the events of cloud-formation stacks.
+The notify option can be set to a string or an array of strings.
+
+```
+notify: arn:foo:boo:mytopic
+components:
+  web:
+    notify: arn:web:topic
+environments:
+  prod:
+    notify: arn:only-prod:topic
+
+```
 ==================
 ### How Termination Works
 
@@ -115,22 +149,6 @@ Components may be deleted several different ways:
     instances
 
 
-=================
-### Tagging Your Stacks
-
-Tags for cf_deployer:application, cf_deployer:environment, and cf_deployer:component are automatically added to the CF stack by cf_deployer. To add your own tags:
-
-```
-components:
-  web:
-    capabilities:
-      - CAPABILITY_IAM
-    tags:
-      Team:  Team Awesome
-      OwnerEmail: awesome@domain.com
-
-```
-
 ==============
 ### Hooks
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cf_deployer (1.2.8)
+    cf_deployer (1.2.11)
       aws-sdk
       log4r
       rainbow
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-sdk (1.41.0)
+    aws-sdk (1.44.0)
       json (~> 1.4)
       nokogiri (>= 1.4.4)
     coderay (1.1.0)

data/lib/cf_deployer/config_loader.rb

@@ -16,11 +16,13 @@ module CfDeployer
       @config[:settings] ||= {}
       @config[:environments] ||= {}
       @config[:tags] ||= {}
+      @config[:notify] ||= []
       get_targets
       copy_config_dir
-      merge_section(:settings)
-      merge_section(:inputs)
-      merge_section(:tags)
+      merge_hash(:settings)
+      merge_hash(:inputs)
+      merge_hash(:tags)
+      merge_array(:notify)
       copy_region_app_env_component
       get_cf_template_keys('Parameters')
       get_cf_template_keys('Outputs')
@@ -37,8 +39,25 @@ module CfDeployer
       raise ApplicationError.new("The config file is not a valid yaml file")
     end
 
+    def merge_array(section)
+      root_value = to_array(@config[section])
+      environment_name = @config[:environment] || ''
+      environment = @config[:environments][environment_name.to_sym] || {}
+      environment_value = to_array(environment[section])
+      @config[:components].each do |component_name, component|
+        component_value = to_array(component[section])
+        component[section] = root_value + component_value + environment_value
+        component[section].uniq!
+      end
+    end
+
+    def to_array(value)
+      return value if value.is_a?(Array)
+      return [] unless value
+      [value]
+    end
 
-    def merge_section(section)
+    def merge_hash(section)
       merge_component_options section
       merge_environment_options(@config[:environment], section)
       merge_environment_variables section

data/lib/cf_deployer/config_validation.rb

@@ -6,7 +6,7 @@ module CfDeployer
 
     CommonInputs = [:application, :environment, :component, :region]
     EnvironmentOptions = [:settings, :inputs, :tags, :components]
-    ComponentOptions = [:settings, :inputs, :tags, :'depends-on', :'deployment-strategy', :'before-destroy', :'after-create', :'after-swap', :'defined_outputs', :'defined_parameters', :config_dir, :capabilities]
+    ComponentOptions = [:settings, :inputs, :tags, :'depends-on', :'deployment-strategy', :'before-destroy', :'after-create', :'after-swap', :'defined_outputs', :'defined_parameters', :config_dir, :capabilities, :notify]
 
     def validate config, validate_inputs = true
       @config = config

data/lib/cf_deployer/deployment_strategy/auto_scaling_group_swap.rb

@@ -71,14 +71,12 @@ module CfDeployer
 
       end
 
-    
       def stack_active?(stack)
         return false unless stack.exists?
         get_active_asg(stack).any?
       end
 
 
-      
       def get_active_asg stack
         return [] unless stack && stack.exists?
         group_ids(stack).select do |id|

data/lib/cf_deployer/deployment_strategy/blue_green.rb

@@ -9,8 +9,12 @@ module CfDeployer
       def destroy
         delete_stack green_stack
         delete_stack blue_stack
+        destroy_post
       end
 
+      def destroy_post
+        #overwrite in sub class
+      end
 
       def output_value(key)
         active_stack ? active_stack.output(key) : "The value will be referenced from the output #{key} of undeployed component #{component_name}"

data/lib/cf_deployer/deployment_strategy/cname_swap.rb

@@ -28,6 +28,10 @@ module CfDeployer
         Log.info "#{component_name} switched successfully"
       end
 
+      def destroy_post
+        dns_driver.delete_record_set(dns_zone, dns_fqdn) 
+      end
+
       private
 
 

data/lib/cf_deployer/driver/route53_driver.rb

@@ -5,22 +5,20 @@ module CfDeployer
         @aws_route53 = aws_route53 || AWS::Route53.new
       end
 
-      def find_alias_target(target_zone_name, target_host_name)
-        target_zone = @aws_route53.hosted_zones.find { |z| z.name == trailing_dot(target_zone_name.downcase) }
-        raise ApplicationError.new('Target zone not found!') if target_zone.nil?
-
-        target_host = target_zone.resource_record_sets.find { |r| r.name == trailing_dot(target_host_name.downcase) }
-        return nil if target_host.nil? || target_host.alias_target.nil?
-
-        remove_trailing_dot(target_host.alias_target[:dns_name])
+      def find_alias_target(hosted_zone_name, target_host_name)
+        hosted_zone = get_hosted_zone(hosted_zone_name)
+        raise ApplicationError.new('Target zone not found!') if hosted_zone.nil?
+        record_set = get_record_set(hosted_zone, target_host_name)
+        return nil if record_set.nil? || record_set.alias_target.nil?
+        remove_trailing_dot(record_set.alias_target[:dns_name])
       end
 
-      def set_alias_target(target_zone_name, target_host_name, elb_hosted_zone_id, elb_dnsname)
-        Log.info "set alias target --Hosted Zone: #{target_zone_name} --Host Name: #{target_host_name} --ELB DNS Name: #{elb_dnsname} --ELB Zone ID: #{elb_hosted_zone_id}"
-        target_zone_name = trailing_dot(target_zone_name)
+      def set_alias_target(hosted_zone_name, target_host_name, elb_hosted_zone_id, elb_dnsname)
+        Log.info "set alias target --Hosted Zone: #{hosted_zone_name} --Host Name: #{target_host_name} --ELB DNS Name: #{elb_dnsname} --ELB Zone ID: #{elb_hosted_zone_id}"
+        hosted_zone_name = trailing_dot(hosted_zone_name)
         target_host_name = trailing_dot(target_host_name)
-        target_zone = @aws_route53.hosted_zones.find { |z| z.name == target_zone_name }
-        raise ApplicationError.new('Target zone not found!') if target_zone.nil?
+        hosted_zone = @aws_route53.hosted_zones.find { |z| z.name == hosted_zone_name }
+        raise ApplicationError.new('Target zone not found!') if hosted_zone.nil?
 
         change = {
           action: "UPSERT",
@@ -36,7 +34,7 @@ module CfDeployer
         }
 
         batch = {
-          hosted_zone_id: target_zone.path,
+          hosted_zone_id: hosted_zone.path,
           change_batch: {
             changes: [change]
           }
@@ -47,6 +45,14 @@ module CfDeployer
         end
       end
 
+      def delete_record_set(hosted_zone_name, target_host_name)
+        hosted_zone = get_hosted_zone(hosted_zone_name)
+        return unless hosted_zone
+        record_set = get_record_set(hosted_zone, target_host_name)
+        CfDeployer::Driver::DryRun.guard "Skipping Route53 DNS delete" do
+          record_set.delete if record_set
+        end
+      end
       private
 
       def change_resource_record_sets_with_retry(batch)
@@ -65,6 +71,14 @@ module CfDeployer
         raise ApplicationError.new('Failed to update Route53 alias target record!')
       end
 
+      def get_hosted_zone(zone_name)
+        @aws_route53.hosted_zones.find { |z| z.name == trailing_dot(zone_name.downcase) }
+      end
+      
+      def get_record_set(hosted_zone, target_host_name)
+       hosted_zone.resource_record_sets.find { |r| r.name == trailing_dot(target_host_name.downcase) }
+      end
+
       def trailing_dot(text)
         return text if text[-1] == '.'
         "#{text}."

data/lib/cf_deployer/stack.rb

@@ -19,10 +19,11 @@ module CfDeployer
       config_dir = @context[:config_dir]
       template = CfDeployer::ConfigLoader.component_json(@component, @context)
       capabilities = @context[:capabilities] || []
-      tags = @context[:tags] || []
+      notify = @context[:notify] || []
+      tags = @context[:tags] || {}
       params = to_str(@context[:inputs].select{|key, value| @context[:defined_parameters].keys.include?(key)})
       CfDeployer::Driver::DryRun.guard "Skipping deploy" do
-        exists? ? update_stack(template, params, capabilities, tags) : create_stack(template, params, capabilities, tags)
+        exists? ? update_stack(template, params, capabilities, tags) : create_stack(template, params, capabilities, tags, notify)
       end
     end
 
@@ -106,11 +107,12 @@ module CfDeployer
       wait_for_stack_op_terminate
     end
 
-    def create_stack(template, params, capabilities, tags)
+    def create_stack(template, params, capabilities, tags, notify)
       Log.info "Creating stack #{@stack_name}..."
       @cf_driver.create_stack template,
                               :disable_rollback => true,
                               :capabilities => capabilities,
+                              :notify => notify,
                               :tags => reformat_tags(tags),
                               :parameters => params
       wait_for_stack_op_terminate

data/lib/cf_deployer/version.rb

@@ -1,3 +1,3 @@
 module CfDeployer
-  VERSION = "1.2.8"
+  VERSION = "1.2.11"
 end

data/spec/unit/config_loader_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 describe "load config settings" do
 
   before :each do
+    Dir.mkdir 'tmp' unless Dir.exists?('tmp')
     @config_file = File.expand_path("../../../tmp/test_config.yml", __FILE__)
     @base_json = File.expand_path("../../../tmp/base.json", __FILE__)
     @api_json = File.expand_path("../../../tmp/api.json", __FILE__)
@@ -69,8 +70,12 @@ application: myApp
 components:
   base:
     deployment-strategy: create-or-update
+    tags:
+      component: base
     inputs:
       foobar: <%= environment %>.IsGreat
+    notify:
+      - arn:base
   api:
     deployment-strategy: auto-scaling-group-swap
     depends-on:
@@ -79,8 +84,10 @@ components:
       require-basic-auth: true
       timeout: 90
       mail-server: http://api.abc.com
+    notify: arn:api
   front-end:
     deployment-strategy: cname-swap
+    notify: arn:base
     depends-on:
       - base
       - api
@@ -97,12 +104,18 @@ inputs:
   mail-server: http://abc.com
   cname: myserver.com
 
+notify: 
+  - arn:root
+
+tags:
+  version: v1.1
 
 environments:
   dev:
     inputs:
       mail-server: http://dev.abc.com
       timeout: 60
+    notify: arn:dev
   production:
     inputs:
       requires-basic-auth: true
@@ -167,6 +180,28 @@ environments:
     config[:components][:'front-end'][:config_dir].should eq(config_dir)
   end
 
+  it "notify option should be merged to component context" do
+    config =  CfDeployer::ConfigLoader.new.load({:'config-file' => @config_file, :environment => 'dev'})
+    config[:components][:base][:notify].should eq(['arn:root', 'arn:base', 'arn:dev'])
+    config[:components][:api][:notify].should eq(['arn:root', 'arn:api', 'arn:dev'])
+    config[:components][:'front-end'][:notify].should eq(['arn:root', 'arn:base', 'arn:dev'])
+  end
+  
+  it "notify option should be merged to environment context" do
+    config =  CfDeployer::ConfigLoader.new.load({:'config-file' => @config_file, :environment => 'uat'})
+    config[:components][:base][:notify].should eq(['arn:root', 'arn:base'])
+    config[:components][:api][:notify].should eq(['arn:root', 'arn:api'])
+    config[:components][:'front-end'][:notify].should eq(['arn:root', 'arn:base'])
+  end
+
+  it "tags option should be copied to component context" do
+    config =  CfDeployer::ConfigLoader.new.load({:'config-file' => @config_file, :environment => 'uat'})
+    config[:components][:api][:tags].should eq({:version => 'v1.1'})
+    config[:components][:base][:tags].should eq({:version => 'v1.1', :component => 'base'})
+    config[:components][:'front-end'][:tags].should eq({:version => 'v1.1'})
+  end
+
+
   it "component's settings should be merged to common settings" do
     config =  CfDeployer::ConfigLoader.new.load({:'config-file' => @config_file, :environment => 'uat'})
     config[:components][:api][:inputs][:'timeout'].should eq(90)

data/spec/unit/config_validation_spec.rb

@@ -13,6 +13,7 @@ describe "Config Validation" do
         :base => {
           :inputs => {:time_out => 30, :mail_server =>'abc'},
           :defined_outputs => {:VPCID => {}},
+          :notify => [ 'arn1', 'arn2'],
           :defined_parameters => {:mail_server => {}, :time_out => {}}
         },
         :web => {
@@ -20,6 +21,7 @@ describe "Config Validation" do
           :config_dir => 'samples/simple',
           :'before-destroy'=> "puts 'destroying'",
           :capabilities => ['CAPABILITIES_IAM'],
+          :notify => 'arn1',
           :'after-create' => {
             :file => "after_create_hook.rb",
             :timeout => 30

data/spec/unit/deployment_strategy/cname_swap_spec.rb

@@ -64,6 +64,7 @@ describe CfDeployer::DeploymentStrategy::CnameSwap do
       allow(before_destroy_hook).to receive(:run) do |arg|
         @log += "#{arg[:parameters][:name]} deleted."
       end
+      expect(dns_driver).to receive(:delete_record_set).with('foobar.com', 'test.foobar.com')
       cname_swap.destroy
       @log.should eq('green deleted.blue deleted.')
     end
@@ -208,6 +209,7 @@ describe CfDeployer::DeploymentStrategy::CnameSwap do
       cname_swap = CfDeployer::DeploymentStrategy.create('myapp', 'dev', 'web', @context)
       expect(blue_stack).to receive(:delete)
       expect(green_stack).to receive(:delete)
+      expect(dns_driver).to receive(:delete_record_set).with('foobar.com', 'test.foobar.com')
       cname_swap.destroy
     end
   end

data/spec/unit/hook_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 describe CfDeployer::Hook do
   before :all do
+    Dir.mkdir 'tmp' unless Dir.exists?('tmp')
     @file = File.expand_path("../../../tmp/test_code.rb", __FILE__)
   end
   it 'should eval string as hook' do

data/spec/unit/stack_spec.rb

@@ -8,14 +8,24 @@ describe CfDeployer::Stack do
 
   context '#deploy' do
     it 'should call CfDeployer::ConfigLoader.component_json to get the JSON for the stack' do
-      config = { :inputs => { :foo => 'foo' },
-                 :defined_parameters => { :bar => 'bar' },
+      config = { :inputs => { :foo => :bar, :goo => :hoo },
+                 :tags => { :app => 'app1', :env => 'dev'},
+                 :defined_parameters => { :foo => 'bar' },
+                 :notify => ['topic1_arn', 'topic2_arn'],
                  :cf_driver => @cf_driver }
-      CfDeployer::ConfigLoader.should_receive(:component_json).with('web', config)
+      template = { :resourses => {}}
+      allow(CfDeployer::ConfigLoader).to receive(:component_json).with('web', config).and_return(template)
       allow(@cf_driver).to receive(:stack_exists?) { false }
       allow(@cf_driver).to receive(:stack_status) { :create_complete }
+      expected_opt = { :disable_rollback => true,
+        :capabilities => [],
+        :notify => ['topic1_arn', 'topic2_arn'],
+        :tags => [{'Key' => 'app', 'Value' => 'app1'},
+                  {'Key' => 'env', 'Value' => 'dev'}],
+        :parameters => {:foo => 'bar'}
+      }
+      expect(@cf_driver).to receive(:create_stack).with(template, expected_opt)
       stack = CfDeployer::Stack.new('test','web', config)
-      allow(stack).to receive(:create_stack)
       stack.deploy
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cf_deployer
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.11
 platform: ruby
 authors:
 - Jame Brechtel
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Support multiple components deployment using CloudFormation templates with