-
Notifications
You must be signed in to change notification settings - Fork 32
/
server.pp
295 lines (273 loc) · 14.7 KB
/
server.pp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
# == Class kafka::server
# Sets up a Kafka Broker and ensures that it is running.
#
# == Parameters:
# $enabled - If false, Kafka Broker Server will not be
# started. Default: true.
#
# $brokers - Hash of Kafka Broker configs keyed by
# fqdn of each kafka broker node. This Hash
# should be of the form:
# { 'hostA' => { 'id' => 1, 'port' => 12345 }, 'hostB' => { 'id' => 2 }, ... }
# 'port' is optional, and will default to 9092.
#
# $log_dirs - Array of directories in which the broker will store its
# received log event data.
# (This is log.dir in server.properties).
# Default: [/var/spool/kafka]
#
# $zookeeper_hosts - Array of zookeeper hostname/IP(:port)s.
# Default: ['localhost:2181]
#
# $zookeeper_connection_timeout_ms - Timeout in ms for connecting to Zookeeper.
# Default: 6000
#
# $zookeeper_session_timeout_ms - Timeout in ms for session to Zookeeper.
# Default: 6000
#
# $zookeeper_chroot - Path in zookeeper in which to keep Kafka data.
# Default: undef (the root znode). Note that if you set
# this paramater, the znode will not be created for you.
# You must do so manually yourself. See the README
# for instructions on how to do so.
#
# $java_home - Value for the JAVA_HOME environment variable. Default: undef
#
# $java_opts - Extra Java options. Default: undef
#
# $classpath - Extra classpath entries. Default: undef
#
# $jmx_port - Port on which to expose JMX metrics. Default: 9999
#
# $heap_opts - Heap options to pass to JVM on startup. Default: undef
#
# $nofiles_ulimit - If set, the kafka user's ulimit will be set to this, and the
# kafka server will set this via ulimit -n. You
# will probably need to reboot for this to take effect.
#
# $auto_create_topics_enable - If autocreation of topics is allowed. Default: false
#
# $auto_leader_rebalance_enable - If leaders should be auto rebalanced.
# Default: true
#
# $num_partitions - The default number of partitions per topic.
# Default: size($log_dirs)
#
# $default_replication_factor - The default replication factor for automatically created topics.
# Default: size(keys($brokers))
#
# $replica_lag_time_max_ms - If a follower hasn't sent any fetch requests for this window
# of time, the leader will remove the follower from ISR.
# Default: undef
#
# $replica_lag_max_messages - If a replica falls more than this many messages behind the leader,
# the leader will remove the follower from ISR.
# Default: undef
#
# $replica_socket_timeout_ms - The socket timeout for network requests to the leader for
# replicating data. Default: undef
#
# $replica_socket_receive_buffer_bytes - The socket receive buffer for network requests to the leader
# for replicating data. Default: undef
#
# $num_replica_fetchers - Number of threads used to replicate messages from leaders.
# Default: 1
#
# $replica_fetch_max_bytes - The number of bytes of messages to attempt to fetch for each
# partition in the fetch requests the replicas send to the leader.
# Default: 1024 * 1024
#
# $num_network_threads - The number of threads handling network
# requests. Default: 3
#
# $num_io_threads - The number of threads doing disk I/O. Default: size($log_dirs)
#
# $socket_send_buffer_bytes - The byte size of the send buffer (SO_SNDBUF)
# used by the socket server. Default: 1048576
#
# $socket_receive_buffer_bytes - The byte size of receive buffer (SO_RCVBUF)
# used by the socket server. Default: 1048576
#
# $socket_request_max_bytes - The maximum size of a request that the socket
# server will accept. Default: 104857600
#
# $log_flush_interval_messages - The number of messages to accept before
# forcing a flush of data to disk. Default 10000
#
# $log_flush_interval_ms - The maximum amount of time a message can sit
# in a log before we force a flush: Default 1000 (1 second)
#
# $log_retention_hours - The minimum age of a log file to be eligible
# for deletion. Default 1 week
#
# $log_retention_size - A size-based retention policy for logs.
# Default: undef (disabled)
#
# $log_segment_bytes - The maximum size of a log segment file. When
# this size is reached a new log segment will
# be created: Default 536870912 (512MB)
#
# $log_cleanup_interval_mins - The interval at which log segments are checked
# to see if they can be deleted according to the
# retention policies. Default: 1
#
# $log_cleanup_policy - The default policy for handling log tails.
# Can be either delete or dedupe. Default: delete
#
# $offsets_retention_minutes - Default number of minutes before Kafka
# expires an offset commit for a
# consumer group. Default 1 week
# $metrics_properties - Config hash of Kafka metrics property key => value pairs.
# Use this for configuring your own metrics reporter classes.
# Default: undef
#
# $kafka_log_file - File in which to write Kafka logs (not event message data).
# Default: /var/log/kafka/kafka.log
# log_max_backup_index - Number of (256 MB) kafka.log files to keep. Default: 4
#
# $jvm_performance_opts - Value to use for KAFKA_JVM_PERFORMANCE_OPTS in /etc/default/kafka.
# This controls GC settings. Default: undef.
#
class kafka::server(
$enabled = true,
$brokers = $kafka::defaults::brokers,
$log_dirs = $kafka::defaults::log_dirs,
$zookeeper_hosts = $kafka::defaults::zookeeper_hosts,
$zookeeper_connection_timeout_ms = $kafka::defaults::zookeeper_connection_timeout_ms,
$zookeeper_session_timeout_ms = $kafka::defaults::zookeeper_session_timeout_ms,
$zookeeper_chroot = $kafka::defaults::zookeeper_chroot,
$java_home = $kafka::defaults::java_home,
$java_opts = $kafka::defaults::java_opts,
$classpath = $kafka::defaults::classpath,
$jmx_port = $kafka::defaults::jmx_port,
$heap_opts = $kafka::defaults::heap_opts,
$nofiles_ulimit = $kafka::defaults::nofiles_ulimit,
$auto_create_topics_enable = $kafka::defaults::auto_create_topics_enable,
$auto_leader_rebalance_enable = $kafka::defaults::auto_leader_rebalance_enable,
$num_partitions = size($log_dirs),
$default_replication_factor = size(keys($brokers)),
$replica_lag_time_max_ms = $kafka::defaults::replica_lag_time_max_ms,
$replica_lag_max_messages = $kafka::defaults::replica_lag_max_messages,
$replica_socket_timeout_ms = $kafka::defaults::replica_socket_timeout_ms,
$replica_socket_receive_buffer_bytes = $kafka::defaults::replica_socket_receive_buffer_bytes,
$num_replica_fetchers = $kafka::defaults::num_replica_fetchers,
$replica_fetch_max_bytes = $kafka::defaults::replica_fetch_max_bytes,
$num_network_threads = $kafka::defaults::num_network_threads,
$num_io_threads = size($log_dirs),
$socket_send_buffer_bytes = $kafka::defaults::socket_send_buffer_bytes,
$socket_receive_buffer_bytes = $kafka::defaults::socket_receive_buffer_bytes,
$socket_request_max_bytes = $kafka::defaults::socket_request_max_bytes,
$log_flush_interval_messages = $kafka::defaults::log_flush_interval_messages,
$log_flush_interval_ms = $kafka::defaults::log_flush_interval_ms,
$log_retention_hours = $kafka::defaults::log_retention_hours,
$log_retention_bytes = $kafka::defaults::log_retention_bytes,
$log_segment_bytes = $kafka::defaults::log_segment_bytes,
$log_cleanup_interval_mins = $kafka::defaults::log_cleanup_interval_mins,
$log_cleanup_policy = $kafka::defaults::log_cleanup_policy,
$offsets_retention_minutes = $kafka::defaults::offsets_retention_minutes,
$metrics_properties = $kafka::defaults::metrics_properties,
$kafka_log_file = $kafka::defaults::kafka_log_file,
$log_max_backup_index = $kafka::defaults::log_max_backup_index,
$jvm_performance_opts = $kafka::defaults::jvm_performance_opts,
$server_properties_template = $kafka::defaults::server_properties_template,
$systemd_override_template = $kafka::defaults::server_systemd_override_template,
$default_template = $kafka::defaults::server_default_template,
$log4j_properties_template = $kafka::defaults::log4j_properties_template,
) inherits kafka::defaults
{
# Kafka class must be included before kafka::server.
# Using 'require' here rather than an explicit class dependency
# so that this class can be used without having to manually
# include the base kafka class. This is for elegance only.
# You'd only need to manually include the base kafka class if
# you need to explicitly set the version of the Kafka package
# you want installed.
require ::kafka
package { 'kafka-server':
ensure => $::kafka::version
}
# Get this broker's id and port out of the $kafka::hosts configuration hash
$broker_id = $brokers[$::fqdn]['id']
# Using a conditional assignment selector with a
# Hash value results in a puppet syntax error.
# Using an if/else instead.
if ($brokers[$::fqdn]['port']) {
$broker_port = $brokers[$::fqdn]['port']
}
else {
$broker_port = $kafka::defaults::default_broker_port
}
# Debian Jessie (and greater) has systemd, and the WMF Kafka .deb
# package installs a systemd service file. It is not possible
# to set number open files ulimit via /etc/default/kafka wth systemd,
# so we need to install a custom systemd override file.
$use_systemd = $::lsbdistid == 'Debian' and $::lsbmajdistrelease >= 8
if $use_systemd {
file { '/etc/systemd/system/kafka.service.d':
ensure => 'directory',
}
file { '/etc/systemd/system/kafka.service.d/override.conf':
content => template($systemd_override_template),
}
# systemd needs a reload to pick up changes to this file.
exec { 'systemd-reload-for-kafka-override':
command => '/bin/systemctl daemon-reload',
refreshonly => true,
subscribe => File['/etc/systemd/system/kafka.service.d/override.conf'],
}
$kafka_service_systemd_require = [Exec['systemd-reload-for-kafka-override']]
}
else {
# Puppet hack. Puppet flattens nested arrays.
# If we aren't using systemd, then we don't want
# the Kafka service below to require the systemd exec.
$kafka_service_systemd_require = []
}
# Render out Kafka Broker config files.
file { '/etc/default/kafka':
content => template($default_template),
require => Package['kafka-server'],
}
file { '/etc/kafka/server.properties':
content => template($server_properties_template),
require => Package['kafka-server'],
}
# This is the message data directory,
# not to be confused with the $kafka_log_file,
# which contains daemon process logs.
file { $log_dirs:
ensure => 'directory',
owner => 'kafka',
group => 'kafka',
mode => '0755',
require => Package['kafka-server'],
}
# log4j configuration for Kafka daemon
# process logs (this uses $kafka_log_dir).
file { '/etc/kafka/log4j.properties':
content => template($log4j_properties_template),
require => Package['kafka-server'],
}
# Start the Kafka server.
# We don't want to subscribe to the config files here.
# It will be better to manually restart Kafka when
# the config files changes.
$kafka_ensure = $enabled ? {
false => 'stopped',
default => 'running',
}
service { 'kafka':
ensure => $kafka_ensure,
hasrestart => true,
hasstatus => true,
require => [
File['/etc/kafka/server.properties'],
File['/etc/kafka/log4j.properties'],
File['/etc/default/kafka'],
File[$log_dirs],
# This will be an empty array if we
# aren't using systemd.
$kafka_service_systemd_require,
]
}
}