ruster 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0fa83c07c41cf0cf7ffa6803b875bd04ec3a7358
+  data.tar.gz: 8dc5ac87df198e559cb9e98424e69850af449a46
+SHA512:
+  metadata.gz: d3d19a0ce3e961cb6ed869cc658d5378ad94a3ad2137d7ab92d8622517dd48c21e257b84438e1203a267d74a46a9185c6342fda8c5dc78716c11b952a1b461e6
+  data.tar.gz: 64b72f3a6821d0ca2e3eb48d53300da5545797d5d25c99c564a24be0509cc0dbc5bd37bdb7a9d6cde368a45d733d4b3ae245bb63b334cf19d35df976df5e8924

data/.gitignore

@@ -0,0 +1,2 @@
+.gs/
+tmp/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Leandro López
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# ruster - a simple Redis Cluster Administration tool
+
+Control your [Redis][redis] [Cluster][redis-cluster] from the command
+line.
+
+## Usage
+
+`ruster` relies on [redic][redic], the lightweight Redis client. It
+currently allows to create a cluster, add and remove nodes, and
+execute a command in all nodes in a cluster.
+
+### Create a cluster
+
+```
+$ ruster create ip:port [ip:port...]
+```
+
+Creates a cluster with all the indicated nodes, and automatically
+shards Redis Cluster 16,384 slots evenly among all of them.
+
+### Add a node
+
+```
+$ ruster add cluster_ip:port ip:port
+```
+
+Adds `ip:port` to the cluster. `cluster_ip:port` must be one of the
+nodes that are already part of the cluster.
+
+### Remove a node
+
+```
+$ ruster remove cluster_ip:port ip:port
+```
+
+Removes `ip:port` from the cluster. `cluster_ip:port` must be one of the
+nodes that are already part of the cluster. The only requirement is
+that `ip:port` isn't the same as `cluster_ip:port`.
+
+**NOTE**: removing a node that has slots assigned leaves the cluster
+in a broken state. These slots should be resharded before removing the
+node.
+
+### Execute a command in all nodes
+
+```
+$ ruster call ip:port [CMD ...]
+```
+
+Executes the [Redis command][redis-commands] in all nodes, displaying
+it's result in STDOUT.
+
+### Reshard
+
+```
+$ ruster reshard cluster_ip:port slots target_ip:port source_ip:port [...]
+```
+
+Reshards the cluster at `cluster_ip:port`, by moving `slots` slots
+from several `source_ip:port` to `target_ip:port`.
+
+## TODO
+
+* documentation
+* resharding
+* add interactive interface
+* add REPL?
+* fix cluster
+* check cluster state
+* cluster information
+* ASSERTIONS
+
+## Thanks
+
+This work wouldn't have been possible without [@antirez][@antirez]
+awesome work on Redis, and [@soveran][@soveran] and [@cyx][@cyx] for
+their super lightweight Redis client.
+
+Thank you to my dear friends [@lucasefe][@lucasefe], [@pote][@pote]
+and [@elcuervo][@cuerbot], who joined the
+[conversation on Twitter][nameme] while I was looking for a name.
+
+Also, I'd like to thank to [Eruca Sativa][eruca] and [Cirse][cirse]
+for the music that's currently blasting my speakers while I write
+this.
+
+[redis]: http://redis.io/
+[redis-cluster]: http://redis.io/topics/cluster-tutorial
+[redic]: https://github.com/amakawa/redic
+[@antirez]: https://twitter.com/antirez
+[@soveran]: https://twitter.com/soveran
+[@cyx]: https://twitter.com/cyx
+[eruca]: https://twitter.com/ErucaSativa
+[cirse]: https://twitter.com/cirsemusic
+[redis-commands]: http://redis.io/commands
+[@cuerbot]: https://twitter.com/cuerbot
+[@pote]: https://twitter.com/poteland
+[@lucasefe]: https://twitter.com/lucasefe
+[nameme]: https://twitter.com/inkel/status/444638064393326592

data/bin/ruster

@@ -0,0 +1,309 @@
+#! /usr/bin/env ruby
+
+require "redic"
+require "clap"
+
+$verbose = 0
+$timeout = 10_000_000
+
+action, *args = Clap.run ARGV, {
+                                "-v" => ->     { $verbose += 1 },
+                                "-t" => ->(ms) { $timeout = ms }
+                              }
+
+abort "Usage: #{File.basename($0)} <action> ip:port [...]" if action.nil? or args.nil? or args.empty?
+
+module UI
+  def err msg
+    $stderr.puts msg
+  end
+
+  def abort msg, backtrace=[]
+    err msg
+    backtrace.each { |line| err line } if $verbose > 1
+    exit 1
+  end
+
+  def info *args
+    $stdout.puts args.join(" ")
+  end
+
+  def log *args
+    $stdout.puts args.join(" ") if $verbose > 0
+  end
+
+  def debug *args
+    $stdout.puts args.join(" ") if $verbose > 1
+  end
+
+  extend self
+end
+
+class Node
+  [:id, :ip_port, :flags, :master_id, :ping, :pong, :config, :state, :slots].each do |a|
+    attr a
+  end
+
+  def initialize(ip_port)
+    @ip_port = ip_port
+    load_info!
+  end
+
+  def cluster_enabled?
+    call("INFO", "cluster").include?("cluster_enabled:1")
+  end
+
+  def only_node?
+    call("CLUSTER", "INFO").include?("cluster_known_nodes:1")
+  end
+
+  def empty?
+    call("INFO", "keyspace").strip == "# Keyspace"
+  end
+
+  def load_info!
+    call("CLUSTER", "NODES").split("\n").each do |line|
+      parts = line.split
+      next unless parts[2].include?("myself")
+      set_info!(*parts)
+    end
+  end
+
+  def set_info!(id, ip_port, flags, master_id, ping, pong, config, state, *slots)
+    @id = id
+    @flags = flags.split(",")
+    @master_id = master_id
+    @ping = ping
+    @pong = pong
+    @config = config
+    @state = state
+    @slots = slots
+    @ip_port = ip_port unless flags.include?("myself")
+  end
+
+  def ip
+    @ip_port.split(":").first
+  end
+
+  def port
+    @ip_port.split(":").last
+  end
+
+  def client
+    @client ||= Redic.new("redis://#{@ip_port}")
+  end
+
+  def call(*args)
+    UI.debug ">", *args
+    client.call(*args)
+  end
+
+  def dead?
+    %w{ disconnected fail noaddr }.any? do |flag|
+      flags.include?(flag)
+    end
+  end
+
+  def alive?
+    p [ip_port, flags, state]
+    !dead?
+  end
+
+  def to_s
+    "#{@id} [#{@ip_port}]"
+  end
+
+  def slots
+    return @_slots if @_slots
+
+    slots = { slots: [], migrating: {}, importing: {} }
+
+    @slots.each do |data|
+      if data[0] == /\[(\d+)-([<>])-(\d+)\]/
+        if $2 == ">"
+          slots[:migrating][$1] = $2
+        else
+          slots[:importing][$1] = $2
+        end
+      elsif data =~ /(\d+)-(\d+)/
+        b, e = $1.to_i, $2.to_i
+        (b..e).each { |slot| slots[:slots] << slot }
+      else
+        slots[:slots] << data.to_i
+      end
+    end
+
+    @_slots = slots
+  end
+end
+
+class Cluster
+  SLOTS = 16384
+
+  def initialize(addrs)
+    @addrs = Array(addrs)
+  end
+
+  def nodes
+    @nodes ||= @addrs.map { |addr| Node.new(addr) }
+  end
+
+  def allocate_slots(node, slots)
+    UI.log "Allocating #{slots.size} slots (#{slots.first}..#{slots.last}) in node #{node}"
+
+    UI.debug "> CLUSTER ADDSLOTS #{slots.first}..#{slots.last}"
+
+    res = node.client.call("CLUSTER", "ADDSLOTS", *slots)
+
+    UI.abort res.message if res.is_a?(RuntimeError)
+  end
+
+  def add_node(node)
+    default = nodes.first
+
+    UI.log "Joining node #{node} to node #{default}"
+
+    ip, port = node.ip_port.split(":")
+
+    res = default.call("CLUSTER", "MEET", ip, port)
+
+    UI.abort res.message if res.is_a?(RuntimeError)
+  end
+
+  def create!
+    nodes.each do |node|
+      raise ArgumentError, "Redis Server at #{node.ip_port} not running in cluster mode" unless node.cluster_enabled?
+      raise ArgumentError, "Redis Server at #{node.ip_port} already exists in a cluster" unless node.only_node?
+      raise ArgumentError, "Redis Server at #{node.ip_port} is not empty" unless node.empty?
+    end
+
+    UI.log "Allocating #{SLOTS} slots in #{nodes.length} nodes"
+
+    available_slots = 0.upto(SLOTS - 1).each_slice((SLOTS.to_f / nodes.length).ceil)
+
+    nodes.each do |node|
+      slots = available_slots.next.to_a
+
+      allocate_slots(node, slots)
+    end
+
+    nodes.each { |node| add_node node }
+  end
+
+  def remove_node(node)
+    default = nodes.first
+
+    UI.log "Removing node #{node} from cluster"
+
+    res = default.call("CLUSTER", "FORGET", node.id)
+
+    UI.abort res.message if res.is_a?(RuntimeError)
+  end
+
+  def nodes!
+    node = nodes.sample
+
+    node.call("CLUSTER", "NODES").split("\n").map do |line|
+      _, ip_port, flags, _ = line.split
+
+      if flags.include?("myself")
+        node
+      else
+        Node.new(ip_port)
+      end
+    end
+  end
+
+  def call(*args)
+    nodes!.each do |node|
+      UI.info "#{node}: #{args.join(' ')}"
+
+      res = node.call(*args)
+      UI.info res
+      UI.info "--"
+    end
+  end
+
+  def reshard(target_addr, slots, sources)
+    target = Node.new(target_addr)
+
+    from = sources.map{ |addr| Node.new(addr) } \
+      .sort{ |a, b| b.slots[:slots].size <=> a.slots[:slots].size }
+
+    total_slots = from.inject(0) do |sum, source|
+      sum + source.slots[:slots].size
+    end
+
+    from.each do |source|
+      # Proportional number of slots, based on current assigned slots
+      node_slots = (slots.to_f / total_slots * source.slots[:slots].size).to_i
+
+      UI.info "Moving #{node_slots} slots from #{source} to #{target}"
+
+      source.slots[:slots].take(node_slots).each do |slot|
+        UI.log "  Moving slot #{slot} from #{source} to #{target}"
+
+        target.call("CLUSTER", "SETSLOT", slot, "IMPORTING", source.id)
+        source.call("CLUSTER", "SETSLOT", slot, "MIGRATING", target.id)
+
+        done = false
+
+        until done
+          keys = source.call("CLUSTER", "GETKEYSINSLOT", slot, 10)
+
+          done = keys.empty?
+
+          keys.each do |key|
+            res = source.call("MIGRATE", target.ip, target.port, key, 0, 5000)
+
+            UI.abort res.message if res.is_a?(RuntimeError)
+          end
+        end
+
+        nodes!.each do |node|
+          res = node.call("CLUSTER", "SETSLOT", slot, "NODE", target.id)
+
+          UI.err res.message if res.is_a?(RuntimeError)
+        end
+      end
+    end
+  end
+end
+
+begin
+  case action
+  when "create"
+    cluster = Cluster.new(args)
+    cluster.create!
+  when "add"
+    cluster = Cluster.new(args.shift)
+
+    args.each do |addr|
+      cluster.add_node(Node.new(addr))
+    end
+  when "remove"
+    cluster = Cluster.new(args.shift)
+
+    args.each do |addr|
+      cluster.remove_node(Node.new(addr))
+    end
+  when "call"
+    cluster = Cluster.new(args.shift)
+
+    cluster.call(*args)
+  when "reshard"
+    cluster = Cluster.new(args.shift)
+
+    slots = Integer(args.shift)
+
+    target = args.shift
+
+    sources = args
+
+    cluster.reshard(target, slots, sources)
+  else
+    UI.abort "Unrecognized action #{action}"
+  end
+rescue => ex
+  UI.abort ex.message, ex.backtrace
+end

data/ruster.gemspec

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name              = "ruster"
+  s.version           = "0.0.1"
+  s.summary           = "A simple Redis Cluster Administration tool"
+  s.description       = "Control your Redis Cluster from the command line."
+  s.authors           = ["Leandro López"]
+  s.email             = ["inkel.ar@gmail.com"]
+  s.homepage          = "http://inkel.github.com/ruster"
+  s.license           = "MIT"
+
+  s.executables.push("ruster")
+
+  s.files             = `git ls-files`.split("\n")
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: ruster
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Leandro López
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies: []
+description: Control your Redis Cluster from the command line.
+email:
+- inkel.ar@gmail.com
+executables:
+- ruster
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- bin/ruster
+- ruster.gemspec
+homepage: http://inkel.github.com/ruster
+licenses:
+- MIT
+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: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A simple Redis Cluster Administration tool
+test_files: []