Puppet Class: zookeeper

Defined in:
modules/zookeeper/manifests/init.pp

Overview

SPDX-License-Identifier: Apache-2.0

Class zookeeper

Installs common zookeeper package and configs.

Parameters

$hosts - Hash of zookeeper fqdns to myids.

$data_dir - Zookeeper dataDir. Default: /var/lib/zookeeper

$data_log_dir - Zookeeper dataLogDir. Default: undef.

$max_client_connections - The maximum number of per-IP client connections.

Default: 0 (unlimited)

$tick_time - The length of a single tick, which is the basic time unit used by

ZooKeeper, as measured in milliseconds.  Default: 2000

$init_limit - Amount of time in ticks to allow followers to connect and sync to

a leader.  Default: 10

$sync_limit - Amount of tim to allow followers to sync with ZooKeeper. Default: 5

Usage

class { 'zookeeper':

hosts    => { 'zoo1.domain.org' => 1, 'zoo2.domain.org' => 2, 'zoo3.domain.org' => 3 },
data_dir => '/var/lib/zookeeper',

}

The above setup should be used to configure a 3 node zookeeper cluster. You can include the above class on any of your nodes that will need to talk to the zookeeper cluster.

On the 3 zookeeper server nodes, you should also include:

class { 'zookeeper::server': }

This will ensure that the zookeeper server is running. Remember that this requires that you also include the zookeeper class as defined above as well as the server class.

On each of the defined zookeeper hosts, a myid file must be created that identifies the host in the zookeeper quorum. This myid number will be inferred from the nodes index in the zookeeper hosts array. e.g. zoo1.domain.org's myid will be '1', zoo2.domain.org's myid will be 2, etc.

Parameters:

  • hosts (Any) (defaults to: { "${::fqdn}" => 1 })
  • data_dir (Any) (defaults to: '/var/lib/zookeeper')
  • data_log_dir (Any) (defaults to: undef)
  • max_client_connections (Any) (defaults to: 0)
  • tick_time (Any) (defaults to: 2000)
  • init_limit (Any) (defaults to: 10)
  • sync_limit (Any) (defaults to: 5)
  • conf_template (Any) (defaults to: 'profile/zookeeper/zoo.cfg.erb')


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'modules/zookeeper/manifests/init.pp', line 47

class zookeeper(
    $hosts                  = { "${::fqdn}" => 1 },
    $data_dir               = '/var/lib/zookeeper',
    $data_log_dir           = undef,
    $max_client_connections = 0,
    $tick_time              = 2000,
    $init_limit             = 10,
    $sync_limit             = 5,
    $conf_template          = 'profile/zookeeper/zoo.cfg.erb',
) {
    ensure_packages('zookeeper')

    file { '/etc/zookeeper/conf/zoo.cfg':
        content => template($conf_template),
        require => Package['zookeeper'],
    }
}