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


varnish (57) Versions 2.2.0

Installs and configures varnish

cookbook 'varnish', '= 2.2.0', :supermarket
cookbook 'varnish', '= 2.2.0'
knife supermarket install varnish
knife supermarket download varnish
Quality 0%

Circle CI

varnish Cookbook

Installs and configures varnish.



  • Requires chef-client 12 and above.


Tested on:

  • Ubuntu 12.04
  • Ubuntu 14.04
  • Debian 6.0
  • Centos 5.9
  • Centos 6.5
  • Centos 7.0


  • node['varnish']['dir'] - location of the varnish configuration directory
  • node['varnish']['default'] - location of the default file that controls the varnish init script on Debian/Ubuntu systems.
  • node['varnish']['version'] - If retrieving from official Varnish project repository, may choose 3.0 or 4.0.
  • node['varnish']['start'] - Should we start varnishd at boot? Set to "no" to disable (yes)
  • node['varnish']['nfiles'] - Open files (131072)
  • node['varnish']['memlock'] - Maxiumum locked memory size for shared memory log (82000)
  • node['varnish']['instance'] - Default varnish instance name (node['fqdn'])
  • node['varnish']['listen_address'] - Default address to bind to. Blank address (the default) means all IPv4 and IPv6 interfaces, otherwise specify a host name, an IPv4 dotted quad, or an IPv6 address in brackets
  • node['varnish']['listen_port'] - Default port to listen on (6081)
  • node['varnish']['vcl_conf'] - Name to use for main configuration file. (default.vcl.erb)
  • node['varnish']['vcl_source'] - Name for default configuration file template. (default.vcl)
  • node['varnish']['vcl_cookbook'] - Cookbook in which to look for the default.vcl.erb (or 'vcl_source' filename) template. This is used to specify custom template without modifying community cookbook files. (varnish)
  • node['varnish']['vcl_generated'] - Generate the varnish configuration using the supplied template. (true)
  • node['varnish']['conf_source'] - Name of the default system configuration file. (default.erb)
  • node['varnish']['conf_cookbook'] - Cookbook in which the default system configuration file is located. (varnish)
  • node['varnish']['secret_file'] - Path to a file containing a secret used for authorizing access to the management port. (/etc/varnish/secret)
  • node['varnish']['admin_listen_address'] - Telnet admin interface listen address (
  • node['varnish']['admin_listen_port'] - Telnet admin interface listen port (6082)
  • node['varnish']['user'] - Specifies the name of an unprivileged user to which the child process should switch before it starts accepting connections (varnish)
  • node['varnish']['group'] - Specifies the name of an unprivileged group to which the child process should switch before it starts accepting connections (varnish)
  • node['varnish']['ttl'] - Specifies a hard minimum time to live for cached documents. (120)
  • node['varnish']['storage'] - The storage type used ('file')
  • node['varnish']['storage_file'] - Specifies either the path to the backing file or the path to a directory in which varnishd will create the backing file. Only used if using file storage. ('/var/lib/varnish/$INSTANCE/varnish_storage.bin')
  • node['varnish']['storage_size'] - Specifies the size of the backing file or max memory allocation. The size is assumed to be in bytes, unless followed by one of the following suffixes: K,k,M,m,G,g,T,g,% (1G)
  • node['varnish']['log_daemon'] - Specifies if the system varnishlog daemon dumping all the varnish logs into /var/log/varnish/varnish.log should be enabled. (true)
  • node['varnish']['parameters'] = Set the parameter specified by param to the specified value. See Run-Time Parameters for a list of parameters. This option can be used multiple times to specifymultiple parameters.

If you don't specify your own vcl_conf file, then these attributes are used in the cookbook default.vcl template:

  • node['varnish']['backend_host'] = Host to serve/cache content from (localhost)
  • node['varnish']['backend_port'] = Port on backend host to access (8080)



Installs the varnish package, manages the default varnish configuration file, and the init script defaults file.


If placed before the default recipe in the run list, the official Varnish project apt repository will offer access to more version and platform support.


On systems that need a high performance caching server, use recipe[varnish]. Additional configuration can be done by modifying the default.vcl.erb and default.erb templates.

If running on a Redhat derivative then you may need to include yum-epel as it provides the jemalloc dependency that varnish needs


See the distro_install and vendor_install recipes for examples of these resources in action.


Installs Varnish with the default configuration supplied by the package.

The :install action handles package installation. By default, it
will install Varnish from your distro repositories. If you set the
vendor_repo parameter to true, then it will install Varnish
from the varnish-cache repositories.


Name Type Default Value
package_name string 'varnish'
vendor_repo true or false false
vendor_version string '4.0'


  • :install - Installs and enables the Varnish service.


Configures the Varnish service. If you do not include this, the config
files that come with your distro package will be used instead.

Name Type Default Value
start_on_boot true or false true
max_open_files integer 131_072
max_locked_memory integer 82_000
instance_name string nil
listen_address string nil
listen_port integer 6081
admin_listen_address string ''
admin_plisten_port integer 6082
user string 'varnish'
group string 'varnish'
ttl integer 120
storage 'malloc' or 'file' 'file'
file_storage_path string '/var/lib/varnish/%s_storage.bin' where %s is replaced with the resource name
file_storage_size string '1G'
malloc_size string nil
path_to_secret string '/etc/varnish/secret'

You can also send a hash to parameters which will add additional parameters to the varnish daemon via the -p option. The default hash is:

{ 'thread_pools' => '4',
  'thread_pool_min' => '5',
  'thread_pool_max' => '500',
  'thread_pool_timeout' => '300' }


  • :configure - Creates the varnish configuration file from template.


Name Type Default Value
backend_host string 'localhost'
backend_port integer 8080


  • :configure - Creates a default.vcl file.


Configures varnishlog or varnishncsa service. You can define both
logfiles by calling varnish_log more than once. You can install logrotate
config files if you wish as well.

Name Type Default Value
file_name string '/var/log/varnish/varnishlog.log'
pid string '/var/run/'
log_format 'varnishlog' or 'varnishncsa' 'varnishlog'
ncsa_format_string string `'%h
instance_name string nil
logrotate true or false true
logrotate_path string '/etc/logrotate.d'


  • :configure - configures the varnishlog or varnishncsa service.

License & Authors

Copyright:: 2008-2009, Joe Williams

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

apt ~> 2.4
build-essential >= 0.0.0
chef-sugar >= 0.0.0
yum ~> 3.0
yum-epel >= 0.0.0

Contingent cookbooks

magentostack Applicable Versions
nodestack Applicable Versions
noosfero Applicable Versions
phpstack Applicable Versions
pythonstack Applicable Versions
stack_commons Applicable Versions

varnish Cookbook CHANGELOG

This file is used to list changes made in each version of the varnish cookbook.


  • Fix default storage bug. Specify a default file storage location, as one is required with file backend, fixes #72. Adjust template for default configuration of varnish so that it won't do the file backend without a path, since that's illegal syntax.

  • Cause varnish reload to happen after restart. Delayed notifications are queued up in order. In this case, it makes sense for the reload to happen after the restart.

  • Switch from service restart to service reload. The varnish_default_vcl has been updated to perform a service reload instead of a service restart. This will prevent the cache from being cleared when a reload of the vcl file is enough.


  • Fixes #56. The apt resource may not be included, so no need to run a notification on it.


  • Make resource_name compatible with older Chef. Switch from passing an argument into resource_name to using the assignment operator '='. This will make resource_name compatible with older versions of Chef.

v1.1.0 (2015-02-16)

  • Created libraries, to eventually replace recipe functionality, currently can be used along side recipes
  • Added CircleCI support for automated testing
  • Added logrotate support
  • Added varnish(log|nsca) support

v0.9.12 (2014-03-12)

  • [COOK-4368] - Improve documentation to include all attributes





  • COOK-3095 - Add MiniTest Chef Handler and Test Kitchen



  • [COOK-2892]: Varnish restarts when vcl is updated instead of reloading


  • [COOK-1261] - fix issues with default.vcl handling


  • [COOK-873] - full daemon configuration through attributes
  • [COOK-1091] - fix path for default.vcl, via COOK-873
  • [COOK-1162] - add apt_repo recipe for using official varnish repository


  • Current public release.

Foodcritic Metric

2.2.0 failed this metric

FC031: Cookbook without metadata file: /tmp/cook/85f198aed3e01cb350a9c2c7/varnish/metadata.rb:1
FC045: Consider setting cookbook name in metadata: /tmp/cook/85f198aed3e01cb350a9c2c7/varnish/metadata.rb:1