Skip to content

Commit

Permalink
Fixes #37291 - Use explicit java on RH with Puppetserver 8
Browse files Browse the repository at this point in the history 
The /usr/bin/java file may point to any version. This changes the logic
to determine the java version (unless explicitly specified) dynamically
based on the puppetserver version and the OS.
  • Loading branch information
@ekohl
ekohl committed Mar 22, 2024
1 parent b524354 commit 70f35a9
Show file tree
Hide file tree
Showing 6 changed files with 47 additions and 14 deletions.
4 changes: 2 additions & 2 deletions manifests/init.pp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@
# $server_envs_target:: Indicates that $envs_dir should be
# a symbolic link to this target
#
# $server_jvm_java_bin:: Set the default java to use.
# $server_jvm_java_bin:: Set the default java to use. If unspecified, it will be derived from the Puppet version.
#
# $server_jvm_config:: Specify the puppetserver jvm configuration file.
#
Expand Down Expand Up @@ -714,7 +714,7 @@
Optional[Stdlib::Absolutepath] $server_puppet_basedir = $puppet::params::server_puppet_basedir,
Enum['current', 'future'] $server_parser = $puppet::params::server_parser,
Variant[Undef, Enum['unlimited'], Pattern[/^\d+[smhdy]?$/]] $server_environment_timeout = $puppet::params::server_environment_timeout,
String $server_jvm_java_bin = $puppet::params::server_jvm_java_bin,
Optional[Stdlib::Absolutepath] $server_jvm_java_bin = undef,
String $server_jvm_config = $puppet::params::server_jvm_config,
Pattern[/^[0-9]+[kKmMgG]$/] $server_jvm_min_heap_size = $puppet::params::server_jvm_min_heap_size,
Pattern[/^[0-9]+[kKmMgG]$/] $server_jvm_max_heap_size = $puppet::params::server_jvm_max_heap_size,
Expand Down
1 change: 0 additions & 1 deletion manifests/params.pp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,6 @@
default => '/etc/default/puppetserver',
}

$server_jvm_java_bin = '/usr/bin/java'
$server_jvm_extra_args = undef
$server_jvm_cli_args = undef

Expand Down
2 changes: 1 addition & 1 deletion manifests/server.pp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@
Optional[Stdlib::Absolutepath] $puppet_basedir = $puppet::server_puppet_basedir,
Enum['current', 'future'] $parser = $puppet::server_parser,
Variant[Undef, Enum['unlimited'], Pattern[/^\d+[smhdy]?$/]] $environment_timeout = $puppet::server_environment_timeout,
String $jvm_java_bin = $puppet::server_jvm_java_bin,
Optional[Stdlib::Absolutepath] $jvm_java_bin = $puppet::server_jvm_java_bin,
String $jvm_config = $puppet::server_jvm_config,
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,
Expand Down
13 changes: 13 additions & 0 deletions manifests/server/install.pp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,19 @@
install_options => $puppet::package_install_options,
}

# Puppetserver 8 on EL 8 relies on JRE 11 or 17. This prefers JRE 17 by installing it first
if (
!$puppet::server::java_bin and
$facts['os']['family'] == 'RedHat' and $facts['os']['release']['major'] == '8' and
# This doesn't use server_version because we have 2 mechanisms to set the version
versioncmp(pick($puppet::server::puppetserver_version, $facts['puppetversion']), '8.0.0') >= 0
) {
# EL 8 packaging can install either Java 17 or Java 11, but we prefer Java 17
stdlib::ensure_packages(['jre-17-headless'])

Package['jre-17-headless'] -> Package[$server_package]
}

if $puppet::server::manage_user {
Package[$server_package] -> User[$puppet::server::user]
}
Expand Down
27 changes: 24 additions & 3 deletions manifests/server/puppetserver.pp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
class puppet::server::puppetserver (
Optional[Pattern[/^[\d]\.[\d]+\.[\d]+$/]] $puppetserver_version = $puppet::server::puppetserver_version,
String $config = $puppet::server::jvm_config,
String $java_bin = $puppet::server::jvm_java_bin,
Optional[Stdlib::Absolutepath] $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,
Expand Down Expand Up @@ -163,6 +163,27 @@

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

if $java_bin {
$_java_bin = $java_bin
} elsif versioncmp($real_puppetserver_version, '8.0.0') >= 0 {
# Follows logic that https://github.com/puppetlabs/ezbake/pull/627 suggests, but takes it a
# step further by also ensuring EL 8 has Java 17
$java_bin = case $facts['os']['family'] {
'RedHat': {
$facts['os']['release']['major'] ? {
/^([89])$/ => '/usr/lib/jvm/jre-17/bin/java',
'7' => '/usr/lib/jvm/jre-11/bin/java',
default => '/usr/bin/java'
}
}
default: {
'/usr/bin/java'
}
}
} else {
$_java_bin = '/usr/bin/java'
}

$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]
Expand All @@ -183,13 +204,13 @@
if $jvm_cli_args {
$changes = [
"set JAVA_ARGS '\"${jvm_cmd}\"'",
"set JAVA_BIN ${java_bin}",
"set JAVA_BIN ${_java_bin}",
"set JAVA_ARGS_CLI '\"${jvm_cli_args}\"'",
]
} else {
$changes = [
"set JAVA_ARGS '\"${jvm_cmd}\"'",
"set JAVA_BIN ${java_bin}",
"set JAVA_BIN ${_java_bin}",
]
}
augeas { 'puppet::server::puppetserver::jvm':
Expand Down
14 changes: 7 additions & 7 deletions spec/classes/puppet_server_puppetserver_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
let(:facts) do
facts
end

let(:java_bin) { %r{^set JAVA_BIN /usr/(lib/jvm/jre-1[17]/)?bin/java$} }
let(:auth_conf) { '/etc/custom/puppetserver/conf.d/auth.conf' }
let(:puppetserver_conf) { '/etc/custom/puppetserver/conf.d/puppetserver.conf' }

Expand Down Expand Up @@ -58,15 +58,15 @@
if facts[:os]['family'] == 'RedHat' and facts[:os]['release']['major'] != '7'
it {

Check failure on line 59 in spec/classes/puppet_server_puppetserver_spec.rb

View workflow job for this annotation

GitHub Actions / Puppet / 8 (Ruby 3.2) 

puppet on almalinux-9-x86_64 with default parameters is expected to contain Augeas[puppet::server::puppetserver::jvm] with changes => ["set JAVA_ARGS '\"-Xms2G -Xmx2G -Dcom.redhat.fips=false\"'", /^set JAVA_BIN \/usr\/(lib\/jvm\/jre-1[17]\/)?bin\/java$/], context => "/files/etc/default/puppetserver", incl => "/etc/default/puppetserver" and lens => "Shellvars.lns"

Failure/Error:
  should contain_augeas('puppet::server::puppetserver::jvm')
    .with_changes(['set JAVA_ARGS \'"-Xms2G -Xmx2G -Dcom.redhat.fips=false"\'', java_bin])
    .with_context('/files/etc/default/puppetserver')
    .with_incl('/etc/default/puppetserver')
    .with_lens('Shellvars.lns')

Puppet::PreformattedError:
  Evaluation Error: Unknown variable: 'puppet::server::java_bin'. (file: /home/runner/work/puppet-puppet/puppet-puppet/spec/fixtures/modules/puppet/manifests/server/install.pp, line: 46, column: 8) on node fv-az1487-819.vpy2y30pan5uhaa0ktko4c43jh.ex.internal.cloudapp.net
should contain_augeas('puppet::server::puppetserver::jvm')
.with_changes(['set JAVA_ARGS \'"-Xms2G -Xmx2G -Dcom.redhat.fips=false"\'', 'set JAVA_BIN /usr/bin/java'])
.with_changes(['set JAVA_ARGS \'"-Xms2G -Xmx2G -Dcom.redhat.fips=false"\'', java_bin])
.with_context('/files/etc/default/puppetserver')
.with_incl('/etc/default/puppetserver')
.with_lens('Shellvars.lns')
}
else
it {

Check failure on line 67 in spec/classes/puppet_server_puppetserver_spec.rb

View workflow job for this annotation

GitHub Actions / Puppet / 7 (Ruby 2.7) 

puppet on scientific-7-x86_64 with default parameters is expected to contain Augeas[puppet::server::puppetserver::jvm] with changes => ["set JAVA_ARGS '\"-Xms2G -Xmx2G\"'", /^set JAVA_BIN \/usr\/(lib\/jvm\/jre-1[17]\/)?bin\/java$/], context => "/files/etc/default/puppetserver", incl => "/etc/default/puppetserver" and lens => "Shellvars.lns"

Failure/Error:
  should contain_augeas('puppet::server::puppetserver::jvm')
    .with_changes(['set JAVA_ARGS \'"-Xms2G -Xmx2G"\'', java_bin])
    .with_context('/files/etc/default/puppetserver')
    .with_incl('/etc/default/puppetserver')
    .with_lens('Shellvars.lns')

Puppet::PreformattedError:
  Evaluation Error: Unknown variable: 'puppet::server::java_bin'. (file: /home/runner/work/puppet-puppet/puppet-puppet/spec/fixtures/modules/puppet/manifests/server/install.pp, line: 46, column: 8) on node fv-az1116-638.iopidld3wkhelkdxw22dv3nexc.bx.internal.cloudapp.net
should contain_augeas('puppet::server::puppetserver::jvm')
.with_changes(['set JAVA_ARGS \'"-Xms2G -Xmx2G"\'', 'set JAVA_BIN /usr/bin/java'])
.with_changes(['set JAVA_ARGS \'"-Xms2G -Xmx2G"\'', java_bin])
.with_context('/files/etc/default/puppetserver')
.with_incl('/etc/default/puppetserver')
.with_lens('Shellvars.lns')
Expand Down Expand Up @@ -390,7 +390,7 @@
should contain_augeas('puppet::server::puppetserver::jvm')
.with_changes([
'set JAVA_ARGS \'"-Xms2G -Xmx2G -Dcom.redhat.fips=false -XX:foo=bar -XX:bar=foo"\'',
'set JAVA_BIN /usr/bin/java'
java_bin
])
.with_context('/files/etc/default/puppetserver')
.with_incl('/etc/default/puppetserver')
Expand All @@ -401,7 +401,7 @@
should contain_augeas('puppet::server::puppetserver::jvm')
.with_changes([
'set JAVA_ARGS \'"-Xms2G -Xmx2G -XX:foo=bar -XX:bar=foo"\'',
'set JAVA_BIN /usr/bin/java'
java_bin
])
.with_context('/files/etc/default/puppetserver')
.with_incl('/etc/default/puppetserver')
Expand All @@ -417,7 +417,7 @@
should contain_augeas('puppet::server::puppetserver::jvm')
.with_changes([
'set JAVA_ARGS \'"-Xms2G -Xmx2G -Dcom.redhat.fips=false"\'',
'set JAVA_BIN /usr/bin/java',
java_bin,
'set JAVA_ARGS_CLI \'"-Djava.io.tmpdir=/var/puppettmp"\''
])
.with_context('/files/etc/default/puppetserver')
Expand All @@ -429,7 +429,7 @@
should contain_augeas('puppet::server::puppetserver::jvm')
.with_changes([
'set JAVA_ARGS \'"-Xms2G -Xmx2G"\'',
'set JAVA_BIN /usr/bin/java',
java_bin,
'set JAVA_ARGS_CLI \'"-Djava.io.tmpdir=/var/puppettmp"\''
])
.with_context('/files/etc/default/puppetserver')
Expand Down

0 comments on commit 70f35a9

Please sign in to comment.