Skip to content

Commit

Permalink
Remove deprecated group and zbx_groups parameters
Browse files Browse the repository at this point in the history
These were deprecated since 7.0.0 via a4750d4
  • Loading branch information
evgeni committed Nov 7, 2023
1 parent a453023 commit 90b832b
Show file tree
Hide file tree
Showing 5 changed files with 2 additions and 82 deletions.
22 changes: 0 additions & 22 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -1348,7 +1348,6 @@ The following parameters are available in the `zabbix::agent` class:
* [`manage_resources`](#-zabbix--agent--manage_resources)
* [`monitored_by_proxy`](#-zabbix--agent--monitored_by_proxy)
* [`agent_use_ip`](#-zabbix--agent--agent_use_ip)
* [`zbx_group`](#-zabbix--agent--zbx_group)
* [`zbx_groups`](#-zabbix--agent--zbx_groups)
* [`zbx_group_create`](#-zabbix--agent--zbx_group_create)
* [`zbx_templates`](#-zabbix--agent--zbx_templates)
Expand Down Expand Up @@ -1516,14 +1515,6 @@ connection should me made via ip, not fqdn.

Default value: `$zabbix::params::agent_use_ip`

##### <a name="-zabbix--agent--zbx_group"></a>`zbx_group`

Data type: `Any`

*Deprecated* (see zbx_groups) Name of the hostgroup where this host needs to be added.

Default value: `$zabbix::params::agent_zbx_group`

##### <a name="-zabbix--agent--zbx_groups"></a>`zbx_groups`

Data type: `Variant[String[1],Array[String[1]]]`
Expand Down Expand Up @@ -3607,7 +3598,6 @@ The following parameters are available in the `zabbix::resources::agent` class:
* [`ipaddress`](#-zabbix--resources--agent--ipaddress)
* [`use_ip`](#-zabbix--resources--agent--use_ip)
* [`port`](#-zabbix--resources--agent--port)
* [`group`](#-zabbix--resources--agent--group)
* [`groups`](#-zabbix--resources--agent--groups)
* [`group_create`](#-zabbix--resources--agent--group_create)
* [`templates`](#-zabbix--resources--agent--templates)
Expand Down Expand Up @@ -3652,14 +3642,6 @@ The port that the zabbix agent is listening on.

Default value: `undef`

##### <a name="-zabbix--resources--agent--group"></a>`group`

Data type: `Any`

*Deprecated* (see groups parameter) Name of the hostgroup.

Default value: `undef`

##### <a name="-zabbix--resources--agent--groups"></a>`groups`

Data type: `Array[String[1]]`
Expand Down Expand Up @@ -6014,10 +5996,6 @@ The basic property that the resource should be in.

Default value: `present`

##### `group`

Deprecated! Name of the hostgroup.

##### `groups`

An array of groups the host belongs to.
Expand Down
22 changes: 0 additions & 22 deletions lib/puppet/type/zabbix_host.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,6 @@
defaultto :present
end

def initialize(*args)
super

# Migrate group to groups
return if self[:group].nil?

self[:groups] = self[:group]
delete(:group)
end

def munge_boolean(value)
case value
when true, 'true', :true
Expand Down Expand Up @@ -96,14 +86,6 @@ def insync?(is)
end
end

newproperty(:group) do
desc 'Deprecated! Name of the hostgroup.'

validate do |_value|
Puppet.warning('Passing group to zabbix_host is deprecated and will be removed. Use groups instead.')
end
end

newproperty(:groups, array_matching: :all) do
desc 'An array of groups the host belongs to.'
def insync?(is)
Expand Down Expand Up @@ -170,8 +152,4 @@ def insync?(is)
end

autorequire(:file) { '/etc/zabbix/api.conf' }

validate do
raise(_('The properties group and groups are mutually exclusive.')) if self[:group] && self[:groups]
end
end
20 changes: 1 addition & 19 deletions manifests/agent.pp
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
# @param agent_use_ip
# When true, when creating hosts via the zabbix-api, it will configure that
# connection should me made via ip, not fqdn.
# @param zbx_group *Deprecated* (see zbx_groups) Name of the hostgroup where this host needs to be added.
# @param zbx_groups An array of hostgroups where this host needs to be added.
# @param zbx_group_create Whether to create hostgroup if missing.
# @param zbx_templates List of templates which will be added when host is configured.
Expand Down Expand Up @@ -148,7 +147,6 @@
Boolean $manage_resources = $zabbix::params::manage_resources,
$monitored_by_proxy = $zabbix::params::monitored_by_proxy,
$agent_use_ip = $zabbix::params::agent_use_ip,
$zbx_group = $zabbix::params::agent_zbx_group,
Variant[String[1],Array[String[1]]] $zbx_groups = $zabbix::params::agent_zbx_groups,
$zbx_group_create = $zabbix::params::agent_zbx_group_create,
$zbx_templates = $zabbix::params::agent_zbx_templates,
Expand Down Expand Up @@ -236,22 +234,6 @@
# is set to false, you'll get warnings like this:
# "Warning: You cannot collect without storeconfigs being set"
if $manage_resources {
# Migrate deprecated zbx_group parameter
if $zbx_group == $zabbix::params::agent_zbx_group and $zbx_groups == $zabbix::params::agent_zbx_groups {
$groups = $zabbix::params::agent_zbx_groups
} else {
if $zbx_group != $zabbix::params::agent_zbx_group and $zbx_groups != $zabbix::params::agent_zbx_groups {
fail("Seems like you have filled zbx_group and zbx_groups with custom values. This isn't support! Please use zbx_groups only.")
}

if $zbx_group != $zabbix::params::agent_zbx_group {
warning('Passing zbx_group to zabbix::agent is deprecated and will be removed. Use zbx_groups instead.')
$groups = Array($zbx_group)
} else {
$groups = $zbx_groups
}
}

if $monitored_by_proxy != '' {
$use_proxy = $monitored_by_proxy
} else {
Expand All @@ -264,7 +246,7 @@
ipaddress => $listen_ip,
use_ip => $agent_use_ip,
port => $listenport,
groups => [$groups].flatten(),
groups => [$zbx_groups].flatten(),
group_create => $zbx_group_create,
templates => $zbx_templates,
macros => $zbx_macros,
Expand Down
15 changes: 1 addition & 14 deletions manifests/resources/agent.pp
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
# @param ipaddress The IP address of the machine running zabbix agent.
# @param use_ip Use ipadress instead of dns to connect.
# @param port The port that the zabbix agent is listening on.
# @param group *Deprecated* (see groups parameter) Name of the hostgroup.
# @param groups An array of groups the host belongs to.
# @param group_create Whether to create hostgroup if missing.
# @param templates List of templates which should be attached to this host.
Expand All @@ -20,7 +19,6 @@
$ipaddress = undef,
$use_ip = undef,
$port = undef,
$group = undef,
Array[String[1]] $groups = undef,
$group_create = undef,
$templates = undef,
Expand All @@ -33,22 +31,11 @@
Optional[String[1]] $tls_issuer = undef,
Optional[String[1]] $tls_subject = undef,
) {
if $group and $groups {
fail("Got group and groups. This isn't support! Please use groups only.")
} else {
if $group {
warning('Passing group to zabbix::resources::agent is deprecated and will be removed. Use groups instead.')
$_groups = Array($group)
} else {
$_groups = $groups
}
}

@@zabbix_host { $hostname:
ipaddress => $ipaddress,
use_ip => $use_ip,
port => $port,
groups => $_groups,
groups => $groups,
group_create => $group_create,
templates => $templates,
macros => $macros,
Expand Down
5 changes: 0 additions & 5 deletions spec/unit/puppet/type/zabbix_host_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

describe 'when validating properties' do
%i[
group
groups
id
interfaceid
Expand Down Expand Up @@ -76,10 +75,6 @@
it_behaves_like 'generic ensurable', :present
end

describe 'group' do
it_behaves_like 'validated property', :group, nil, ['group1', 'Group One']
end

describe 'groups' do
it_behaves_like 'array_matching property', :groups, nil

Expand Down

0 comments on commit 90b832b

Please sign in to comment.