Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chartbeat-labs/puppet-varnish
Puppet Module to manage Varnish on Debian
https://github.com/chartbeat-labs/puppet-varnish
Last synced: about 2 months ago
JSON representation
Puppet Module to manage Varnish on Debian
- Host: GitHub
- URL: https://github.com/chartbeat-labs/puppet-varnish
- Owner: chartbeat-labs
- License: mit
- Created: 2013-11-19T22:27:23.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-10-12T02:04:18.000Z (about 7 years ago)
- Last Synced: 2024-03-26T03:03:40.336Z (9 months ago)
- Language: Ruby
- Size: 438 KB
- Stars: 3
- Watchers: 13
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Varnish
Puppet module for varnish.
[](https://travis-ci.org/chartbeat-labs/puppet-varnish)
### Example usage
The base class just installs varnish and stops the service. This is because
varnish services are created in the varnish::instance defined type.
If you just want to install the varnish package but don't want it running:
```puppet
include varnish
```
If you want to modify which version of varnish you want to run, there are
currently two supported methods.
*Class Parameters*
```puppet
class { 'varnish' :
package_ensure => '1.2.3',
}
```
*Hiera*
```
---
varnish::package_ensure: '1.2.3'
```
Include with default parameters:
```puppet
varnish::instance { 'instance0' : }
```
Include with multiple different storage types:
```puppet
varnish::instance { 'instance0' :
storage_file => ['file,/mnt/varnish/instance0/varnish_storage.bin,70%',
'persistent,/data/varnish/varnish_storage.bin,20%']
}
```
The varnish::instance type is fully configurable. All of the varnish
options are available as parameters. If, for instance, you want to
increase the thread pool max size you could specify that as a param.
All of the parameters are set to the defaults as defined in varnishd(1)
```puppet
varnish::instance { 'instance0' :
thread_pool_max => '1500',
}
```
### VMODS
The varnish::instance class supports installing vmods. Currently it expects
them to be installed via APT. There are plans to support building it from
source, but that would require a custom provider which is not yet built.
To ensure that a given varnish::instance has the throttle vmod installed
that it needs:
```puppet
varnish::instance { 'instance0' :
vmods => ['libvmod-throttle'],
}
```
### Repo
This varnish module currently uses the public repo.varnish-cache.org debian
repository. If you want to use another repo, you can do it like the varnish
package above, with class parameters or hiera.
*Class Parameters*
```puppet
class { 'varnish' :
apt_location => 'http://some.other.repo',
apt_repos => 'main restricted universe',
...
}
```
*Hiera*
```
---
varnish::apt_location: 'http://some.other/repo'
varnish::apt_repos: 'repo-name'
varnish::apt_key: 'XXXXXX'
varnish::key_source: 'http://some.other/key.txt'
varnish::apt_include_src: false
```
### Configs
The varnish::instance type ships with a pretty simple config. You can pass
in your own vcl config by just specifying the following:
```puppet
varnish::instance { 'instance0' :
vcl_conf => 'puppet:///path/to/config/file.vcl',
}
```
Or if your config is a template, you can do that as well:
```puppet
varnish::instance { 'instance0' :
vcl_conf => 'path/to/template/file.vcl.erb',
}
```
**Note that if you pass in your own config, you'll have to handle the backend
configuration, backend probes, vmod imports, acls yourself**
#### Extra conf
There is an extra_conf parameter that you can use as a way to customize the
default vcl conf further, but also retaining much of the scaffolding present
in the default vcl conf. When multiple subroutines are defined in varnish,
varnish will concatentate them together, for example:
```
vcl_recv {
if (req.restarts == 0) {
if (req.http.x-forwarded-for) {
set req.http.X-Forwarded-For =
req.http.X-Forwarded-For + ", " + client.ip;
} else {
set req.http.X-Forwarded-For = client.ip;
}
}
}
vcl_recv {
# Serve up stale data for this long
set req.grace = 6s;
}
```
Will result in the following compiled version:
```
vcl_recv {
if (req.restarts == 0) {
if (req.http.x-forwarded-for) {
set req.http.X-Forwarded-For =
req.http.X-Forwarded-For + ", " + client.ip;
} else {
set req.http.X-Forwarded-For = client.ip;
}
}
# Serve up stale data for this long
set req.grace = 6s;
}
```
As long as a return(SUBROUTINE) is not hit somewhere higher up, processing
will continue on through the vcl. The default vcl conf that ships with this
module has no return statements (except for the PURGE request) so you can
safely **append** your custom vcl configurations by just passing them in
as extra_conf.
```puppet
varnish::instance { 'instance0' :
extra_conf => 'puppet:///path/to/extra/conf.vcl'
}
```
### Testing
This module uses rspec-puppet, rspec-puppet-system and rspec-system-serverspec.
To test, install the required gems through [Bundler](http://bundler.io).
```shell
$ git clone git://github.com/chartbeat/puppet-varnish.git
$ cd puppet-varnish
$ bundle install
$ bundle exec rake spec
$ bundle exec rake acceptance
```
To perform acceptance tests, you'll need [Vagrant](http://vagrantup.com) installed.
See [LICENSE](LICENSE) file.