cloudfoundry_blue_green_deploy 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54397c469bcc873ba16da8358aaf7659e5e0a7cd
-  data.tar.gz: 9f27071ae08a3dda2347f6371dddb242a6d8405e
+  metadata.gz: 2129061dc5383e80ad6d6cb88dddddf71f7d956f
+  data.tar.gz: 758e8c64b46156e56ba1d3ceda7a76ba1130c595
 SHA512:
-  metadata.gz: 924f6dfc9bf0c9e813629c0c5adccd0e6671be57c9d9c7c068c1074b8ecb4751b6348227c064e3b1b344f1fc1c97a9f1c3be38082dfbab9182210a9fa68d9c6d
-  data.tar.gz: e90a718e563b61cc450bc0c486c561812e26f09f5a84082a00e417bc4b145e29dc282072fac517d393dfbf1ccd31d5e4b6d3a3b79b3aa18b563926ed1a5d28bd
+  metadata.gz: c694025ce07bea6181b9858b88ccb30202187bb5cb423cebd270aa5cddd824d523651da38d53e5661481c9708133b540c6a2ee1d185d9672b4c553cb2280d627
+  data.tar.gz: cdfa76bc1dad1e760d3016177c0fcba9c5b203b5383a95cd933b5ac59e7d77a818c8dfc8aaddf258fa928dcbc3d7103f994abd334079e0e45f7e4f50596f8342

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/README.md

@@ -1,184 +1,177 @@
 # Overview
 
-Using a simple deployment process, one can introduce significant (even if planned) downtime of your application.
+Using a simple deployment process, downtime can occur. By running two identical production environments (Blue and Green), the risk of significant downtime is minimized. If you want to automate this process and minimize errors, use the Blue/Green deployment approach: http://docs.gopivotal.com/pivotalcf/devguide/deploy-apps/blue-green.html
 
-If you want to minimize this impact to your site's availability, you might opt to use the Blue/Green deployment approach: http://docs.gopivotal.com/pivotalcf/devguide/deploy-apps/blue-green.html
-
-This gem provides a Rake task to automate Blue/Green deployment to a Cloud Foundry installation.
+This gem provides a Rake task to automate Blue/Green deployment to a Cloud Foundry installation. For deployments that include migrations, there is an option to deploy a Rack-based shutter app.
 
 
 ## Installation
 
+Currently, this gem requires Ruby 2.1.x or better. It is compatible with [Cloud Foundy CLI](https://github.com/cloudfoundry/cli) versions 6.6 - 6.11.
+
 Add this line to your application's Gemfile:
 
     gem 'cloudfoundry_blue_green_deploy'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+Or download and install:
 
     $ gem install cloudfoundry_blue_green_deploy
 
-## For first deployment - where app to deploy needs to be specified
+## First Deployment
+Make sure that all services that are specified in the manifest.yml file are created before running a first deployment.
 
 ## Usage
 
-1. define the blue and green instances of your application(s) in your Cloud Foundry Manifest.  (see rules in the next section)
-2. run
+1. Define the Blue and Green instances of your application(s) in your Cloud Foundry Manifest.  (see rules in the next section)
+
+2. Run:
 
-    $ bundle exec rake cf:blue_green_deploy[web-app-name]
+        $ bundle exec rake cf:blue_green_deploy[web-app-name]
 
    Where "web-app-name" is the "name" attribute in your manifest.yml.
    The default color for first deployment is blue.
-   You may optionally specify the color that you would like to be the "live" instance on the first deployment.
 
 ### manifest.yml
 
 Your Cloud Foundry manifest file must comply with the following requirements:
 
-1. name: two application instances are required. One name ending with "-green" and another ending with "-blue"
-2. host: the url. One ending with "-green" and the other ending with "-blue"
-3. domain: required
-4. command: bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV
-5. services: Optional, only required if there are services that need to be bound
+- `name`: two application instances are required. One name ending with `-green` and another ending with `-blue`
+- `host`: the url. One ending with `-green` and the other ending with `-blue`
+- `domain`: required
+- `memory`: optional, default will be used if omitted
+- `command`: `bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV`
+- `services`: Optional, only required if there are services that need to be bound
 
 #### Bare Minimum Example:
 
 In this example:
-- Our web application is known to Cloud Foundry as "carrot-soup".
-- "carrot-soup" has a database service known as "oyster-cracker".
+Our web application is known to Cloud Foundry as `awesome-app` with a database service known as `memory-bank-db`. Its URL is `awesomeapp.cfapps.io`.
 
     ---
     applications:
-
-    - name: carrot-soup-green
-      host: la-pong-green
+    - name: awesome-app-blue
+      host: awesomeapp-blue
       domain: cfapps.io
       command: bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV
       services:
-      - oyster-cracker
+      - memory-bank-db
 
-    - name: carrot-soup-blue
-      host: la-pong-blue
+    - name: awesome-app-green
+      host: awesomeapp-green
       domain: cfapps.io
       command: bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV
       services:
-      - oyster-cracker
+      - memory-bank-db
 
 And perform a blue/green deploy like this:
 
-    $ bundle exec rake cf:blue_green_deploy[carrot-soup]
+    $ bundle exec rake cf:blue_green_deploy[awesome-app]
 
 ## Workers
 
 Non-trivial applications often require background processes to perform asynchronous jobs (e.g. sending email, importing data from external systems, etc.).
-If these applications' code are to stay in sync with the web application, they need blue/green treatment as well.
+If these applications' code are to stay in sync with the web application, they need Blue and Green treatment as well.
 
 This Rake task natively supports worker application instances.
 
 ### Usage (with Workers)
 
-1. define the blue and green instances of your application(s) and workers in your Cloud Foundry Manifest. (see rules in the next section)
-2. run:
+1. Define the Blue and Green instances of your application and workers in your Cloud Foundry Manifest. (see rules in the next section)
+2. Run:
+
+
+        $ bundle exec rake cf:blue_green_deploy[web-app-name,worker-name,another-worker-name]
 
-    $ bundle exec rake cf:blue_green_deploy[web-app-name,worker-name,another-worker-name]
 
-   Note:
-     The "web-app-name" is the "name" attribute (without a color) detailed in your manifest.yml
-     The "worker-name" and "another-worker-name" are "name" attributes for 2 separate worker apps as detailed in your manifest.yml
-     Multiple worker apps can be specified as long as they comply with the blue/green deployment requirements in the manifest.yml
+- The `web-app-name` is the `name` attribute (without a color) detailed in your manifest.yml
+- The `worker-name` and `another-worker-name` are `name` attributes for two separate worker apps as detailed in your manifest.yml
+- Multiple worker apps can be specified as long as they comply with the blue/green deployment requirements in the manifest.yml.
 
 ### manifest.yml
 
 For web application deployment (see requirements above)
 
-For worker applications
-1. name: two application instances are required. One name ending with "-green" and another ending with "-blue"
-2. command:
-3. path: Relative to the current working directory
-4. services: Optional, only required if there are services that need to be bound
+For worker applications:
+- `name`: Two application instances are required. One name ending with `-green` and another ending with `-blue`
+- `command`: Required
+- `path`: Relative to the current working directory
+- `services`: Optional, only required if there are services that need to be bound
 
 #### Example with Workers
 
 In this example:
-- Our web application is known to Cloud Foundry as "carrot-soup".
-- The app "carrot-soup" has a database service known as "oyster-cracker".
-- We have a worker application named "relish", whose database is known as "creme-fraiche".
-
-    ---
-    applications:
-
-    - name: relish-green
-      command: bundle exec rails s -p $PORT -e $RAILS_ENV
-      path: ../relish
-      services:
-      - creme-fraiche
-
-    - name: carrot-soup-green
-      host: la-pong-green
-      domain: cfapps.io
-      size: 1GB
-      path: .
-      command: bundle exec rails s -p $PORT -e $RAILS_ENV
-      services:
-      - oyster-cracker
-
-    - name: carrot-soup-blue
-      host: la-pong-blue
-      domain: cfapps.io
-      size: 1GB
-      path: .
-      command: bundle exec rails s -p $PORT -e $RAILS_ENV
-      services:
-      - oyster-cracker
-
-    - name: relish-blue
-      command: bundle exec rails s -p $PORT -e $RAILS_ENV
-      path: ../relish
-      services:
-      - creme-fraiche
-
- And perform the blue/green deploy like this:
-     $ bundle exec rake cf:blue_green_deploy[carrot-soup,relish]
-
+- Our web application is known to Cloud Foundry as `awesome-app`.
+- Its URL is `awesomeapp.cfapps.io`
+- The app `awesome-app` has a database service known as `memory-bank-db`.
+- We have a worker application named `super-queue`, whose database is known as `key-vals-db`.
+
+        ---
+        applications:
+        - name: awesome-app-blue
+          host: awesomeapp-blue
+          domain: cfapps.io
+          memory: 1GB
+          path: .
+          command: bundle exec rails s -p $PORT -e $RAILS_ENV
+          services:
+          - memory-bank-db
+
+        - name: awesome-app-green
+          host: awesomeapp-green
+          domain: cfapps.io
+          memory: 1GB
+          path: .
+          command: bundle exec rails s -p $PORT -e $RAILS_ENV
+          services:
+          - memory-bank-db
+
+        - name: super-queue-blue
+          command: bundle exec rails s -p $PORT -e $RAILS_ENV
+          path: ../super-queue
+          services:
+          - key-vals-db
+
+        - name: super-queue-green
+          command: bundle exec rails s -p $PORT -e $RAILS_ENV
+          path: ../super-queue
+          services:
+          - key-vals-db
+
+
+And perform the blue/green deploy like this:
+
+    $ bundle exec rake cf:blue_green_deploy[awesome-app, super-queue]
 
 # Blue/Green with Shutter
 
-For blue/green deployments that require a database migration this tool provides the ability to automatically shutter the app during the required downtime. To use this feature, create a shutter app and configure your manifest.yml.
+For Blue and Green deployments that require a database migration this tool provides the ability to automatically shutter the app during the required downtime. To use this feature, create a shutter app and configure your `manifest.yml`.
 
 ## Creating a Minimal Shutter App
 
 1. Add the following to your manifest.yml. Note that the name must match the name of your production application and end in -shutter.
 
-    - name: carrot-soup-shutter
-      command: bundle exec rackup config.ru -p $PORT -E $RACK_ENV
-      path: shutter-app
+        - name: awesome-app-shutter
+          command: bundle exec rackup config.ru -p $PORT -E $RACK_ENV
+          path: shutter-app
 
-2. Create a directory named "shutter-app".  In that directory:
-   1. create a Rack config (config.ru):
+2. Create a directory named `shutter-app`. In that directory:
 
-    class Message
-      def call(env)
-        [200, {"Content-Type" => "text/plain"}, ["Temporarily down for maintenance. Please check back shortly."]]
-      end
-    end
+- Create a Rack config [config.ru](https://gist.github.com/marianaIAm/4d04a20fdb6d05c64bce)
 
-    run Message.new
+- Create a minimal Gemfile:
 
-   2. create a minimal Gemfile:
+        source 'https://rubygems.org'
+        ruby '2.1.2'
 
-    source 'https://rubygems.org'
-    ruby '2.0.0'
+        gem 'rack'
 
-    gem 'rack'
-
-   3. create the Gemfile.lock by running Bundler in the "shutter-app" directory:
-
-    $ bundle install
+- Create the Gemfile.lock by running Bundler in the `shutter-app` directory:
 
+        $ bundle install
 
- - Note: as of 05/09/14 deployment using Cloud Foundry's buildpack does not appear to be compatible with ruby version 2.1.0.
- - Our fail-fast philosophy. We recommend understanding deployment on Cloud Foundry before using this tool.
 
+Our fail-fast philosophy. We recommend understanding deployment on Cloud Foundry before using this tool.

data/cloudfoundry_blue_green_deploy.gemspec

@@ -7,16 +7,17 @@ Gem::Specification.new do |spec|
   spec.name          = 'cloudfoundry_blue_green_deploy'
   spec.version       = CloudfoundryBlueGreenDeploy::VERSION
   spec.authors       = ['John Ryan and Mariana Lenetis']
-  spec.email         = ['jryan@pivotallabs.com', 'mlenetis@pivotallabs.com']
+  spec.email         = ['jryan@pivotal.io', 'mlenetis@pivotal.io']
   spec.summary       = %q{Blue-green deployment tool for Cloud Foundry.}
   spec.description   = %q{Blue-green deployment tool for Cloud Foundry. Please see readme.}
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/marianaIAm/cloudfoundry_blue_green_deploy'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.1'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'

data/lib/cloudfoundry_blue_green_deploy/cloudfoundry.rb

@@ -49,13 +49,16 @@ module CloudfoundryBlueGreenDeploy
         found_header = false
         lines.each do |line|
           line = line.split
-          if line[0] == 'host' && found_header == false
+          if !found_header && line.include?('host') && line.include?('domain') && line.include?('apps')
             found_header = true
+            @host_index = line.find_index('host')
+            @domain_index = line.find_index('domain')
+            @apps_index = line.find_index('apps')
             next
           end
 
           if found_header
-            routes << Route.new(line[0], line[1], line[2])
+            routes << Route.new(line[@host_index], line[@domain_index], line[@apps_index])
           end
         end
         routes

data/lib/cloudfoundry_blue_green_deploy/version.rb

@@ -1,3 +1,3 @@
 module CloudfoundryBlueGreenDeploy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/cloudfoundry_spec.rb

@@ -15,9 +15,11 @@ module CloudfoundryBlueGreenDeploy
         before do
           allow(CommandLine).to receive(:system).and_return(false)
         end
+
         it 'throws a CloudfoundryCliError' do
           expect{ subject }.to raise_error(CloudfoundryCliError)
         end
+
       end
     end
 
@@ -34,9 +36,11 @@ module CloudfoundryBlueGreenDeploy
         before do
           allow(CommandLine).to receive(:system).and_return(false)
         end
+
         it 'throws a CloudfoundryCliError' do
           expect{ subject }.to raise_error(CloudfoundryCliError)
         end
+
       end
     end
 
@@ -67,8 +71,8 @@ module CloudfoundryBlueGreenDeploy
           expect(subject[1].name).to eq 'carrot-soup-green'
           expect(subject[1].state).to eq 'started'
         end
-      end
 
+      end
     end
 
     describe '#routes' do
@@ -78,27 +82,49 @@ module CloudfoundryBlueGreenDeploy
       end
 
       context 'there is a route defined in the current organization' do
-        let(:cli_routes_output) {
-          <<-CLI
+        context 'the cf routes output does not include the space (cli version < 6.11)' do
+          let(:cli_routes_output) {
+            <<-CLI
         Getting routes as pivot-pong-developers@googlegroups.com ...
 
         host                 domain      apps
         pivot-pong-blue      cfapps.io   pivot-pong-staging-blue
         pivot-pong-green     cfapps.io   pivot-pong-staging-green
         la-pong              cfapps.io   pivot-pong-staging-green
-          CLI
-        }
+            CLI
+          }
 
+          it 'parses the CLI "routes" output into a collection of Route objects, one for each route' do
+            expect(subject).to be_kind_of(Array)
+            expect(subject.length).to eq 3
+            expect(subject[0].host).to eq 'pivot-pong-blue'
+            expect(subject[0].domain).to eq 'cfapps.io'
+            expect(subject[0].app).to eq 'pivot-pong-staging-blue'
+          end
 
-        it 'parses the CLI "routes" output into a collection of Route objects, one for each route' do
-          expect(subject).to be_kind_of(Array)
-          expect(subject.length).to eq 3
-          expect(subject[0].host).to eq 'pivot-pong-blue'
-          expect(subject[0].domain).to eq 'cfapps.io'
-          expect(subject[0].app).to eq 'pivot-pong-staging-blue'
         end
-      end
+        context 'the cf routes output order is changed' do
+          let(:cli_routes_output) {
+            <<-CLI
+        Getting routes as pivot-pong-developers@googlegroups.com ...
+
+        space        host               domain      apps
+        production   pivot-pong-blue    cfapps.io   pivot-pong-production-blue
+        production   pivot-pong-green   cfapps.io   pivot-pong-production-green
+        production   la-pong            cfapps.io   pivot-pong-production-green
+            CLI
+          }
+
+          it 'parses the CLI "routes" output into a collection of Route objects, one for each route' do
+            expect(subject).to be_kind_of(Array)
+            expect(subject.length).to eq 3
+            expect(subject[0].host).to eq 'pivot-pong-blue'
+            expect(subject[0].domain).to eq 'cfapps.io'
+            expect(subject[0].app).to eq 'pivot-pong-production-blue'
+          end
 
+        end
+      end
       context '"cf routes" fails with an error' do
         let(:cli_routes_output) {
           <<-CLI
@@ -108,9 +134,11 @@ module CloudfoundryBlueGreenDeploy
         Failed fetching routes.
           CLI
         }
+
         it 'throws a CloudfoundryCliError' do
           expect{ subject }.to raise_error(CloudfoundryCliError)
         end
+
       end
     end
 
@@ -130,9 +158,11 @@ module CloudfoundryBlueGreenDeploy
         before do
           allow(CommandLine).to receive(:system).and_return(false)
         end
+
         it 'throws a CloudfoundryCliError' do
           expect{ subject }.to raise_error(CloudfoundryCliError)
         end
+
       end
     end
 
@@ -152,9 +182,11 @@ module CloudfoundryBlueGreenDeploy
         before do
           allow(CommandLine).to receive(:system).and_return(false)
         end
+
         it 'throws a CloudfoundryCliError' do
           expect{ subject }.to raise_error(CloudfoundryCliError)
         end
+
       end
     end
   end

data/spec/manifest.yml

@@ -3,14 +3,14 @@ applications:
 
 - name: the-web-app-worker-green
   host: the-web-app-worker-green
-  size: 1GB
+  memory: 1GB
   command: bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV
   services:
   - creme-fraiche
 
 - name: hard-worker-green
   host: hard-worker-green
-  size: 1GB
+  memory: 1GB
   command: bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV
   services:
   - creme-fraiche
@@ -18,7 +18,7 @@ applications:
 - name: the-web-app-green
   host: the-web-url-green
   domain: cfapps.io
-  size: 1GB
+  memory: 1GB
   command: bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV
   services:
   - oyster-cracker
@@ -26,21 +26,21 @@ applications:
 - name: the-web-app-blue
   host: the-web-url-blue
   domain: cfapps.io
-  size: 1GB
+  memory: 1GB
   command: bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV
   services:
   - oyster-cracker
 
 - name: the-web-app-worker-blue
   host: the-web-app-worker-blue
-  size: 1GB
+  memory: 1GB
   command: bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV
   services:
   - creme-fraiche
 
 - name: hard-worker-blue
   host: hard-worker-blue
-  size: 1GB
+  memory: 1GB
   command: bundle exec rake cf:on_first_instance db:migrate && bundle exec rails s -p $PORT -e $RAILS_ENV
   services:
   - creme-fraiche

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudfoundry_blue_green_deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Ryan and Mariana Lenetis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2015-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,13 +68,14 @@ dependencies:
         version: '0'
 description: Blue-green deployment tool for Cloud Foundry. Please see readme.
 email:
-- jryan@pivotallabs.com
-- mlenetis@pivotallabs.com
+- jryan@pivotal.io
+- mlenetis@pivotal.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -99,7 +100,7 @@ files:
 - spec/manifest.yml
 - spec/route_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/marianaIAm/cloudfoundry_blue_green_deploy
 licenses:
 - MIT
 metadata: {}
@@ -109,9 +110,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -119,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Blue-green deployment tool for Cloud Foundry.