jrodriguezjr / varnish

Varnish

#varnish

####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 varnish
   • What varnish affects
   • Beginning with varnish
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

##Overview

The Varnish module installs, configures, and manages the varnish service.

##Module Description

The Varnish module handles running the Varnish caching system on your server.

##Setup

###What varnish affects

• varnish package.
• varnish configuration file.
• varnish service.

###Beginning with varnish

include '::varnish' is enough to get you up and running. If you wish to pass in parameters like which servers to use then you can use:

class { '::varnish':
  vbackend_servers => [ 'varnish1.corp.com', 'varnish2.corp.com' ],
}

##Usage

All interaction with the varnish module can do be done through the main varnish class. This means you can simply toggle the options in the varnish class to get at the full functionality.

###I just want varnish, what's the minimum I need?

include '::varnish'

###I just want change the frontend port varnish will listen on, nothing else.

class { '::varnish':
  vfrontend_port  => '8888'   # default '80'
}

###I'd like to change the backend servers and ports they listen on.

class { '::varnish':
  vbackend_servers  => [ 'varnish1.corp.lan', 'varnish2.corp.lan' ],
  vbackend_port     => '8080',
}

###Looks great! But I'd like a different template, we need to do something unique here.

class { '::varnish':
  vbackend_servers  => [ 'varnish1.corp.lan', 'varnish2.corp.lan' ],
  vbackend_port     => '8080',
  vcl_config_template => 'different/module/custom.template.erb',
}

##Reference

###Classes

• varnish: Main class, includes all the rest.
• varnish::install: Handles the packages.
• varnish::config: Handles the configuration file.
• varnish::service: Handles the service.

###Parameters

The following parameters are available in the varnish module

####config

This sets the file to write varnish configuration into.

####config_template

This determines which template puppet should use for the varnish configuration.

####package_ensure

This can be set to 'present' or 'latest' or a specific version to choose the varnish package to be installed.

####package_name

This determines the name of the package to install.

####servers

This selects the servers to use for varnish peers.

####service_enable

This determines if the service should be enabled at boot.

####service_ensure

This determines if the service should be running or not.

####service_manage

This selects if puppet should manage the service in the first place.

####service_name

This selects the name of the varnish service for puppet to manage.

##Limitations

This module has been built on and tested against Puppet 2.7 and higher.

The module has been tested on the following platforms:

• Debian 6/7
• Ubuntu 12.04

=======

Testing on other platforms has been light and cannot be guaranteed.

##Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our contributors to follow so that we can have a chance of keeping on top of things.

You can read the complete module contribution guide on the Puppet Labs wiki.