Sha256: 3b661114ecac0c1594d1df9f4425c3d5ab2db5376687b61e5eb7357cc184e1b8

Contents?: true

Size: 1.6 KB

Versions: 23

Compression:

Stored size: 1.6 KB

Contents

= gizzmo

Gizzmo is a command-line client for managing gizzard clusters.

== Installation and setup

Installation is a simple gem install.  You may find it useful to create a ~/.gizzmorc file, which is simply YAML key/values.  The keys are the long-style command line option keys converted into Ruby-style variables.  A common .gizzmorc will simply be:

    host: localhost
    port: 7917

== Usage

Run `gizzmo help` for up-to-date usage.

== Recipes

=== Block and unblock a shard

    BLOCKER=`gizzmo wrap com.twitter.gizzard.shards.BlockedShard a_shard`
    
    gizzmo unwrap $BLOCKER

=== Reweight a shard safely (the hard way)

    NEW_WEIGHT=1
    REPL=`gizzmo wrap com.twitter.service.flock.edges.ReplicatingShard a_shard`
    PARENT=`gizzmo links $REPL | cut -f 1 | grep -v $REPL | head -1`
    gizzmo addlink $PARENT a_shard $NEW_WEIGHT
    gizzmo unwrap $REPL
    
== Contributing

Contributions are welcome!  Please send a pull request, or if you're internal to Twitter, please make a branch!  Commits to master, and/or patches without minimal test coverage will be rejected/reverted.

== Running tests

The tests may be somewhat difficult to run outside of Twitter.  They assume the following:

1. You have a running FlockDB development environment exposing a ShardManager over thrift on localhost:7917
2. You don't mind blowing away the data in your dev environment.
3. Your MySQL username and password are in the environment variables DB_USERNAME and DB_PASSWORD

Assuming you've put together the dependencies, ./test/test.sh should run fine.
 
== Copyright

Copyright (c) 2010 Twitter, Inc. See LICENSE for details.
 

Version data entries

23 entries across 23 versions & 1 rubygems

Version Path
gizzmo-0.12.0 README.rdoc
gizzmo-0.11.4 README.rdoc
gizzmo-0.11.3 README.rdoc
gizzmo-0.11.2 README.rdoc
gizzmo-0.11.1 README.rdoc
gizzmo-0.11.0 README.rdoc
gizzmo-0.10.1 README.rdoc
gizzmo-0.10.0 README.rdoc
gizzmo-0.9.0 README.rdoc
gizzmo-0.8.3 README.rdoc
gizzmo-0.8.2 README.rdoc
gizzmo-0.8.1 README.rdoc
gizzmo-0.8.0 README.rdoc
gizzmo-0.7.5 README.rdoc
gizzmo-0.7.4 README.rdoc
gizzmo-0.7.0 README.rdoc
gizzmo-0.6.0 README.rdoc
gizzmo-0.5.0 README.rdoc
gizzmo-0.4.2 README.rdoc
gizzmo-0.4.1 README.rdoc