Github user srdo commented on a diff in the pull request:
https://github.com/apache/storm/pull/2637#discussion_r182955561
--- Diff: docs/storm-kafka-client.md ---
@@ -313,4 +313,25 @@ KafkaSpoutConfig<String, String> kafkaConf =
KafkaSpoutConfig
.setTupleTrackingEnforced(true)
```
-Note: This setting has no effect with AT_LEAST_ONCE processing guarantee,
where tuple tracking is required and therefore always enabled.
\ No newline at end of file
+Note: This setting has no effect with AT_LEAST_ONCE processing guarantee,
where tuple tracking is required and therefore always enabled.
+
+# Migrating a `storm-kafka` spout to use `storm-kafka-client`
+
+This may not be an exhaustive list because the `storm-kafka` configs were
taken from Storm 0.9.6
+[SpoutConfig](https://github.com/apache/storm/blob/v0.9.6/external/storm-kafka/src/jvm/storm/kafka/SpoutConfig.java)
and
+[KafkaConfig](https://github.com/apache/storm/blob/v0.9.6/external/storm-kafka/src/jvm/storm/kafka/KafkaConfig.java).
+`storm-kafka-client` spout configurations were taken from Storm 1.0.6
+[KafkaSpoutConfig](https://github.com/apache/storm/blob/v1.0.6/external/storm-kafka-client/src/main/java/org/apache/storm/kafka/spout/KafkaSpoutConfig.java).
+
+| Storm-0.9.6 SpoutConfig | Storm-1.0.6 KafkaSpoutConfig name |
KafkaSpoutConfig usage help |
+| ------------------------- | ---------------------------- |
--------------------------- |
+| **Setting:** `startOffsetTime`<br><br> **Default:**
`EarliestTime`<br>________________________________________________ <br>
`forceFromStart` <br> **Default:** `false` <br><br> `startOffsetTime` &
`forceFromStart` together determine where consumer offsets are being read from,
ZooKeeper, beginning, or end of Kafka stream | **Setting:**
[`FirstPollOffsetStrategy`](javadocs/org/apache/storm/kafka/spout/KafkaSpoutConfig.FirstPollOffsetStrategy.html)<br>
**Default:** `UNCOMMITTED_EARLIEST` <br><br> [Refer to this
gist](https://gist.github.com/srishtyagrawal/e8f512b2b7f61f239b1bb5dc15d2437b)
for choosing the right `FirstPollOffsetStrategy` based on your
`startOffsetTime` & `forceFromStart` settings | **Import package:**
`org.apache.storm.kafka.spout.KafkaSpoutConfig.FirstPollOffsetStrategy.<strategy-name>`
<br><br> **Usage:**
[`<KafkaSpoutConfig-Builder>.setFirstPollOffsetStrategy(<strategy-name>)`](javadocs/org/apache/storm/kafka/spout/KafkaSpoutConfig.Builder.html#setFirstPollOffse
tStrategy-org.apache.storm.kafka.spout.KafkaSpoutConfig.FirstPollOffsetStrategy-)|
--- End diff --
Nit: The phrasing for the old consumer properties is a little awkward. How
about "`startOffsetTime` & `forceFromStart` together determine the starting
offset. `forceFromStart` determines whether the Zookeeper offset is ignored.
`startOffsetTime` sets the timestamp that determines the beginning offset, in
case there is no offset in Zookeeper, or the Zookeeper offset is ignored"
---
