From 94762e5303bb26aa9eba5d8a62f7c4d92220aff5 Mon Sep 17 00:00:00 2001 From: Jorge Quilcate Otoya Date: Mon, 8 Jan 2018 16:12:52 +0100 Subject: [PATCH] draft updating docs for streams app reset tool --- .../developer-guide/app-reset-tool.html | 27 +++++++++++++++++-- docs/streams/upgrade-guide.html | 6 +++++ 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/docs/streams/developer-guide/app-reset-tool.html b/docs/streams/developer-guide/app-reset-tool.html index 096d37a747ca8..d6979bee986ad 100644 --- a/docs/streams/developer-guide/app-reset-tool.html +++ b/docs/streams/developer-guide/app-reset-tool.html @@ -40,7 +40,7 @@ when resetting the application.

Here’s what the application reset tool does for each topic type:

@@ -87,12 +87,16 @@

Step 1: Run the application reset tool(default: localhost:9092) +--by-duration <String: urls> Reset offsets to offset by duration from + current timestamp. Format: 'PnDTnHnMnS' --config-file <String: file name> Property file containing configs to be passed to admin clients and embedded consumer. --dry-run Display the actions that would be performed without executing the reset commands. +--from-file <String: urls> Reset offsets to values defined in CSV + file. --input-topics <String: list> Comma-separated list of user input topics. For these topics, the tool will reset the offset to the earliest @@ -101,13 +105,32 @@

Step 1: Run the application reset tool(topics used in the through() method). For these topics, the tool will skip to the end. +--shift-by <Long: number-of-offsets> Reset offsets shifting current offset by + 'n', where 'n' can be positive or + negative +--to-datetime <String> Reset offsets to offset from datetime. + Format: 'YYYY-MM-DDTHH:mm:SS.sss' +--to-earliest Reset offsets to earliest offset. +--to-latest Reset offsets to latest offset. +--to-offset <Long> Reset offsets to a specific offset. --zookeeper Zookeeper option is deprecated by bootstrap.servers, as the reset tool would no longer access Zookeeper directly. -

Parameters can be combined as needed. For example, if you want to restart an application from an +

Consider the following as reset-offset scenarios for input-topics:

+
    +
  • by-duration
    • +
  • from-file
    • +
  • shift-by
    • +
  • to-datetime
    • +
  • to-earliest
    • +
  • to-latest
    • +
  • to-offset
    • +
+

Only one of these scenarios can be defined. If not, to-earliest will be executed by default

+

All the other parameters can be combined as needed. For example, if you want to restart an application from an empty internal state, but not reprocess previous data, simply omit the parameters --input-topics and --intermediate-topics.

diff --git a/docs/streams/upgrade-guide.html b/docs/streams/upgrade-guide.html index a8783310ecb52..54fa813deb51b 100644 --- a/docs/streams/upgrade-guide.html +++ b/docs/streams/upgrade-guide.html @@ -70,6 +70,12 @@

Streams API
  • added getAdminClient(config) that allows to override an AdminClient used for administrative requests such as internal topic creations, etc.
    • +

    Changes in StreamsResetter:

    +     + +

    Streams API changes in 1.0.0