MINOR: Improve Streams Dev Guide content on web docs This PR migrates content from CP Streams Dev Guide.
Here is the top-level page:  Here is a child page:  See related: https://github.com/apache/kafka-site/pull/112 Author: Joel Hamill <[email protected]> Reviewers: Guozhang Wang <[email protected]> Closes #4252 from joel-hamill/20171122-migrate-cp-dev-guide Project: http://git-wip-us.apache.org/repos/asf/kafka/repo Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/3e2fe17c Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/3e2fe17c Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/3e2fe17c Branch: refs/heads/trunk Commit: 3e2fe17c084370d81ffd35a03a5ed463945ee263 Parents: 7d6f6f7 Author: Joel Hamill <[email protected]> Authored: Thu Dec 21 11:15:54 2017 -0800 Committer: Guozhang Wang <[email protected]> Committed: Thu Dec 21 11:15:54 2017 -0800 ---------------------------------------------------------------------- docs/documentation/streams/developer-guide.html | 19 - .../streams/developer-guide/app-reset-tool.html | 19 + .../streams/developer-guide/config-streams.html | 19 + .../streams/developer-guide/datatypes.html | 19 + .../streams/developer-guide/dsl-api.html | 19 + .../streams/developer-guide/index.html | 19 + .../developer-guide/interactive-queries.html | 19 + .../streams/developer-guide/manage-topics.html | 19 + .../streams/developer-guide/memory-mgmt.html | 19 + .../streams/developer-guide/processor-api.html | 19 + .../streams/developer-guide/running-app.html | 19 + .../streams/developer-guide/security.html | 19 + .../streams/developer-guide/write-streams.html | 19 + docs/images/streams-elastic-scaling-1.png | Bin 0 -> 88673 bytes docs/images/streams-elastic-scaling-2.png | Bin 0 -> 91141 bytes docs/images/streams-elastic-scaling-3.png | Bin 0 -> 88604 bytes docs/images/streams-session-windows-01.png | Bin 0 -> 49003 bytes docs/images/streams-session-windows-02.png | Bin 0 -> 55956 bytes docs/images/streams-time-windows-hopping.png | Bin 0 -> 110392 bytes docs/images/streams-time-windows-tumbling.png | Bin 0 -> 63888 bytes docs/streams/architecture.html | 4 +- docs/streams/core-concepts.html | 4 +- docs/streams/developer-guide.html | 3026 ----------------- .../streams/developer-guide/app-reset-tool.html | 173 + .../streams/developer-guide/config-streams.html | 717 ++++ docs/streams/developer-guide/datatypes.html | 223 ++ docs/streams/developer-guide/dsl-api.html | 3208 ++++++++++++++++++ docs/streams/developer-guide/index.html | 102 + .../developer-guide/interactive-queries.html | 530 +++ docs/streams/developer-guide/manage-topics.html | 129 + docs/streams/developer-guide/memory-mgmt.html | 241 ++ docs/streams/developer-guide/processor-api.html | 437 +++ docs/streams/developer-guide/running-app.html | 197 ++ docs/streams/developer-guide/security.html | 176 + docs/streams/developer-guide/write-streams.html | 198 ++ docs/streams/index.html | 5 +- docs/streams/quickstart.html | 4 +- docs/streams/tutorial.html | 4 +- docs/streams/upgrade-guide.html | 2 +- 39 files changed, 6571 insertions(+), 3056 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide.html b/docs/documentation/streams/developer-guide.html deleted file mode 100644 index 8812737..0000000 --- a/docs/documentation/streams/developer-guide.html +++ /dev/null @@ -1,19 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> - -<!-- should always link the latest release's documentation --> -<!--#include virtual="../../streams/developer-guide.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/app-reset-tool.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/app-reset-tool.html b/docs/documentation/streams/developer-guide/app-reset-tool.html new file mode 100644 index 0000000..64a43aa --- /dev/null +++ b/docs/documentation/streams/developer-guide/app-reset-tool.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/app-reset-tool.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/config-streams.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/config-streams.html b/docs/documentation/streams/developer-guide/config-streams.html new file mode 100644 index 0000000..979f66d --- /dev/null +++ b/docs/documentation/streams/developer-guide/config-streams.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/config-streams.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/datatypes.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/datatypes.html b/docs/documentation/streams/developer-guide/datatypes.html new file mode 100644 index 0000000..98dd3a1 --- /dev/null +++ b/docs/documentation/streams/developer-guide/datatypes.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/datatypes.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/dsl-api.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/dsl-api.html b/docs/documentation/streams/developer-guide/dsl-api.html new file mode 100644 index 0000000..1bbc06d --- /dev/null +++ b/docs/documentation/streams/developer-guide/dsl-api.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/dsl-api.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/index.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/index.html b/docs/documentation/streams/developer-guide/index.html new file mode 100644 index 0000000..3a61247 --- /dev/null +++ b/docs/documentation/streams/developer-guide/index.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/index.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/interactive-queries.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/interactive-queries.html b/docs/documentation/streams/developer-guide/interactive-queries.html new file mode 100644 index 0000000..0506012 --- /dev/null +++ b/docs/documentation/streams/developer-guide/interactive-queries.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/interactive-queries.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/manage-topics.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/manage-topics.html b/docs/documentation/streams/developer-guide/manage-topics.html new file mode 100644 index 0000000..f422554 --- /dev/null +++ b/docs/documentation/streams/developer-guide/manage-topics.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/manage-topics.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/memory-mgmt.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/memory-mgmt.html b/docs/documentation/streams/developer-guide/memory-mgmt.html new file mode 100644 index 0000000..024e137 --- /dev/null +++ b/docs/documentation/streams/developer-guide/memory-mgmt.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/memory-mgmt.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/processor-api.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/processor-api.html b/docs/documentation/streams/developer-guide/processor-api.html new file mode 100644 index 0000000..9e9ab91 --- /dev/null +++ b/docs/documentation/streams/developer-guide/processor-api.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/processor-api.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/running-app.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/running-app.html b/docs/documentation/streams/developer-guide/running-app.html new file mode 100644 index 0000000..05d5f0b --- /dev/null +++ b/docs/documentation/streams/developer-guide/running-app.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/running-app.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/security.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/security.html b/docs/documentation/streams/developer-guide/security.html new file mode 100644 index 0000000..5d6e5f0 --- /dev/null +++ b/docs/documentation/streams/developer-guide/security.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/security.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/documentation/streams/developer-guide/write-streams.html ---------------------------------------------------------------------- diff --git a/docs/documentation/streams/developer-guide/write-streams.html b/docs/documentation/streams/developer-guide/write-streams.html new file mode 100644 index 0000000..976c6fe --- /dev/null +++ b/docs/documentation/streams/developer-guide/write-streams.html @@ -0,0 +1,19 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<!-- should always link the latest release's documentation --> +<!--#include virtual="../../../streams/developer-guide/write-streams.html" --> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/images/streams-elastic-scaling-1.png ---------------------------------------------------------------------- diff --git a/docs/images/streams-elastic-scaling-1.png b/docs/images/streams-elastic-scaling-1.png new file mode 100644 index 0000000..7823ac1 Binary files /dev/null and b/docs/images/streams-elastic-scaling-1.png differ http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/images/streams-elastic-scaling-2.png ---------------------------------------------------------------------- diff --git a/docs/images/streams-elastic-scaling-2.png b/docs/images/streams-elastic-scaling-2.png new file mode 100644 index 0000000..374b5ff Binary files /dev/null and b/docs/images/streams-elastic-scaling-2.png differ http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/images/streams-elastic-scaling-3.png ---------------------------------------------------------------------- diff --git a/docs/images/streams-elastic-scaling-3.png b/docs/images/streams-elastic-scaling-3.png new file mode 100644 index 0000000..0b4adaf Binary files /dev/null and b/docs/images/streams-elastic-scaling-3.png differ http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/images/streams-session-windows-01.png ---------------------------------------------------------------------- diff --git a/docs/images/streams-session-windows-01.png b/docs/images/streams-session-windows-01.png new file mode 100644 index 0000000..2d711d8 Binary files /dev/null and b/docs/images/streams-session-windows-01.png differ http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/images/streams-session-windows-02.png ---------------------------------------------------------------------- diff --git a/docs/images/streams-session-windows-02.png b/docs/images/streams-session-windows-02.png new file mode 100644 index 0000000..6c0382f Binary files /dev/null and b/docs/images/streams-session-windows-02.png differ http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/images/streams-time-windows-hopping.png ---------------------------------------------------------------------- diff --git a/docs/images/streams-time-windows-hopping.png b/docs/images/streams-time-windows-hopping.png new file mode 100644 index 0000000..5fcb9d2 Binary files /dev/null and b/docs/images/streams-time-windows-hopping.png differ http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/images/streams-time-windows-tumbling.png ---------------------------------------------------------------------- diff --git a/docs/images/streams-time-windows-tumbling.png b/docs/images/streams-time-windows-tumbling.png new file mode 100644 index 0000000..571ab79 Binary files /dev/null and b/docs/images/streams-time-windows-tumbling.png differ http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/streams/architecture.html ---------------------------------------------------------------------- diff --git a/docs/streams/architecture.html b/docs/streams/architecture.html index 0dbb1dc..efc01bd 100644 --- a/docs/streams/architecture.html +++ b/docs/streams/architecture.html @@ -110,7 +110,7 @@ <p> Kafka Streams builds on fault-tolerance capabilities integrated natively within Kafka. Kafka partitions are highly available and replicated; so when stream data is persisted to Kafka it is available even if the application fails and needs to re-process it. Tasks in Kafka Streams leverage the fault-tolerance capability - offered by the <a href="https://www.confluent.io/blog/tutorial-getting-started-with-the-new-apache-kafka-0.9-consumer-client/";>Kafka consumer client</a> to handle failures. + offered by the Kafka consumer client to handle failures. If a task runs on a machine that fails, Kafka Streams automatically restarts the task in one of the remaining running instances of the application. </p> @@ -143,7 +143,7 @@ <!--#include virtual="../../includes/_docs_banner.htm" --> <ul class="breadcrumbs"> <li><a href="/documentation">Documentation</a></li> - <li><a href="/documentation/streams">Kafka Streams API</a></li> + <li><a href="/documentation/streams">Kafka Streams</a></li> </ul> <div class="p-content"></div> </div> http://git-wip-us.apache.org/repos/asf/kafka/blob/3e2fe17c/docs/streams/core-concepts.html ---------------------------------------------------------------------- diff --git a/docs/streams/core-concepts.html b/docs/streams/core-concepts.html index dbc3f21..1675c1f 100644 --- a/docs/streams/core-concepts.html +++ b/docs/streams/core-concepts.html @@ -23,7 +23,7 @@ <div class="sticky-top"> <div style="height:35px"> <a href="/{{version}}/documentation/streams/">Introduction</a> - <a href="/{{version}}/documentation/streams/developer-guide">Developer Guide</a> + <a href="/{{version}}/documentation/streams/developer-guide/">Developer Guide</a> <a class="active-menu-item" href="/{{version}}/documentation/streams/core-concepts">Concepts</a> <a href="/{{version}}/documentation/streams/quickstart">Run Demo App</a> <a href="/{{version}}/documentation/streams/tutorial">Tutorial: Write App</a> @@ -180,7 +180,7 @@ <!--#include virtual="../../includes/_docs_banner.htm" --> <ul class="breadcrumbs"> <li><a href="/documentation">Documentation</a></li> - <li><a href="/documentation/streams">Kafka Streams API</a></li> + <li><a href="/documentation/streams">Kafka Streams</a></li> </ul> <div class="p-content"></div> </div>
