Puppet Class: puppet::server::puppetserver

Defined in:
manifests/server/puppetserver.pp

Overview

Configures the puppetserver jvm configuration file using augeas.

Examples:


# configure memory for java < 8
class {'::puppet::server::puppetserver':
  jvm_min_heap_size => '1G',
  jvm_max_heap_size => '3G',
  jvm_extra_args    => '-XX:MaxPermSize=256m',
}

Parameters:

  • java_bin (String) (defaults to: $puppet::server::jvm_java_bin) —

    Path to the java executable to use

  • config (String) (defaults to: $puppet::server::jvm_config) —

    Path to the jvm configuration file. This file is usually either /etc/default/puppetserver or /etc/sysconfig/puppetserver depending on your *nix flavor.

  • jvm_min_heap_size (Pattern[/^[0-9]+[kKmMgG]$/]) (defaults to: $puppet::server::jvm_min_heap_size) —

    Translates into the -Xms option and is added to the JAVA_ARGS

  • jvm_max_heap_size (Pattern[/^[0-9]+[kKmMgG]$/]) (defaults to: $puppet::server::jvm_max_heap_size) —

    Translates into the -Xmx option and is added to the JAVA_ARGS

  • jvm_extra_args (Variant[String, Array[String]]) (defaults to: $puppet::server::real_jvm_extra_args) —

    Custom options to pass through to the java binary. These get added to the end of the JAVA_ARGS variable

  • jvm_cli_args (Optional[String]) (defaults to: $puppet::server::jvm_cli_args) —

    Custom options to pass through to the java binary when using a puppetserver subcommand, (eg puppetserver gem). These get used in the JAVA_ARGS_CLI variable.

  • server_puppetserver_dir (Stdlib::Absolutepath) (defaults to: $puppet::server::puppetserver_dir) —

    Puppetserver config directory

  • server_puppetserver_vardir (Stdlib::Absolutepath) (defaults to: $puppet::server::puppetserver_vardir) —

    Puppetserver var directory

  • server_jruby_gem_home (Optional[Stdlib::Absolutepath]) (defaults to: $puppet::server::jruby_gem_home) —

    Puppetserver jruby gemhome

  • server_environment_vars (Hash[String, String]) (defaults to: $puppet::server::server_environment_vars) —

    Puppetserver hash of environment vars

  • server_cipher_suites (Array[String]) (defaults to: $puppet::server::cipher_suites) —

    Puppetserver array of acceptable ciphers

  • server_ssl_protocols (Array[String]) (defaults to: $puppet::server::ssl_protocols) —

    Puppetserver array of acceptable ssl protocols

  • server_max_active_instances (Integer[1]) (defaults to: $puppet::server::max_active_instances) —

    Puppetserver number of max jruby instances

  • server_max_requests_per_instance (Integer[0]) (defaults to: $puppet::server::max_requests_per_instance) —

    Puppetserver number of max requests per jruby instance

  • server_max_queued_requests (Integer[0]) (defaults to: $puppet::server::max_queued_requests) —

    The maximum number of requests that may be queued waiting to borrow a JRuby from the pool.

  • server_max_retry_delay (Integer[0]) (defaults to: $puppet::server::max_retry_delay) —

    Sets the upper limit for the random sleep set as a Retry-After header on 503 responses returned when max-queued-requests is enabled.

  • server_multithreaded (Boolean) (defaults to: $puppet::server::multithreaded) —

    Configures the puppetserver to use multithreaded jruby.

  • disable_fips (Boolean) (defaults to: $facts['os']['family'] == 'RedHat' and $facts['os']['release']['major'] == '8') —

    Disables FIPS support within the JVM

  • server_puppetserver_rundir (Optional[Stdlib::Absolutepath]) (defaults to: $puppet::server::puppetserver_rundir)
  • server_puppetserver_logdir (Optional[Stdlib::Absolutepath]) (defaults to: $puppet::server::puppetserver_logdir)
  • server_ruby_load_paths (Array[String]) (defaults to: $puppet::server::ruby_load_paths)
  • server_ssl_ca_crl (Stdlib::Absolutepath) (defaults to: $puppet::server::ssl_ca_crl)
  • server_ssl_ca_cert (Stdlib::Absolutepath) (defaults to: $puppet::server::ssl_ca_cert)
  • server_ssl_cert (Stdlib::Absolutepath) (defaults to: $puppet::server::ssl_cert)
  • server_ssl_cert_key (Stdlib::Absolutepath) (defaults to: $puppet::server::ssl_cert_key)
  • server_ssl_chain (Variant[Boolean, Stdlib::Absolutepath]) (defaults to: $puppet::server::ssl_chain)
  • server_crl_enable (Boolean) (defaults to: $puppet::server::crl_enable_real)
  • server_ip (String) (defaults to: $puppet::server::ip)
  • server_port (Stdlib::Port) (defaults to: $puppet::server::port)
  • server_http (Boolean) (defaults to: $puppet::server::http)
  • server_http_port (Stdlib::Port) (defaults to: $puppet::server::http_port)
  • server_ca (Boolean) (defaults to: $puppet::server::ca)
  • server_dir (String) (defaults to: $puppet::server::dir)
  • codedir (Stdlib::Absolutepath) (defaults to: $puppet::server::codedir)
  • server_idle_timeout (Integer[0]) (defaults to: $puppet::server::idle_timeout)
  • server_web_idle_timeout (Integer[0]) (defaults to: $puppet::server::web_idle_timeout)
  • server_connect_timeout (Integer[0]) (defaults to: $puppet::server::connect_timeout)
  • server_ca_auth_required (Boolean) (defaults to: $puppet::server::ca_auth_required)
  • server_ca_client_self_delete (Boolean) (defaults to: $puppet::server::ca_client_self_delete)
  • server_ca_client_allowlist (Array[String]) (defaults to: $puppet::server::ca_client_allowlist)
  • server_admin_api_allowlist (Array[String]) (defaults to: $puppet::server::admin_api_allowlist)
  • server_check_for_updates (Boolean) (defaults to: $puppet::server::check_for_updates)
  • server_environment_class_cache_enabled (Boolean) (defaults to: $puppet::server::environment_class_cache_enabled)
  • server_metrics (Optional[Boolean]) (defaults to: $puppet::server::puppetserver_metrics)
  • server_profiler (Boolean) (defaults to: $puppet::server::puppetserver_profiler)
  • server_telemetry (Boolean) (defaults to: pick($puppet::server::puppetserver_telemetry, false))
  • metrics_jmx_enable (Boolean) (defaults to: $puppet::server::metrics_jmx_enable)
  • metrics_graphite_enable (Boolean) (defaults to: $puppet::server::metrics_graphite_enable)
  • metrics_graphite_host (String) (defaults to: $puppet::server::metrics_graphite_host)
  • metrics_graphite_port (Stdlib::Port) (defaults to: $puppet::server::metrics_graphite_port)
  • metrics_server_id (String) (defaults to: $puppet::server::metrics_server_id)
  • metrics_graphite_interval (Integer) (defaults to: $puppet::server::metrics_graphite_interval)
  • metrics_allowed (Optional[Array]) (defaults to: $puppet::server::metrics_allowed)
  • server_experimental (Boolean) (defaults to: $puppet::server::puppetserver_experimental)
  • server_auth_template (Optional[String[1]]) (defaults to: $puppet::server::puppetserver_auth_template)
  • server_trusted_agents (Array[String]) (defaults to: $puppet::server::puppetserver_trusted_agents)
  • server_trusted_certificate_extensions (Array[Hash]) (defaults to: $puppet::server::puppetserver_trusted_certificate_extensions)
  • allow_header_cert_info (Boolean) (defaults to: $puppet::server::allow_header_cert_info)
  • compile_mode (Optional[Enum['off', 'jit', 'force']]) (defaults to: $puppet::server::compile_mode)
  • acceptor_threads (Optional[Integer[1]]) (defaults to: $puppet::server::acceptor_threads)
  • selector_threads (Optional[Integer[1]]) (defaults to: $puppet::server::selector_threads)
  • ssl_acceptor_threads (Optional[Integer[1]]) (defaults to: $puppet::server::ssl_acceptor_threads)
  • ssl_selector_threads (Optional[Integer[1]]) (defaults to: $puppet::server::ssl_selector_threads)
  • max_threads (Optional[Integer[1]]) (defaults to: $puppet::server::max_threads)
  • ca_allow_sans (Boolean) (defaults to: $puppet::server::ca_allow_sans)
  • ca_allow_auth_extensions (Boolean) (defaults to: $puppet::server::ca_allow_auth_extensions)
  • ca_enable_infra_crl (Boolean) (defaults to: $puppet::server::ca_enable_infra_crl)
  • max_open_files (Optional[Integer[1]]) (defaults to: $puppet::server::max_open_files)
  • versioned_code_id (Optional[Stdlib::Absolutepath]) (defaults to: $puppet::server::versioned_code_id)
  • versioned_code_content (Optional[Stdlib::Absolutepath]) (defaults to: $puppet::server::versioned_code_content)
  • jolokia_metrics_allowlist (Array[String[1]]) (defaults to: $puppet::server::jolokia_metrics_allowlist) 


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
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'manifests/server/puppetserver.pp', line 75

class puppet::server::puppetserver (
  String $config = $puppet::server::jvm_config,
  String $java_bin = $puppet::server::jvm_java_bin,
  Variant[String, Array[String]] $jvm_extra_args = $puppet::server::real_jvm_extra_args,
  Optional[String] $jvm_cli_args = $puppet::server::jvm_cli_args,
  Pattern[/^[0-9]+[kKmMgG]$/] $jvm_min_heap_size = $puppet::server::jvm_min_heap_size,
  Pattern[/^[0-9]+[kKmMgG]$/] $jvm_max_heap_size = $puppet::server::jvm_max_heap_size,
  Stdlib::Absolutepath $server_puppetserver_dir = $puppet::server::puppetserver_dir,
  Stdlib::Absolutepath $server_puppetserver_vardir = $puppet::server::puppetserver_vardir,
  Optional[Stdlib::Absolutepath] $server_puppetserver_rundir = $puppet::server::puppetserver_rundir,
  Optional[Stdlib::Absolutepath] $server_puppetserver_logdir = $puppet::server::puppetserver_logdir,
  Optional[Stdlib::Absolutepath] $server_jruby_gem_home = $puppet::server::jruby_gem_home,
  Hash[String, String] $server_environment_vars = $puppet::server::server_environment_vars,
  Array[String] $server_ruby_load_paths = $puppet::server::ruby_load_paths,
  Array[String] $server_cipher_suites = $puppet::server::cipher_suites,
  Integer[1] $server_max_active_instances = $puppet::server::max_active_instances,
  Integer[0] $server_max_requests_per_instance = $puppet::server::max_requests_per_instance,
  Integer[0] $server_max_queued_requests = $puppet::server::max_queued_requests,
  Integer[0] $server_max_retry_delay = $puppet::server::max_retry_delay,
  Boolean $server_multithreaded = $puppet::server::multithreaded,
  Array[String] $server_ssl_protocols = $puppet::server::ssl_protocols,
  Stdlib::Absolutepath $server_ssl_ca_crl = $puppet::server::ssl_ca_crl,
  Stdlib::Absolutepath $server_ssl_ca_cert = $puppet::server::ssl_ca_cert,
  Stdlib::Absolutepath $server_ssl_cert = $puppet::server::ssl_cert,
  Stdlib::Absolutepath $server_ssl_cert_key = $puppet::server::ssl_cert_key,
  Variant[Boolean, Stdlib::Absolutepath] $server_ssl_chain = $puppet::server::ssl_chain,
  Boolean $server_crl_enable = $puppet::server::crl_enable_real,
  String $server_ip = $puppet::server::ip,
  Stdlib::Port $server_port = $puppet::server::port,
  Boolean $server_http = $puppet::server::http,
  Stdlib::Port $server_http_port = $puppet::server::http_port,
  Boolean $server_ca = $puppet::server::ca,
  String $server_dir = $puppet::server::dir,
  Stdlib::Absolutepath $codedir = $puppet::server::codedir,
  Integer[0] $server_idle_timeout = $puppet::server::idle_timeout,
  Integer[0] $server_web_idle_timeout = $puppet::server::web_idle_timeout,
  Integer[0] $server_connect_timeout = $puppet::server::connect_timeout,
  Boolean $server_ca_auth_required = $puppet::server::ca_auth_required,
  Boolean $server_ca_client_self_delete = $puppet::server::ca_client_self_delete,
  Array[String] $server_ca_client_allowlist = $puppet::server::ca_client_allowlist,
  Array[String] $server_admin_api_allowlist = $puppet::server::admin_api_allowlist,
  Boolean $server_check_for_updates = $puppet::server::check_for_updates,
  Boolean $server_environment_class_cache_enabled = $puppet::server::environment_class_cache_enabled,
  Optional[Boolean] $server_metrics = $puppet::server::puppetserver_metrics,
  Boolean $server_profiler = $puppet::server::puppetserver_profiler,
  Boolean $server_telemetry = pick($puppet::server::puppetserver_telemetry, false),
  Boolean $metrics_jmx_enable = $puppet::server::metrics_jmx_enable,
  Boolean $metrics_graphite_enable = $puppet::server::metrics_graphite_enable,
  String $metrics_graphite_host = $puppet::server::metrics_graphite_host,
  Stdlib::Port $metrics_graphite_port = $puppet::server::metrics_graphite_port,
  String $metrics_server_id = $puppet::server::metrics_server_id,
  Integer $metrics_graphite_interval = $puppet::server::metrics_graphite_interval,
  Optional[Array] $metrics_allowed = $puppet::server::metrics_allowed,
  Boolean $server_experimental = $puppet::server::puppetserver_experimental,
  Optional[String[1]] $server_auth_template = $puppet::server::puppetserver_auth_template,
  Array[String] $server_trusted_agents = $puppet::server::puppetserver_trusted_agents,
  Array[Hash] $server_trusted_certificate_extensions = $puppet::server::puppetserver_trusted_certificate_extensions,
  Boolean $allow_header_cert_info = $puppet::server::allow_header_cert_info,
  Optional[Enum['off', 'jit', 'force']] $compile_mode = $puppet::server::compile_mode,
  Optional[Integer[1]] $acceptor_threads = $puppet::server::acceptor_threads,
  Optional[Integer[1]] $selector_threads = $puppet::server::selector_threads,
  Optional[Integer[1]] $ssl_acceptor_threads = $puppet::server::ssl_acceptor_threads,
  Optional[Integer[1]] $ssl_selector_threads = $puppet::server::ssl_selector_threads,
  Optional[Integer[1]] $max_threads = $puppet::server::max_threads,
  Boolean $ca_allow_sans = $puppet::server::ca_allow_sans,
  Boolean $ca_allow_auth_extensions = $puppet::server::ca_allow_auth_extensions,
  Boolean $ca_enable_infra_crl = $puppet::server::ca_enable_infra_crl,
  Optional[Integer[1]] $max_open_files = $puppet::server::max_open_files,
  Optional[Stdlib::Absolutepath] $versioned_code_id = $puppet::server::versioned_code_id,
  Optional[Stdlib::Absolutepath] $versioned_code_content = $puppet::server::versioned_code_content,
  Boolean $disable_fips = $facts['os']['family'] == 'RedHat' and $facts['os']['release']['major'] == '8',
  Array[String[1]] $jolokia_metrics_allowlist = $puppet::server::jolokia_metrics_allowlist,
) {
  include puppet::server

  $puppetserver_package = pick($puppet::server::package, 'puppetserver')

  $jvm_heap_arr = ["-Xms${jvm_min_heap_size}", "-Xmx${jvm_max_heap_size}"]
  if $disable_fips {
    $jvm_cmd_arr = $jvm_heap_arr + ['-Dcom.redhat.fips=false', $jvm_extra_args]
  } else {
    $jvm_cmd_arr = $jvm_heap_arr + [$jvm_extra_args]
  }
  $jvm_cmd = strip(join(flatten($jvm_cmd_arr), ' '))

  if $facts['os']['family'] == 'FreeBSD' {
    $server_gem_paths = ['${jruby-puppet.gem-home}', "\"${server_puppetserver_vardir}/vendored-jruby-gems\"", sprintf('"%s"', regsubst($facts['ruby']['sitedir'], 'site_ruby', 'gems'))] # lint:ignore:single_quote_string_with_variables
    augeas { 'puppet::server::puppetserver::jvm':
      context => '/files/etc/rc.conf',
      changes => ["set puppetserver_java_opts '\"${jvm_cmd}\"'"],
    }
  } elsif $facts['os']['family'] == 'Debian' and !$puppet::params::aio_package {
    $server_gem_paths = ['${jruby-puppet.gem-home}', '/usr/lib/puppetserver/vendored-jruby-gems'] # lint:ignore:single_quote_string_with_variables
  } else {
    if $jvm_cli_args {
      $changes = [
        "set JAVA_ARGS '\"${jvm_cmd}\"'",
        "set JAVA_BIN ${java_bin}",
        "set JAVA_ARGS_CLI '\"${jvm_cli_args}\"'",
      ]
    } else {
      $changes = [
        "set JAVA_ARGS '\"${jvm_cmd}\"'",
        "set JAVA_BIN ${java_bin}",
      ]
    }
    augeas { 'puppet::server::puppetserver::jvm':
      lens    => 'Shellvars.lns',
      incl    => $config,
      context => "/files${config}",
      changes => $changes,
    }

    $bootstrap_paths = "${server_puppetserver_dir}/services.d/,/opt/puppetlabs/server/apps/puppetserver/config/services.d/"

    $server_gem_paths = ['${jruby-puppet.gem-home}', "\"${server_puppetserver_vardir}/vendored-jruby-gems\"", "\"/opt/puppetlabs/puppet/lib/ruby/vendor_gems\""] # lint:ignore:single_quote_string_with_variables

    augeas { 'puppet::server::puppetserver::bootstrap':
      lens    => 'Shellvars.lns',
      incl    => $config,
      context => "/files${config}",
      changes => "set BOOTSTRAP_CONFIG '\"${bootstrap_paths}\"'",
    }

    augeas { 'puppet::server::puppetserver::jruby_jar':
      lens    => 'Shellvars.lns',
      incl    => $config,
      context => "/files${config}",
      changes => 'rm JRUBY_JAR',
    }

    $ensure_max_open_files = $max_open_files ? {
      undef   => 'absent',
      default => 'present',
    }
    if $facts['service_provider'] == 'systemd' {
      systemd::dropin_file { 'puppetserver.service-limits.conf':
        ensure   => $ensure_max_open_files,
        filename => 'limits.conf',
        unit     => 'puppetserver.service',
        content  => "[Service]\nLimitNOFILE=${max_open_files}\n",
      }

      # https://github.com/puppetlabs/ezbake/pull/623
      systemd::dropin_file { 'puppetserver.service-privatetmp.conf':
        ensure   => present,
        filename => 'privatetmp.conf',
        unit     => 'puppetserver.service',
        content  => "[Service]\nPrivateTmp=true\n",
      }
    } else {
      file_line { 'puppet::server::puppetserver::max_open_files':
        ensure => $ensure_max_open_files,
        path   => $config,
        line   => "ulimit -n ${max_open_files}",
        match  => '^ulimit\ -n',
      }
    }
  }

  $servicesd = "${server_puppetserver_dir}/services.d"
  file { $servicesd:
    ensure => directory,
  }
  file { "${servicesd}/ca.cfg":
    ensure  => file,
    content => template('puppet/server/puppetserver/services.d/ca.cfg.erb'),
  }

  file { "${server_puppetserver_dir}/conf.d/ca.conf":
    ensure  => file,
    content => template('puppet/server/puppetserver/conf.d/ca.conf.erb'),
  }

  file { "${server_puppetserver_dir}/conf.d/puppetserver.conf":
    ensure  => file,
    content => template('puppet/server/puppetserver/conf.d/puppetserver.conf.erb'),
  }

  $auth_template = pick($server_auth_template, 'puppet/server/puppetserver/conf.d/auth.conf.erb')
  file { "${server_puppetserver_dir}/conf.d/auth.conf":
    ensure  => file,
    content => template($auth_template),
  }

  file { "${server_puppetserver_dir}/conf.d/webserver.conf":
    ensure  => file,
    content => template('puppet/server/puppetserver/conf.d/webserver.conf.erb'),
  }

  file { "${server_puppetserver_dir}/conf.d/product.conf":
    ensure  => file,
    content => template('puppet/server/puppetserver/conf.d/product.conf.erb'),
  }

  file { "${server_puppetserver_dir}/conf.d/metrics.conf":
    ensure  => 'file',
    content => template('puppet/server/puppetserver/conf.d/metrics.conf.erb'),
  }
}