Puppet Class: go::server

Inherits:
::go::server::params
Defined in:
manifests/server.pp

Overview

Class: go::server

Manages the server component of Thoughtworks Go

Parameters

ensure

Traditional ensurable, supports teardown via absent Valid values: string - present, absent

service_ensure

Manage the state of the go server daemon Valid values: string - running, stopped, unmanaged

service_enable

Manage if go server daemon should start on boot Valid values: boolean

service_refresh

Manage if go server daemon should be restarted automatically on configuration and package changes Valid values: boolean

manage_package_repo

Manage Thoughtworks package repository Valid values: boolean

manage_user

Use user and group definition declared in this module Valid values: boolean

force

On teardown, remove directory trees Valid values: boolean

package_version

Which version of package to install. Defaults to just ‘present’ Valid values: string - package type ensure

lib_directory

Valid values: string - path

log_directory

Valid values: string - path

server_port

Valid values: string - port number

server_ssl_port

Valid values: string - port number

java_home

Valid values: string - path

server_mem

SERVER_MEM setting, leave undef to use default in Go Valid values: string - sizeUNIT (ex 1G)

server_max_mem

SERVER_MAX_MEM setting, leave undef to use default in Go Valid values: string - sizeUNIT (ex 1G)

server_min_perm_gen

SERVER_MIN_PERM_GEN settings, leave undef to use default in Go Valid values: string - sizeUNIT (ex 1G)

server_max_perm_gen

SERVER_MAX_PERM_GEN settings, leave undef to use default in Go Valid values: string - sizeUNIT(ex 1G)

local_auth_enable

Adds local file authentication to cruise-config.xml Note that this does not handle teardown, setting a false value will only NOT manage the augeas resource Valid values: boolean

local_password_file

Manages the content of a password file in Go. Use the define go::server::local_account to manage individual user entries Valid values: undef or absolute path to file

ldap_auth_enable

Adds ldap authentication to cruise-config.xml Valid values: boolean

ldap_uri

If ldap_auth_enable, sets the ldap uri Valid values: string ldap uri

ldap_manager_dn

If ldap_auth_enable, sets the bind dn of the user doing ldap lookups Valid values: string ldap bind dn

ldap_manager_password

If ldap_auth_enable, sets the password of ldap_manager_dn doing ldap lookups Valid values: string cleartext password

ldap_search_filter

If ldap_auth_enable, sets the search filter for ldap when looking up users Valid values: string ldap search filter

ldap_base_dn

If ldap_auth_enable, sets the base dn when lookup up users Valid values: string ldap base dn

install_augeas

Boolean if augeas should be installed when managing one of autoregister, local_auth_enable or ldap_auth_enable. Valid values: boolean

augeas_packages

If install_augeas, provides a list of augeas packages to install Valid values: array string package names

Examples

class { '::go::server':
  ensure              => present,
  manage_package_repo => true,
  manage_user         => true,
  force               => true
}

Parameters:

  • ensure (Any) (defaults to: 'present')
  • service_ensure (Any) (defaults to: 'running')
  • service_enable (Any) (defaults to: true)
  • service_refresh (Any) (defaults to: true)
  • manage_package_repo (Any) (defaults to: false)
  • manage_user (Any) (defaults to: false)
  • force (Any) (defaults to: false)
  • package_version (Any) (defaults to: $::go::server::params::package_version)
  • lib_directory (Any) (defaults to: $::go::server::params::lib_directory)
  • log_directory (Any) (defaults to: $::go::server::params::log_directory)
  • config_directory (Any) (defaults to: $::go::server::params::config_directory)
  • server_port (Any) (defaults to: $::go::server::params::server_port)
  • server_ssl_port (Any) (defaults to: $::go::server::params::server_ssl_port)
  • java_home (Any) (defaults to: $::go::server::params::java_home)
  • server_mem (Any) (defaults to: undef)
  • server_max_mem (Any) (defaults to: undef)
  • server_min_perm_gen (Any) (defaults to: undef)
  • server_max_perm_gen (Any) (defaults to: undef)
  • autoregister (Any) (defaults to: false)
  • autoregister_key (Any) (defaults to: undef)
  • encryption_cipher (Any) (defaults to: undef)
  • local_auth_enable (Any) (defaults to: false)
  • local_password_file (Any) (defaults to: undef)
  • ldap_auth_enable (Any) (defaults to: false)
  • ldap_uri (Any) (defaults to: undef)
  • ldap_manager_dn (Any) (defaults to: undef)
  • ldap_manager_password (Any) (defaults to: undef)
  • ldap_search_filter (Any) (defaults to: '(sAMAccountName={0})')
  • ldap_base_dn (Any) (defaults to: undef)
  • install_augeas (Any) (defaults to: false)
  • augeas_packages (Any) (defaults to: $::go::server::params::augeas_packages) 


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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'manifests/server.pp', line 124

class go::server (
  $ensure               = 'present',
  $service_ensure       = 'running',
  $service_enable       = true,
  $service_refresh      = true,
  $manage_package_repo  = false,
  $manage_user          = false,
  $force                = false,
  $package_version      = $::go::server::params::package_version,
  $lib_directory        = $::go::server::params::lib_directory,
  $log_directory        = $::go::server::params::log_directory,
  $config_directory     = $::go::server::params::config_directory,
  $server_port          = $::go::server::params::server_port,
  $server_ssl_port      = $::go::server::params::server_ssl_port,
  $java_home            = $::go::server::params::java_home,
  $server_mem           = undef,
  $server_max_mem       = undef,
  $server_min_perm_gen  = undef,
  $server_max_perm_gen  = undef,
  $autoregister         = false,
  $autoregister_key     = undef,
  $encryption_cipher    = undef,
  $local_auth_enable    = false,
  $local_password_file  = undef,
  $ldap_auth_enable     = false,
  $ldap_uri             = undef,
  $ldap_manager_dn      = undef,
  $ldap_manager_password = undef,
  $ldap_search_filter   = '(sAMAccountName={0})',
  $ldap_base_dn         = undef,
  $install_augeas       = false,
  $augeas_packages      = $::go::server::params::augeas_packages,
) inherits ::go::server::params {

  # input validation
  validate_re($ensure, ['present', 'absent'], "Invalid ensure value ${ensure}. Valid values: present, absent")
  validate_re($service_ensure, ['running', 'stopped', 'unmanaged'], "Invalid service_ensure value ${service_ensure}. Valid values: running, stopped, unmanaged")
  validate_bool($service_enable)
  validate_bool($manage_package_repo)
  validate_bool($ldap_auth_enable)
  validate_bool($local_auth_enable)

  # input validation optional parameters
  $memory_regex = '[0-9]+[gGmMkK]'
  if $server_mem {
    validate_re($server_mem, $memory_regex, "Invalid server_mem value ${server_mem}. Leave it off or set to ${memory_regex}")
  }
  if $server_max_mem {
    validate_re($server_max_mem, $memory_regex, "Invalid server_max_mem value ${server_max_mem}. Leave it off or set to ${memory_regex}")
  }
  if $server_min_perm_gen {
    validate_re($server_min_perm_gen, $memory_regex, "Invalid server_min_perm_gen value ${server_min_perm_gen}. Leave it off or set to ${memory_regex}")
  }
  if $server_max_perm_gen {
    validate_re($server_max_perm_gen, $memory_regex, "Invalid server_max_perm_gen value ${server_max_perm_gen}. Leave it off or set to ${memory_regex}")
  }
  if $local_auth_enable or $local_password_file {
    validate_absolute_path($local_password_file)
  }
  if $ldap_auth_enable and !$encryption_cipher {
    fail('Must provide encryption_cipher when configuring ldap authentication')
  }

  # module resources
  case $ensure {
    present: {
      anchor { '::go::server::begin': } ->
      class { '::go::server::user': } ->
      class { '::go::server::package': } ->
      class { '::go::server::file': } ->
      class { '::go::server::config': } ->
      class { '::go::server::service': } ->
      anchor { '::go::server::end': }

      if $autoregister or $ldap_auth_enable or $local_auth_enable {
        Class['::go::server::service'] ->
        class { '::go::server::wait_for_service': } ->
        class { '::go::server::config::xml': } ->
        Anchor['::go::server::end']
      }

    }
    absent: {
      anchor { '::go::server::begin': } ->
      class { '::go::server::service': } ->
      class { '::go::server::user': } ->
      class { '::go::server::config': } ->
      class { '::go::server::file': } ->
      class { '::go::server::package': } ->
      anchor { '::go::server::end': }
    }
    default: {}
  }

}