root
/
kafka
mirror of https://github.com/apache/kafka.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

MINOR: Make 'Topic-Level Configs' a doc section for easier access 

Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Ismael Juma <ismael@juma.me.uk>

Closes #3415 from vahidhashemian/doc/make_topic_config_a_section

(cherry picked from commit 3bfc073f03)
Signed-off-by: Ismael Juma <ismael@juma.me.uk>
This commit is contained in:
Vahid Hashemian 2017-07-19 14:25:02 +01:00 committed by Ismael Juma
parent 81ceed30dc
commit 63a06c853e
4 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
clients/src/main/java/org/apache/kafka/common/config/TopicConfig.java
View File

@ -53,7 +53,7 @@ public class TopicConfig {
"we would fsync after every message; if it were 5 we would fsync after every five messages. " +
"In general we recommend you not set this and use replication for durability and allow the " +
"operating system's background flush capabilities as it is more efficient. This setting can " +
"be overridden on a per-topic basis (see <a href=\"#topic-config\">the per-topic configuration section</a>).";
"be overridden on a per-topic basis (see <a href=\"#topicconfigs\">the per-topic configuration section</a>).";
public static final String FLUSH_MS_CONFIG = "flush.ms";
public static final String FLUSH_MS_DOC = "This setting allows specifying a time interval at which we will " +

18
docs/configuration.html
View File

@ -27,13 +27,13 @@
<li><code>zookeeper.connect</code>
</ul>
Topic-level configurations and defaults are discussed in more detail <a href="#topic-config">below</a>.
Topic-level configurations and defaults are discussed in more detail <a href="#topicconfigs">below</a>.
<!--#include virtual="generated/kafka_config.html" -->
<p>More details about broker configuration can be found in the scala class <code>kafka.server.KafkaConfig</code>.</p>
<a id="topic-config" href="#topic-config">Topic-level configuration</a>
<h3><a id="topicconfigs" href="#topicconfigs">3.2 Topic-Level Configs</a></h3>
Configurations pertinent to topics have both a server default as well an optional per-topic override. If no per-topic configuration is given the server default is used. The override can be set at topic creation time by giving one or more <code>--config</code> options. This example creates a topic named <i>my-topic</i> with a custom max message size and flush rate:
<pre class="brush: bash;">
@ -60,7 +60,7 @@
<!--#include virtual="generated/topic_config.html" -->
<h3><a id="producerconfigs" href="#producerconfigs">3.2 Producer Configs</a></h3>
<h3><a id="producerconfigs" href="#producerconfigs">3.3 Producer Configs</a></h3>
Below is the configuration of the Java producer:
<!--#include virtual="generated/producer_config.html" -->
@ -70,16 +70,16 @@
here</a>.
</p>
<h3><a id="consumerconfigs" href="#consumerconfigs">3.3 Consumer Configs</a></h3>
<h3><a id="consumerconfigs" href="#consumerconfigs">3.4 Consumer Configs</a></h3>
In 0.9.0.0 we introduced the new Java consumer as a replacement for the older Scala-based simple and high-level consumers.
The configs for both new and old consumers are described below.
<h4><a id="newconsumerconfigs" href="#newconsumerconfigs">3.3.1 New Consumer Configs</a></h4>
<h4><a id="newconsumerconfigs" href="#newconsumerconfigs">3.4.1 New Consumer Configs</a></h4>
Below is the configuration for the new consumer:
<!--#include virtual="generated/consumer_config.html" -->
<h4><a id="oldconsumerconfigs" href="#oldconsumerconfigs">3.3.2 Old Consumer Configs</a></h4>
<h4><a id="oldconsumerconfigs" href="#oldconsumerconfigs">3.4.2 Old Consumer Configs</a></h4>
The essential old consumer configurations are the following:
<ul>
@ -246,15 +246,15 @@
<p>More details about consumer configuration can be found in the scala class <code>kafka.consumer.ConsumerConfig</code>.</p>
<h3><a id="connectconfigs" href="#connectconfigs">3.4 Kafka Connect Configs</a></h3>
<h3><a id="connectconfigs" href="#connectconfigs">3.5 Kafka Connect Configs</a></h3>
Below is the configuration of the Kafka Connect framework.
<!--#include virtual="generated/connect_config.html" -->
<h3><a id="streamsconfigs" href="#streamsconfigs">3.5 Kafka Streams Configs</a></h3>
<h3><a id="streamsconfigs" href="#streamsconfigs">3.6 Kafka Streams Configs</a></h3>
Below is the configuration of the Kafka Streams client library.
<!--#include virtual="generated/streams_config.html" -->
<h3><a id="adminclientconfigs" href="#adminclientconfigs">3.6 AdminClient Configs</a></h3>
<h3><a id="adminclientconfigs" href="#adminclientconfigs">3.7 AdminClient Configs</a></h3>
Below is the configuration of the Kafka Admin client library.
<!--#include virtual="generated/admin_client_config.html" -->
</script>

4
docs/ops.html
View File

@ -24,7 +24,7 @@
<h4><a id="basic_ops_add_topic" href="#basic_ops_add_topic">Adding and removing topics</a></h4>
You have the option of either adding topics manually or having them be created automatically when data is first published to a non-existent topic. If topics are auto-created then you may want to tune the default <a href="#topic-config">topic configurations</a> used for auto-created topics.
You have the option of either adding topics manually or having them be created automatically when data is first published to a non-existent topic. If topics are auto-created then you may want to tune the default <a href="#topicconfigs">topic configurations</a> used for auto-created topics.
<p>
Topics are added and modified using the topic tool:
<pre class="brush: bash;">
@ -37,7 +37,7 @@
<p>
Each sharded partition log is placed into its own folder under the Kafka log directory. The name of such folders consists of the topic name, appended by a dash (-) and the partition id. Since a typical folder name can not be over 255 characters long, there will be a limitation on the length of topic names. We assume the number of partitions will not ever be above 100,000. Therefore, topic names cannot be longer than 249 characters. This leaves just enough room in the folder name for a dash and a potentially 5 digit long partition id.
<p>
The configurations added on the command line override the default settings the server has for things like the length of time data should be retained. The complete set of per-topic configurations is documented <a href="#topic-config">here</a>.
The configurations added on the command line override the default settings the server has for things like the length of time data should be retained. The complete set of per-topic configurations is documented <a href="#topicconfigs">here</a>.
<h4><a id="basic_ops_modify_topic" href="#basic_ops_modify_topic">Modifying topics</a></h4>

15
docs/toc.html
View File

@ -42,15 +42,16 @@
<li><a href="#configuration">3. Configuration</a>
<ul>
<li><a href="#brokerconfigs">3.1 Broker Configs</a>
<li><a href="#producerconfigs">3.2 Producer Configs</a>
<li><a href="#consumerconfigs">3.3 Consumer Configs</a>
<li><a href="#topicconfigs">3.2 Topic Configs</a>
<li><a href="#producerconfigs">3.3 Producer Configs</a>
<li><a href="#consumerconfigs">3.4 Consumer Configs</a>
<ul>
<li><a href="#newconsumerconfigs">3.3.1 New Consumer Configs</a>
<li><a href="#oldconsumerconfigs">3.3.2 Old Consumer Configs</a>
<li><a href="#newconsumerconfigs">3.4.1 New Consumer Configs</a>
<li><a href="#oldconsumerconfigs">3.4.2 Old Consumer Configs</a>
</ul>
<li><a href="#connectconfigs">3.4 Kafka Connect Configs</a>
<li><a href="#streamsconfigs">3.5 Kafka Streams Configs</a>
<li><a href="#adminclientconfigs">3.6 AdminClient Configs</a>
<li><a href="#connectconfigs">3.5 Kafka Connect Configs</a>
<li><a href="#streamsconfigs">3.6 Kafka Streams Configs</a>
<li><a href="#adminclientconfigs">3.7 AdminClient Configs</a>
</ul>
</li>
<li><a href="#design">4. Design</a>