Puppet Class: kafka::consumer

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

Overview

Class: kafka::consumer

This class will install kafka with the consumer role.

Requirements/Dependencies

Currently requires the puppetlabs/stdlib module on the Puppet Forge in order to validate much of the the provided configuration.

Parameters

version

The version of kafka that should be installed.

scala_version

The scala version what kafka was built with.

install_dir

The directory to install kafka to.

mirror_url

The url where the kafka is downloaded from.

install_java

Install java if it’s not already installed.

package_dir

The directory to install kafka.

package_name

Package name, when installing kafka from a package.

package_ensure

Package version (or ‘present’, ‘absent’, ‘latest’), when installing kafka from a package.

user

User to run kafka as.

group

Group to run kafka as.

user_id

Create the kafka user with this ID.

group_id

Create the kafka group with this ID.

manage_user

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

manage_group

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

config_mode

The permissions for the config files.

config_dir

The directory to create the kafka config files to.

log_dir

The directory for kafka log files.

bin_dir

The directory where the kafka scripts are.

service_name

Set the name of the service.

service_install

Install the init.d or systemd service.

service_ensure

Set the ensure state of the service to ‘stopped’ or ‘running’.

service_restart

Whether the configuration files should trigger a service restart.

service_requires

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

limit_nofile

Set the ‘LimitNOFILE’ option of the systemd service.

limit_core

Set the ‘LimitCORE’ option of the systemd service.

env

A hash of the environment variables to set.

config

A hash of the consumer configuration options.

service_config

A hash of the ‘kafka-console-consumer.sh` script options.

Examples

Create the consumer service connecting to a local zookeeper

class { ‘kafka::consumer’:

config => { 'client.id' => '0', 'zookeeper.connect' => 'localhost:2181' }

}

Parameters:

  • version (String) (defaults to: $kafka::params::version)
  • scala_version (String) (defaults to: $kafka::params::scala_version)
  • install_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::install_dir)
  • mirror_url (Stdlib::HTTPUrl) (defaults to: $kafka::params::mirror_url)
  • install_java (Boolean) (defaults to: $kafka::params::install_java)
  • package_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::package_dir)
  • package_name (Optional[String]) (defaults to: $kafka::params::package_name)
  • package_ensure (String) (defaults to: $kafka::params::package_ensure)
  • user (String) (defaults to: $kafka::params::user)
  • group (String) (defaults to: $kafka::params::group)
  • user_id (Optional[Integer]) (defaults to: $kafka::params::user_id)
  • group_id (Optional[Integer]) (defaults to: $kafka::params::group_id)
  • manage_user (Boolean) (defaults to: $kafka::params::manage_user)
  • manage_group (Boolean) (defaults to: $kafka::params::manage_group)
  • config_mode (Stdlib::Filemode) (defaults to: $kafka::params::config_mode)
  • config_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::config_dir)
  • log_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::log_dir)
  • bin_dir (Stdlib::Absolutepath) (defaults to: $kafka::params::bin_dir)
  • service_name (String) (defaults to: 'kafka-consumer')
  • service_install (Boolean) (defaults to: $kafka::params::service_install)
  • service_ensure (Enum['running', 'stopped']) (defaults to: $kafka::params::service_ensure)
  • service_restart (Boolean) (defaults to: $kafka::params::service_restart)
  • service_requires (Array[String]) (defaults to: $kafka::params::service_requires)
  • limit_nofile (Optional[String]) (defaults to: $kafka::params::limit_nofile)
  • limit_core (Optional[String]) (defaults to: $kafka::params::limit_core)
  • env (Hash) (defaults to: {})
  • config (Hash) (defaults to: {})
  • service_config (Hash) (defaults to: {})
  • jmx_opts (String) (defaults to: $kafka::params::consumer_jmx_opts)
  • log4j_opts (String) (defaults to: $kafka::params::consumer_log4j_opts) 


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

class kafka::consumer (
  String $version                            = $kafka::params::version,
  String $scala_version                      = $kafka::params::scala_version,
  Stdlib::Absolutepath $install_dir          = $kafka::params::install_dir,
  Stdlib::HTTPUrl $mirror_url                = $kafka::params::mirror_url,
  Boolean $install_java                      = $kafka::params::install_java,
  Stdlib::Absolutepath $package_dir          = $kafka::params::package_dir,
  Optional[String] $package_name             = $kafka::params::package_name,
  String $package_ensure                     = $kafka::params::package_ensure,
  String $user                               = $kafka::params::user,
  String $group                              = $kafka::params::group,
  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 $service_name                       = 'kafka-consumer',
  Boolean $service_install                   = $kafka::params::service_install,
  Enum['running', 'stopped'] $service_ensure = $kafka::params::service_ensure,
  Boolean $service_restart                   = $kafka::params::service_restart,
  Array[String] $service_requires            = $kafka::params::service_requires,
  Optional[String] $limit_nofile             = $kafka::params::limit_nofile,
  Optional[String] $limit_core               = $kafka::params::limit_core,
  Hash $env                                  = {},
  Hash $config                               = {},
  Hash $service_config                       = {},
  String $jmx_opts                           = $kafka::params::consumer_jmx_opts,
  String $log4j_opts                         = $kafka::params::consumer_log4j_opts,
) inherits kafka::params {

  class { '::kafka::consumer::install': }
  -> class { '::kafka::consumer::config': }
  -> class { '::kafka::consumer::service': }
  -> Class['kafka::consumer']
}