kyleslattery/yokozuna

Riak + Solr

Yokozuna

NOTICE: This is a prototype. It is in developmental stages and is not recommended for production use at this time. Breaking changes could be made on any commit. After more testing and verification has been performed this will be considered as a replacement for Riak Search.

Yokozuna - Horizontal rope. The top rank in sumo, usually translated Grand Champion. The name comes from the rope a yokozuna wears.

The goal of the yokozuna application is to integrate Apache Solr with Riak in order to find the "top rank" documents for a given query.

Getting Started

Since Yokozuna is a prototype it takes more work to get running than vanilla Riak. If you are comfortable building Riak from source then you should be able to complete these steps.

Building

1. Clone the Yokozuna branch of Riak

    git clone -b yz-merge-1.3.0 git://github.com/basho/riak.git
    cd riak
   

2. Compile Riak and Yokozuna.

    make
   

3. Make a stage rel or stage devrel.

    make stagedevrel
   

Running

Yokozuna is merely an extension to Riak. This means that the basics of running and administrating Riak are no different than a vanilla build. The following instructions assume a devrel.

1. Start the nodes. After this has complete ps should show 4 beam.smp processes and 4 java processes. The Solr instances should be listening on ports 10016, 10026, 10036, and 10046.

    for d in dev/dev*; do $d/bin/riak start; done
    for d in dev/dev*; do $d/bin/riak ping; done
   

2. Form a cluster.

    for d in dev/dev{2,3,4}; do $d/bin/riak-admin cluster join [email protected]; done
    ./dev/dev1/bin/riak-admin cluster plan
    ./dev/dev1/bin/riak-admin cluster commit
   

Creating an Index

An index must be created in order for Yokozuna to index data.

Currently the index name is a 1:1 mapping with the bucket name. This may eventually change to a 1:M mapping from index to bucket.

You can create an index via the HTTP interface.

curl -XPUT -i -H 'content-type: application/json' http://localhost:10018/yz/index/name_of_index

Optionally, you may create an index from the console.

Index Some Data

Indexing data is a matter of writing data to KV. Currently Yokozuna knows hows to index plain text, XML, and JSON.

curl -H 'content-type: text/plain' -X PUT 'http://localhost:10018/buckets/name_of_bucket/keys/name' -d "Ryan Zezeski"

Searching

The syntax for querying Yokozuna is the same as querying a single instance of Solr. Yokozuna actually uses Solr's distributed search API but that is hidden for you. This means you don't have to worry about where your shards are located. This also means you should be able to use any off-the-shelf Solr client to query Yokozuna.

curl 'http://localhost:10018/search/name_of_index?q=text:Ryan'