knife-mysql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8d0fd4b00f5a88f5f7e90d28913295b5444c2f30
+  data.tar.gz: 8221333cd8c91b41284735c3f16393a501a814d0
+SHA512:
+  metadata.gz: b2ed1854d37e405da44073d38343341dfe0545d07bf7467068ac4d780add123d14f27bb2a72c6c30a02f4c7a8ce0f1a3fff37a8f15498ab79a61c95b896f84e1
+  data.tar.gz: d8a08ba68afc29b699120dede4213fe5a72c17dd561e7b27d4b7609258e9b3dcb49bdac06541c1ba721740ca4231d4b790994bf2f9b6cd3cc9e2727be1f8633d

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.sw[a-z]

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in knife-mysql.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# knife-mysql
+
+`knife-mysql` is a [knife](http://docs.getchef.com/knife.html) plugin for working with MySQL databases on servers managed by [Chef](http://getchef.com/).
+
+## Installation
+
+`gem install knife-mysql`
+
+## Usage
+
+### scp
+
+    knife mysql scp SOURCE DESTINATION (options)
+
+The `knife mysql scp` subcommand makes it easy to copy databases between nodes.
+
+This task will `ssh` to each node matching the [source query](http://docs.getchef.com/essentials_search.html) and `mysqldump` the requested databases to a SQL file,
+then download the resulting file to your local machine, and then upload it to each node matching the destination query, finally importing the data to `mysql` and
+cleaning up all the files.
+
+#### Examples
+
+Copying a single database from one node to another.
+
+    $ knife mysql scp name:db1.example.com name:db2.example.com --databases db_example
+
+Copying everything from your `production` database servers into a `staging` environment.
+
+    $ knife mysql scp "role:database AND chef_environment:production" "role:database AND chef_environment:staging"
+
+See `knife mysql scp --help` for the full list of options.
+
+## Contributing
+
+Please do! Open a pull request with your changes and I'll be happy to review it.
+
+## License
+
+Copyright (c) 2014 Logan Koester. Released under the MIT license. See LICENSE-MIT for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/knife-mysql.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "knife-mysql/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'knife-mysql'
+  s.version     = Knife::Mysql::VERSION
+  s.authors     = ['Logan Koester']
+  s.email       = ['logan@logankoester.com']
+  s.homepage    = 'http://github.com/logankoester/knife-mysql'
+  s.summary     = %q{Knife plugin to interact with MySQL on your nodes}
+  s.description = %q{`knife-mysql` contains a utilities working with your database nodes, such as copying databases from one node or environment to another.}
+
+  s.rubyforge_project = 'knife-mysql'
+
+  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_runtime_dependency 'chef'
+  s.add_runtime_dependency 'net-scp'
+  s.add_runtime_dependency 'ruby-progressbar'
+end

data/lib/chef/knife/mysql_scp.rb

@@ -0,0 +1,182 @@
+require 'chef/knife'
+
+module Knife
+  class MysqlScp < Chef::Knife
+
+    deps do
+      require 'etc'
+      require 'net/ssh'
+      require 'net/scp'
+      require 'ruby-progressbar'
+      require 'securerandom'
+      require 'fileutils'
+      require 'chef/search/query'
+    end
+
+    banner 'knife mysql scp SOURCE DESTINATION (options)'
+
+    option :databases,
+      :short => "-B database_1,database_2",
+      :long => "--databases database_1,database_2",
+      :description => "SCP several databases",
+      :proc => Proc.new { |names| names.split(',') },
+      :default => false
+
+    option :all_databases,
+      :short => '-A',
+      :long => '--all-databases',
+      :description => 'SCP all databases',
+      :boolean => true,
+      :default => true
+
+    option :ssh_user,
+      :short => '-x USERNAME',
+      :long => '--ssh-user USERNAME',
+      :description => 'The ssh username',
+      :default => Etc.getlogin
+
+    option :user,
+      :short => '-u USERNAME',
+      :long => '--user USERNAME',
+      :description => 'The MySQL username',
+      :default => 'root'
+
+    def run
+      ensure_required_args
+      source_query = Chef::Search::Query.new
+      source_query.search 'node', name_args[0] do |source_node|
+        dumpfile = mysqldump source_node, config
+        download source_node, dumpfile
+
+        destination_query = Chef::Search::Query.new
+        destination_query.search 'node', name_args[1] do |destination_node|
+          puts destination_node
+          upload destination_node, dumpfile
+          mysqlrestore destination_node, dumpfile, config
+          delete_remote destination_node, dumpfile
+        end
+
+        delete dumpfile
+      end
+    end
+
+    private
+    def ensure_required_args
+      unless name_args.size == 2
+        puts 'Both a source query and a destination query are required.'
+        show_usage
+        exit 1
+      end
+    end
+
+    private
+    def mysqldump(node, config)
+      Net::SSH.start node.fqdn, config[:ssh_user] do |ssh|
+        source_password = ui.ask_question "[#{node.name}] MySQL password (#{config[:user]}): "
+        dumpfile = "knife-mysql-scp-#{SecureRandom.uuid}.sql"
+        command = "mysqldump --single-transaction -u #{config[:user]} -p#{source_password} #{databases_to_arg(config)} > #{dumpfile}"
+        ssh.open_channel do |channel|
+          ui.info "[#{node.name}] Running #{command}"
+          channel.exec command do |ch, success|
+            unless success
+              ui.error "[#{node.name}] [mysqldump] An error occurred."
+              abort
+            end
+
+            channel.on_request 'exit-status' do |ch, data|
+              ui.info "[#{node.name}] [mysqldump] Finished!"
+            end
+          end
+        end
+        ssh.loop
+        return dumpfile
+      end
+    end
+
+    private
+    def mysqlrestore(node, dumpfile, config)
+      Net::SSH.start node.fqdn, config[:ssh_user] do |ssh|
+        source_password = ui.ask_question "MySQL password (#{config[:user]})"
+        command = "mysql -u #{config[:user]} -p#{source_password} < #{dumpfile}"
+        ssh.open_channel do |channel|
+          ui.info "[#{node.name}] Running #{command}"
+          channel.exec command do |ch, success|
+            unless success
+              ui.error "[#{node.name}] [mysql] An error occurred."
+              abort
+            end
+
+            channel.on_request 'exit-status' do |ch, data|
+              ui.info "[#{node.name}] [mysql] Finished!"
+            end
+          end
+        end
+        ssh.loop
+      end
+    end
+
+    private
+    def download(node, filename)
+      Net::SCP.start node.fqdn, config[:ssh_user] do |scp|
+        ui.info "[#{node.name}] [scp] Downloading #{filename}..."
+        progress = ProgressBar.create :title => filename, :format => '%a %B %p%% %t'
+        scp.download! filename, filename do |ch, name, sent, total|
+          progress.total = total
+          progress.progress = sent
+        end
+        progress.finish
+        ui.info "[#{node.name}] [scp] Finished!"
+      end
+    end
+
+    def upload(node, filename)
+      Net::SCP.start node.fqdn, config[:ssh_user] do |scp|
+        ui.info "[#{node.name}] [scp] Uploading #{filename}..."
+        progress = ProgressBar.create :title => filename, :format => '%a %B %p%% %t'
+        scp.upload! filename, filename do |ch, name, sent, total|
+          progress.total = total
+          progress.progress = sent
+        end
+        progress.finish
+        ui.info "[#{node.name}] [scp] Finished!"
+      end
+    end
+
+    def delete(filename)
+      ui.info "Deleting #{filename}..."
+      FileUtils.rm(filename)
+      ui.info "Finished!"
+    end
+
+    def delete_remote(node, filename)
+      Net::SSH.start node.fqdn, config[:ssh_user] do |ssh|
+        ui.info "[#{node.name}] Deleting #{filename}..."
+        command = "rm #{filename}"
+        ssh.open_channel do |channel|
+          channel.exec command do |ch, success|
+            unless success
+              ui.info "[#{node.name}] Failed to delete #{filename}!"
+              abort
+            end
+
+            channel.on_request 'exit-status' do |ch, data|
+              ui.info "[#{node.name}] Finished!"
+            end
+          end
+        end
+        ssh.loop
+      end
+    end
+
+    private
+    def databases_to_arg(config)
+      databases = config[:databases] || []
+      if config[:all_databases]
+        '--all-databases'
+      else
+        "--databases #{databases.join(' ')}"
+      end
+    end
+
+  end
+end

data/lib/knife-mysql/version.rb

@@ -0,0 +1,5 @@
+module Knife
+  module Mysql
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: knife-mysql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "`knife-mysql` contains a utilities working with your database nodes,
+  such as copying databases from one node or environment to another."
+email:
+- logan@logankoester.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- knife-mysql.gemspec
+- lib/chef/knife/mysql_scp.rb
+- lib/knife-mysql/version.rb
+homepage: http://github.com/logankoester/knife-mysql
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: knife-mysql
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Knife plugin to interact with MySQL on your nodes
+test_files: []