Document Pulsar and Kafka "modes" (openmessaging#13)

lucperkins · merlimat · commit 060b58d9151b · 2018-01-02T08:24:43.000+01:00
* add .tfvars files and update READMEs

* add variables for number of instances

* fix terraform formatting

* add docs for pulsar and kafka 'modes'
diff --git a/driver-kafka/README.md b/driver-kafka/README.md
@@ -107,3 +107,10 @@ $ cd /opt/benchmark
 $ sudo bin/benchmark --drivers driver-kafka/kafka.yaml workloads/*.yaml
 ```
 
+There are multiple Kafka "modes" for which you can run benchmarks. Each mode has its own YAML configuration file in the `driver-kafka` folder.
+
+Mode | Description | Config file
+:----|:------------|:-----------
+Standard | Kafka with message idempotence disabled (at-least-once semantics) | `kafka.yaml`
+Exactly once | Kafka with message idempotence enabled ("exactly-once" semantics) | `kafka-exactly-once.yaml`
+Sync | Kafka with durability enabled (all published messages synced to disk) | `kafka-sync.yaml`
diff --git a/driver-kafka/kafka-sync.yaml b/driver-kafka/kafka-sync.yaml
@@ -19,7 +19,6 @@
 
 # Kafka driver profile that is configuring to sync all
 # published messages to disk to achieve durability
-
 name: Kafka
 driverClass: io.openmessaging.benchmark.driver.kafka.KafkaBenchmarkDriver
 
diff --git a/driver-pulsar/README.md b/driver-pulsar/README.md
@@ -107,3 +107,9 @@ $ cd /opt/benchmark
 $ sudo bin/benchmark --drivers driver-pulsar/pulsar.yaml workloads/*.yaml
 ```
 
+There are multiple Pulsar "modes" for which you can run benchmarks. Each mode has its own YAML configuration file in the `driver-pulsar` folder.
+
+Mode | Description | Config file
+:----|:------------|:-----------
+Standard | Pulsar with message de-duplication disabled (at-least-once semantics) | `pulsar.yaml`
+Effectively once | Pulsar with message de-duplication enabled ("effectively-once" semantics) | `pulsar-effectively-once.yaml`
diff --git a/driver-pulsar/pulsar-effectively-once.yaml b/driver-pulsar/pulsar-effectively-once.yaml
@@ -17,7 +17,7 @@
 # under the License.
 #
 
-name: Pulsar-exactly-once
+name: Pulsar-effectively-once
 driverClass: io.openmessaging.benchmark.driver.pulsar.PulsarBenchmarkDriver
 
 # Pulsar client-specific configuration

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`# under the License.`
`18`	`18`	`#`
`19`	`19`
`20`		`-name: Pulsar-exactly-once`
	`20`	`+name: Pulsar-effectively-once`
`21`	`21`	`driverClass: io.openmessaging.benchmark.driver.pulsar.PulsarBenchmarkDriver`
`22`	`22`
`23`	`23`	`# Pulsar client-specific configuration`