clustr 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWRlNjk2ZGY1YTM1OTA2YjI4MWJiMWM3YjI1Y2VlMzlhZmIxNjEzMw==
+    ZDBiODA5ZWYwODkxYzg1MDAzM2MwZjRiMGU5NWEwMWU3MDYwYjk0MA==
   data.tar.gz: !binary |-
-    OWRhYzAwODI2ZGQxZjU1MjljZGEwYzEwMzlkNDI2YjUzNmY4YTE1Yg==
+    OTQxNDBhNzY3YzdlYjFjYTExYThiYjEwYThhMWI2MTliMGMzZTUwMA==
 SHA512:
   metadata.gz: !binary |-
-    NzRiZDkzYjhhNzMwNWYxYzNlYjdiYWRiNTZlMGM5ZTFiMzhhYTU1M2FkNTdh
-    ZDQyMzc1NDA3ODFkOGMyZTc1YmM1MGIxZTVhZTZmYTI4YmM4YjY1OGQzN2Zj
-    Yzg4MTNlMTE4M2ZhZDYxNzMwNDVhN2ZmNmMxMDc1ZGMzZmZkZDE=
+    YjIyYmM5ZTU0OWM2ODJmYTA0MjdhOWEzZGIzMjg5MmIzZWE5YWI3NjNmZGYw
+    ZDA3MDUyMTVmZDJlYWFkYTg3MjEzMWU3ZGEyNDdjNzkzYmU2ZDE5Nzc0YzQ4
+    YzI2YWIwMmVhYTk4OTFlOWEzM2RmZmQ0NGZhMTYxNGE1NDc1OGQ=
   data.tar.gz: !binary |-
-    MjJmOGEzYWY5ZDQ3OTAwYjIyZDBkYTRiMDY4NTRhNWQwNWI1NDc4MDE2MzE4
-    OGY3NDllNTRiMjU3NTBhZjc0MjAxMjUxMDdlZDM5NTE5Yzc0ZTcwNGJmMTE0
-    ZWQwYjhlZWY4NDk1NDMwMDY1YzI5ZjFjM2YzZDc4ZTYyZGVhZTA=
+    NDNkMTU2ODM5ZTgxZDA3ZTU3YjNjMmFiYzI3MjI2NTEwN2Y1OTU2ZGZiNjcz
+    OWFkODY5ZTYzMjk1NzhmOWRiODgzMzE2YzQ2YzA3MDc4YzM2OWMzMGFkOTBh
+    OWY5ZWM4YmU0NjAyOTc1OWNlYTU4YjNmZDVmNjU1YjRmNjNmMDk=

data/README.md

@@ -1,8 +1,14 @@
 # Clustr
 
-[![Coverage Status](https://coveralls.io/repos/davidkelley/clustr/badge.png)](https://coveralls.io/r/davidkelley/clustr) [![Build Status](https://travis-ci.org/davidkelley/clustr.svg?branch=master)](https://travis-ci.org/davidkelley/clustr) [![Code Climate](https://codeclimate.com/github/davidkelley/clustr.png)](https://codeclimate.com/github/davidkelley/clustr) [![Dependency Status](https://gemnasium.com/davidkelley/clustr.svg)](https://gemnasium.com/davidkelley/clustr)
+[![Coverage Status](https://coveralls.io/repos/davidkelley/clustr/badge.png)](https://coveralls.io/r/davidkelley/clustr) [![Build Status](https://travis-ci.org/davidkelley/clustr.svg?branch=master)](https://travis-ci.org/davidkelley/clustr) [![Code Climate](https://codeclimate.com/github/davidkelley/clustr.png)](https://codeclimate.com/github/davidkelley/clustr) [![Dependency Status](https://gemnasium.com/davidkelley/clustr.svg)](https://gemnasium.com/davidkelley/clustr) [![Gem Version](https://badge.fury.io/rb/clustr.svg)](http://badge.fury.io/rb/clustr)
 
-TODO: Write a gem description
+Clustr provides the means to cluster servers together, by storing unique identifiers (and any additional information) for each node in a store, which in-turn is managed by an adapter that is configured by the user.
+
+A server can belong to many different clusters (enables the use of [Docker](http://docker.io) containers), and is able to interrogate other clusters, aslong as they are correctly configured inside the configuration directory, `~/.clustr/`.
+
+## Available Adapters
+
+* __AWS SimpleDB__ - Uses a pre-existing domain, or creates one to store unique information about each node within the cluster.
 
 ## Installation
 
@@ -18,9 +24,61 @@ Or install it yourself as:
 
     $ gem install clustr
 
+## Configuring Clusters
+
+If cluster files are defined inside the folder `~/.cluster`, where `~` represents your user home directory, they will be automatically detected and initialized.
+
+Cluster files describe clusters that a node is able to join and/or retrieve information from, such as the clusters members.
+
+### Adapter
+
+The adapter key identifies how this cluster is formed, in the future I plan to implement DynamoDB as well as Memcached and MySQL. The adapter controls how information is extracted and inserted into the cluster at the lowest level.
+
+### Key
+
+Every cluster must contain a unique key, this helps to namespace individual clusters incase they are using the same underlying adapter. In most cases, the key can simply
+be a unique domain or even a database table.
+
+### Example
+
+Given the following Cluster file `~/.clustr/rabbitmq`, with the content:
+
+```
+adapter=SimpleDB
+key=my-simple-db-domain-daw9249ad
+```
+
+Clustr will automatically initialize a cluster named "rabbitmq" with a SimpleDB adapter pointing at the shared domain identified by the `key` value.
+
+Clustr configuration files enable the gem to join the server to a cluster, as well as interrogate clusters that the server may not necessarily be a part of. Nodes are not joined to the cluster automatically, this must be done manually via the command line.
+
 ## Usage
 
-TODO: Write usage instructions here
+*Depending upon the adapter that you use, you may need to setup your AWS Credentials, follow the instructions [here](http://aws.amazon.com/developers/getting-started/ruby/) to set them up.*
+
+The command line arguments `--access-key-id`, `--secret-access-key` and `--region` also enable you to pass AWS credentials in with each individual command.
+
+### Joining a Cluster
+
+Given the [previous example](#example) where we setup a configuration file for a RabbitMQ cluster, we can join the node to the cluster using the command:
+
+```
+$ clustr join --clusters rabbitmq --id rabbit@`echo hostname` --access-key-id 0123456 --secret-access-key a0b1c2d3e4 --region eu-west-1
+```
+
+### Retrieving Members of a Cluster
+
+Given the same previous example where a RabbitMQ cluster was defined, we can retrieve the list of members by their unique ID's (their hostname in this case) in a space delimited list, with the following command:
+
+```
+$ clustr list --cluster rabbitmq #=> rabbit@192-168-0-1 rabbit@192-168-0-5
+```
+
+Given this command, we could in practise combine this into the rabbitmqctl clustering command:
+
+```
+$ sudo rabbitmqctl cluster `clustr list --cluster rabbitmq`
+```
 
 ## Contributing
 

data/lib/clustr/adapter/simpledb.rb

@@ -11,7 +11,7 @@ module Clustr
       # Initializes a new SimpleDB Adapter class. If the domain
       # that has been defined in the @key attribute does not exist,
       # it will create it.
-      def initialize
+      def initialize(*a)
         super
         sdb.domains.create(@key) unless domain.exists?
       end

data/lib/clustr/cli.rb

@@ -26,7 +26,6 @@ module Clustr
       # Set AWS Configuration if it has been passed in
       config = ["access_key_id", "secret_access_key", "region"]
       ::AWS.config(options.select { |k| config.include?(k) })
-      describe_aws_configuration
     end
 
     desc "version", "Displays the current version number of Clustr."
@@ -68,27 +67,5 @@ module Clustr
         @clusters ||= ClusterCollection.new(Config::Clusters.configuration)
       end
 
-      def aws_configuration
-        AWS.config.credentials
-      end
-
-      def aws_configured?
-        begin
-          aws_configuration
-        rescue
-          false
-        end
-      end
-
-      def describe_aws_configuration
-        if aws_configured?
-          config = aws_configuration
-          Log.info "AWS Region #{config[:region]}"
-          Log.info "AWS Access Key #{config[:access_key_id]}"
-        else
-          Log.warn "No AWS config detected."
-        end
-      end
-
   end
 end

data/lib/clustr/version.rb

@@ -1,4 +1,4 @@
 module Clustr
   # Version number of the Clustr gem
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clustr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - davidkelley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-30 00:00:00.000000000 Z
+date: 2014-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor