conan 0.2.0 → 0.2.1

data/README.md

@@ -1,9 +1,109 @@
-Conan The Deployer
+Conan the Deployer
 ==================
 
-Conan will set up a project to enable you to configure servers using Chef via Capistrano.
+Conan was conceived and developed to facilitate the deployment of a Rails
+application to one or more EC2 instances without the need for any additional
+centralised infrastructure. It glues together Capistrano and Chef and some
+common assumptions to make it easy to capture the environment of an application
+in the source repository.
 
+What it is
+----------
+
+* Some Capistrano extensions
+* Template files and directories
+
+What Conan does
+---------------
+
+Short version: it lets you set up a server and deploy your application in one line:
+
+    cap production configure deploy
+
+Longer version:
+
+* It creates a `Capfile` and `config/deploy.rb` for Capistrano
+* It adds some files
+* It adds a Git submodule with Chef cookbooks
+* It knows how to merge together JSON files describing servers and roles
+
+Assumptions:
+
+* You have a Rails 2.3.x or 3.x.x project that uses Bundler.
+* You keep your project in a Git repository.
+* You have staging and production servers (this can be changed).
+* You have SSH access to some Ubuntu servers and can sign in and `sudo` as `ubuntu` (this is presently a hard requirement, but is not fundamental).
+
+How to use it
+-------------
+
+    gem install conan
     cd /path/to/rails/app
     conan init
 
-Follow the instructions to complete configuration.
+Follow the instructions to complete configuration: this mainly consists of
+editing TODOs in newly added files. See the section *Roles and configuration*
+below for more details.
+
+To set up the server using Chef Solo, use:
+
+    cap staging configure
+
+And to deploy (including running migrations):
+
+    cap staging deploy
+
+Stages
+------
+
+The default configuration assumes that you have a staging and production server
+(or servers), and that you deploy the `master` branch to staging, test staging,
+and deploy the same branch to production. To achieve this, Conan tags your
+deployments with `(stage name).last-deploy`. If a deployment succeeds, it is
+tagged with `(stage name).last-successful-deploy`. A happy deployment path is thus:
+
+    master                         => staging.last-deploy
+    staging.last-deploy            => staging.last-successful-deploy
+    staging.last-successful-deploy => production.last-deploy
+    production.last-deploy         => production.last-successful-deploy
+
+Roles and configuration
+-----------------------
+
+The concept of *roles* is fundamental to Conan. `config/servers.json` describes
+the available servers and their roles, whilst `deploy/chef/dna/*.json`
+specifies the configuration specific to each role. The stage (`staging`,
+`production`, etc.) can be considered a special case of role for practical
+purposes.
+
+Here is an example `config/servers.json`:
+
+    {
+      "staging": {
+        "ec2-A-A-A-A.compute-1.amazonaws.com": {
+          "roles": ["app", "db", "staging"],
+          "alias": "staging"
+        }
+      },
+      "production": {
+        "ec2-B-B-B-B.compute-1.amazonaws.com": {
+          "roles": ["app", "db", "production"],
+          "alias": "app1"
+        },
+        "ec2-C-C-C-C.compute-1.amazonaws.com": {
+          "roles": ["app", "production"],
+          "alias": "app2"
+        }
+      }
+    }
+
+In this scenario, the configuration for the staging server will be produced by merging:
+
+* `base.json`
+* `app.json`
+* `db.json`
+* `staging.json`
+
+Furthermore, this server will have the `app` and `db` roles in Capistrano, with
+the usual meanings: the application will be deployed on this server, and the
+database migrations will be run.

data/lib/conan/deployment/chef.rb

@@ -61,7 +61,7 @@ namespace :chef do
   before "chef:bootstrap", "chef:rsync"
   task :bootstrap do
     with_user "ubuntu" do
-      run "sudo /etc/chef/recipes/cookbooks/bootstrap/bootstrap.sh"
+      run "sudo env INSTALL_RUBY=#{ruby_version} /etc/chef/recipes/cookbooks/bootstrap/bootstrap.sh"
     end
   end
 

data/lib/conan/template/config/deploy.rb

@@ -40,6 +40,7 @@ set :keep_releases, 5
 set :scm,           "git"
 set :user,          "rails"
 set :deploy_to,     "/mnt/#{application}"
+set :ruby_version,  "1.9.2"
 
 # Let Conan take over
 require "conan/version"

data/lib/conan/version.rb

@@ -1,3 +1,3 @@
 module Conan
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: conan
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
+  hash: 21
+  prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Paul Battley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-18 00:00:00 +01:00
+date: 2011-09-29 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,34 +43,31 @@ extra_rdoc_files: []
 
 files: 
 - bin/conan
-- lib/conan/settings.rb
 - lib/conan/capistrano.rb
-- lib/conan/smart_hash_merge.rb
-- lib/conan/deployment/git.rb
 - lib/conan/deployment/chef.rb
 - lib/conan/deployment/deploy.rb
-- lib/conan/settings.rbc
+- lib/conan/deployment/git.rb
 - lib/conan/deployment.rb
-- lib/conan/template/config/servers.json
+- lib/conan/initializer.rb
+- lib/conan/settings.rb
+- lib/conan/smart_hash_merge.rb
+- lib/conan/template/Capfile
+- lib/conan/template/CONAN_TODO
 - lib/conan/template/config/deploy.rb
-- lib/conan/template/deploy/chef/dna/base.json
-- lib/conan/template/deploy/chef/dna/staging.json
+- lib/conan/template/config/servers.json
 - lib/conan/template/deploy/chef/dna/app.json
+- lib/conan/template/deploy/chef/dna/base.json
 - lib/conan/template/deploy/chef/dna/production.json
-- lib/conan/template/deploy/chef/solo.rb
-- lib/conan/template/deploy/chef/recipes/config/server.rb
-- lib/conan/template/deploy/chef/recipes/config/rake.rb
+- lib/conan/template/deploy/chef/dna/staging.json
+- lib/conan/template/deploy/chef/recipes/certificates/README
 - lib/conan/template/deploy/chef/recipes/config/client.rb
+- lib/conan/template/deploy/chef/recipes/config/rake.rb
+- lib/conan/template/deploy/chef/recipes/config/server.rb
 - lib/conan/template/deploy/chef/recipes/config/solo.rb
 - lib/conan/template/deploy/chef/recipes/Rakefile
-- lib/conan/template/deploy/chef/recipes/certificates/README
 - lib/conan/template/deploy/chef/recipes/site-cookbooks/README
-- lib/conan/template/CONAN_TODO
-- lib/conan/template/Capfile
+- lib/conan/template/deploy/chef/solo.rb
 - lib/conan/version.rb
-- lib/conan/version.rbc
-- lib/conan/initializer.rb
-- lib/conan/initializer.rbc
 - README.md
 has_rdoc: true
 homepage: http://github.com/madebymany/conan
@@ -102,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Conan The Deployer

data/lib/conan/initializer.rbc

@@ -1,1523 +0,0 @@
-!RBIX
-7927234798965029024
-x
-M
-1
-n
-n
-x
-10
-__script__
-i
-37
-5
-7
-0
-64
-47
-49
-1
-1
-15
-99
-7
-2
-65
-49
-3
-2
-13
-99
-12
-7
-4
-12
-7
-5
-12
-65
-12
-49
-6
-4
-15
-49
-4
-0
-15
-2
-11
-I
-6
-I
-0
-I
-0
-I
-0
-n
-p
-7
-s
-9
-fileutils
-x
-7
-require
-x
-5
-Conan
-x
-11
-open_module
-x
-15
-__module_init__
-M
-1
-n
-n
-x
-5
-Conan
-i
-29
-5
-66
-99
-7
-0
-1
-65
-49
-1
-3
-13
-99
-12
-7
-2
-12
-7
-3
-12
-65
-12
-49
-4
-4
-15
-49
-2
-0
-11
-I
-6
-I
-0
-I
-0
-I
-0
-n
-p
-5
-x
-11
-Initializer
-x
-10
-open_class
-x
-14
-__class_init__
-M
-1
-n
-n
-x
-11
-Initializer
-i
-158
-5
-66
-65
-7
-0
-45
-1
-2
-7
-3
-64
-65
-49
-4
-0
-49
-5
-2
-49
-6
-2
-15
-65
-7
-7
-45
-8
-9
-13
-71
-10
-47
-9
-49
-47
-49
-11
-0
-13
-45
-12
-13
-47
-49
-14
-1
-15
-8
-55
-45
-12
-15
-49
-10
-1
-49
-6
-2
-15
-99
-7
-16
-7
-17
-65
-5
-49
-18
-4
-15
-99
-7
-14
-7
-19
-65
-67
-49
-20
-0
-49
-21
-4
-15
-99
-7
-16
-7
-22
-65
-67
-49
-20
-0
-49
-21
-4
-15
-5
-48
-23
-15
-99
-7
-24
-7
-25
-65
-67
-49
-20
-0
-49
-21
-4
-15
-99
-7
-26
-7
-27
-65
-67
-49
-20
-0
-49
-21
-4
-15
-99
-7
-28
-7
-29
-65
-67
-49
-20
-0
-49
-21
-4
-15
-99
-7
-30
-7
-31
-65
-67
-49
-20
-0
-49
-21
-4
-11
-I
-5
-I
-0
-I
-0
-I
-0
-n
-p
-32
-x
-13
-TEMPLATE_PATH
-x
-4
-File
-n
-s
-11
-../template
-x
-11
-active_path
-x
-11
-expand_path
-x
-9
-const_set
-x
-17
-ShellCommandError
-x
-5
-Class
-n
-x
-3
-new
-x
-8
-allocate
-x
-12
-RuntimeError
-n
-x
-10
-initialize
-n
-x
-3
-run
-M
-1
-n
-n
-x
-3
-run
-i
-35
-5
-13
-72
-0
-47
-9
-23
-47
-49
-1
-0
-13
-20
-0
-20
-1
-47
-49
-2
-2
-15
-8
-31
-20
-0
-20
-1
-47
-49
-0
-2
-49
-3
-0
-11
-I
-6
-I
-2
-I
-2
-I
-2
-n
-p
-4
-x
-3
-new
-x
-8
-allocate
-x
-10
-initialize
-x
-3
-run
-p
-5
-I
--1
-I
-8
-I
-0
-I
-9
-I
-23
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-2
-x
-5
-where
-x
-8
-settings
-x
-13
-attach_method
-M
-1
-n
-n
-x
-10
-initialize
-i
-16
-45
-0
-1
-20
-0
-49
-2
-1
-38
-3
-15
-20
-1
-38
-4
-11
-I
-4
-I
-2
-I
-2
-I
-2
-n
-p
-5
-x
-4
-File
-n
-x
-11
-expand_path
-x
-12
-@destination
-x
-9
-@settings
-p
-7
-I
--1
-I
-c
-I
-0
-I
-d
-I
-b
-I
-e
-I
-10
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-2
-x
-5
-where
-x
-8
-settings
-x
-17
-method_visibility
-x
-15
-add_defn_method
-M
-1
-n
-n
-x
-3
-run
-i
-12
-5
-48
-0
-15
-5
-48
-1
-15
-5
-48
-2
-11
-I
-1
-I
-0
-I
-0
-I
-0
-n
-p
-3
-x
-13
-copy_template
-x
-13
-add_gitignore
-x
-17
-add_git_submodule
-p
-9
-I
--1
-I
-11
-I
-0
-I
-12
-I
-4
-I
-13
-I
-8
-I
-14
-I
-c
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-0
-x
-7
-private
-x
-13
-add_gitignore
-M
-1
-n
-n
-x
-13
-add_gitignore
-i
-21
-7
-0
-64
-19
-0
-15
-45
-1
-2
-7
-0
-64
-7
-3
-64
-56
-4
-50
-5
-2
-11
-I
-5
-I
-1
-I
-0
-I
-0
-n
-p
-6
-s
-10
-.gitignore
-x
-4
-File
-n
-s
-1
-a
-M
-1
-p
-2
-x
-9
-for_block
-t
-n
-x
-13
-add_gitignore
-i
-28
-57
-19
-0
-15
-20
-0
-49
-0
-0
-15
-20
-0
-7
-1
-64
-49
-0
-1
-15
-20
-0
-7
-2
-64
-49
-0
-1
-11
-I
-4
-I
-1
-I
-1
-I
-1
-n
-p
-3
-x
-4
-puts
-s
-31
-/deploy/chef/dna/generated.json
-s
-29
-/deploy/chef/dna/aliases.json
-p
-9
-I
-0
-I
-1a
-I
-4
-I
-1b
-I
-a
-I
-1c
-I
-13
-I
-1d
-I
-1c
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-1
-x
-1
-f
-x
-4
-open
-p
-7
-I
--1
-I
-18
-I
-0
-I
-19
-I
-6
-I
-1a
-I
-15
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-1
-x
-9
-gitignore
-x
-17
-add_git_submodule
-M
-1
-n
-n
-x
-17
-add_git_submodule
-i
-26
-45
-0
-1
-7
-2
-64
-49
-3
-1
-9
-14
-1
-8
-16
-1
-11
-15
-5
-7
-4
-64
-47
-49
-5
-1
-11
-I
-2
-I
-0
-I
-0
-I
-0
-n
-p
-6
-x
-4
-File
-n
-s
-4
-.git
-x
-10
-directory?
-s
-105
-git submodule add git://github.com/madebymany/cookbooks.git deploy/chef/recipes/cookbooks >/dev/null 2>&1
-x
-2
-sh
-p
-9
-I
--1
-I
-21
-I
-0
-I
-22
-I
-10
-I
-0
-I
-11
-I
-23
-I
-1a
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-0
-x
-13
-copy_template
-M
-1
-n
-n
-x
-13
-copy_template
-i
-12
-45
-0
-1
-45
-2
-3
-56
-4
-50
-5
-1
-11
-I
-3
-I
-0
-I
-0
-I
-0
-n
-p
-6
-x
-3
-Dir
-n
-x
-13
-TEMPLATE_PATH
-n
-M
-1
-p
-2
-x
-9
-for_block
-t
-n
-x
-13
-copy_template
-i
-15
-45
-0
-1
-7
-2
-64
-49
-3
-1
-56
-4
-50
-5
-0
-11
-I
-3
-I
-0
-I
-0
-I
-0
-I
--2
-p
-6
-x
-3
-Dir
-n
-s
-4
-**/*
-x
-2
-[]
-M
-1
-p
-2
-x
-9
-for_block
-t
-n
-x
-13
-copy_template
-i
-108
-57
-19
-0
-15
-45
-0
-1
-39
-2
-20
-0
-49
-3
-2
-19
-1
-15
-45
-0
-4
-20
-0
-49
-5
-1
-9
-37
-45
-6
-7
-20
-1
-49
-8
-1
-8
-107
-45
-0
-9
-20
-0
-49
-10
-1
-19
-2
-15
-20
-2
-7
-11
-13
-70
-9
-68
-15
-44
-43
-12
-7
-13
-78
-49
-14
-2
-6
-11
-56
-15
-50
-16
-1
-15
-45
-0
-17
-20
-1
-7
-18
-64
-56
-19
-50
-20
-2
-15
-45
-0
-21
-45
-0
-22
-20
-0
-49
-23
-1
-49
-24
-0
-20
-1
-49
-25
-2
-11
-I
-8
-I
-3
-I
-1
-I
-1
-n
-p
-26
-x
-4
-File
-n
-x
-12
-@destination
-x
-4
-join
-n
-x
-10
-directory?
-x
-9
-FileUtils
-n
-x
-7
-mkdir_p
-n
-x
-4
-read
-n
-x
-6
-Regexp
-s
-17
-\{\{([A-Z_]+)\}\}
-x
-3
-new
-M
-1
-p
-2
-x
-9
-for_block
-t
-n
-x
-13
-copy_template
-i
-19
-39
-0
-4
-5
-78
-98
-1
-2
-49
-2
-1
-13
-10
-18
-15
-7
-3
-64
-11
-I
-4
-I
-0
-I
-0
-I
-0
-I
--2
-p
-4
-x
-9
-@settings
-x
-24
-regexp_last_match_result
-x
-2
-[]
-s
-4
-TODO
-p
-3
-I
-0
-I
-2e
-I
-13
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-0
-x
-5
-gsub!
-n
-s
-1
-w
-M
-1
-p
-2
-x
-9
-for_block
-t
-n
-x
-13
-copy_template
-i
-13
-57
-19
-0
-15
-20
-0
-21
-1
-2
-49
-0
-1
-11
-I
-4
-I
-1
-I
-1
-I
-1
-n
-p
-1
-x
-2
-<<
-p
-5
-I
-0
-I
-2f
-I
-4
-I
-30
-I
-d
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-1
-x
-1
-f
-x
-4
-open
-n
-n
-x
-4
-stat
-x
-4
-mode
-x
-5
-chmod
-p
-19
-I
-0
-I
-28
-I
-4
-I
-29
-I
-11
-I
-2a
-I
-1b
-I
-2b
-I
-25
-I
-2d
-I
-30
-I
-2e
-I
-4a
-I
-2f
-I
-58
-I
-32
-I
-6b
-I
-0
-I
-6c
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-3
-x
-6
-source
-x
-6
-target
-x
-7
-content
-x
-4
-each
-p
-3
-I
-0
-I
-28
-I
-f
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-0
-x
-5
-chdir
-p
-5
-I
--1
-I
-26
-I
-0
-I
-27
-I
-c
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-0
-x
-2
-sh
-M
-1
-n
-n
-x
-2
-sh
-i
-22
-5
-20
-0
-47
-49
-0
-1
-13
-10
-21
-15
-5
-45
-1
-2
-20
-0
-47
-49
-3
-2
-11
-I
-4
-I
-1
-I
-1
-I
-1
-n
-p
-4
-x
-6
-system
-x
-17
-ShellCommandError
-n
-x
-5
-raise
-p
-5
-I
--1
-I
-38
-I
-0
-I
-39
-I
-16
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-1
-x
-7
-command
-p
-21
-I
-2
-I
-5
-I
-16
-I
-6
-I
-3b
-I
-8
-I
-46
-I
-c
-I
-54
-I
-11
-I
-62
-I
-17
-I
-66
-I
-18
-I
-74
-I
-21
-I
-82
-I
-26
-I
-90
-I
-38
-I
-9e
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-0
-x
-13
-attach_method
-p
-3
-I
-2
-I
-4
-I
-1d
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-0
-x
-13
-attach_method
-p
-5
-I
-0
-I
-1
-I
-9
-I
-3
-I
-25
-x
-50
-/home/paul/Projects/conan/lib/conan/initializer.rb
-p
-0