capistrano-scope 0.0.1

data/README

@@ -0,0 +1,337 @@
+
+
+
+# -------------------------------------------------------------------------
+# clientx.rb capistrano config file
+
+# The order you specify servers or roles doesn't matter, you can define
+# scope.role for a server before you define scope.server or visa versa.
+# You can give servers any name you like but they are broken into logical
+# groups by using the ":" separator.
+
+scope.server 'clienta:projectx:staging:lb:1', '123.456.567.1'
+scope.server 'clienta:projectx:staging:lb:2', '123.456.567.2'
+scope.server 'clienta:projectx:staging:app:1', '123.456.567.3'
+scope.server 'clienta:projectx:staging:app:2', '123.456.567.4'
+scope.server 'clienta:projectx:staging:db:1', '123.456.567.5'
+scope.server 'clienta:projectx:staging:db:2', '123.456.567.6'
+
+scope.server 'clienta:projectx:production:lb:1', '123.456.567.7'
+scope.server 'clienta:projectx:production:lb:2', '123.456.567.8'
+scope.server 'clienta:projectx:production:app:1', '123.456.567.9'
+scope.server 'clienta:projectx:production:app:2', '123.456.567.10'
+scope.server 'clienta:projectx:production:db:1', '123.456.567.12'
+scope.server 'clienta:projectx:production:db:2', '123.456.567.13'
+
+scope.server 'clienta:projecty:staging:lb:1', '123.456.567.1'
+scope.server 'clienta:projecty:staging:lb:2', '123.456.567.2'
+scope.server 'clienta:projecty:staging:app:1', '123.456.567.3'
+scope.server 'clienta:projecty:staging:app:2', '123.456.567.4'
+scope.server 'clienta:projecty:staging:db:1', '123.456.567.5'
+scope.server 'clienta:projecty:staging:db:2', '123.456.567.6'
+
+scope.server 'clienta:projecty:production:lb:1', '123.456.567.7'
+scope.server 'clienta:projecty:production:lb:2', '123.456.567.8'
+scope.server 'clienta:projecty:production:app:1', '123.456.567.9'
+scope.server 'clienta:projecty:production:app:2', '123.456.567.10'
+scope.server 'clienta:projecty:production:db:1', '123.456.567.12'
+scope.server 'clienta:projecty:production:db:2', '123.456.567.13'
+
+
+scope.role :server, 'clienta:projectx:staging:lb:1'
+scope.role :server, 'clienta:projectx:staging:lb:2'
+scope.role :server, 'clienta:projectx:staging:app:1'
+scope.role :server, 'clienta:projectx:staging:app:2'
+scope.role :server, 'clienta:projectx:staging:db:1'
+scope.role :server, 'clienta:projectx:staging:db:2'
+scope.role :server, 'clienta:projectx:production:lb:1'
+scope.role :server, 'clienta:projectx:production:lb:2'
+scope.role :server, 'clienta:projectx:production:app:1'
+scope.role :server, 'clienta:projectx:production:app:2'
+scope.role :server, 'clienta:projectx:production:db:1'
+scope.role :server, 'clienta:projectx:production:db:2'
+scope.role :server, 'clienta:projecty:staging:lb:1'
+scope.role :server, 'clienta:projecty:staging:lb:2'
+scope.role :server, 'clienta:projecty:staging:app:1'
+scope.role :server, 'clienta:projecty:staging:app:2'
+scope.role :server, 'clienta:projecty:staging:db:1'
+scope.role :server, 'clienta:projecty:staging:db:2'
+scope.role :server, 'clienta:projecty:production:lb:1'
+scope.role :server, 'clienta:projecty:production:lb:2'
+scope.role :server, 'clienta:projecty:production:app:1'
+scope.role :server, 'clienta:projecty:production:app:2'
+scope.role :server, 'clienta:projecty:production:db:1'
+scope.role :server, 'clienta:projecty:production:db:2'
+
+scope.role :load_balancer, 'clienta:projectx:staging:lb:1'
+scope.role :load_balancer, 'clienta:projectx:staging:lb:2'
+scope.role :load_balancer, 'clienta:projectx:production:lb:1'
+scope.role :load_balancer, 'clienta:projectx:production:lb:2'
+scope.role :load_balancer, 'clienta:projecty:staging:lb:1'
+scope.role :load_balancer, 'clienta:projecty:staging:lb:2'
+scope.role :load_balancer, 'clienta:projecty:production:lb:1'
+scope.role :load_balancer, 'clienta:projecty:production:lb:2'
+
+scope.role :app, 'clienta:projectx:staging:app:1'
+scope.role :app, 'clienta:projectx:staging:app:2'
+scope.role :app, 'clienta:projectx:production:app:1'
+scope.role :app, 'clienta:projectx:production:app:2'
+scope.role :app, 'clienta:projecty:staging:app:1'
+scope.role :app, 'clienta:projecty:staging:app:2'
+scope.role :app, 'clienta:projecty:production:app:1'
+scope.role :app, 'clienta:projecty:production:app:2'
+
+scope.role :db, 'clienta:projectx:staging:db:1', :primary => true
+scope.role :db, 'clienta:projectx:staging:db:2'
+scope.role :db, 'clienta:projectx:production:db:1', :primary => true
+scope.role :db, 'clienta:projectx:production:db:2'
+scope.role :db, 'clienta:projecty:staging:db:1', :primary => true
+scope.role :db, 'clienta:projecty:staging:db:2'
+scope.role :db, 'clienta:projecty:production:db:1', :primary => true
+scope.role :db, 'clienta:projecty:production:db:2'
+
+# end of clientx.rb
+# -------------------------------------------------------------------------
+
+
+
+
+# For the sake of demonstration lets assume we also have the following tasks
+# defined and included from somewhere else.
+# -------------------------------------------------------------------------
+# recipes.rb
+
+namespace :server do
+  desc "Concatenate Keys and upload new authorized_keys file to the server."
+  task :authorized_keys, :roles => :server do
+    ...
+  end
+
+  desc "Install Subversion"
+  task :install_subversion, :roles => :server do
+    ...
+  end
+end
+
+namespace :mysql do
+  desc "Backup Database"
+  task :backup, :roles => :db do
+    ...
+  end
+end
+
+namespace :app do
+  desc "Install bundler"
+  task :install_bundler, :roles => :app do
+    ...
+  end
+  
+  desc "Install nginx"
+  task :install_nginx, :roles => :app do
+    ...
+  end
+
+  desc "Install imagemagick"
+  task :install_imagemagick, :roles => :app do
+    ...
+  end
+end
+
+namespace :nagios do
+  desc "Update nagios config on the admin server and restart nagios service"
+  task :deploy, :roles => :admin do
+    ...
+  end
+
+  desc "Restart the nagios SMF Service"
+  task :restart, :roles => :admin do
+    ...
+  end
+  
+  namespace :nrpe do
+    desc "Install NRPE"
+    task :install, :roles => :server do
+      ...
+    end
+  
+    desc "Update NRPE Configuration"
+    task :deploy, :roles => :server do
+      ...
+    end
+  end
+
+  namespace :plugins do
+    desc "Copy plugins to servers"
+    task :deploy, :roles => :server do
+      ...
+    end
+  end
+end
+
+# end of recipes.rb
+# -------------------------------------------------------------------------
+
+
+
+# Now on the command line you can see the tasks that you normally would 
+# by listing out tasks with descriptions.
+
+$ cap -T
+
+cap @:all                                       # Scope all defined servers
+cap @:show                                      # Show the roles and servers ...
+cap app:install_bundler
+cap app:install_nginx
+cap app:install_image_magick
+cap mysql:backup
+cap nagios:deploy
+cap nagios:restart
+cap nagios:nrpe:install
+cap nagios:nrpe:deploy
+cap nagios:plugins:deploy
+cap server:authorized_keys
+cap server:install_subversion
+
+
+
+# And if you want to see a list of all the server scopes that you have 
+# defined  use the verbose flag.  Since we used the '@' as the top level
+# namespace for our scoping tasks they should all sort to the top of the
+# list and then be followed by your normal capistrano tasks.
+
+$ cap -vT
+
+cap @:all                                       # Scope all defined servers
+cap @:clienta:all                               # 
+cap @:clienta:projectx:all                      # 
+cap @:clienta:projectx:production:all           # 
+cap @:clienta:projectx:production:app:1         # 
+cap @:clienta:projectx:production:app:2         # 
+cap @:clienta:projectx:production:app:all       # 
+cap @:clienta:projectx:production:db:1          # 
+cap @:clienta:projectx:production:db:2          # 
+cap @:clienta:projectx:production:db:all        # 
+cap @:clienta:projectx:production:lb:1          # 
+cap @:clienta:projectx:production:lb:2          # 
+cap @:clienta:projectx:production:lb:all        # 
+cap @:clienta:projectx:staging:all              # 
+cap @:clienta:projectx:staging:app:1            # 
+cap @:clienta:projectx:staging:app:2            # 
+cap @:clienta:projectx:staging:app:all          # 
+cap @:clienta:projectx:staging:db:1             # 
+cap @:clienta:projectx:staging:db:2             # 
+cap @:clienta:projectx:staging:db:all           # 
+cap @:clienta:projectx:staging:lb:1             # 
+cap @:clienta:projectx:staging:lb:2             # 
+cap @:clienta:projectx:staging:lb:all           # 
+cap @:clienta:projecty:all                      # 
+cap @:clienta:projecty:production:all           # 
+cap @:clienta:projecty:production:app:1         # 
+cap @:clienta:projecty:production:app:2         # 
+cap @:clienta:projecty:production:app:all       # 
+cap @:clienta:projecty:production:db:1          # 
+cap @:clienta:projecty:production:db:2          # 
+cap @:clienta:projecty:production:db:all        # 
+cap @:clienta:projecty:production:lb:1          # 
+cap @:clienta:projecty:production:lb:2          # 
+cap @:clienta:projecty:production:lb:all        # 
+cap @:clienta:projecty:staging:all              # 
+cap @:clienta:projecty:staging:app:1            # 
+cap @:clienta:projecty:staging:app:2            # 
+cap @:clienta:projecty:staging:app:all          # 
+cap @:clienta:projecty:staging:db:1             # 
+cap @:clienta:projecty:staging:db:2             # 
+cap @:clienta:projecty:staging:db:all           # 
+cap @:clienta:projecty:staging:lb:1             # 
+cap @:clienta:projecty:staging:lb:2             # 
+cap @:clienta:projecty:staging:lb:all           # 
+cap @:create_role_tasks                         # 
+cap @:show                                      # Show the roles and servers ...
+cap app:install_bundler
+cap app:install_nginx
+cap app:install_image_magick
+cap mysql:backup
+cap nagios:deploy
+cap nagios:restart
+cap nagios:nrpe:install
+cap nagios:nrpe:deploy
+cap nagios:plugins:deploy
+cap server:authorized_keys
+cap server:install_subversion
+
+
+
+
+# Now to execute a task on a single server you can precede the task with the
+# scope task for that server.
+
+$ cap @:clienta:projectx:production:app:1 app:install_bundler
+
+
+# Or if you want to execute that task on a group of servers you can use the
+# all task that is defined for you at each level.
+
+$ cap @:clienta:projectx:production:app:all
+
+
+# Since we have added roles to our tasks and servers we can still execute
+# tasks on larger groups of servers that include servers that we don't want
+# the command to run on.  Because the task is role based it will only execute
+# the task on the correct servers.  For example if we wanted to install nginx
+# on all app servers of clientx but not clienty we could do this:
+
+$ cap @:clientx:all app:install_nginx
+
+# And if we really wanted to go global we can execute something across all
+# servers with the @:all scope.  Lets say we want to deploy they updated
+# nrpe config file and a new plugin we wrote to all our servers.
+
+$ cap @:all nagios:nrpe:deploy nagios:plugins:deploy
+
+
+# Included with this package is a @:show task that will list out all the
+# servers and roles that are defined for a given scope.
+
+$ cap @:clienta:projectx:all @:show
+
+    triggering load callbacks
+  * executing `@:create_role_tasks'
+  * executing `@:clienta:projectx:all'
+  * executing `@:show'
+Roles:
+         app
+         db
+         load_balancer
+         server
+Servers:
+         clienta:projectx:production:app:1
+         clienta:projectx:production:app:2
+         clienta:projectx:production:db:1
+         clienta:projectx:production:db:2
+         clienta:projectx:staging:app:1
+         clienta:projectx:staging:app:2
+         clienta:projectx:staging:db:2
+         clienta:projecty:production:lb:1
+         clienta:projecty:production:lb:2
+         clienta:projecty:staging:db:1
+         clienta:projecty:staging:lb:1
+         clienta:projecty:staging:lb:2
+
+
+
+
+$ cap @:clienta:projectx:staging:db:all @:show
+
+    triggering load callbacks
+  * executing `@:create_role_tasks'
+  * executing `@:clienta:projectx:staging:db:all'
+  * executing `@:show'
+Roles:
+         db
+         server
+Servers:
+         clienta:projectx:staging:db:2
+         clienta:projecty:staging:db:1
+
+
+

data/lib/capistrano/scope.rb

@@ -0,0 +1,112 @@
+# require 'capistrano'
+# unless Capistrano::Configuration.respond_to?(:instance)
+#   abort "scope requires requires Capistrano 2"
+# end
+
+
+module Scope
+  @@servers = Hash.new {|h,k| h[k] = {:ip_address => nil, :roles => [] } }
+
+  def role(role, server_name, options={})
+    @@servers[server_name][:roles] << {:name => role, :options => options}
+  end
+
+  def server(server_name, ip_address)
+    @@servers[server_name][:ip_address] = ip_address
+  end
+
+  def create_task(name, pattern, ns)
+    ns.task(name) do
+      keys = @@servers.keys.grep(/^#{pattern}/)
+      
+      keys.each do |key|
+        ip_address = @@servers[key][:ip_address]
+        @@servers[key][:roles].each do |role|
+          top.role(role[:name], ip_address, role[:options])
+        end
+      end
+    end
+  end
+  
+  def namespace_task(namespace_list, ns)
+    name    = namespace_list.pop
+    pattern = "#{ns.fully_qualified_name}:#{name}".sub('@:','')
+
+    if namespace_list.empty?
+      create_task name, pattern, ns
+    else
+      ns.namespace name.to_sym do
+      end
+      create_task 'all', pattern, ns.namespaces[name.to_sym]
+      namespace_task namespace_list, ns.namespaces[name.to_sym]
+    end 
+  end
+
+  # Execution starts here.
+  def create_role_tasks(ns)
+    @@servers.keys.each do |name| 
+      namespace_task name.split(':').reverse, ns
+    end
+  end
+  
+  def all(ns)
+    @@servers.each_value do |scope_server|
+      scope_server[:roles].each do |role|
+        ns.top.role(role[:name], scope_server[:ip_address], role[:options])
+      end
+    end
+  end
+  
+  def defined_roles(ns)
+    ns.top.roles.keys.collect {|r| r.to_s }.sort {|a,b| a <=> b }
+  end
+
+  def defined_servers(ns)
+    ip_to_name = @@servers.keys.inject({}) do |h,key| 
+      h[@@servers[key][:ip_address]] = key
+      h
+    end
+    defined_servers = []
+    ns.top.roles.each_value do |defined_role|
+      defined_role.servers.each do |server|
+        unless defined_servers.include? ip_to_name[server.host]
+          defined_servers << ip_to_name[server.host]
+        end
+      end
+    end
+
+    return defined_servers.sort
+  end
+end
+Capistrano.plugin :scope, Scope
+
+
+Capistrano::Configuration.instance.load do
+  namespace '@'.to_sym do
+
+    task :create_role_tasks do
+      scope.create_role_tasks self
+    end
+
+    desc "Scope all defined servers"
+    task :all do
+      scope.all self
+    end
+  
+    desc "Show the roles and servers defined by this scope."
+    task :show do
+      puts "Roles:"
+      scope.defined_roles(self).each do |defined_role|
+        puts "         #{defined_role}"
+      end
+      puts "Servers:"
+      scope.defined_servers(self).each do |defined_server|
+        puts "         #{defined_server}"
+      end
+    end
+
+  end
+
+  on :load, '@:create_role_tasks'
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: capistrano-scope
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kirt Fitzpatrick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-17 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 2
+        - 5
+        - 18
+        version: 2.5.18
+  type: :runtime
+  version_requirements: *id001
+description: Adds the ability to restrict the set of servers that capistrano acts on via the command line.
+email: kirt.fitzpatrick@akqa.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/capistrano/scope.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 59
+      segments: 
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Scoping system for capistrano servers.
+test_files: []
+