knife-update 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg/*
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,78 @@
+# knife update
+
+A small collection of knife plugins to ease the process of safely updating
+chef in a setup with hundreds of nodes.
+
+## Installation
+
+    gem install knife-update
+
+## Usage
+
+### knife update status
+
+Returns the current state of installed chef-client versions.
+
+```bash
+$ knife update status
+Search nodes '*:*'
+
+Currently installed chef-client versions:
+  Chef 0.9.12: 5 nodes
+  Chef 0.9.16: 10 nodes
+  Chef 0.9.18: 400 nodes
+  Chef 10.14.4: 500 nodes
+  Chef 10.24.0: 1000 nodes
+```
+
+### knife update run_list
+
+Displays lists of run_list items both used and not yet used in the target
+chef-client version.
+
+```bash
+$ knife update run_list
+Search nodes '*:*'
+
+Compatbile Chef 10.24.0 run_list items:
+  role[base]
+  role[web-server]
+
+Incompatible / not tested run_list items:
+  role[loadbalancer]
+  role[database-server]
+```
+
+### knife update run
+
+Updates all nodes which contain only run_list items already applied on other
+nodes running the target chef-client version (therefore, assuming these are
+compatible).
+
+```bash
+$ knife update run
+Search nodes '*:*'
+
+Update 2 nodes to chef 10.24.0
+node01.example.com      Successfully installed chef-10.24.0
+node01.example.com      1 gem installed
+node33.example.com      Successfully installed chef-10.24.0
+node33.example.com      1 gem installed
+```
+
+### Options
+
+Lookup possible options for each command with the `-h` option. In addition to
+common knife ssh options, the two update specific options are:
+
+  * `-q, --search-query QUERY`
+
+    Filter nodes by a different search query, defaults to `*:*`.
+
+  * `-t, --target-version VERSION`
+
+    The desired chef-client version, defaults to `Chef::VERSION` of knife.
+
+## Authors
+
+SoundCloud Inc., [Tobias Schmidt](mailto:ts@soundcloud.com)

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler'
+require 'rdoc/task'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Default: run specs'
+  task :default => :spec
+
+  desc "Run all specs in spec directory"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+
+rescue LoadError
+  STDERR.puts "\n*** RSpec not available. (sudo) gem install rspec to run unit tests. ***\n\n"
+end
+

data/knife-update.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'knife-update/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'knife-update'
+  s.version     = Knife::Update::VERSION
+  s.authors     = ['Tobias Schmidt']
+  s.email       = ['ts@soundcloud.com']
+  s.homepage    = 'https://github.com/soundcloud/knife-update'
+  s.summary     = 'knife update plugin'
+  s.description = 'A small collection of knife plugins to ease the process of safely updating chef in a setup with hundreds of nodes.'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'chef', '>= 0.10.24'
+  s.add_development_dependency 'rspec'
+end

data/lib/chef/knife/update.rb

@@ -0,0 +1,86 @@
+#
+# Author:: Tobias Schmidt (<ts@soundcloud.com>)
+# Copyright:: Copyright (c) 2013 SoundCloud, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    module Update
+      def self.included(includer)
+        includer.class_eval do
+
+          deps do
+            require 'net/ssh'
+            require 'net/ssh/multi'
+            require 'chef/knife/ssh'
+            require 'chef/search/query'
+
+            Chef::Knife::Ssh.load_deps
+          end
+
+          option :query,
+            :short => "-q QUERY",
+            :long => "--search-query QUERY",
+            :description => "Filter nodes by search query",
+            :default => '*:*'
+
+          option :target_version,
+            :short => "-t VERSION",
+            :long => "--target-version VERSION",
+            :description => "The target chef-client version",
+            :default => Chef::VERSION
+        end
+      end
+
+      # Get a list of nodes and their used chef version
+      def node_list
+        list   = {}
+        search = Chef::Search::Query.new
+        query  = config[:query]
+
+        ui.msg "Search nodes '#{query}'"
+        search.search('node', query) do |node|
+          if node['chef'] && node['chef']['client_version']
+            version = node['chef']['client_version']
+
+            list[version] ||= []
+            list[version] << node
+          end
+        end
+
+        list
+      end
+
+      # List of all compatible run_list items
+      def run_list_items(nodes)
+        nodes.inject([]) do |memo, node|
+          node.run_list.each do |item|
+            memo << item.to_s unless memo.include?(item.to_s)
+          end
+
+          memo
+        end
+      end
+
+      # Returns target update chef version
+      def target_version
+        config[:target_version] || Chef::VERSION
+      end
+    end
+  end
+end

data/lib/chef/knife/update_run.rb

@@ -0,0 +1,117 @@
+#
+# Author:: Tobias Schmidt (<ts@soundcloud.com>)
+# Copyright:: Copyright (c) 2013 SoundCloud, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    class UpdateRun < Knife
+      banner 'knife update run (options)'
+
+      option :ssh_user,
+        :short => "-x USERNAME",
+        :long => "--ssh-user USERNAME",
+        :description => "The ssh username",
+        :default => "root"
+
+      option :ssh_password,
+        :short => "-P PASSWORD",
+        :long => "--ssh-password PASSWORD",
+        :description => "The ssh password"
+
+      option :ssh_port,
+        :short => "-p PORT",
+        :long => "--ssh-port PORT",
+        :description => "The ssh port",
+        :proc => Proc.new { |key| Chef::Config[:knife][:ssh_port] = key }
+
+      option :ssh_gateway,
+        :short => "-G GATEWAY",
+        :long => "--ssh-gateway GATEWAY",
+        :description => "The ssh gateway",
+        :proc => Proc.new { |key| Chef::Config[:knife][:ssh_gateway] = key }
+
+      option :identity_file,
+        :short => "-i IDENTITY_FILE",
+        :long => "--identity-file IDENTITY_FILE",
+        :description => "The SSH identity file used for authentication"
+
+      option :host_key_verify,
+        :long => "--[no-]host-key-verify",
+        :description => "Verify host key, enabled by default.",
+        :boolean => true,
+        :default => true
+
+      option :use_sudo,
+        :long => "--sudo",
+        :description => "Execute the update via sudo",
+        :boolean => true
+
+      include Chef::Knife::Update
+
+      def run
+        list  = node_list
+        items = run_list_items(list[target_version])
+
+        nodes = list.inject([]) do |memo, (version, nodes)|
+          if version != target_version
+            nodes.each do |node|
+              if node.run_list.all? { |item| items.include?(item.to_s) }
+                memo << node
+              end
+            end
+          end
+
+          memo
+        end
+
+        ui.msg "\nUpdate #{nodes.size} nodes to chef #{target_version}"
+        update_ssh(nodes, target_version).run
+      end
+
+      # Update given nodes to specified version
+      def update_ssh(nodes, version)
+        fqdns = nodes.map { |node| node.fqdn }.join(' ')
+
+        ssh = Chef::Knife::Ssh.new
+        ssh.ui = ui
+        ssh.name_args = [ fqdns, ssh_command(version) ]
+        ssh.config[:manual] = true
+        ssh.config[:ssh_user] = Chef::Config[:knife][:ssh_user] || config[:ssh_user]
+        ssh.config[:ssh_password] = config[:ssh_password]
+        ssh.config[:ssh_port] = Chef::Config[:knife][:ssh_port] || config[:ssh_port]
+        ssh.config[:ssh_gateway] = Chef::Config[:knife][:ssh_gateway] || config[:ssh_gateway]
+        ssh.config[:identity_file] = Chef::Config[:knife][:identity_file] || config[:identity_file]
+        ssh.config[:host_key_verify] = Chef::Config[:knife][:host_key_verify] || config[:host_key_verify]
+        ssh.config[:on_error] = :raise
+        ssh
+      end
+
+      def ssh_command(version)
+        command = "gem install chef -v #{version}"
+
+        if config[:use_sudo]
+          command = "sudo #{command}"
+        end
+
+        command
+      end
+
+    end
+  end
+end

data/lib/chef/knife/update_run_list.rb

@@ -0,0 +1,53 @@
+#
+# Author:: Tobias Schmidt (<ts@soundcloud.com>)
+# Copyright:: Copyright (c) 2013 SoundCloud, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    class UpdateRunList < Knife
+      banner 'knife update run_list (options)'
+
+      include Chef::Knife::Update
+
+      def run
+        list  = node_list
+        old_nodes = list.inject([]) do |memo, (version, nodes)|
+          version == target_version ? memo : memo += nodes
+        end
+        compatible = run_list_items(list[target_version])
+        incompatible = run_list_items(old_nodes)
+
+        if compatible.any?
+          ui.msg "\nCompatbile Chef #{target_version} run_list items:"
+          compatible.sort.each do |item|
+            ui.msg "  #{item}"
+          end
+        end
+
+        if incompatible.any?
+          ui.msg "\Incompatible / not tested run_list items:"
+          incompatible.sort.each do |item|
+            ui.msg "  #{item}"
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/chef/knife/update_status.rb

@@ -0,0 +1,39 @@
+#
+# Author:: Tobias Schmidt (<ts@soundcloud.com>)
+# Copyright:: Copyright (c) 2013 SoundCloud, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef/knife'
+
+class Chef
+  class Knife
+    class UpdateStatus < Knife
+      banner 'knife update status (options)'
+
+      include Chef::Knife::Update
+
+      def run
+        list = node_list
+
+        ui.msg "\nCurrently installed chef-client versions:"
+        list.sort.each do |version, nodes|
+          ui.msg "  Chef #{version}: #{nodes.size} nodes"
+        end
+      end
+
+    end
+  end
+end

data/lib/knife-update/version.rb

@@ -0,0 +1,24 @@
+#
+# Author:: Tobias Schmidt (<ts@soundcloud.com>)
+# Copyright:: Copyright (c) 2013 SoundCloud, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Knife
+  module Update
+    VERSION = '0.0.1'
+    MAJOR, MINOR, TINY = VERSION.split('.')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'chef'
+require 'chef/knife/update'

data/spec/unit/update_spec.rb

@@ -0,0 +1,23 @@
+#
+# Author:: Tobias Schmidt (<ts@soundcloud.com>)
+# Copyright:: Copyright (c) 2013 SoundCloud, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require File.expand_path('../../spec_helper', __FILE__)
+require 'chef/knife/update'
+
+describe Chef::Knife::Update do
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: knife-update
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tobias Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.24
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.24
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A small collection of knife plugins to ease the process of safely updating
+  chef in a setup with hundreds of nodes.
+email:
+- ts@soundcloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- knife-update.gemspec
+- lib/chef/knife/update.rb
+- lib/chef/knife/update_run.rb
+- lib/chef/knife/update_run_list.rb
+- lib/chef/knife/update_status.rb
+- lib/knife-update/version.rb
+- spec/spec_helper.rb
+- spec/unit/update_spec.rb
+homepage: https://github.com/soundcloud/knife-update
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -334156609659399358
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -334156609659399358
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: knife update plugin
+test_files:
+- spec/spec_helper.rb
+- spec/unit/update_spec.rb