snapback 0.0.1 → 0.0.3

data/lib/snapback/cli/drop.rb

@@ -0,0 +1,94 @@
+desc 'Drop an existing database'
+arg_name 'database [, ...]'
+command :drop do |c|
+  c.action do |global_options,options,args|
+    help_now!('database(s) required') if args.empty?
+
+    # Load the configuration
+    config = Snapback::ConfigurationLoader.factory global_options[:config]
+
+    # Connect to MySQL
+    mysql_client = config.mysql_client
+
+    args.each do |database|
+
+      # Start the transaction
+      Snapback::Transaction.new do
+        run_command "Selecting database: #{database}" do
+          mysql_client.database_select(database)
+        end
+
+        vg_name = config.lvm_volume_group
+        lv_name = "#{config.lvm_database_prefix}-#{database}"
+        lv_path = "/dev/#{vg_name}/#{lv_name}"
+
+        mount_database_directory  = config.filesystem_mount_directory(database)
+        mysql_database_directory  = "#{mysql_client.get_data_directory}/#{database}"
+
+        # Drop tablespaces
+        tables = run_command "Getting list of tables in database" do
+          mysql_client.database_tables
+        end
+
+        tables.each do |table|
+          table = table.to_s
+          run_command "Changing table engine to MyISAM: #{table}" do
+            mysql_client.table_set_engine(table, "MyISAM")
+          end
+
+          run_command "Dropping table: #{table}" do
+            mysql_client.table_drop(table)
+          end
+        end
+
+        # Flush
+        run_command "Flush tables with read lock" do
+          mysql_client.flush_tables
+        end
+
+        # Stop MySQL
+        run_command "Stop MySQL server" do
+          Snapback::MySQL::ServiceControl.stop
+        end
+
+        revert do
+          run_command "Start MySQL server" do
+            Snapback::MySQL::ServiceControl.start
+          end
+        end
+
+        run_command "Unlinking mysql data directory",
+          "unlink #{mysql_database_directory}"
+
+        revert do
+          run_command "Linking mysql data directory",
+            "ln -s #{mount_database_directory} #{mysql_database_directory}"
+        end
+
+        # Mount the new logical volume
+        run_command "Unmounting logical volume",
+          "umount #{mount_database_directory}"
+
+        revert do
+          run_command "Mounting logical volume",
+            "mount #{lv_path} #{mount_database_directory}"
+        end
+
+        # Remove logical volume
+        run_command "Remove logical volume", 
+          "lvremove -f #{lv_path}"
+
+        # Start MySQL
+        run_command "Starting MySQL server" do
+          Snapback::MySQL::ServiceControl.start
+        end
+
+        revert do
+          run_command "Stopping MySQL server" do
+            Snapback::MySQL::ServiceControl.stop
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snapback/cli/install.rb

@@ -0,0 +1,179 @@
+require 'lvm'
+require 'snapback/configuration_loader'
+
+desc 'Ensure the environment is setup'
+command :install do |c|
+  c.action do |global_options,options,args|
+    help_now!('found arguments, none expected') if !args.empty?
+
+    Snapback::Transaction.new do
+
+      puts ""
+      puts "Hi!"
+      puts ""
+      puts "I'm going to guide you through setting up #{"snapback".colorize(:green)}. "
+      puts "This script will check to see if your environment can run "
+      puts "Snapback and will setup configuration files for you."
+      puts ""
+
+      run_command "Checking LVM is installed",
+        "lvm version"
+
+      lvm = nil
+      volume_groups = nil
+
+      # Get information from LVM
+      run_command "Retrieving volume group information" do
+        lvm = LVM::LVM.new({:command => "sudo lvm", :version => "2.02.30"})
+        volume_groups = lvm.volume_groups.to_a
+
+        if volume_groups.size == 0 then
+          raise "LVM is not setup: you do not have any volume groups"
+        end
+
+        true
+      end
+
+      puts ""
+
+      selected_volume_group = nil
+
+      # Decide which volume group to use
+      if volume_groups.size == 1 then
+        selected_volume_group = volume_groups[0];
+        puts "There is one volume group available"
+      else
+        puts "There are multiple volume groups available:"
+
+        volume_groups.each_with_index.map { |volume_group, index|
+          puts "  #{index + 1}.\t#{volume_group.name.colorize(:yellow)}"
+        }
+
+        puts ""
+
+        volume_group_number = ask_int "Which volume group would you like Snapback use", volume_groups.size
+        selected_volume_group = volume_groups[volume_group_number - 1];
+      end
+
+      puts "Snapback will use the volume group #{selected_volume_group.name.colorize(:green)}"
+      puts ""
+
+      # Check for mount directory
+      mysql_mount_directory = ask_string "Where do you want to mount your logical volumes [/mnt/mysql]"
+      mysql_mount_directory = "/mnt/mysql" if mysql_mount_directory.empty?
+
+      run_command "Changing owner to mysql: #{mysql_mount_directory}",
+        "chown -R mysql:mysql #{mysql_mount_directory}"
+
+      has_mysql_mount_directory = run_command "Checking for directory #{mysql_mount_directory}" do
+          File.directory? mysql_mount_directory
+      end
+
+      if !has_mysql_mount_directory then
+        run_command "Creating directory #{mysql_mount_directory}",
+          "mkdir -p #{mysql_mount_directory}"
+
+        revert do
+          run_command "Removing directory #{mysql_mount_directory}",
+            "rm -rf #{mysql_mount_directory}"
+        end
+      end
+
+      # MySQL connection
+      mysql_client = Snapback::MySQL::ClientControl.instance
+
+      while true
+        puts ""
+        puts "Enter the credentials to connect to MySQL on localhost"
+
+        mysql_client.hostname = "localhost"
+        
+        # Ask for username
+        mysql_client.username = ask_string "MySQL username [root]"
+        mysql_client.username = "root" if mysql_client.username.empty?
+
+        # Ask for password
+        mysql_client.password = ask_string "MySQL password"
+
+        connected = run_command "Connecting to MySQL database" do
+          begin
+            mysql_client.connect
+            true
+          rescue
+            false
+          end
+        end
+
+        if connected then
+          break
+        else
+          next
+        end
+      end
+
+      # MySQL properties
+
+      has_innodb_file_per_table = run_command "Checking innodb_file_per_table is activated" do
+        mysql_client.has_innodb_file_per_table?
+      end
+
+      if !has_innodb_file_per_table then
+        run_command "Setting innodb_file_per_table to ON" do
+          mysql_client.set_innodb_file_per_table true
+        end
+
+        revert do
+          run_command "Setting innodb_file_per_table to OFF" do
+            mysql_client.set_innodb_file_per_table false
+          end
+        end
+      end
+
+      run_command "Writing configuration to file" do
+        config = {
+          'version' => Snapback::VERSION,
+          'lvm' => {
+            'volume_group'    => "#{selected_volume_group.name}",
+            'database_prefix' => "snapback-database",
+            'snapshot_prefix' => "snapback-snapshot"
+          },
+
+          'mysql' => {
+            'hostname'        => mysql_client.hostname,
+            'username'        => mysql_client.username,
+            'password'        => mysql_client.password
+          },
+
+          'filesystem' => {
+            'mount'           => mysql_mount_directory
+          }
+        }
+
+        File.open(global_options[:config], 'w+') { |f| f.write(config.to_yaml) }
+      end
+
+      revert do
+        run_command "Removing configuration file" do
+          File.unlink global_options[:config]
+        end
+      end
+
+      puts ""
+      puts "Snapback has now been configured."
+      puts "To start using Snapback, run the following command: "
+      puts ""
+      puts "sudo snapback help".colorize(:yellow)
+      puts ""
+      puts "If your operating system uses AppArmor (e.g.: Ubuntu) you will need to "
+      puts "manually update your #{"/etc/apparmor.d/usr/sbin/mysqld".colorize(:green)} file "
+      puts "to include the following lines:"
+      puts "\t#{"/mnt/mysql/ rwk,".colorize(:green)}"
+      puts "\t#{"/mnt/mysql/** rwk,".colorize(:green)}"
+      puts ""
+      puts "Then manually restart AppArmor and MySQL using: "
+      puts "\t#{"service apparmor restart".colorize(:green)}"
+      puts "\t#{"service mysql restart".colorize(:green)}"
+      puts ""
+    end
+  end
+end

data/lib/snapback/cli/mount.rb

@@ -0,0 +1,97 @@
+desc 'Mount an existing database'
+arg_name 'database [, ...]'
+command :mount do |c|
+  c.action do |global_options,options,args|
+    # Ensure all flags and switches are present
+    help_now!('database(s) required') if args.empty?
+
+    # Load the configuration
+    config = Snapback::ConfigurationLoader.factory global_options[:config]
+
+    # Connect to MySQL
+    mysql_client = config.mysql_client
+
+    # For each database
+    args.each do |database|
+
+      # Start the transaction
+      Snapback::Transaction.new do
+        run_command "Selecting database: #{database}" do
+          mysql_client.database_select(database)
+        end
+
+        vg_name = config.lvm_volume_group
+        lv_name = config.lvm_logical_database database
+        lv_path = "/dev/#{vg_name}/#{lv_name}"
+
+        mount_database_directory  = config.filesystem_mount_directory(database)
+        mysql_database_directory  = "#{mysql_client.get_data_directory}/#{database}"
+
+        lv_exists = run_command "Checking logical volume exists" do
+          File.exists?(lv_path)
+        end
+
+        if !lv_exists then
+          raise "Logical volume #{lv_path.colorize(:red)} does not exist"
+        end
+
+        # Flush
+        run_command "Flush tables with read lock" do
+          mysql_client.flush_tables
+        end
+
+        # Stop MySQL
+        run_command "Stop MySQL server" do
+          Snapback::MySQL::ServiceControl.stop
+        end
+
+        revert do
+          run_command "Start MySQL server" do
+            Snapback::MySQL::ServiceControl.start
+          end
+        end
+
+        directory_exists = run_command "Checking if mount directory exists" do
+          File.directory? mount_database_directory
+        end
+
+        # Check mount directory exists
+        if !directory_exists then
+          run_command "Creating mount directory",
+            "mkdir #{mount_database_directory}"
+
+          revert do
+            run_command "Removing mount directory",
+              "rmdir #{$mount_database_directory}"
+          end
+
+          run_command "Changing permissions of mount directory",
+            "chmod 0777 #{mount_database_directory}"
+        end
+
+        run_command "Mounting directory",
+          "mount #{lv_path} #{mount_database_directory}"
+
+        run_command "Linking mount directory",
+          "ln -s #{mount_database_directory} #{mysql_database_directory}"
+
+        run_command "Changing ownership of: #{mount_database_directory}",
+          "chown -R mysql:mysql #{mount_database_directory}"
+
+        run_command "Changing ownership of: #{mysql_database_directory}",
+          "chown -R mysql:mysql #{mysql_database_directory}"
+
+        # Start MySQL
+        run_command "Start MySQL server" do
+          Snapback::MySQL::ServiceControl.start
+        end
+
+        revert do
+          run_command "Stop MySQL server" do
+            Snapback::MySQL::ServiceControl.stop
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snapback/cli/rollback.rb

@@ -0,0 +1,161 @@
+desc 'Rollback the working copy to the snapshot'
+arg_name 'database [, ...]'
+command :rollback do |c|
+  c.action do |global_options,options,args|
+    help_now!('database(s) required') if args.empty?
+
+    # Load the configuration
+    config = Snapback::ConfigurationLoader.factory global_options[:config]
+
+    # Connect to MySQL
+    mysql_client = config.mysql_client
+
+    args.each do |database|
+
+      # Start the transaction
+      Snapback::Transaction.new do
+
+        run_command "Selecting database: #{database}" do
+          mysql_client.database_select(database)
+        end
+
+        vg_name = config.lvm_volume_group
+        lv_name = "#{config.lvm_database_prefix}-#{database}"
+        lv_path = "/dev/#{vg_name}/#{lv_name}"
+
+        mount_database_directory  = config.filesystem_mount_directory(database)
+        mysql_database_directory  = "#{mysql_client.get_data_directory}/#{database}"
+
+        # Drop tablespaces
+        tables = run_command "Getting list of tables in database" do
+          mysql_client.database_tables
+        end
+
+        tables.each do |table|
+          table = table.to_s
+          run_command "Changing table engine to MyISAM: #{table}" do
+            mysql_client.table_set_engine(table, "MyISAM")
+          end
+
+          run_command "Dropping table: #{table}" do
+            mysql_client.table_drop(table)
+          end
+        end
+
+        # Flush
+        run_command "Flush tables with read lock" do
+          mysql_client.flush_tables
+        end
+
+        # Stop MySQL
+        run_command "Stop MySQL server" do
+          Snapback::MySQL::ServiceControl.stop
+        end
+
+        revert do
+          run_command "Start MySQL server" do
+            Snapback::MySQL::ServiceControl.start
+          end
+        end
+
+        # Unlink
+        run_command "Unlinking mysql data directory",
+          "unlink #{mysql_database_directory}"
+
+        revert do
+          run_command "Linking mysql data directory",
+            "ln -s #{mount_database_directory} #{mysql_database_directory}"
+        end
+
+        # Unmount
+        run_command "Unmounting logical volume",
+          "umount #{mount_database_directory}"
+
+        revert do
+          run_command "Mounting logical volume",
+            "mount #{lv_path} #{mount_database_directory}"
+        end
+
+        # Deactivate
+        run_command "De-activating logical volume",
+          "lvchange -an #{lv_path}"
+
+        revert do
+          run_command "Re-activating logical volume",
+            "lvchange -ay #{lv_path}"
+        end
+
+        # Merge the old logical volume into the new one
+        # lvconvert --merge /dev/{vgName}/backup-{dbName}
+        run_command "Rolling back to the snapshot",
+          "lvconvert --merge /dev/#{vg_name}/#{config.lvm_snapshot_prefix}-#{database}"
+
+        # Active the master drive
+        run_command "Activating logical volume",
+          "lvchange -ay #{lv_path}"
+
+        revert do
+          run_command "Deactivating logical volume",
+            "lvchange -an #{lv_path}"
+        end
+
+        # Mount the master drive
+        run_command "Mounting logical volume",
+          "mount #{lv_path} #{mount_database_directory}"
+
+        revert do
+          run_command "Unmounting logical volume",
+            "umount #{mount_database_directory}"
+        end
+
+        # Symbolic-link the MySQL data directory to the new logical volume
+        run_command "Linking mysql data directory",
+          "ln -s #{mount_database_directory} #{mysql_database_directory}"
+
+        revert do
+          run_command "Unlinking mysql data directory",
+            "unlink #{mysql_database_directory}"
+        end
+
+        # Change the permissions & ownership to MySQL
+        run_command "Changing owner to mysql: #{mysql_database_directory}",
+          "chown -R mysql:mysql #{mysql_database_directory}"
+
+        run_command "Changing owner to mysql: #{mount_database_directory}",
+          "chown -R mysql:mysql #{mount_database_directory}"
+
+        # Start MySQL
+        run_command "Starting MySQL server" do
+          Snapback::MySQL::ServiceControl.start
+        end
+
+        revert do
+          run_command "Stopping MySQL server" do
+            Snapback::MySQL::ServiceControl.stop
+          end
+        end
+
+        # Reconnect
+        run_command "Re-connecting to MySQL" do
+          mysql_client.connect
+        end
+
+        run_command "Re-selecting database: #{database}" do
+          mysql_client.database_select(database)
+        end
+
+        # Import tablespaces and optimize table
+        tables = run_command "Getting list of tables in database" do
+          mysql_client.database_tables
+        end
+
+        tables.each do |table|
+          table = table.to_s
+          run_command "Optimizing table: #{table}" do
+            mysql_client.table_optimize(table)
+          end
+        end
+      end
+    end
+  end
+end