Skip to content

Commit a0cfb7b

Browse files
authored
improve documentation, add REFERENCE.md (#178)
1 parent d6ddc69 commit a0cfb7b

File tree

4 files changed

+677
-42
lines changed

4 files changed

+677
-42
lines changed

README.md

+1-33
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# memached module for Puppet
1+
# memcached module for Puppet
22

33
[![Build Status](https://github.com/saz/puppet-memcached/workflows/CI/badge.svg)](https://github.com/saz/puppet-memcached/actions?query=workflow%3ACI)
44

@@ -103,35 +103,3 @@ memcached::instance{'11222':
103103
override_source => "${module_name}/memcached_11222_override.conf\n",
104104
}
105105
```
106-
107-
### Other class parameters
108-
109-
* $package_ensure = 'present'
110-
* $logfile = '/var/log/memcached.log'
111-
* $logstdout = false (Set this to true to disable logging to a file/syslog entirely, useful when memcached runs in containers)
112-
* $pidfile = '/var/run/memcached.pid' (Debian family only, set to false to disable pidfile)
113-
* $max_memory = false
114-
* $max_item_size = false
115-
* $min_item_size = false
116-
* $factor = false
117-
* $lock_memory = false (WARNING: good if used intelligently, google for -k key)
118-
* $listen = '127.0.0.1' (if TLS/SSL is enabled, 'notls' prefix can be used to disable for specific listeners "notls:<ip>:<port>")
119-
* $listen_ip = '127.0.0.1' (deprecated, listen will take precedence over this)
120-
* $tcp_port = 11211
121-
* $udp_port = 0
122-
* $manage_firewall = false
123-
* $user = '' (OS specific setting, see params.pp)
124-
* $max_connections = 8192
125-
* $verbosity = undef
126-
* $unix_socket = undef
127-
* $install_dev = false (TRUE if 'libmemcached-dev' package should be installed)
128-
* $processorcount = $::processorcount
129-
* $service_restart = true (restart service after configuration changes, false to prevent restarts)
130-
* $service_flags = '-l 127.0.0.1 -u _memcached -P /var/run/memcached.pid' (only relevant for OpenBSD, to configure the service)
131-
* $use_sasl = false (start memcached with SASL support)
132-
* $use_tls = false (start memcached with TLS support)
133-
* $tls_cert_chain = undef
134-
* $tls_key = undef
135-
* $tls_ca_cert = undef
136-
* $tls_verify_mode = 1 (0: None, 1: Request, 2: Require, 3: Once)
137-
* $large_mem_pages = false (try to use large memory pages)

0 commit comments

Comments
 (0)