Adding instructions for running with Geode

geode/README.md

+<!--
+Copyright (c) 2014 - 2015 YCSB contributors. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License. You
+may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing
+permissions and limitations under the License. See accompanying
+LICENSE file.
+-->
+
+## Quick Start
+
+This section describes how to run YCSB on Apache Geode (incubating).
+
+### Get Apache Geode
+
+You can clone Geode source from apache or the github mirror and build
+
+```
+$ git clone https://github.com/apache/incubator-geode
+$ cd incubator-geode
+$ ./gradlew build installDist
+```
+You can also get the latest release (once it is available) from
+http://geode.incubator.apache.org/download/
+
+#### Start Geode Cluster
+
+Use the Geode shell (gfsh) to start the cluster. You will need to start
+at-least one locator which is a member discovery service and one or more
+Geode servers.
+
+Launch gfsh:
+
+```
+$ cd gemfire-assembly/build/install/apache-geode
+$ ./bin/gfsh
+```
+
+Start a locator and two servers:
+
+```
+gfsh> start locator --name=locator1
+gfsh> start server --name=server1 --server-port=40404
+gfsh> start server --name=server2 --server-port=40405
+```
+
+Create the "usertable" region required by YCSB driver:
+```
+gfsh>create region --name=usertable --type=PARTITION
+```
+gfsh has tab autocompletion, so you can play around with various options.
+
+### Start YCSB workload
+
+From your YCSB directory, you can run the ycsb workload as follows
+`./bin/ycsb load geode -P workloads/workloada -p geode.locator=host[port]`
+
+In the default mode, ycsb geode driver will connect as a client to the geode
+cluster. To make the ycsb driver a peer member of the distributed system
+use the property
+`-p geode.topology=p2p -p geode.locator=host[port]`
+
+Note:
+For update workloads, please use the property `-p writeallfields=true`