Puppet module for configuring the squid caching service.
The set up a simple squid server with a cache to forward http port 80 requests.
class { 'squid': }
squid::acl { 'Safe_ports':
type => port,
entries => ['80'],
}
squid::http_access { 'Safe_ports':
action => allow,
}
squid::http_access{ '!Safe_ports':
action => deny,
}
This module will set the SELINUX-context for the cache_dir and/or port, requires puppet-selinux
Parameters to the squid class almost map 1 to 1 to squid.conf parameters themselves.
ensure_service
The ensure value of the squid service, defaults torunning
.enable_service
The enable value of the squid service, defaults totrue
.config
Location of squid.conf file, defaults to/etc/squid/squid.conf
.config_user
user which owns the config file, default depends on$operatingsystem
config_group
group which owns the config file, default depends on$operatingsystem
daemon_user
user which runs the squid daemon, this is used for ownership of the cache directory, default depends on$operatingsystem
daemon_group
group which runs the squid daemon, this is used for ownership of the cache directory, default depends on$operatingsystem
cache_mem
defaults to256 MB
. cache_mem docs.cache_replacement_policy
defaults to undef. cache_replacement_policy docs.memory_replacement_policy
defaults to undef. memory_replacement_policy docs.memory_cache_shared
defaults to undef. memory_cache_shared docs.maximum_object_size_in_memory
defaults to512 KB
. maximum_object_size_in_memory docsaccess_log
defaults todaemon:/var/logs/squid/access.log squid
. access_log docscoredump_dir
defaults to undef. coredump_dir docs.error_directory
defaults to undef. error_directory.err_page_stylesheet
defaults to undef. err_page_stylesheet.package_name
name of the squid package to manage, default depends on$operatingsystem
service_name
name of the squid service to manage, default depends on$operatingsystem
max_filedescriptors
defaults to undef. max_filedescriptors docs.workers
defaults to undef. workers docs.snmp_incoming_address
defaults to undef. Can be set to an IP address to only listen for snmp requests on an individual interface. snmp_incoming_address.buffered_logs
defaults to undef. buffered_logs docs.acls
defaults to undef. If you pass in a hash of acl entries, they will be defined automatically. acl entries.visible_hostname
defaults to undef. visible_hostname docsvia
defaults to undef. via docshttpd_suppress_version_string
defaults to undef. httpd_suppress_version_string docsforwarded_for
defaults to undef. forwarded_for docshttp_access
defaults to undef. If you pass in a hash of http_access entries, they will be defined automatically. http_access entries.http_ports
defaults to undef. If you pass in a hash of http_port entries, they will be defined automatically. http_port entries.https_ports
defaults to undef. If you pass in a hash of https_port entries, they will be defined automatically. https_port entries.icp_access
defaults to undef. If you pass in a hash of icp_access entries, they will be defined automatically. icp_access entries.refresh_patterns
defaults to undef. If you pass a hash of refresh_pattern entires, they will be defined automatically. refresh_pattern entries.snmp_ports
defaults to undef. If you pass in a hash of snmp_port entries, they will be defined automatically. snmp_port entries.send_hit
defaults to undef. If you pass in a hash of send_hit entries, they will be defined automatically. send_hit entries.cache_dirs
defaults to undef. If you pass in a hash of cache_dir entries, they will be defined automatically. cache_dir entries.ssl_bump
defaults to undef. If you pass in a hash of ssl_bump entries, they will be defined automatically. ssl_bump entries.sslproxy_cert_error
defaults to undef. If you pass in a hash of sslproxy_cert_error entries, they will be defined automatically. sslproxy_cert_error entries.extra_config_sections
defaults to empty hash. If you pass in a hash ofextra_config_section
resources, they will be defined automatically.
class { 'squid':
cache_mem => '512 MB',
workers => 3,
coredump_dir => '/var/spool/squid',
}
class { 'squid':
cache_mem => '512 MB',
workers => 3,
coredump_dir => '/var/spool/squid',
acls => { 'remote_urls' => {
type => 'url_regex',
entries => ['http://example.org/path',
'http://example.com/anotherpath'],
},
},
http_access => { 'our_networks hosts' => { action => 'allow', }},
http_ports => { '10000' => { options => 'accel vhost', }},
snmp_ports => { '1000' => { process_number => 3, }},
cache_dirs => { '/data/' => { type => 'ufs', options => '15000 32 256 min-size=32769', process_number => 2 }},
}
The acls, http_access, http_ports, snmp_port, cache_dirs lines above are equivalent to their examples below.
Defines acl entries for a squid server.
squid::acl { 'remote_urls':
type => 'url_regex',
entries => ['http://example.org/path',
'http://example.com/anotherpath'],
}
would result in a multi entry squid acl
acl remote_urls url_regex http://example.org/path
acl remote_urls url_regex http://example.com/anotherpath
These may be defined as a hash passed to ::squid
type
The acltype of the acl, must be defined, e.g url_regex, urlpath_regex, port, ..aclname
The name of acl, defaults to thetitle
.entries
An array of acl entries, multiple members results in multiple lines in squid.conf.order
Each ACL has an order05
by default this can be specified if order of ACL definition matters.
Defines cache_dir entries for a squid server.
squid::cache_dir { '/data':
type => 'ufs',
options => '15000 32 256 min-size=32769',
process_number => 2,
}
Results in the squid configuration of
if ${processor} = 2
cache_dir ufs 15000 32 256 min-size=32769
endif
type
the type of cache, e.g ufs. defaults toufs
.path
defaults to the namevar, file path to cache.options
String of options for the cache. Defaults to empty string.process_number
if specfied as an integer the cache will be wrapped in aif $proceess_number
statement so the cache will be used by only one process. Default is undef.
Defines cache entries for a squid server.
squid::cache { 'our_network_hosts_acl':
action => 'deny',
comment => 'Our networks hosts are denied for caching',
}
Adds a squid.conf line
# Our networks hosts denied for caching
cache deny our_network_hosts_acl
Defines url_rewrite_program entries for a squid server.
squid::url_rewrite_program { '/usr/bin/squidguard -c /etc/squidguard/squidguard.conf':
}
Adds a squid.conf line
# fragment for url_rewrite_program /usr/bin/squidguard -c /etc/squidguard/squidguard.conf
url_rewrite_program /usr/bin/squidguard -c /etc/squidguard/squidguard.conf
squid::url_rewrite_program { '/usr/bin/squidguard -c /etc/squidguard/squidguard.conf':
children => 10
}
Adds a squid.conf line
# fragment for url_rewrite_program /usr/bin/squidguard -c /etc/squidguard/squidguard.conf
url_rewrite_program /usr/bin/squidguard -c /etc/squidguard/squidguard.conf
url_rewrite_children 10
Defines http_access entries for a squid server.
squid::http_access { 'our_networks hosts':
action => 'allow',
}
Adds a squid.conf line
# http_access fragment for out_networks hosts
http_access allow our_networks hosts
squid::http_access { 'our_networks hosts':
action => 'allow',
comment => 'Our networks hosts are allowed',
}
Adds a squid.conf line
# Our networks hosts are allowed
http_access allow our_networks hosts
Defines send_hit for a squid server.
squid:::send_hit{'PragmaNoCache':
action => 'deny',
}
Adds a squid.conf line
send_hit deny PragmaNoCache
value
defaults to the namevar
. The rule to allow or deny.
action
must one of deny
or allow
order
by default is 05.
comment
A comment to add to the configuration file.
Defines snmp_access entries for a squid server.
squid::snmp_access { 'monitoring hosts':
action => 'allow',
}
Adds a squid.conf line
# snmp_access fragment for monitoring hosts
snmp_access allow monitoring hosts
squid::snmp_access { 'monitoring hosts':
action => 'allow',
comment => 'Our monitoring hosts are allowed',
}
Adds a squid.conf line
# Our monitoring hosts are allowed
snmp_access allow monitoring hosts
These may be defined as a hash passed to ::squid
Defines icp_access entries for a squid server.
squid::icp_access { 'our_networks hosts':
action => 'allow',
}
Adds a squid.conf line
icp_access allow our_networks hosts
These may be defined as a hash passed to ::squid
value
defaults to thenamevar
the rule to allow or deny.action
must bedeny
orallow
. By default it is allow. The squid.conf file is ordered so by default all allows appear before all denys. This can be overidden with theorder
parameter.order
by default is05
Defines http_port entries for a squid server.
By setting optional ssl
parameter to true
will create https_port entries instead.
squid::http_port { '10000':
options => 'accel vhost'
}
squid::http_port { '10001':
ssl => true,
options => 'cert=/etc/squid/ssl_cert/server.cert key=/etc/squid/ssl_cert/server.key'
}
Results in a squid configuration of
http_port 10000 accel vhost
https_port 10001 cert=/etc/squid/ssl_cert/server.cert key=/etc/squid/ssl_cert/server.key
port
defaults to the namevar and is the port number.options
A string to specify any options for the default. By default and empty string.ssl
A boolean. When set totrue
creates https_port entries. Defaults tofalse
.
Defines https_port entries for a squid server.
As an alternative to using the Squid::Http_port defined type with ssl
set to true
, you can use this type instead. The result is the same. Internally this type uses Squid::Http_port to create the configuration entries.
port
defaults to the namevar and is the port number.options
A string to specify any options to add to the https_port line. Defaults to an empty string.
Defines url_rewrite_program for a squid server.
squid::url_rewrite_program { '/usr/bin/squidGuard -c /etc/squidguard/squidGuard.conf':
children => 8,
child_options => 'startup=0 idle=1 concurrency=0',
}
would result in the following squid url rewrite program
url_rewrite_program /usr/bin/squidGuard -c /etc/squidguard/squidGuard.conf
url_rewrite_children 8 startup=0 idle=1 concurrency=0
Defines refresh_pattern entries for a squid server.
squid::refresh_pattern { '^ftp:':
min => 1440,
max => 10080,
percent => 20,
order => 60,
}
squid::refresh_pattern { '(/cgi-bin/|\?)':
case_sensitive => falke,
min => 0,
max => 0,
percent => 0,
order => 61,
}
would result in the following squid refresh patterns
# refresh_pattern fragment for ^ftp
refresh_pattern ^ftp: 1440 20% 10080
# refresh_pattern fragment for (/cgi-bin/|\?)
refresh_pattern (/cgi-bin/|\?) -i 0 0% 0
These may be defined as a hash passed to ::squid
YAML example:
squid::refresh_patterns:
'^ftp':
max: 10080
min: 1440
percent: 20
order: '60'
'^gopher':
max: 1440
min: 1440
percent: 0
order: '61'
'(/cgi-bin/|\?)':
case_sensitive: false
max: 0
min: 0
percent: 0
order: '62'
'.':
max: 4320
min: 0
percent: 20
order: '63'
case_sensitive
Boolean value, if true (default) the regex is case sensitive, when false the case insensitive flag '-i' is added to the patterncomment
Comment added before refresh rule, defaults to refresh_pattern fragment fortitle
min
Must be defined, the time (in minutes) an object without an explicit expiry time should be considered fresh.max
Must be defined, the upper limit (in minutes) on how long objects without an explicit expiry time will be considered fresh.percent
Must be defined, is a percentage of the objects age (time since last modification age)options
See squid documentation for available options.order
Each refresh_pattern has an order05
by default this can be specified if order of refresh_pattern definition matters.
Defines snmp_port entries for a squid server.
squid::snmp_port { '1000':
process_number => 3
}
Results in a squid configuration of
if ${process_number} = 3
snmp_port 1000
endif
port
defaults to the namevar and is the port number.options
A string to specify any options for the default. By default and empty string.process_number
If set to and integer the snmp_port is enabled only for a particular squid thread. Defaults to undef.
Defines auth_param entries for a squid server.
squid::auth_param { 'basic auth_param':
scheme => 'basic',
entries => [
'program /usr/lib64/squid/basic_ncsa_auth /etc/squid/.htpasswd',
'children 5',
'realm Squid Basic Authentication',
'credentialsttl 5 hours',
],
}
would result in multi entry squid auth_param
auth_param basic program /usr/lib64/squid/basic_ncsa_auth /etc/squid/.htpasswd
auth_param basic children 5
auth_param basic realm Squid Basic Authentication
auth_param basic credentialsttl 5 hours
These may be defined as a hash passed to ::squid
scheme
the scheme used for authentication must be definedentries
An array of entries, multiple members results in multiple lines in squid.conforder
by default is '40'
Defines ssl_bump entries for a squid server.
squid::ssl_bump { 'all':
action => 'bump',
}
Adds a squid.conf line
ssl_bump bump all
These may be defined as a hash passed to ::squid
value
The type of the ssl_bump, must be defined, e.g bump, peek, ..action
The name of acl, defaults tobump
.order
by default is05
Defines sslproxy_cert_error entries for a squid server.
squid::sslproxy_cert_error { 'all':
action => 'allow',
}
Adds a squid.conf line
sslproxy_cert_error allow all
These may be defined as a hash passed to ::squid
value
defaults to thenamevar
the rule to allow or deny.action
must bedeny
orallow
. By default it is allow. The squid.conf file is ordered so by default all allows appear before all denys. This can be overidden with theorder
parameter.order
by default is05
Squid has a large number of configuration directives. Not all of these have been exposed individually in this module. For those that haven't, the extra_config_section
defined type can be used.
Using a hash of config_entries:
squid::extra_config_section { 'mail settings':
order => '60',
config_entries => {
'mail_from' => 'squid@example.com',
'mail_program' => 'mail',
},
}
Results in a squid configuration of
# mail settings
mail_from squid@example.com
mail_program mail
Using an array of config_entries:
squid::extra_config_section { 'ssl_bump settings':
order => '60',
config_entries => {
'ssl_bump' => ['server-first', 'all'],
'sslcrtd_program' => ['/usr/lib64/squid/ssl_crtd', '-s', '/var/lib/ssl_db', '-M', '4MB'],
'sslcrtd_children' => ['8', 'startup=1', 'idle=1'],
}
}
Results in a squid configuration of
# ssl_bump settings
ssl_bump server-first all
sslcrtd_program /usr/lib64/squid/ssl_crtd -s /var/lib/ssl_db -M 4MB
sslcrtd_children 8 startup=1 idle=1
Using an array of hashes of config_entries:
squid::extra_config_section { 'always_directs':
order => '60',
config_entries => [{
'always_direct' => ['deny www.reallyreallybadplace.com',
'allow my-good-dst',
'allow my-other-good-dst'],
}],
}
Results in a squid configuration of
# always_directs
always_direct deny www.reallyreallybadplace.com
always_direct allow my-good-dst
always_direct allow my-other-good-dst
comment
defaults to the namevar and is used as a section comment insquid.conf
.config_entries
A hash of configuration entries to create in this section. The hash key is the name of the configuration directive. The value is either a string, or an array of strings to use as the configuration directive options.order
by default is '60'. It can be used to configure where insquid.conf
this configuration section should occur.