Puppet Class: kafka::broker

Inherits:
kafka::params
Defined in:
manifests/broker.pp

Summary

This class handles the Kafka (broker).

Overview

Examples:

Basic usage

class { 'kafka::broker':
  config => {
    'broker.id'         => '0',
    'zookeeper.connect' => 'localhost:2181'
  }
}

Parameters:

  • kafka_version (String[1]) (defaults to: $kafka::params::kafka_version) —

    The version of Kafka that should be installed.

  • scala_version (String[1]) (defaults to: $kafka::params::scala_version) —

    The scala version what Kafka was built with.

  • install_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::install_dir) —

    The directory to install Kafka to.

  • mirror_url (Stdlib::HTTPUrl) (defaults to: $kafka::params::mirror_url) —

    The url where the Kafka is downloaded from.

  • manage_java (Boolean) (defaults to: $kafka::params::manage_java) —

    Install java if it’s not already installed.

  • package_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::package_dir) —

    The directory to install Kafka.

  • package_name (Optional[String[1]]) (defaults to: $kafka::params::package_name) —

    Package name, when installing Kafka from a package.

  • package_ensure (String[1]) (defaults to: $kafka::params::package_ensure) —

    Package version or ensure state, when installing Kafka from a package.

  • user_name (String[1]) (defaults to: $kafka::params::user_name) —

    User to run Kafka as.

  • user_shell (Stdlib::Absolutepath) (defaults to: $kafka::params::user_shell) —

    Login shell of the Kafka user.

  • group_name (String[1]) (defaults to: $kafka::params::group_name) —

    Group to run Kafka as.

  • user_id (Optional[Integer]) (defaults to: $kafka::params::user_id) —

    Create the Kafka user with this ID.

  • group_id (Optional[Integer]) (defaults to: $kafka::params::group_id) —

    Create the Kafka group with this ID.

  • manage_user (Boolean) (defaults to: $kafka::params::manage_user) —

    Create the Kafka user if it’s not already present.

  • manage_group (Boolean) (defaults to: $kafka::params::manage_group) —

    Create the Kafka group if it’s not already present.

  • config_mode (Stdlib::Filemode) (defaults to: $kafka::params::config_mode) —

    The permissions for the config files.

  • config_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::config_dir) —

    The directory to create the Kafka config files to.

  • log_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::log_dir) —

    The directory for Kafka log files.

  • bin_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::bin_dir) —

    The directory where the Kafka scripts are.

  • service_name (String[1]) (defaults to: 'kafka') —

    Set the name of the service.

  • manage_service (Boolean) (defaults to: $kafka::params::manage_service) —

    Install the systemd service.

  • service_ensure (Enum['running', 'stopped']) (defaults to: $kafka::params::service_ensure) —

    Set the ensure state of the service.

  • service_restart (Boolean) (defaults to: $kafka::params::service_restart) —

    Whether the configuration files should trigger a service restart.

  • service_requires (Array[String[1]]) (defaults to: $kafka::params::service_requires) —

    Set the list of services required to be running before Kafka.

  • limit_nofile (Optional[String[1]]) (defaults to: $kafka::params::limit_nofile) —

    Set the ‘LimitNOFILE’ option of the systemd service.

  • limit_core (Optional[String[1]]) (defaults to: $kafka::params::limit_core) —

    Set the ‘LimitCORE’ option of the systemd service.

  • timeout_stop (Optional[String[1]]) (defaults to: $kafka::params::timeout_stop) —

    Set the ‘TimeoutStopSec’ option of the systemd service.

  • exec_stop (Boolean) (defaults to: $kafka::params::exec_stop) —

    Set the ‘ExecStop’ option of the systemd service to ‘kafka-server-stop.sh’.

  • daemon_start (Boolean) (defaults to: $kafka::params::daemon_start) —

    Use the ‘-daemon’ option when starting Kafka with ‘kafka-server-start.sh’.

  • env (Hash) (defaults to: {}) —

    A hash of the environment variables to set.

  • config (Hash[String[1], Any]) (defaults to: {}) —

    A hash of the broker configuration options.

  • heap_opts (String[1]) (defaults to: $kafka::params::broker_heap_opts) —

    Set the Java heap size.

  • jmx_opts (String[1]) (defaults to: $kafka::params::broker_jmx_opts) —

    Set the JMX options.

  • log4j_opts (String[1]) (defaults to: $kafka::params::broker_log4j_opts) —

    Set the Log4j options.

  • manage_log4j (Boolean) (defaults to: $kafka::params::manage_log4j) —

    Enable or disable the management of the log4j configuration file.

  • log4j_content (Optional[String[1]]) (defaults to: undef) —

    Provide custom content for the log4j configuration file if manage_log4j is enabled, instead of using the content provided in this module.

  • log_file_size (Pattern[/[1-9][0-9]*[KMG]B/]) (defaults to: $kafka::params::log_file_size) —

    Set the max size of the Kafka log files before they are rolled.

  • log_file_count (Integer[1, 50]) (defaults to: $kafka::params::log_file_count) —

    Set the number of Kafka log files to keep.

  • opts (String[0]) (defaults to: $kafka::params::broker_opts) —

    Set the Kafka options.



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
 
# File 'manifests/broker.pp', line 130

class kafka::broker (
  String[1] $kafka_version                      = $kafka::params::kafka_version,
  String[1] $scala_version                      = $kafka::params::scala_version,
  Stdlib::Absolutepath $install_dir             = $kafka::params::install_dir,
  Stdlib::HTTPUrl $mirror_url                   = $kafka::params::mirror_url,
  Boolean $manage_java                          = $kafka::params::manage_java,
  Stdlib::Absolutepath $package_dir             = $kafka::params::package_dir,
  Optional[String[1]] $package_name             = $kafka::params::package_name,
  String[1] $package_ensure                     = $kafka::params::package_ensure,
  String[1] $user_name                          = $kafka::params::user_name,
  Stdlib::Absolutepath $user_shell              = $kafka::params::user_shell,
  String[1] $group_name                         = $kafka::params::group_name,
  Optional[Integer] $user_id                    = $kafka::params::user_id,
  Optional[Integer] $group_id                   = $kafka::params::group_id,
  Boolean $manage_user                          = $kafka::params::manage_user,
  Boolean $manage_group                         = $kafka::params::manage_group,
  Stdlib::Filemode $config_mode                 = $kafka::params::config_mode,
  Stdlib::Absolutepath $config_dir              = $kafka::params::config_dir,
  Stdlib::Absolutepath $log_dir                 = $kafka::params::log_dir,
  Stdlib::Absolutepath $bin_dir                 = $kafka::params::bin_dir,
  String[1] $service_name                       = 'kafka',
  Boolean $manage_service                       = $kafka::params::manage_service,
  Enum['running', 'stopped'] $service_ensure    = $kafka::params::service_ensure,
  Boolean $service_restart                      = $kafka::params::service_restart,
  Array[String[1]] $service_requires            = $kafka::params::service_requires,
  Optional[String[1]] $limit_nofile             = $kafka::params::limit_nofile,
  Optional[String[1]] $limit_core               = $kafka::params::limit_core,
  Optional[String[1]] $timeout_stop             = $kafka::params::timeout_stop,
  Boolean $exec_stop                            = $kafka::params::exec_stop,
  Boolean $daemon_start                         = $kafka::params::daemon_start,
  Hash $env                                     = {},
  Hash[String[1], Any] $config                  = {},
  String[1] $heap_opts                          = $kafka::params::broker_heap_opts,
  String[1] $jmx_opts                           = $kafka::params::broker_jmx_opts,
  String[1] $log4j_opts                         = $kafka::params::broker_log4j_opts,
  String[0] $opts                               = $kafka::params::broker_opts,
  Boolean $manage_log4j                         = $kafka::params::manage_log4j,
  Optional[String[1]] $log4j_content            = undef,
  Pattern[/[1-9][0-9]*[KMG]B/] $log_file_size   = $kafka::params::log_file_size,
  Integer[1, 50] $log_file_count                = $kafka::params::log_file_count
) inherits kafka::params {
  class { 'kafka::broker::install': }
  -> class { 'kafka::broker::config': }
  -> class { 'kafka::broker::service': }
  -> Class['kafka::broker']
}