Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up docs #62

Merged
merged 4 commits into from
Oct 9, 2017
Merged

Clean up docs #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
74f80a2
(docs) Make examples comply with style guide
alex-harvey-z3q Oct 5, 2017
946e25c
(maint) Add a better example and tests
alex-harvey-z3q Oct 5, 2017
1517279
(maint) Use forge_modules in .fixtures.yml
alex-harvey-z3q Oct 5, 2017
a752679
(docs) Also add hash of arrays example
alex-harvey-z3q Oct 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .fixtures.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
fixtures:
repositories:
concat: 'https://github.com/puppetlabs/puppetlabs-concat'
stdlib: 'https://github.com/puppetlabs/puppetlabs-stdlib'
forge_modules:
concat: puppetlabs-concat
stdlib: puppetlabs-stdlib
symlinks:
"squid": "#{source_dir}"
130 changes: 74 additions & 56 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ The set up a simple squid server with a cache to forward
http port 80 requests.

```puppet
class{'::squid':}
squid::acl{'Safe_ports':
class { 'squid': }
squid::acl { 'Safe_ports':
type => port,
entries => ['80'],
}
squid::http_access{'Safe_ports':
squid::http_access { 'Safe_ports':
action => allow,
}
squid::http_access{'!Safe_ports':
squid::http_access{ '!Safe_ports':
action => deny,
}
```
Expand Down Expand Up @@ -65,28 +65,28 @@ Parameters to the squid class almost map 1 to 1 to squid.conf parameters themsel
* `extra_config_sections` defaults to empty hash. If you pass in a hash of `extra_config_section` resources, they will be defined automatically.

```puppet
class{'::squid':
class { 'squid':
cache_mem => '512 MB',
workers => 3,
coredump_dir => '/var/spool/squid',
}
```

```puppet
class{'::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'],
},
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, }},
cache_dirs => { '/data/' => { type => 'ufs', options => '15000 32 256 min-size=32769', process_number => 2 }},
}
```

Expand All @@ -96,11 +96,10 @@ The acls, http_access, http_ports, snmp_port, cache_dirs lines above are equival
Defines [acl entries](http://www.squid-cache.org/Doc/config/acl/) for a squid server.

```puppet
squid::acl{'remote_urls':
squid::acl { 'remote_urls':
type => 'url_regex',
entries => ['http://example.org/path',
'http://example.com/anotherpath'],

}
```

Expand All @@ -119,12 +118,11 @@ These may be defined as a hash passed to ::squid
* `entries` An array of acl entries, multiple members results in multiple lines in squid.conf.
* `order` Each ACL has an order `05` by default this can be specified if order of ACL definition matters.


### Defined Type squid::cache\_dir
Defines [cache_dir entries](http://www.squid-cache.org/Doc/config/cache_dir/) for a squid server.

```puppet
squid::cache_dir{'/data':
squid::cache_dir { '/data':
type => 'ufs',
options => '15000 32 256 min-size=32769',
process_number => 2,
Expand All @@ -147,13 +145,11 @@ endif
in a `if $proceess_number` statement so the cache will be used by only
one process. Default is undef.



### Defined Type squid::http\_access
Defines [http_access entries](http://www.squid-cache.org/Doc/config/http_access/) for a squid server.

```puppet
squid::http_access{'our_networks hosts':
squid::http_access { 'our_networks hosts':
action => 'allow',
}
```
Expand All @@ -166,7 +162,7 @@ http_access allow our_networks hosts
```

```puppet
squid::http_access{'our_networks hosts':
squid::http_access { 'our_networks hosts':
action => 'allow',
comment => 'Our networks hosts are allowed',
}
Expand All @@ -185,7 +181,7 @@ These may be defined as a hash passed to ::squid
Defines [icp_access entries](http://www.squid-cache.org/Doc/config/icp_access/) for a squid server.

```puppet
squid::icp_access{'our_networks hosts':
squid::icp_access { 'our_networks hosts':
action => 'allow',
}
```
Expand All @@ -209,10 +205,10 @@ Defines [http_port entries](http://www.squid-cache.org/Doc/config/http_port/) fo
By setting optional `ssl` parameter to `true` will create [https_port entries](http://www.squid-cache.org/Doc/config/https_port/) instead.

```puppet
squid::http_port{'10000':
squid::http_port { '10000':
options => 'accel vhost'
}
squid::http_port{'10001':
squid::http_port { '10001':
ssl => true,
options => 'cert=/etc/squid/ssl_cert/server.cert key=/etc/squid/ssl_cert/server.key'
}
Expand All @@ -238,24 +234,23 @@ As an alternative to using the Squid::Http\_port defined type with `ssl` set to
* `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.


### Defined Type squid::refresh_pattern
Defines [refresh_pattern entries](http://www.squid-cache.org/Doc/config/refresh_pattern/) for a squid server.

```puppet
squid::refresh_pattern{'^ftp':
min => 1440,
max => 10080,
percent => 20,
order => 60,
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,
squid::refresh_pattern { '(/cgi-bin/|\?)':
case_sensitive => falke,
min => 0,
max => 0,
percent => 0,
order => 61,
}
```

Expand Down Expand Up @@ -305,12 +300,11 @@ squid::refresh_patterns:
* `options` See squid documentation for available options.
* `order` Each refresh_pattern has an order `05` by default this can be specified if order of refresh_pattern definition matters.


### Defined Type Squid::Snmp\_port
Defines [snmp_port entries](http://www.squid-cache.org/Doc/config/snmp_port/) for a squid server.

```puppet
squid::snmp_port{'1000':
squid::snmp_port { '1000':
process_number => 3
}
```
Expand All @@ -333,12 +327,14 @@ endif
Defines [auth_param entries](http://www.squid-cache.org/Doc/config/auth_param/) for a squid server.

```puppet
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'],
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',
],
}
```

Expand All @@ -362,7 +358,7 @@ These may be defined as a hash passed to ::squid
Defines [ssl_bump entries](http://www.squid-cache.org/Doc/config/ssl_bump/) for a squid server.

```puppet
squid::ssl_bump{'all':
squid::ssl_bump { 'all':
action => 'bump',
}
```
Expand All @@ -384,7 +380,7 @@ These may be defined as a hash passed to ::squid
Defines [sslproxy_cert_error entries](http://www.squid-cache.org/Doc/config/sslproxy_cert_error/) for a squid server.

```puppet
squid::sslproxy_cert_error{'all':
squid::sslproxy_cert_error { 'all':
action => 'allow',
}
```
Expand All @@ -406,8 +402,10 @@ These may be defined as a hash passed to ::squid
### Defined Type squid::extra\_config\_section
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:

```puppet
squid::extra_config_section {'mail settings':
squid::extra_config_section { 'mail settings':
order => '60',
config_entries => {
'mail_from' => '[email protected]',
Expand All @@ -424,28 +422,48 @@ mail_from [email protected]
mail_program mail
```

And using an array:
Using an array of config_entries:

```puppet
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:

```puppet
squid::extra_config_section { 'refresh patterns':
squid::extra_config_section { 'always_directs':
order => '60',
config_entries => [{
'refresh_pattern' => ['^ftp: 1440 20% 10080',
'^gopher: 1440 0% 1440',
'-i (/cgi-bin/|\?) 0 0% 0',
'. 0 20% 4320'],
'always_direct' => ['deny www.reallyreallybadplace.com',
'allow my-good-dst',
'allow my-other-good-dst'],
}],
}
```

Results in a squid configuration of

```
# refresh_patterns
refresh_pattern ^ftp: 1440 20% 10080
refresh_pattern ^gopher: 1440 0% 1440
refresh_pattern -i (/cgi-bin/|\?) 0 0% 0
refresh_pattern . 0 20% 4320
# always_directs
always_direct deny www.reallyreallybadplace.com
always_direct allow my-good-dst
always_direct allow my-other-good-dst
```

#### Parameters for Type squid::extra\_config\_section
Expand Down
42 changes: 35 additions & 7 deletions spec/defines/extra_config_section_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,14 @@
let(:facts) do
facts
end
let :pre_condition do
let(:pre_condition) do
' class{"::squid":
config => "/tmp/squid.conf"
}
'
end
let(:title) { 'my config section' }

expected_config_section = %(# my config section\n)
expected_config_section += %(ssl_bump server-first all\n)
expected_config_section += %(sslcrtd_program /usr/lib64/squid/ssl_crtd -s /var/lib/ssl_db -M 4MB\n)
expected_config_section += %(sslcrtd_children 8 startup=1 idle=1\n)
expected_config_section += %(\n)

context 'when config entry parameters are strings' do
let(:params) do
{
Expand All @@ -31,6 +25,12 @@
}
end

expected_config_section = %(# my config section\n)
expected_config_section += %(ssl_bump server-first all\n)
expected_config_section += %(sslcrtd_program /usr/lib64/squid/ssl_crtd -s /var/lib/ssl_db -M 4MB\n)
expected_config_section += %(sslcrtd_children 8 startup=1 idle=1\n)
expected_config_section += %(\n)

it { is_expected.to contain_concat_fragment('squid_extra_config_section_my config section').with_target('/tmp/squid.conf') }
it { is_expected.to contain_concat_fragment('squid_extra_config_section_my config section').with_order('60-my config section') }
it 'config section' do
Expand All @@ -49,6 +49,34 @@
}
end

expected_config_section = %(# my config section\n)
expected_config_section += %(ssl_bump server-first all\n)
expected_config_section += %(sslcrtd_program /usr/lib64/squid/ssl_crtd -s /var/lib/ssl_db -M 4MB\n)
expected_config_section += %(sslcrtd_children 8 startup=1 idle=1\n)
expected_config_section += %(\n)

it 'config section' do
content = catalogue.resource('concat_fragment', 'squid_extra_config_section_my config section').send(:parameters)[:content]
expect(content).to match(expected_config_section)
end
end
context 'when config entry parameters are arrays of hashes' do
let(:params) do
{
config_entries: [{
'always_direct' => ['deny www.reallyreallybadplace.com',
'allow my-good-dst',
'allow my-other-good-dst']
}]
}
end

expected_config_section = %(# my config section\n)
expected_config_section += %(always_direct deny www.reallyreallybadplace.com\n)
expected_config_section += %(always_direct allow my-good-dst\n)
expected_config_section += %(always_direct allow my-other-good-dst\n)
expected_config_section += %(\n)

it 'config section' do
content = catalogue.resource('concat_fragment', 'squid_extra_config_section_my config section').send(:parameters)[:content]
expect(content).to match(expected_config_section)
Expand Down