Skip to content

Commit c141acb

Browse files
jsanciocmccabe
authored andcommitted
KAFKA-17048; Update docs for KIP-853 (#17076)
Change the configurations under config/kraft to use controller.quorum.bootstrap.servers instead of controller.quorum.voters. Add comments explaining how to use the older static quorum configuration where appropriate. In docs/ops.html, remove the reference to "tentative timelines for ZooKeeper removal" and "Tiered storage is considered as an early access feature" since they are no longer up-to-date. Add KIP-853 information. In docs/quickstart.html, move the ZK instructions to be after the KRaft instructions. Update the KRaft instructions to use KIP-853. In docs/security.html, add an explanation of --bootstrap-controller and document controller.quorum.bootstrap.servers instead of controller.quorum.voters. Reviewers: Mickael Maison <[email protected]>, Alyssa Huang <[email protected]>, Colin P. McCabe <[email protected]>
1 parent 389a8d8 commit c141acb

File tree

6 files changed

+236
-46
lines changed

6 files changed

+236
-46
lines changed

config/kraft/broker.properties

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ process.roles=broker
2626
# The node id associated with this instance's roles
2727
node.id=2
2828

29-
# The connect string for the controller quorum
30-
controller.quorum.voters=1@localhost:9093
29+
# Information about the KRaft controller quorum.
30+
controller.quorum.bootstrap.servers=localhost:9093
3131

3232
############################# Socket Server Settings #############################
3333

config/kraft/controller.properties

+5-3
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,15 @@ process.roles=controller
2626
# The node id associated with this instance's roles
2727
node.id=1
2828

29-
# The connect string for the controller quorum
30-
controller.quorum.voters=1@localhost:9093
29+
# Information about the KRaft controller quorum.
30+
# Uncomment controller.quorum.voters to use a static controller quorum.
31+
#controller.quorum.voters=1@localhost:9093
32+
controller.quorum.bootstrap.servers=localhost:9093
3133

3234
############################# Socket Server Settings #############################
3335

3436
# The address the socket server listens on.
35-
# Note that only the controller listeners are allowed here when `process.roles=controller`, and this listener should be consistent with `controller.quorum.voters` value.
37+
# Note that only the controller listeners are allowed here when `process.roles=controller`
3638
# FORMAT:
3739
# listeners = listener_name://host_name:port
3840
# EXAMPLE:
+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one or more
2+
# contributor license agreements. See the NOTICE file distributed with
3+
# this work for additional information regarding copyright ownership.
4+
# The ASF licenses this file to You under the Apache License, Version 2.0
5+
# (the "License"); you may not use this file except in compliance with
6+
# the License. You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
16+
#
17+
# This configuration file is intended for use in KRaft mode, where
18+
# Apache ZooKeeper is not present.
19+
#
20+
21+
############################# Server Basics #############################
22+
23+
# The role of this server. Setting this puts us in KRaft mode
24+
process.roles=broker,controller
25+
26+
# The node id associated with this instance's roles
27+
node.id=1
28+
29+
# List of controller endpoints used connect to the controller cluster
30+
controller.quorum.bootstrap.servers=localhost:9093
31+
32+
############################# Socket Server Settings #############################
33+
34+
# The address the socket server listens on.
35+
# Combined nodes (i.e. those with `process.roles=broker,controller`) must list the controller listener here at a minimum.
36+
# If the broker listener is not defined, the default listener will use a host name that is equal to the value of java.net.InetAddress.getCanonicalHostName(),
37+
# with PLAINTEXT listener name, and port 9092.
38+
# FORMAT:
39+
# listeners = listener_name://host_name:port
40+
# EXAMPLE:
41+
# listeners = PLAINTEXT://your.host.name:9092
42+
listeners=PLAINTEXT://:9092,CONTROLLER://:9093
43+
44+
# Name of listener used for communication between brokers.
45+
inter.broker.listener.name=PLAINTEXT
46+
47+
# Listener name, hostname and port the broker or the controller will advertise to clients.
48+
# If not set, it uses the value for "listeners".
49+
advertised.listeners=PLAINTEXT://localhost:9092,CONTROLLER://localhost:9093
50+
51+
# A comma-separated list of the names of the listeners used by the controller.
52+
# If no explicit mapping set in `listener.security.protocol.map`, default will be using PLAINTEXT protocol
53+
# This is required if running in KRaft mode.
54+
controller.listener.names=CONTROLLER
55+
56+
# Maps listener names to security protocols, the default is for them to be the same. See the config documentation for more details
57+
listener.security.protocol.map=CONTROLLER:PLAINTEXT,PLAINTEXT:PLAINTEXT,SSL:SSL,SASL_PLAINTEXT:SASL_PLAINTEXT,SASL_SSL:SASL_SSL
58+
59+
# The number of threads that the server uses for receiving requests from the network and sending responses to the network
60+
num.network.threads=3
61+
62+
# The number of threads that the server uses for processing requests, which may include disk I/O
63+
num.io.threads=8
64+
65+
# The send buffer (SO_SNDBUF) used by the socket server
66+
socket.send.buffer.bytes=102400
67+
68+
# The receive buffer (SO_RCVBUF) used by the socket server
69+
socket.receive.buffer.bytes=102400
70+
71+
# The maximum size of a request that the socket server will accept (protection against OOM)
72+
socket.request.max.bytes=104857600
73+
74+
75+
############################# Log Basics #############################
76+
77+
# A comma separated list of directories under which to store log files
78+
log.dirs=/tmp/kraft-combined-logs
79+
80+
# The default number of log partitions per topic. More partitions allow greater
81+
# parallelism for consumption, but this will also result in more files across
82+
# the brokers.
83+
num.partitions=1
84+
85+
# The number of threads per data directory to be used for log recovery at startup and flushing at shutdown.
86+
# This value is recommended to be increased for installations with data dirs located in RAID array.
87+
num.recovery.threads.per.data.dir=1
88+
89+
############################# Internal Topic Settings #############################
90+
# The replication factor for the group metadata internal topics "__consumer_offsets" and "__transaction_state"
91+
# For anything other than development testing, a value greater than 1 is recommended to ensure availability such as 3.
92+
offsets.topic.replication.factor=1
93+
transaction.state.log.replication.factor=1
94+
transaction.state.log.min.isr=1
95+
96+
############################# Log Flush Policy #############################
97+
98+
# Messages are immediately written to the filesystem but by default we only fsync() to sync
99+
# the OS cache lazily. The following configurations control the flush of data to disk.
100+
# There are a few important trade-offs here:
101+
# 1. Durability: Unflushed data may be lost if you are not using replication.
102+
# 2. Latency: Very large flush intervals may lead to latency spikes when the flush does occur as there will be a lot of data to flush.
103+
# 3. Throughput: The flush is generally the most expensive operation, and a small flush interval may lead to excessive seeks.
104+
# The settings below allow one to configure the flush policy to flush data after a period of time or
105+
# every N messages (or both). This can be done globally and overridden on a per-topic basis.
106+
107+
# The number of messages to accept before forcing a flush of data to disk
108+
#log.flush.interval.messages=10000
109+
110+
# The maximum amount of time a message can sit in a log before we force a flush
111+
#log.flush.interval.ms=1000
112+
113+
############################# Log Retention Policy #############################
114+
115+
# The following configurations control the disposal of log segments. The policy can
116+
# be set to delete segments after a period of time, or after a given size has accumulated.
117+
# A segment will be deleted whenever *either* of these criteria are met. Deletion always happens
118+
# from the end of the log.
119+
120+
# The minimum age of a log file to be eligible for deletion due to age
121+
log.retention.hours=168
122+
123+
# A size-based retention policy for logs. Segments are pruned from the log unless the remaining
124+
# segments drop below log.retention.bytes. Functions independently of log.retention.hours.
125+
#log.retention.bytes=1073741824
126+
127+
# The maximum size of a log segment file. When this size is reached a new log segment will be created.
128+
log.segment.bytes=1073741824
129+
130+
# The interval at which log segments are checked to see if they can be deleted according
131+
# to the retention policies
132+
log.retention.check.interval.ms=300000

0 commit comments

Comments
 (0)