kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From guozh...@apache.org
Subject [kafka-site] branch asf-site updated: MINOR: add config docs to manage-topics (#185)
Date Mon, 11 Feb 2019 18:27:19 GMT
This is an automated email from the ASF dual-hosted git repository.

guozhang pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/kafka-site.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new 87c8a52  MINOR: add config docs to manage-topics (#185)
87c8a52 is described below

commit 87c8a523301d11c26fe3d4af9e76be13d2671d00
Author: John Roesler <vvcephei@users.noreply.github.com>
AuthorDate: Mon Feb 11 12:27:14 2019 -0600

    MINOR: add config docs to manage-topics (#185)
    
    The config documentation from https://github.com/apache/kafka/pull/3459/files#diff-8dfad184a2604987442db10d8bebf8bc
got lost at some point. This PR adds it back.
    
    Reviewers: Guozhang Wang <wangguoz@gmail.com>
---
 10/streams/developer-guide/manage-topics.html | 38 +++++++++++++++++++++++----
 11/streams/developer-guide/manage-topics.html | 38 +++++++++++++++++++++++----
 20/streams/developer-guide/manage-topics.html | 38 +++++++++++++++++++++++----
 21/streams/developer-guide/manage-topics.html | 38 +++++++++++++++++++++++----
 4 files changed, 132 insertions(+), 20 deletions(-)

diff --git a/10/streams/developer-guide/manage-topics.html b/10/streams/developer-guide/manage-topics.html
index 094ed1d..0c19118 100644
--- a/10/streams/developer-guide/manage-topics.html
+++ b/10/streams/developer-guide/manage-topics.html
@@ -67,10 +67,38 @@
     </div>
     <div class="section" id="internal-topics">
       <span id="streams-developer-guide-topics-internal"></span><h2>Internal
topics<a class="headerlink" href="#internal-topics" title="Permalink to this headline"></a></h2>
-      <p>Internal topics are used internally by the Kafka Streams application while
executing, for example the
-        changelog topics for state stores. These topics are created by the application and
are only used by that stream application.</p>
-      <p>If security is enabled on the Kafka brokers, you must grant the underlying
clients admin permissions so that they can
-        create internal topics set. For more information, see <a class="reference internal"
href="security.html#streams-developer-guide-security"><span class="std std-ref">Streams
Security</span></a>.</p>
+      <p>
+        Internal topics are used internally by the Kafka Streams application
+        while executing, for example the changelog topics for state stores.
+        These topics are created by the application and are only used by that
+        stream application.
+      </p>
+      <p>
+        If security is enabled on the Kafka brokers, you must grant the
+        underlying clients admin permissions so that they can
+        create internal topics set. For more information, see
+        <a class="reference internal" href="security.html#streams-developer-guide-security">
+          <span class="std std-ref">Streams Security</span>
+        </a>.
+      </p>
+      <p>
+        Kafka Streams automatically creates internal repartitioning and changelog
+        topics, and does <em>not</em> use broker auto-topic creation.
+        Therefore, internal topics take on the default broker configurations for
+        new topics.
+        You can override the default configs used when creating these topics by
+        adding any configs from <code>TopicConfig</code> to your
+        <code>StreamsConfig</code> with the prefix
+        <code>StreamsConfig.topicPrefix()</code>.
+      </p>
+      <p>
+        <pre class="brush: java;">
+          Properties config = new Properties();
+          config.put(StreamsConfig.APPLICATION_ID_CONFIG, "myapp");
+          config.put(StreamsConfig.topicPrefix(TopicConfig.SEGMENT_MS_CONFIG), 100);
+          KafkaStreams streams = new KafkaStreams(topology, config);
+        </pre>
+      </p>
       <div class="admonition note">
         <p class="first admonition-title">Note</p>
         <p class="last">The internal topics follow the naming convention <code class="docutils
literal"><span class="pre">&lt;application.id&gt;-&lt;operatorName&gt;-&lt;suffix&gt;</span></code>,
but this convention
@@ -126,4 +154,4 @@
         // Display docs subnav items
         $('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
     });
-</script>
\ No newline at end of file
+</script>
diff --git a/11/streams/developer-guide/manage-topics.html b/11/streams/developer-guide/manage-topics.html
index 094ed1d..0c19118 100644
--- a/11/streams/developer-guide/manage-topics.html
+++ b/11/streams/developer-guide/manage-topics.html
@@ -67,10 +67,38 @@
     </div>
     <div class="section" id="internal-topics">
       <span id="streams-developer-guide-topics-internal"></span><h2>Internal
topics<a class="headerlink" href="#internal-topics" title="Permalink to this headline"></a></h2>
-      <p>Internal topics are used internally by the Kafka Streams application while
executing, for example the
-        changelog topics for state stores. These topics are created by the application and
are only used by that stream application.</p>
-      <p>If security is enabled on the Kafka brokers, you must grant the underlying
clients admin permissions so that they can
-        create internal topics set. For more information, see <a class="reference internal"
href="security.html#streams-developer-guide-security"><span class="std std-ref">Streams
Security</span></a>.</p>
+      <p>
+        Internal topics are used internally by the Kafka Streams application
+        while executing, for example the changelog topics for state stores.
+        These topics are created by the application and are only used by that
+        stream application.
+      </p>
+      <p>
+        If security is enabled on the Kafka brokers, you must grant the
+        underlying clients admin permissions so that they can
+        create internal topics set. For more information, see
+        <a class="reference internal" href="security.html#streams-developer-guide-security">
+          <span class="std std-ref">Streams Security</span>
+        </a>.
+      </p>
+      <p>
+        Kafka Streams automatically creates internal repartitioning and changelog
+        topics, and does <em>not</em> use broker auto-topic creation.
+        Therefore, internal topics take on the default broker configurations for
+        new topics.
+        You can override the default configs used when creating these topics by
+        adding any configs from <code>TopicConfig</code> to your
+        <code>StreamsConfig</code> with the prefix
+        <code>StreamsConfig.topicPrefix()</code>.
+      </p>
+      <p>
+        <pre class="brush: java;">
+          Properties config = new Properties();
+          config.put(StreamsConfig.APPLICATION_ID_CONFIG, "myapp");
+          config.put(StreamsConfig.topicPrefix(TopicConfig.SEGMENT_MS_CONFIG), 100);
+          KafkaStreams streams = new KafkaStreams(topology, config);
+        </pre>
+      </p>
       <div class="admonition note">
         <p class="first admonition-title">Note</p>
         <p class="last">The internal topics follow the naming convention <code class="docutils
literal"><span class="pre">&lt;application.id&gt;-&lt;operatorName&gt;-&lt;suffix&gt;</span></code>,
but this convention
@@ -126,4 +154,4 @@
         // Display docs subnav items
         $('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
     });
-</script>
\ No newline at end of file
+</script>
diff --git a/20/streams/developer-guide/manage-topics.html b/20/streams/developer-guide/manage-topics.html
index 094ed1d..0c19118 100644
--- a/20/streams/developer-guide/manage-topics.html
+++ b/20/streams/developer-guide/manage-topics.html
@@ -67,10 +67,38 @@
     </div>
     <div class="section" id="internal-topics">
       <span id="streams-developer-guide-topics-internal"></span><h2>Internal
topics<a class="headerlink" href="#internal-topics" title="Permalink to this headline"></a></h2>
-      <p>Internal topics are used internally by the Kafka Streams application while
executing, for example the
-        changelog topics for state stores. These topics are created by the application and
are only used by that stream application.</p>
-      <p>If security is enabled on the Kafka brokers, you must grant the underlying
clients admin permissions so that they can
-        create internal topics set. For more information, see <a class="reference internal"
href="security.html#streams-developer-guide-security"><span class="std std-ref">Streams
Security</span></a>.</p>
+      <p>
+        Internal topics are used internally by the Kafka Streams application
+        while executing, for example the changelog topics for state stores.
+        These topics are created by the application and are only used by that
+        stream application.
+      </p>
+      <p>
+        If security is enabled on the Kafka brokers, you must grant the
+        underlying clients admin permissions so that they can
+        create internal topics set. For more information, see
+        <a class="reference internal" href="security.html#streams-developer-guide-security">
+          <span class="std std-ref">Streams Security</span>
+        </a>.
+      </p>
+      <p>
+        Kafka Streams automatically creates internal repartitioning and changelog
+        topics, and does <em>not</em> use broker auto-topic creation.
+        Therefore, internal topics take on the default broker configurations for
+        new topics.
+        You can override the default configs used when creating these topics by
+        adding any configs from <code>TopicConfig</code> to your
+        <code>StreamsConfig</code> with the prefix
+        <code>StreamsConfig.topicPrefix()</code>.
+      </p>
+      <p>
+        <pre class="brush: java;">
+          Properties config = new Properties();
+          config.put(StreamsConfig.APPLICATION_ID_CONFIG, "myapp");
+          config.put(StreamsConfig.topicPrefix(TopicConfig.SEGMENT_MS_CONFIG), 100);
+          KafkaStreams streams = new KafkaStreams(topology, config);
+        </pre>
+      </p>
       <div class="admonition note">
         <p class="first admonition-title">Note</p>
         <p class="last">The internal topics follow the naming convention <code class="docutils
literal"><span class="pre">&lt;application.id&gt;-&lt;operatorName&gt;-&lt;suffix&gt;</span></code>,
but this convention
@@ -126,4 +154,4 @@
         // Display docs subnav items
         $('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
     });
-</script>
\ No newline at end of file
+</script>
diff --git a/21/streams/developer-guide/manage-topics.html b/21/streams/developer-guide/manage-topics.html
index 094ed1d..0c19118 100644
--- a/21/streams/developer-guide/manage-topics.html
+++ b/21/streams/developer-guide/manage-topics.html
@@ -67,10 +67,38 @@
     </div>
     <div class="section" id="internal-topics">
       <span id="streams-developer-guide-topics-internal"></span><h2>Internal
topics<a class="headerlink" href="#internal-topics" title="Permalink to this headline"></a></h2>
-      <p>Internal topics are used internally by the Kafka Streams application while
executing, for example the
-        changelog topics for state stores. These topics are created by the application and
are only used by that stream application.</p>
-      <p>If security is enabled on the Kafka brokers, you must grant the underlying
clients admin permissions so that they can
-        create internal topics set. For more information, see <a class="reference internal"
href="security.html#streams-developer-guide-security"><span class="std std-ref">Streams
Security</span></a>.</p>
+      <p>
+        Internal topics are used internally by the Kafka Streams application
+        while executing, for example the changelog topics for state stores.
+        These topics are created by the application and are only used by that
+        stream application.
+      </p>
+      <p>
+        If security is enabled on the Kafka brokers, you must grant the
+        underlying clients admin permissions so that they can
+        create internal topics set. For more information, see
+        <a class="reference internal" href="security.html#streams-developer-guide-security">
+          <span class="std std-ref">Streams Security</span>
+        </a>.
+      </p>
+      <p>
+        Kafka Streams automatically creates internal repartitioning and changelog
+        topics, and does <em>not</em> use broker auto-topic creation.
+        Therefore, internal topics take on the default broker configurations for
+        new topics.
+        You can override the default configs used when creating these topics by
+        adding any configs from <code>TopicConfig</code> to your
+        <code>StreamsConfig</code> with the prefix
+        <code>StreamsConfig.topicPrefix()</code>.
+      </p>
+      <p>
+        <pre class="brush: java;">
+          Properties config = new Properties();
+          config.put(StreamsConfig.APPLICATION_ID_CONFIG, "myapp");
+          config.put(StreamsConfig.topicPrefix(TopicConfig.SEGMENT_MS_CONFIG), 100);
+          KafkaStreams streams = new KafkaStreams(topology, config);
+        </pre>
+      </p>
       <div class="admonition note">
         <p class="first admonition-title">Note</p>
         <p class="last">The internal topics follow the naming convention <code class="docutils
literal"><span class="pre">&lt;application.id&gt;-&lt;operatorName&gt;-&lt;suffix&gt;</span></code>,
but this convention
@@ -126,4 +154,4 @@
         // Display docs subnav items
         $('.b-nav__docs').parent().toggleClass('nav__item__with__subs--expanded');
     });
-</script>
\ No newline at end of file
+</script>


Mime
View raw message