Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add the ability to manage the user and group for nrpe #39

Merged
merged 1 commit into from
Oct 10, 2023
Merged

Add the ability to manage the user and group for nrpe #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions REFERENCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ The following parameters are available in the `nrpe` class:
* [`ssl_log_client_cert`](#-nrpe--ssl_log_client_cert)
* [`ssl_log_client_cert_details`](#-nrpe--ssl_log_client_cert_details)
* [`manage_pid_dir`](#-nrpe--manage_pid_dir)
* [`manage_group`](#-nrpe--manage_group)
* [`manage_user`](#-nrpe--manage_user)
* [`user_comment`](#-nrpe--user_comment)
* [`user_home_dir`](#-nrpe--user_home_dir)
* [`user_shell`](#-nrpe--user_shell)
* [`config`](#-nrpe--config)
* [`include_dir`](#-nrpe--include_dir)
* [`provider`](#-nrpe--provider)
Expand Down Expand Up @@ -394,6 +399,46 @@ Whether to manage the directory where the PID file should exist.

Default value: `false`

##### <a name="-nrpe--manage_group"></a>`manage_group`

Data type: `Boolean`

Whether to manage the group nrpe uses.

Default value: `false`

##### <a name="-nrpe--manage_user"></a>`manage_user`

Data type: `Boolean`

Whether to manage the user nrpe uses.

Default value: `false`

##### <a name="-nrpe--user_comment"></a>`user_comment`

Data type: `Optional[String]`

An optional string to use for the user's GECOS field.

Default value: `undef`

##### <a name="-nrpe--user_home_dir"></a>`user_home_dir`

Data type: `Stdlib::Absolutepath`

The absolute path to the home directory to use for the user.

Default value: `$nrpe::params::user_home_dir`

##### <a name="-nrpe--user_shell"></a>`user_shell`

Data type: `Stdlib::Absolutepath`

The absolute path to the shell to use for the user.

Default value: `$nrpe::params::user_shell`

##### <a name="-nrpe--config"></a>`config`

Data type: `Stdlib::Absolutepath`
Expand Down
30 changes: 27 additions & 3 deletions manifests/config.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,34 @@
#
# @api private
class nrpe::config {
unless $nrpe::supplementary_groups.empty {
if $nrpe::manage_group {
group { $nrpe::nrpe_group:
ensure => 'present',
system => true,
}
$group_req = Group[$nrpe::nrpe_group]
} else {
$group_req = undef
}

if $nrpe::manage_user {
user { $nrpe::nrpe_user:
gid => $nrpe::nrpe_group,
groups => $nrpe::supplementary_groups,
ensure => 'present',
before => Service[$nrpe::service_name],
comment => $nrpe::user_comment,
gid => $nrpe::nrpe_group,
groups => $nrpe::supplementary_groups,
home => $nrpe::user_home_dir,
require => $group_req,
shell => $nrpe::user_shell,
system => true,
}
} else {
unless $nrpe::supplementary_groups.empty {
user { $nrpe::nrpe_user:
gid => $nrpe::nrpe_group,
groups => $nrpe::supplementary_groups,
}
}
}

Expand Down
15 changes: 15 additions & 0 deletions manifests/init.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,16 @@
# Whether to log details of client SSL certificates.
# @param manage_pid_dir
# Whether to manage the directory where the PID file should exist.
# @param manage_group
# Whether to manage the group nrpe uses.
# @param manage_user
# Whether to manage the user nrpe uses.
# @param user_comment
# An optional string to use for the user's GECOS field.
# @param user_home_dir
# The absolute path to the home directory to use for the user.
# @param user_shell
# The absolute path to the shell to use for the user.
# @param config
# **Private** You should not need to override this parameter.
# @param include_dir
Expand Down Expand Up @@ -139,6 +149,11 @@
Array[String[1]] $supplementary_groups = [],
Boolean $manage_pid_dir = false,
Integer[0] $listen_queue_size = $nrpe::params::listen_queue_size,
Boolean $manage_user = false,
Boolean $manage_group = false,
Optional[String] $user_comment = undef,
Stdlib::Absolutepath $user_home_dir = $nrpe::params::user_home_dir,
Stdlib::Absolutepath $user_shell = $nrpe::params::user_shell,

# Private parameters. You shouldn't need to override these.
Stdlib::Absolutepath $config = $nrpe::params::nrpe_config,
Expand Down
14 changes: 14 additions & 0 deletions manifests/params.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
'nagios-nrpe-server',
'monitoring-plugins',
]
$user_home_dir = '/var/lib/nagios'
$user_shell = '/bin/false'
}
'Solaris': {
$libdir = '/opt/csw/libexec/nagios-plugins'
Expand All @@ -42,6 +44,8 @@
'nrpe',
'nagios_plugins',
]
$user_home_dir = '/var/lib/nagios'
$user_shell = '/bin/false'
}
'RedHat': {
$libdir = fact('os.architecture') ? {
Expand All @@ -59,6 +63,8 @@
'nrpe',
'nagios-plugins-all',
]
$user_home_dir = '/var/run/nrpe'
$user_shell = '/sbin/nologin'
}
'FreeBSD': {
$libdir = '/usr/local/libexec/nagios'
Expand All @@ -73,6 +79,8 @@
'nrpe3',
'nagios-plugins',
]
$user_home_dir = '/var/spool/nagios'
$user_shell = '/sbin/nologin'
}
'OpenBSD': {
$libdir = '/usr/local/libexec/nagios'
Expand All @@ -87,6 +95,8 @@
'nrpe',
'monitoring-plugins',
]
$user_home_dir = '/var/lib/nagios'
$user_shell = '/bin/false'
}
'Suse': {
$libdir = '/usr/lib/nagios/plugins'
Expand Down Expand Up @@ -115,6 +125,8 @@
]
}
}
$user_home_dir = '/var/lib/nagios'
$user_shell = '/bin/false'
}
'Gentoo': {
$libdir = fact('os.architecture') ? {
Expand All @@ -132,6 +144,8 @@
'net-analyzer/nrpe',
'net-analyzer/nagios-plugins',
]
$user_home_dir = '/dev/null'
$user_shell = '/sbin/nologin'
}
default: {
}
Expand Down
92 changes: 92 additions & 0 deletions spec/classes/nrpe_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,98 @@

it { is_expected.to compile.with_all_deps }
end

context 'when manage_group is true' do
let(:params) { { 'manage_group' => true } }

case facts[:osfamily]
when 'OpenBSD'
it { is_expected.to contain_group('_nrpe') }
when 'RedHat'
it { is_expected.to contain_group('nrpe') }
else
it { is_expected.to contain_group('nagios') }
end
end

context 'when manage_user is true' do
let(:params) { { 'manage_user' => true } }

case facts[:osfamily]
when 'FreeBSD'
it {
is_expected.to contain_user('nagios').
with_gid('nagios').
with_home('/var/spool/nagios').
with_shell('/sbin/nologin')
}
when 'Gentoo'
it {
is_expected.to contain_user('nagios').
with_gid('nagios').
with_home('/dev/null').
with_shell('/sbin/nologin')
}

when 'OpenBSD'
it {
is_expected.to contain_user('_nrpe').
with_gid('_nrpe').
with_home('/var/lib/nagios').
with_shell('/bin/false')
}
when 'RedHat'
it {
is_expected.to contain_user('nrpe').
with_gid('nrpe').
with_home('/var/run/nrpe').
with_shell('/sbin/nologin')
}
else
it {
is_expected.to contain_user('nagios').
with_gid('nagios').
with_home('/var/lib/nagios').
with_shell('/bin/false')
}
end
end

context 'when manage_group and manage_user are true' do
let(:params) do
{
'manage_group' => true,
'manage_user' => true
}
end

case facts[:osfamily]
when 'OpenBSD'
it {
is_expected.to contain_group('_nrpe')
}

it {
is_expected.to contain_user('_nrpe').with_require('Group[_nrpe]')
}
when 'RedHat'
it {
is_expected.to contain_group('nrpe')
}

it {
is_expected.to contain_user('nrpe').with_require('Group[nrpe]')
}
else
it {
is_expected.to contain_group('nagios')
}

it {
is_expected.to contain_user('nagios').with_require('Group[nagios]')
}
end
end
end
end
end
Loading