Admin Tool

Admin Tool(s)

Since 0.60, Voldemort has included an admin protocol that could be used for functionality such as streaming and migrating partitions and changing metadata e.g., adding new machines to the cluster or adding new stores. Initially this was meant for operations such as node-to-node gossip and rebalancing. Recently command line tools have been added to make it easy to use this functionality.

This requires a recent version of Voldemort. Cloning master is one way:

git clone git://github.com/voldemort/voldemort.git

Basic admin tool (voldemort-admin-tool.sh) usage

Getting help

To get help, run ./bin/voldemort-admin-tool.sh --help

The options are:

--add-stores <stores.xml>               Add stores in this stores.xml
--ascii                                 Fetch keys as ASCII
--delete-partitions <Integer:           Delete partitions
  partition-ids>
--delete-store <store-name>             Delete store
--fetch-entries <Integer: partition-    Fetch full entries
  ids>
--fetch-keys <Integer: partition-ids>   Fetch keys
--get-metadata <metadata-key>           retreive metadata information [stores.
                                          xml | cluster.xml]
--help                                  print help information
--node <Integer: node-id>               node id
--outdir <output-directory>             Output directory
--parallelism <Integer: parallelism>    Parallelism
--restore                               Restore from replication
--stores <store-names>                  Store names
--update-entries <input-directory>      [EXPERIMENTAL] Insert or update entries
--url <bootstrap-url>                   [REQUIRED] bootstrap URL

Functionality

Deleting stores

To delete a store, use the --delete-store option e.g.,

./bin/voldemort-admin-tool.sh --url tcp://foo:6666 --delete-store bar

Note, for read/write stores this doesn’t delete the data in the stores.

Adding stores

To add stores, use --add-stores option e.g.,

./bin/voldemort-admin-tool.sh --url tcp://foo:6666 --add-stores new-stores.xml

This will add all stores specified in new-stores.xml (note: this means new-stores.xml can only contain descriptions for new stores)