Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Keshava Munegowda <[email protected]>
  • Loading branch information
kmgowda authored Jun 6, 2020
1 parent 5db83a6 commit 3f6a959
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Currently SBK supports benchmarking of
16. [PostgreSQL](https://github.com/kmgowda/SBK/tree/master/driver-jdbc#jdbc-with-postgresql)
17. [Microsoft SQL](https://github.com/kmgowda/SBK/tree/master/driver-jdbc#jdbc-with-microsoft-sql-server)
18. [SQLite](https://github.com/kmgowda/SBK/tree/master/driver-jdbc#jdbc-with-sqlite)
19. [MinIO](https://min.io)

In future, many more storage storage systems drivers will be plugged in.

Expand All @@ -43,7 +44,7 @@ we welcome open source developers to contribute to this project by adding a driv
### Prerequisites

- Java 8+
- Gradle 4+
- Gradle 6+

### Building

Expand Down Expand Up @@ -73,8 +74,9 @@ Running SBK locally:
usage: sbk
-class <arg> Storage Driver Class,
Available Drivers [Artemis, AsyncFile, BookKeeper,
ConcurrentQ, File, HDFS, Jdbc, Kafka, Nats,
NatsStream, Nsq, Pravega, Pulsar, RabbitMQ, RocketMQ]
ConcurrentQ, File, FileChannel, HDFS, Jdbc, Kafka,
MinIO, Nats, NatsStream, Nsq, Pravega, Pulsar,
RabbitMQ, RocketMQ]
-context <arg> Prometheus Metric context;default context:
8080/metrics; 'no' disables the metrics
-flush <arg> Each Writer calls flush after writing <arg> number of
Expand Down Expand Up @@ -260,7 +262,7 @@ All submissions to the master are done through pull requests. If you'd like to m
3. Make your changes.
* you can refer ([Oracle Java Coding Style](https://www.oracle.com/technetwork/java/codeconvtoc-136057.html)) for coding style; however, Running the Gradle build helps you to fix the Coding syte issues too.
4. Verify all changes are working and Gradle build checkstyle is good.
5. Submit a pull request with Issue Numer, Description and your Sign-off.
5. Submit a pull request with Issue numer, Description and your Sign-off.

Make sure that you update the issue with all details of testing you have done; it will helpful for me to review and merge.

Expand All @@ -272,8 +274,8 @@ git push --force origin <pr-branch-name>
```
in the above, I'm assuming that:

* upstream is sbk/sbk.git
* origin is youraccount/sbk.git
* upstream is kmgowda/SBK.git
* origin is youraccount/SBK.git

The rebase might introduce conflicts, so you better do it frequently to avoid outrageous sessions of conflict resolving.

Expand All @@ -286,7 +288,7 @@ To import the source into IntelliJ:
1. Import the project directory into IntelliJ IDE. It will automatically detect the gradle project and import things correctly.
2. Enable `Annotation Processing` by going to `Build, Execution, Deployment` -> `Compiler` > `Annotation Processors` and checking 'Enable annotation processing'.
3. Install the `Lombok Plugin`. This can be found in `Preferences` -> `Plugins`. Restart your IDE.
4. Pravega should now compile properly.
4. SBK should now compile properly.

For eclipse, you can generate eclipse project files by running `./gradlew eclipse`.

Expand Down Expand Up @@ -384,16 +386,17 @@ tar -xvf ./build/distributions/sbk.tar -C ./build/distributions/.
Example: For pulsar driver
```
<SBK directory>./build/distributions/sbk/bin/sbk -class pulsar -help
usage: sbk -class Pulsar
usage: sbk -class Pulsar
-ackQuorum <arg> AckQuorum (default: 1)
-admin <arg> Admin URI, required to create the partitioned
topic
-broker <arg> Broker URI
-class <arg> Storage Driver Class,
Available Drivers [Artemis, AsyncFile, BookKeeper,
ConcurrentQ, File, HDFS, Jdbc, Kafka, Nats,
NatsStream, Nsq, Pravega, Pulsar, RabbitMQ,
RocketMQ]
ConcurrentQ, File, FileChannel, HDFS, Jdbc, Kafka,
MinIO, Nats, NatsStream, Nsq, Pravega, Pulsar,
RabbitMQ, RocketMQ]
-cluster <arg> Cluster name (optional parameter)
-context <arg> Prometheus Metric context;default context:
8080/metrics; 'no' disables the metrics
Expand Down

0 comments on commit 3f6a959

Please sign in to comment.