memcached (openstack) is no longer in use
[mirror/dsa-puppet.git] / 3rdparty / modules / memcached / README.md
1 # puppet-memcached [![Build Status](https://secure.travis-ci.org/saz/puppet-memcached.png)](http://travis-ci.org/saz/puppet-memcached)
2
3 Manage memcached via Puppet
4
5 ## Show some love
6 If you find this module useful, send some bitcoins to 1Na3YFUmdxKxJLiuRXQYJU2kiNqA3KY2j9
7
8 ## How to use
9
10 ### Use roughly 90% of memory
11
12 ```ruby
13     class { 'memcached': }
14 ```
15
16 ### Set a fixed memory limit in MB
17
18 ```ruby
19     class { 'memcached':
20       max_memory => 2048
21     }
22 ```
23
24 ### Use 12% of available memory
25
26 ```ruby
27     class { 'memcached':
28       max_memory => '12%'
29     }
30 ```
31
32 ### Other class parameters
33
34 * $package_ensure = 'present'
35 * $logfile = '/var/log/memcached.log'
36 * $pidfile = '/var/run/memcached.pid' (Debian family only, set to false to disable pidfile)
37 * $max_memory = false
38 * $item_size = false
39 * $lock_memory = false (WARNING: good if used intelligently, google for -k key)
40 * $listen_ip = '0.0.0.0'
41 * $tcp_port = 11211
42 * $udp_port = 11211
43 * $manage_firewall = false
44 * $user = '' (OS specific setting, see params.pp)
45 * $max_connections = 8192
46 * $verbosity = undef
47 * $unix_socket = undef
48 * $install_dev = false (TRUE if 'libmemcached-dev' package should be installed)
49 * $processorcount = $::processorcount
50 * $service_restart = true (restart service after configuration changes, false to prevent restarts)
51 * $use_sasl = false (start memcached with SASL support)
52 * $large_mem_pages = false (try to use large memory pages)