beanstalkd

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with beanstalkd
   • What beanstalkd affects
   • Setup requirements
   • Beginning with beanstalkd
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Overview

This is a Puppet module to manage a Beanstalkd instance.

Module Description

The Beanstalkd module handles installing, configuring, and running the Beanstalkd daemon.

If you are running this on a rhel based distro you need to make sure you have the epel repository set up. We have not included this as a hard dependency but you can easily add it using the epel module provided by stahnma (https://forge.puppet.com/stahnma/epel).

Setup

What beanstalkd affects

• beanstalkd package
• beanstalkd configuration
• beanstalkd service

Beginning with beanstalkd

include 'beanstalkd' is enough to get you up and running. If you'd like to pass parameters, you can do something like this:

class { 'beanstalkd':
  listen_addr      => '0.0.0.0',
  listen_port      => '11300',
  enable_binlog    => true,
  binlog_directory => '/var/lib/beanstalkd',
}

Or, you can use the same options in hiera:

---
beanstalkd::listen_addr: '0.0.0.0'
beanstalkd::listen_port: '11300'
beanstalkd::enable_binlog: 'true'
beanstalkd::binlog_directory: '/var/lib/beanstalkd'

Reference

Classes

Public Classes

• beanstalkd: Main class, includes all other classes

Private Classes

• beanstalkd::install: Handles the package installation
• beanstalkd::config: Handles the configuration
• beanstalkd::service: Handles the service

Parameters

The following parameters are available:

####listen_addr Which address to bind beanstalkd to. Defaults to '127.0.0.1'.

####listen_port Which port to bind beanstalkd to. Defaults to '11300'.

####enable_binlog Whether to enable binlogging. Defaults to false. Other value is true.

####binlog_directory If binlogging is enabled, specify the directory that the beanstalkd binlog will log to. Defaults to '/var/lib/beanstalkd' on Debian families and '/var/lib/beanstalkd/binlog' on RedHat families.

####package_ensure Whether the beanstalkd package is present. Defaults to 'present'. Other values are 'latest', or a specific version.

####service_ensure Whether the beanstalkd service should be running. Defaults to 'running'. Other value is 'stopped'.

####service_enable Whether the beanstalkd service should be enabled at boot. Defaults to true. Other value is false.

####user User that the beanstalkd process runs as. Default is 'beanstalkd'.

####max_job_size Maximum size in bytes that beanstalkd allows for a job. Defaults to '65535'.

Limitations

This module currently is tested using Ubuntu 16.04, 14.04, 12.04 as well as CentOS 6, 7 and Debian 7. The EPEL module is required for RedHat families to install beanstalkd.

Development

Feel free to submit pull requests if you'd like to add additional platforms or features.

License

Copyright 2018 Jeremy Bowers

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Contributors

This module was written by Jeremy Bowers [email protected]

Other contributions from:

• Mattias Geniar [email protected]
• Sobit Akhmedov [email protected]
• Andreas Feldmann [email protected]
• Ted Wells [email protected]
• Bryan Gwilliam