Merge pull request #37 from EladLeev/imporve-doc

Update main & Kafka doc

Author: vongosling

docs/benchmarks/index.md

@@ -22,15 +22,52 @@ OpenMessaging benchmarking suites are currently available for the following syst
 * [Apache RocketMQ](https://rocketmq.apache.org)
 * [Apache Pulsar](https://pulsar.incubator.apache.org)
 * [Apache Kafka](https://kafka.apache.org)
+* [RabbitMQ](https://www.rabbitmq.com/)
+* [NATS Streaming](https://nats.io/)
+* [Redis](https://redis.com/)
+* [Pravega](https://pravega.io/)
 
-> Benchmarking suites for [RabbitMQ](https://www.rabbitmq.com) will be available soon.
 
 For each platform, the benchmarking suite includes easy-to-use scripts for deploying that platform on [AlibabaCloud](https://www.alibabacloud.com/) and [Amazon Web Services](https://aws.amazon.com) (AWS) and then running benchmarks upon deployment. For end-to-end instructions, see platform-specific docs for:
 
 * [Apache RocketMQ](../benchmarks/rocketmq)
 * [Apache Pulsar](../benchmarks/pulsar)
 * [Apache Kafka](../benchmarks/kafka)
 
+## OpenMessaging Benchmark Framework Components
+The OpenMessaging Benchmark Framework contains two components - the driver, and the workers.  
+**Driver** - The main "driver" is responsible to assign the tasks, creating the benchmark topic, creating the consumers & producers, etc. The benchmark executor.  
+**Worker** - A benchmark worker that listens to tasks to perform them. A worker ensemble communicates over HTTP (defaults to port `8080`). 
+
+## Basic usage & flags
+### Driver
+```
+$ sudo bin/benchmark \
+  --drivers driver-kafka/kafka-exactly-once.yaml \
+  --workers 1.2.3.4:8080,4.5.6.7:8080 \ # or -w 1.2.3.4:8080,4.5.6.7:8080
+  workloads/1-topic-16-partitions-1kb.yaml
+```
+| Flag                 | Description                                                       | Default |
+|----------------------|-------------------------------------------------------------------|---------|
+| -c / --csv           | Print results from this directory to a CSV file.                  | N/A     |
+| -d / --drivers       | Drivers list. eg.: pulsar/pulsar.yaml,kafka/kafka.yaml            | N/A     |
+| -x / --extra         | Allocate extra consumer workers when your backlog builds.         | `false` |
+| -w / --workers       | List of worker nodes. eg: http://1.2.3.4:8080,http://4.5.6.7:8080 | N/A     |
+| -wf / --workers-file | Path to a YAML file containing the list of workers addresses.     | N/A     |
+| -h / --help          | Print help message                                                | `false` |
+
+### Workers
+```
+$ sudo bin/benchmark-worker \
+  --port 9090 \
+  --stats-port 9091
+```
+| Flag               | Description              | Default |
+|--------------------|--------------------------|---------|
+| -p / --port        | HTTP port to listen to.  | `8080`  |
+| -sp / --stats-port | Stats port to listen to. | `8081`  |
+| -h / --help        | Print help message       | `false` |
+
 ## Benchmarking workloads
 
 Benchmarking workloads are specified in [YAML](http://yaml.org/) configuration files that are available in the [`workloads`](workloads) directory. The table below describes each workload in terms of the following parameters:

docs/benchmarks/kafka.md

@@ -18,6 +18,7 @@ $ cd openmessaging-benchmark
 You'll also need to have [Maven](https://maven.apache.org/install.html) installed.
 
 ## Create local artifacts
+> The current Kafka client version is `2.8.1`. In order to downgrade it edit the `./driver-kafka/pom.xml` file. 
 
 Once you have the repo cloned locally, you can create all the artifacts necessary to run the benchmarks with a single Maven command: