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

Select Status


lsyncd (6) Versions 0.2.3

Installs/Configures lsyncd

cookbook 'lsyncd', '~> 0.2.3', :supermarket
cookbook 'lsyncd', '~> 0.2.3'
knife supermarket install lsyncd
knife supermarket download lsyncd
Quality 71%

lsyncd Cookbook

The lsyncd cookbook installs lsyncd, creates a basic config, and starts the
service. Additionally, it exposes the lsyncd_target resource to easily add sync

Through some ugly Lua hackery, the main config, /etc/lsyncd/lsyncd.conf.lua,
is setup such that it will include all sync configs in /etc/lsyncd/conf.d/.
The lsyncd_target resource pretty much just creates the configs in

The basis for this cookbook came from
bflad's lsyncd cookbook.


  • Chef 11 or greater

Tested on:

  • Debian 7.x (Wheezy)
  • Ubuntu 12.04
  • Ubuntu 14.04
  • CentOS 6.5
  • CentOS 7.0




  • :create - creates a sync config
  • :delete - deletes the sync config


  • mode - lsyncd sync mode. Defaults to rsync
  • source - source directory. Required
  • target - target directory to sync files to. Required
  • user - User name to use when syncing content. Optional, will assume root if a user name is not provided.
  • host - IP or hostname of remote host. Required for remote syncing with the rsync or rsyncssh modes.
  • rsync_opts - list of rsync options
  • exclude - list of exclusions
  • exclude_from - path to file containing exclusions


Sync a directory to another local directory:

include_recipe 'lsyncd'

lsyncd_target 'foo' do
  source '/tmp/foo'
  target '/tmp/bar'
  notifies :restart, 'service[lsyncd]', :delayed

You can also do remote rsync by specifying rsync or rsyncssh for the mode:

include_recipe 'lsyncd'

lsyncd_target 'foo' do
  host 'test'
  source '/tmp/foo'
  target '/tmp/bar'
  notifies :restart, 'service[lsyncd]', :delayed



Installs lsyncd, creates /etc/lsyncd/conf.d, sets up base config, and starts
lsyncd service. Note that the service will not actually start until you have a sync config in place.


default[:lsyncd][:conf_d] = '/etc/lsyncd/conf.d'
default[:lsyncd][:log_file] = '/var/log/lsyncd.log'
default[:lsyncd][:status_file] = '/var/log/lsyncd-status.log'
default[:lsyncd][:interval] = 20


This cookbook includes chefspec unit tests and integration tests via test-kitchen and serverspec.
There is a test cookbook to exercise the lsync_target LWRP included.

I've included a custom matcher for chefspec. The methods available are:

  • create_lsyncd_target
  • delete_lsyncd_target

There is also an lsyncd_target chef_runner method, so you can do things like:

resource = chef_run.lsyncd_target('test1')
expect(resource).to notify('service[lsyncd]').to(:restart).delayed

License & Authors

Authors:: Daniel Givens (
Authors:: Brian Flad (

Copyright 2014, Rackspace, Inc.

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

yum >= 3.5.3

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Collaborator Number Metric

0.2.3 passed this metric

Contributing File Metric

0.2.3 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Foodcritic Metric

0.2.3 passed this metric

No Binaries Metric

0.2.3 passed this metric

Supported Platforms Metric

0.2.3 passed this metric

Testing File Metric

0.2.3 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Version Tag Metric

0.2.3 passed this metric