Skip to content

Commit

Permalink
Fixes #33214: Set minimum Puma threads equal to maximum puma threads …
Browse files Browse the repository at this point in the history
…by default

This has been shown to prevent memory leaks that can appear in Foreman
when running under Puma. This only changes the default to match and
users must still be aware of this potential when changing the tunings.
  • Loading branch information
ehelms committed Aug 10, 2021
1 parent 24ca255 commit 172a16d
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 5 deletions.
1 change: 1 addition & 0 deletions manifests/config.pp
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
content => template('foreman/database.yml.erb'),
}

$min_puma_threads = pick($foreman::foreman_service_puma_threads_min, $foreman::foreman_service_puma_threads_max)
systemd::dropin_file { 'foreman-service':
filename => 'installer.conf',
unit => "${foreman::foreman_service}.service",
Expand Down
6 changes: 4 additions & 2 deletions manifests/init.pp
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,9 @@
#
# $cors_domains:: List of domains that show be allowed for Cross-Origin Resource Sharing
#
# $foreman_service_puma_threads_min:: Minimum number of threads for every Puma worker
# $foreman_service_puma_threads_min:: Minimum number of threads for every Puma worker. If no value is specified, this defaults
# to setting min threads to maximum threads. Setting min threads equal to max threads has
# been shown to alleviate memory leaks and in some cases produce better performance.
#
# $foreman_service_puma_threads_max:: Maximum number of threads for every Puma worker
#
Expand Down Expand Up @@ -272,7 +274,7 @@
Optional[Redis::RedisUrl] $dynflow_redis_url = $foreman::params::dynflow_redis_url,
Boolean $hsts_enabled = $foreman::params::hsts_enabled,
Array[Stdlib::HTTPUrl] $cors_domains = $foreman::params::cors_domains,
Integer[0] $foreman_service_puma_threads_min = $foreman::params::foreman_service_puma_threads_min,
Optional[Integer[0]] $foreman_service_puma_threads_min = $foreman::params::foreman_service_puma_threads_min,
Integer[0] $foreman_service_puma_threads_max = $foreman::params::foreman_service_puma_threads_max,
Integer[0] $foreman_service_puma_workers = $foreman::params::foreman_service_puma_workers,
Hash[String, Any] $rails_cache_store = $foreman::params::rails_cache_store,
Expand Down
2 changes: 1 addition & 1 deletion manifests/params.pp
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
$foreman_service = 'foreman'
$foreman_service_ensure = 'running'
$foreman_service_enable = true
$foreman_service_puma_threads_min = 0
$foreman_service_puma_threads_min = undef
$foreman_service_puma_threads_max = 16
$foreman_service_puma_workers = 2

Expand Down
13 changes: 12 additions & 1 deletion spec/classes/foreman_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,18 @@
.with_content(/^SocketUser=#{apache_user}$/)
end

it { should contain_systemd__dropin_file('foreman-service').with_filename('installer.conf').with_unit('foreman.service') }
it 'overrides foreman.service systemd service' do
should contain_systemd__dropin_file('foreman-service')
.with_ensure('present')
.with_filename('installer.conf')
.with_unit('foreman.service')
.with_content(%r{^User=foreman$})
.with_content(%r{^Environment=FOREMAN_ENV=production$})
.with_content(%r{^Environment=FOREMAN_HOME=/usr/share/foreman$})
.with_content(%r{^Environment=FOREMAN_PUMA_THREADS_MIN=16$})
.with_content(%r{^Environment=FOREMAN_PUMA_THREADS_MAX=16$})
.with_content(%r{^Environment=FOREMAN_PUMA_WORKERS=2$})
end

it { should contain_apache__vhost('foreman').without_custom_fragment(/Alias/) }

Expand Down
2 changes: 1 addition & 1 deletion templates/foreman.service-overrides.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
User=<%= scope['foreman::user'] %>
Environment=FOREMAN_ENV=<%= scope['foreman::rails_env'] %>
Environment=FOREMAN_HOME=<%= scope['foreman::app_root'] %>
Environment=FOREMAN_PUMA_THREADS_MIN=<%= scope['foreman::foreman_service_puma_threads_min'] %>
Environment=FOREMAN_PUMA_THREADS_MIN=<%= scope['foreman::config::min_puma_threads'] %>
Environment=FOREMAN_PUMA_THREADS_MAX=<%= scope['foreman::foreman_service_puma_threads_max'] %>
Environment=FOREMAN_PUMA_WORKERS=<%= scope['foreman::foreman_service_puma_workers'] %>

0 comments on commit 172a16d

Please sign in to comment.