Skip to content

Latest commit

 

History

History
115 lines (85 loc) · 6.51 KB

README.md

File metadata and controls

115 lines (85 loc) · 6.51 KB
Raw

Apache Zookeeper Cookbook

Cookbook Version Build Status

Installs and configures Apache Zookeeper.

View the Change Log to see what has changed.

Supports

  • CentOS
  • Ubuntu

Usage

Using the default attributes will setup a single Zookeeper server in standalone mode.

If you are wanting to setup Zookeeper in a multi-server cluster make sure to fill out the node["apache_zookeeper"]["servers"] like this,

node["apache_zookeeper"]["servers"] = ["myzkhost1.com", "myzkhost2.com", myzkhost3.com"]

The array should include a value per server and can be any of the following values,

  • FQDN - node['fqdn']
  • Host Name - node['hostname']
  • Machine Name - node['machinename']
  • Any network interface - node["network"]["interfaces"][..]
  • EC2 Host Name - node['ec2']['public_hostname']
  • EC2 IP Address - node['ec2']['public_ipv4']

This array is used to configure/calculate the server ids for each zookeeper.

You can also provide the server ids yourself by including values for the attributes node["apache_zookeeper"]["zoo.cfg"]["server.[ID]"]. If this is done you don't have to provide the node["apache_zookeeper"]["servers"] attribute.

What does the installation look like

By default the installation will look like,

zkCli | /usr/bin/zkCli  - The Zookeeper cli binary command
/opt/zookeeper/current/*        - All of Zookeeper's files (config, binaries, logs...)
/var/opt/zookeeper/logs - Zookeeper log information
/var/opt/zookeeper/data - Zookeeper data
/etc/init.d/zookeeper   - An init.d script to start/stop zookeeper. You can use service
				        zookeeper [start|stop|restart|status] instead

Unique Quorum and Leader Election Ports

It is possible to provide unique quorum and leader election ports in a few different ways.

node["apache_zookeeper"]["servers"] = ["host1", "host2", "host3"]
node["apache_zookeeper"]["follower_port"] = 2888
node["apache_zookeeper"]["election_port"] = 3888

OR

node["apache_zookeeper"]["servers"] = ["host1:2888:3888", "host2:2888:3888", "host3:2888:3888"]

OR

node["apache_zookeeper"]["zoo.cfg"]["server.1"] = "host1:2888:3888"
node["apache_zookeeper"]["zoo.cfg"]["server.2"] = "host2:2888:3888"
node["apache_zookeeper"]["zoo.cfg"]["server.3"] = "host3:2888:3888"

Environment Variables

Should note that the zkServer.sh and other various scripts provided by zookeeper use various environment variables to tweak runtime settings. Here are some,

  • ZOO_LOG_DIR : Overwrites log4j zookeeper.log.file. Defaults to . if not set which is why we provide a default value for it to the node["apache_zookeeper"]["log_dir"] value.
  • ZOO_LOG4J_PROP : Overwrites log4j zookeeper.root.logger. Defaults to 'INFO, CONSOLE' if not set which is why we provide a default value for it 'INFO,CONSOLE,ROLLINGFILE'
  • JMXDISABLE : Disables jmx. Defaults to enabling JMX. To disable set to any value
  • SERVER_JVMFLAGS : JVM flags for the server process

Recipes

  • default: Installs, configures and runs zookeeper as a service
  • install: Installs zookeeper
  • configure: Configures zookeeper
  • service: Runs zookeeper

Attributes

  • node["apache_zookeeper"]["install_java"] : If you want to use the java cookbook to install java (default=true)
  • node["apache_zookeeper"]["user"] : The user that owns the Zookeeper installation (default="zookeeper")
  • node["apache_zookeeper"]["group"] : The group that owns the Zookeeper installation (default="zookeeper")
  • node["apache_zookeeper"]["env_vars"] : The environment variables set for the zookeeper user (default={"ZOO_LOG_DIR" => node["apache_zookeeper"]["log_dir"], "ZOO_LOG4J_PROP" => "'INFO, CONSOLE, ROLLINGFILE'"})
  • node["apache_zookeeper"]["servers"] : The array of fqdn/hostnames/ips for the zookeeper servers in the cluster (default=[])
  • node["apache_zookeeper"]["follower_port"] : The port used by zookeeper followers (default=2888)
  • node["apache_zookeeper"]["election_port"] : The port used for zookeeper elections (default=3888)
  • node["apache_zookeeper"]["version"] : The version of Zookeeper to install (default="3.4.6")
  • node["apache_zookeeper"]["mirror"] : The URL to the mirror that hosts the zookeeper binary (default=http://archive.apache.org/dist/zookeeper)
  • node["apache_zookeeper"]["binary_url"] : The full binary url of Zookeeper. If you override this value make sure to provide a valid and up to date value for node["apache_zookeeper"]["version"] (default=File.join node["apache_zookeeper"]["mirror"], "zookeeper-#{node["apache_zookeeper"]["version"]}", "zookeeper-#{node["apache_zookeeper"]["version"]}.tar.gz")
  • node["apache_zookeeper"]["init_style"] : The style of script to use for running the zookeeper service. Currently only supports init. (default = init)
  • node["apache_zookeeper"]["install_dir"] : The base directory Zookeeper should be installed into (default="/opt/zookeeper")
  • node["apache_zookeeper"]["local_state_dir"] : The base directory for all of Zookeepers local state (data, logs)
  • node["apache_zookeeper"]["data_dir"] : The data directory for Zookeeper (default="#{node["apache_zookeeper"]["local_state_dir"]}/data")
  • node["apache_zookeeper"]["log_dir"] : The log directory for Zookeeper (default="#{node["apache_zookeeper"]["local_state_dir"]}/logs")
  • node["apache_zookeeper"]["bin_dir"] : The bind directory for Zookeeper (default="#{node["apache_zookeeper"]["install_dir"]}/current/bin")
  • node["apache_zookeeper"]["config_dir"] : The config directory for Zookeeper (default="#{node["apache_zookeeper"]["install_dir"]}/current/config")
  • node["apache_zookeeper"]["zoo.cfg"][*] : The key/values set for the zoo.cfg config file (see attributes file for defaults)
  • node["apache_zookeeper"]["log4j.properties"][*] : The key/values set for the log4j.properties config file (see attributes file for defaults)
  • node['apache_zookeeper']['install']['type'] : Type of zookeeper installation. Can be source or package
  • node['apache_zookeeper']['package']['version'] : Default nil. Set if you need not the latest version.