Puppet Class: memcached

Inherits:
memcached::params
Defined in:
manifests/init.pp

Overview

Class: memcached

Manage memcached

Parameters

* syslog *

Boolean. If true will pipe output to /bin/logger, sends to syslog.

Parameters:

  • package_ensure (Enum['present', 'latest', 'absent']) (defaults to: 'present')
  • service_manage (Boolean) (defaults to: true)
  • logfile (Optional[Stdlib::Absolutepath]) (defaults to: $memcached::params::logfile)
  • logstdout (Boolean) (defaults to: false)
  • syslog (Boolean) (defaults to: false)
  • pidfile (Variant[Stdlib::Absolutepath, Undef]) (defaults to: '/var/run/memcached.pid')
  • manage_firewall (Boolean) (defaults to: false)
  • max_memory (Any) (defaults to: '95%')
  • max_item_size (Optional[Variant[Integer, String]]) (defaults to: undef)
  • min_item_size (Optional[Variant[Integer, String]]) (defaults to: undef)
  • factor (Optional[Variant[Integer, String]]) (defaults to: undef)
  • lock_memory (Boolean) (defaults to: false)
  • listen (Optional[Variant[String,Array[String]]]) (defaults to: undef)
  • listen_ip (Optional[Variant[Stdlib::Ip::Address,Array[Stdlib::Ip::Address]]]) (defaults to: undef)
  • tcp_port (Integer) (defaults to: 11211)
  • udp_port (Integer) (defaults to: 0)
  • user (String) (defaults to: $memcached::params::user)
  • max_connections (Integer) (defaults to: 8192)
  • verbosity (Optional[String]) (defaults to: undef)
  • unix_socket (Optional[String]) (defaults to: undef)
  • unix_socket_mask (String) (defaults to: '0755')
  • install_dev (Boolean) (defaults to: false)
  • processorcount (Variant[String,Integer]) (defaults to: $facts['processors']['count'])
  • service_restart (Boolean) (defaults to: true)
  • auto_removal (Boolean) (defaults to: false)
  • use_sasl (Boolean) (defaults to: false)
  • use_tls (Boolean) (defaults to: false)
  • tls_cert_chain (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • tls_key (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • tls_ca_cert (Optional[Stdlib::Absolutepath]) (defaults to: undef)
  • tls_verify_mode (Integer) (defaults to: 1)
  • use_registry (Boolean) (defaults to: $memcached::params::use_registry)
  • registry_key (String) (defaults to: 'HKLM\System\CurrentControlSet\services\memcached\ImagePath')
  • large_mem_pages (Boolean) (defaults to: false)
  • use_svcprop (Boolean) (defaults to: $memcached::params::use_svcprop)
  • svcprop_fmri (String) (defaults to: 'memcached:default')
  • svcprop_key (String) (defaults to: 'memcached/options')
  • extended_opts (Optional[Array[String]]) (defaults to: undef)
  • config_tmpl (String) (defaults to: $memcached::params::config_tmpl)
  • disable_cachedump (Boolean) (defaults to: false) 


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'manifests/init.pp', line 10

class memcached (
  Enum['present', 'latest', 'absent'] $package_ensure                                        = 'present',
  Boolean $service_manage                                                                    = true,
  Optional[Stdlib::Absolutepath] $logfile                                                    = $memcached::params::logfile,
  Boolean $logstdout                                                                         = false,
  Boolean $syslog                                                                            = false,
  Variant[Stdlib::Absolutepath, Undef] $pidfile                                              = '/var/run/memcached.pid',
  Boolean $manage_firewall                                                                   = false,
  $max_memory                                                                                = '95%',
  Optional[Variant[Integer, String]] $max_item_size                                          = undef,
  Optional[Variant[Integer, String]] $min_item_size                                          = undef,
  Optional[Variant[Integer, String]] $factor                                                 = undef,
  Boolean $lock_memory                                                                       = false,
  Optional[Variant[String,Array[String]]] $listen                                            = undef,
  Optional[Variant[Stdlib::Ip::Address,Array[Stdlib::Ip::Address]]] $listen_ip               = undef,
  Integer $tcp_port                                                                          = 11211,
  Integer $udp_port                                                                          = 0,
  String $user                                                                               = $memcached::params::user,
  Integer $max_connections                                                                   = 8192,
  Optional[String] $verbosity                                                                = undef,
  Optional[String] $unix_socket                                                              = undef,
  String $unix_socket_mask                                                                   = '0755',
  Boolean $install_dev                                                                       = false,
  Variant[String,Integer] $processorcount                                                    = $facts['processors']['count'],
  Boolean $service_restart                                                                   = true,
  Boolean $auto_removal                                                                      = false,
  Boolean $use_sasl                                                                          = false,
  Boolean $use_tls                                                                           = false,
  Optional[Stdlib::Absolutepath] $tls_cert_chain                                             = undef,
  Optional[Stdlib::Absolutepath] $tls_key                                                    = undef,
  Optional[Stdlib::Absolutepath] $tls_ca_cert                                                = undef,
  Integer $tls_verify_mode                                                                   = 1,
  Boolean $use_registry                                                                      = $memcached::params::use_registry,
  String $registry_key                                                                       = 'HKLM\System\CurrentControlSet\services\memcached\ImagePath',
  Boolean $large_mem_pages                                                                   = false,
  Boolean $use_svcprop                                                                       = $memcached::params::use_svcprop,
  String $svcprop_fmri                                                                       = 'memcached:default',
  String $svcprop_key                                                                        = 'memcached/options',
  Optional[Array[String]] $extended_opts                                                     = undef,
  String $config_tmpl                                                                        = $memcached::params::config_tmpl,
  Boolean $disable_cachedump                                                                 = false,
) inherits memcached::params {
  # Logging to syslog and file are mutually exclusive
  # Fail if both options are defined
  if $syslog and str2bool($logfile) {
    fail 'Define either syslog or logfile as logging destinations but not both.'
  }

  if $use_tls {
    if $tls_cert_chain == undef or $tls_key == undef {
      fail 'tls_cert_chain and tls_key should be set when use_tls is true.'
    }
  }

  if $package_ensure == 'absent' {
    $service_ensure = 'stopped'
    $service_enable = false
  } else {
    $service_ensure = 'running'
    $service_enable = true
  }

  if ! $listen and ! $listen_ip {
    # if both are not set, we're setting $real_listen to 127.0.0.1
    $real_listen = ['127.0.0.1']
  } else {
    if $listen {
      # Handle if $listen is not an array
      $real_listen = [$listen]
    } else {
      warning('memcached::listen_ip is deprecated in favor of memcached::listen')
      # Handle if $listen_ip is not an array
      $real_listen = [$listen_ip]
    }
  }

  package { $memcached::params::package_name:
    ensure   => $package_ensure,
    provider => $memcached::params::package_provider,
  }

  if $install_dev {
    package { $memcached::params::dev_package_name:
      ensure  => $package_ensure,
      require => Package[$memcached::params::package_name],
    }
  }

  if $manage_firewall {
    firewall { "100_tcp_${tcp_port}_for_memcached":
      dport  => $tcp_port,
      proto  => 'tcp',
      action => 'accept',
    }

    if $udp_port != 0 {
      firewall { "100_udp_${udp_port}_for_memcached":
        dport  => $udp_port,
        proto  => 'udp',
        action => 'accept',
      }
    }
  }

  if $service_restart and $service_manage {
    $service_notify_real = Service[$memcached::params::service_name]
  } else {
    $service_notify_real = undef
  }

  if ( $memcached::params::config_file ) {
    file { $memcached::params::config_file:
      ensure  => 'file',
      owner   => 'root',
      group   => 0,
      mode    => '0644',
      content => template($config_tmpl),
      require => Package[$memcached::params::package_name],
      notify  => $service_notify_real,
    }
  }

  if $logfile and !$syslog {
    file { $logfile:
      ensure  => 'file',
      owner   => $user,
      group   => 0,
      mode    => '0640',
      require => Package[$memcached::params::package_name],
      notify  => $service_notify_real,
    }
  }

  if $service_manage {
    service { $memcached::params::service_name:
      ensure     => $service_ensure,
      enable     => $service_enable,
      hasrestart => true,
      hasstatus  => $memcached::params::service_hasstatus,
    }
  }

  if $use_registry {
    registry_value { $registry_key:
      ensure => 'present',
      type   => 'string',
      data   => template($config_tmpl),
      notify => $service_notify_real,
    }
  }

  if $use_svcprop {
    svcprop { $svcprop_key:
      fmri     => $svcprop_fmri,
      property => $svcprop_key,
      value    => template($memcached::params::config_tmpl),
      notify   => $service_notify_real,
    }
  }
}