herdis 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,71 @@
+# Herdis
+
+Herdis is a simplistic Redis cluster manager based on 
+[Redis Presharding](http://antirez.com/post/redis-presharding.html) described in antirez blog.
+
+## Installation
+
+### Ruby
+
+We use Ruby 1.9.3. 
+
+To install and run on your local machine use [RVM](https://rvm.beginrescueend.com/). 
+For Mac machines make sure you compile with gcc-4.2 (because the compiler from Xcode doesn't compile Ruby 1.9.3 properly). 
+Download and install gcc from https://github.com/kennethreitz/osx-gcc-installer 
+
+    $ gem install rvm
+    $ rvm install 1.9.3
+
+And for Macs
+
+    $ rvm install 1.9.3 --with-gcc=gcc-4.2
+
+### Rubygems
+
+Use [Bundler](http://gembundler.com/) to install the gems needed by Herdis
+
+    $ bundle install
+
+### Redis
+
+Herdis naturally needs [Redis](http://redis.io/) to run. Install it and put redis-server in your $PATH.
+
+## Running
+
+The `bin/herdis` script runs a [Goliath](https://github.com/postrank-labs/goliath/) server with standard Goliath
+parameters such as `-p` for port selection, `-s` for logging to STDOUT, `-v` for verbose logging etc.
+
+The server also uses a set of ENV variables to control its configuration: 
+
+* `SHEPHERD_FIRST_PORT` for the first port to run Redis instances on. Defaults to `9080`.
+* `SHEPHERD_DIR` for the directory to put Redis dumps and pidfiles in. Defaults to `$HOME/.herdis`.
+* `SHEPHERD_ID` for the id of the server to start. Defaults to a random string.
+* `SHEPHERD_INMEMORY` to run a server managing only non-persistent Redis instances. Defaults to `false`
+* `SHEPHERD_REDUNDANCY` to define number of backups to maintain of each shard. Defaults to `2`.
+* `SHEPHERD_CONNECT_TO` to define another server to connect to on startup. Defaults to `nil`.
+
+To actually start the server, simply
+
+    $ bin/herdis
+
+## Using
+
+To use it you `require 'herdis/client'` and then instantiate a `Herdis::Client` which will act just like a `Redis::Distributed`.
+
+    require 'herdis/client'
+
+    client = Herdis::Client.new("http://localhost:9000")
+    client.set("test", "value")
+    raise "this should work, for example" unless client.get("test") == "value"
+
+If you have a cluster of herdis nodes, you can give all their addresses to the new `Herdis::Client` when you start it (`Herdis::Client.new(url1, url2, url3... urln)`), that way it will keep trying until it finds one that works (if you want to be able to restart your clients even if the cluster is currently maimed).
+
+## Test suite
+
+    $ rake
+
+## Console
+
+To run an eventmachine-friendly console to test your servers from IRB
+
+    $ bundle exec em-console

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: herdis
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-21 00:00:00.000000000 Z
+date: 2012-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiredis
-  requirement: &70292529824640 !ruby/object:Gem::Requirement
+  requirement: &70144567540360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292529824640
+  version_requirements: *70144567540360
 - !ruby/object:Gem::Dependency
   name: em-synchrony
-  requirement: &70292529823960 !ruby/object:Gem::Requirement
+  requirement: &70144567539740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292529823960
+  version_requirements: *70144567539740
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70292529823360 !ruby/object:Gem::Requirement
+  requirement: &70144567539300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292529823360
+  version_requirements: *70144567539300
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70292529822900 !ruby/object:Gem::Requirement
+  requirement: &70144567538880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292529822900
+  version_requirements: *70144567538880
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70292529822460 !ruby/object:Gem::Requirement
+  requirement: &70144567538440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292529822460
+  version_requirements: *70144567538440
 - !ruby/object:Gem::Dependency
   name: goliath
-  requirement: &70292529822020 !ruby/object:Gem::Requirement
+  requirement: &70144567538000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70292529822020
+  version_requirements: *70144567538000
 description: ! 'A Redis herder for simplifying Redis presharding
 
 '
@@ -106,6 +106,8 @@ files:
 - lib/herdis/rmerge.rb
 - lib/herdis/server.rb
 - lib/herdis/shepherd.rb
+- README.md
+- assets/shepherd.png
 - bin/herdis
 homepage: http://github.com/zond/herdis
 licenses: []