Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms


zookeeper (80) Versions 7.0.0

Installs/Configures zookeeper

cookbook 'zookeeper', '= 7.0.0'
cookbook 'zookeeper', '= 7.0.0', :supermarket
knife supermarket install zookeeper
knife supermarket download zookeeper
Quality -%

zookeeper cookbook

Build Status Cookbook Version

Table of Contents

Apache ZooKeeper

Apache ZooKeeper is a coordination and discovery service maintained by the Apache Software Foundation.

This cookbook focuses on deploying ZooKeeper via Chef.


This cookbook is primarily a library cookbook. It implements a zookeeper and zookeeper_config resource to handle the installation and configuration of ZooKeeper. It ships with a default recipe for backwards compatibility pre-LWRP which will work fine, but is really just an example.

Testing is handled using Test Kitchen, with the expectation that you have it installed as part of the Chef DK.


  • zookeeper::default : Installs and configures ZooKeeper. This does not start or manage the service.
  • zookeeper::install : Installs the ZooKeeper but does not configure it.
  • zookeeper::config_render : Configures ZooKeeper but does not install it.
  • zookeeper::service : Starts and manages the ZooKeeper service. Requires ZooKeeper to be installed/configured.


This cookbook ships with two resources, with future plans for one more covering service management.


The zookeeper resource is responsible for installing and (eventually) uninstalling Zookeeper from a node.

Actions: :install, :uninstall


  • version: Version of ZooKeeper to install (name attribute)
  • user: The user who will eventually run Zookeeper (default: 'zookeeper')
  • user_home: Path to the home folder for the Zookeeper user (default: /home/zookeeper)
  • mirror: The mirror to obtain ZooKeeper from (required)
  • checksum: Checksum for the ZooKeeper download file
  • install_dir: Which directory to install Zookeeper to (default: '/opt/zookeeper')


zookeeper '3.4.8' do
  user     'zookeeper'
  mirror   ''
  checksum 'f10a0b51f45c4f64c1fe69ef713abf9eb9571bc7385a82da892e83bb6c965e90'
  action   :install


This resource renders a ZooKeeper configuration file. Period-delimited parameters can be specified either as a flat hash, or by embeddeding each sub-section within a separate hash. See the example below for an example.

Actions: :render, :delete


  • user: The user to give ownership of the file to (default: zookeeper)
  • config: Hash of configuration parameters to add to the file
  • path: Path to write the configuration file to.


config_hash = {
  clientPort: 2181, 
  dataDir: '/mnt/zk', 
  tickTime: 2000,
  autopurge: {
    snapRetainCount: 1,
    purgeInterval: 1

zookeeper_config '/opt/zookeeper/zookeeper-3.4.8/conf/zoo.cfg' do
  config config_hash
  user   'zookeeper'
  action :render


This resource can create nodes in a running instance of ZooKeeper.

Actions: :create, :create_if_missing, :delete


  • path: The ZooKeeper node path (default: The name of the resource)
  • connect_str: The ZooKeeper connection string (required)
  • data: The data to write to the node
  • auth_scheme: The authentication scheme (default: digest)
  • auth_cert: The authentication password or data
  • acl_digest: Hash of acl permissions per 'digest' id
  • acl_ip: Hash of acl permissions per 'ip'
  • acl_sasl: Hash of acl permissions per 'sasl' id (SASLAuthentication provider must be enabled)
  • acl_world: Acl permissions for anyone (default: Zk::PERM_ALL)


zookeeper_node '/data/myNode' do
  action       :create
  connect_str  "localhost:2181"
  data         "my data"
  auth_scheme  "digest"
  auth_cert    "user1:pwd1"
  acl_digest   "user1:a9l5yfb9zl8WCXjVmi5/XOC0Ep4=" => Zk::PERM_ALL
  acl_ip       "" => Zk::PERM_READ | Zk::PERM_WRITE
  acl_sasl     "user@CHEF.IO" => Zk::PERM_ADMIN
  acl_world    Zk::PERM_NONE


  • Version 1.4.7 on the community site is in fact version 1.4.8.

Author and License

Simple Finance
Apache License, Version 2.0

CHANGELOG for zookeeper

This file is used to list changes made in each version of zookeeper.


Potentially Breaking

  • Completely refactor existing LWRPs into Chef 12.5 Custom Resources
  • Refactor zookeeper::service into a Custom Resource (#86)
  • Drop apt cookbook in favor of built-in resources in Chef >= 12.11
  • Migrate all logic inside resources
  • Use ark to download & install ZooKeeper, rather than handling every resource directly
    • This is almost certainly a breaking change, as it moves where ZooKeeper is installed by default
    • Advantage: a symlink is created at /#{install_dir}/zookeeper, pointing to /#{install_dir}/zookeeper-#{version}, so handling paths to the current install is far easier
    • Caution: /#{install_dir}/zookeeper has been, until now, a container directory for any installations of ZooKeeper (e.g., /#{install_dir}/zookeeper/zookeeper-#{version})
  • Refactor recipes to wrap resources
    • An attempt at backwards compatibility has been made, using the previous attribute-driven style
    • These attributes & recipes will be dropped in future, as per a deprecation notice added to zookeeper::default


  • Add more tests in an attempt at being comprehensive of various ways this cookbook can be used


Potentially Breaking

  • Drop separate environment-defaults file for Upstart/SysV in favor of using same env vars as Runit
    • Consistency is key
  • Use for all service scripts
  • Drop pinning for build-essential
  • Rewire how env vars are used to correctly set the config & log locations
    • Default values added to set the config & log paths properly


  • Set Upstart & SysV services to action: [:enable, :start] to match the Runit service


  • Pass values into Upstart & SysV init scripts, rather than directly using attributes
  • Drop any Minitest unit tests in favor of ChefSpec



  • Update to working Apache mirror (#170 #178)



  • Drop pinning of apt cookbook to avoid transitive depsolving pain



  • Use java-cookbook-installed version of Java by way of the $JAVA_HOME env var


  • Ensure gets the correct values:
    • Properly set node[zookeeper][config_dir] with lazy interpolation of the node[zookeeper][version] attribute
    • Use lazy evaluation for exports_config
  • Export some env vars for subshelled SysV-run services

Other changes

  • Add proper testing suite using RuboCop, Foodcritic, ChefSpec, and Test Kitchen, automated w/ Travis CI
  • Pin dependency versions to avoid breaking changes being introduced from upstream


  • Add ability to configure JMX port & local only settings via attributes (#172 @felka)


  • Upgrade to ZooKeeper 3.4.8


  • Add initLimit and syncLimit to ZooKeeper config (#171)


  • Use node[zookeeper][user] attribute consistently
  • Fix user for runit-managed service style (#166 #167)


  • Add missing user_home attribute to zookeeper resource


  • Ensure zookeeper user has a home folder (#163, #164)


  • Roll back to version 3.4.6 as per a deadlock issue found by @eherot on #156


  • Run apt-get update at compile time
  • Use lazy evaluation for config_dir (#153, h/t to @Maniacal)
  • Update to testing using Chef 12.x
    • Works around the fact that Serverspec requires a version of net-ssh that needs Ruby >= 2.0


  • Fix setting of CLASSPATH to have version dynamically set
  • Upgrade to ZooKeeper 3.4.7, due to the disappearance of ZK 3.4.6 at the chosen mirror
    • Upgrading ZK is potentially breaking


  • Switch to using value_for_platform_family() to determine the SysV service script provider to use
    • Makes the cookbook less restrictive w/r/t using it on a RHEL-based OS


  • Improve generally for better CentOS support (#146)
  • Create ZooKeeper log dir on installation (#147)
  • Add SysV support for CentOS systems not using Upstart/Runit/Exhibitor
  • Fix testing by dropping usage of Chef Zero
    • Not sure why Chef Zero won’t work, but it’d be nice to get it going again
    • Seems to complain about not being able to find something w/r/t the tester cookbook


  • Add ability to configure znode ACL via node LWRP (#145 thanks @Annih)
  • Create zookeeper user as system user (#142 thanks @petere)
  • Update to prelease runit cookbook b/c of a bug in that cookbook
    • Soon as the next release of it is cut, we can revert e371719
  • Switch to chef-zero for the Test Kitchen provisioner


  • Fix logic around creating (Fixes #141)
  • Add tests for default attributes & using node[zookeeper][env_vars]
  • Add JAVA_OPTS attribute (#144, thanks @andrewgoktepe)


  • Move creation of to zookeeper::install, to allow cookbooks that only call that recipe (e.g., exhibitor)
  • Relax permissions on ZK install_dir (#140)


  • Add creation & configuration of, an optional file to bring in custom EnvVars for Zookeeper to use
  • Fix typo in source for SysV init script (#139)


  • Proper init support (contributed by @shaneramey)


  • Add some tests
  • Fix up zookeeper_node
  • Call runit recipe before service declaration


  • Run apt::default and update at compille time if on Debian (#127)


  • Report zookeeper_config as updated only if zoo.cfg is updated (#110)
  • Fix zk_installed return value (#113)
  • Fix docs (#114, #115)
  • Fix for undefined new method error (#116)
  • Always install build-essential, regardless of usage of java cookbook


  • Allow configurable data_dir parameter for Zookeeper data directory location (contributed by @eherot)


  • Fix erroneous attribute reference


  • Allow pre-installed Java (contributed by @solarce)


  • Fixed recipe call (contributed by @solarce)


  • Split out config rendering to separate recipe (contributed by @solarce)


  • Split out installation to a separate recipe (contributed by @Gazzonyx)


  • Set minimum build-essential version for RHEL support (contributed by @Gazzonyx)


  • Upstart support (contributed by @solarce)


  • Added a service recipe which can be run and activated using new service_style attribute.


  • A basic configuration is rendered by default.
  • Clarify some points in the README about zookeeper_config


  • Exhibitor cookbook factored out (contributed by @wolf31o2)
  • Zookeeper recipe rewritten as LWRP
  • Documentation updated slightly
  • Tested and verified and (hopefully) as backwards-compatible as possible
    • Being a full version bump, there are no backwards-compatibility promises
  • TODO
    • Better documentation
    • zookeeper_service resource
    • zookeeper_config resource
    • Better tests
    • Swap out "community" Java


  • Force build-essential to run at compile time (contributed by @davidgiesberg)


  • Bugfix for attribute access (fixes 1.7.2 bug)


  • Move ZK download location calculation to recipe to eliminate ordering bug


  • Test-kitchen support added
  • Patch installed to support CentOS platform


  • Switched to Runit for process supervision (contributed by @gansbrest)
  • DEPRECATION WARNING: Upstart is no longer supported and has been removed
  • Re-add script but punt on utilizing it
  • This means we recommend staying on 1.6.1 or below if you use Upstart
  • In the meantime, we are working on a strategy to integrate this functionality into the Runit script, to support dependent services


  • Attribute overrides to defaultconfig should now work (contributed by @trane)


  • Add correct (Apache v2) license to metadta.rb (#61)


  • Add logic to download existing exhibitor jar


  • changes: Skip S3 credentials file if AWS credentials are not provided
  • Moved property files from inaccessible chef dir to exhibitor install dir.
  • Logged output to syslog.
  • Added option to set exhibitor/amazon log level


  • Added: s3credentials template to assist with --configtype s3


  • Added config hook and default for servers-spec setting
  • bugfix: cache permission denied error on exhibitor jar move
  • bugfix: ZooKeeper install tar cache EACCES error


  • bugfix: zk_connect_str actually returned when chroot passed.
  • forward zk port in vagrant


  • fix for backwards compatibility with ruby 1.8.7


  • Initial release of zookeeper

No quality metric results found