Bootstrap agent2 support

* Add param binary_location for specify zabbix agent binary (only for systemd) * Remove some parameters in zabbix agent configuration if it's zabbix agent2 package * LogRemoteCommands * StartAgents * MaxLinesPerSecond * AllowRoot * User * LoadModulePath * Fix EnableRemoteCommands still use on zabbix agentd > 5 but remove on agent2 Conflicts: manifests/agent.pp spec/classes/agent_spec.rb templates/zabbix_agentd.conf.erb
voxpupuli · Mar 7, 2024 · f7ff08d · f7ff08d
1 parent db01009
commit f7ff08d
Show file tree

Hide file tree

Showing 12 changed files with 246 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@
 5. [Usage - Configuration options and additional functionality](#usage)
     * [zabbix-server](#usage-zabbix-server)
     * [zabbix-agent](#usage-zabbix-agent)
+    * [zabbix-agent2](#usage-zabbix-agent2)
     * [zabbix-proxy](#usage-zabbix-proxy)
     * [zabbix-javagateway](#usage-zabbix-javagateway)
     * [zabbix-sender](#usage-zabbix-sender)
@@ -200,6 +201,21 @@ class { 'zabbix::agent':
 }
 ```
 
+### Usage zabbix-agent2
+
+To use Zabbix agent2 you need to define some parameters
+
+```ruby
+  class { 'zabbix::agent':
+    package_name          => 'zabbix-agent2',
+    agent_configfile_path => '/etc/zabbix/zabbix_agent2.d',
+    pidfile               => '/var/run/zabbix/zabbix_agentd2.pid',
+    servicename           => 'zabbix-agent2',
+    zabbix_package_agent  => 'zabbix-agent2',
+    binary_location       => '/usr/sbin/zabbix_agent2'
+  }
+```
+
 ### Usage zabbix-proxy
 
 Like the zabbix-server, the zabbix-proxy can also be used in 2 ways:

diff --git a/REFERENCE.md b/REFERENCE.md
@@ -1342,6 +1342,20 @@ class { 'zabbix::agent':
 }
 ```
 
+##### Using Zabbix Agent 2
+
+```puppet
+class { 'zabbix::agent':
+  package_name          => 'zabbix-agent2',
+  agent_configfile_path => '/etc/zabbix/zabbix_agent2.conf',
+  agent_include         => '/etc/zabbix/zabbix_agent2.d',
+  pidfile               => '/var/run/zabbix/zabbix_agentd2.pid',
+  servicename           => 'zabbix-agent2',
+  zabbix_package_agent  => 'zabbix-agent2',
+  binary_location       => '/usr/sbin/zabbix_agent2'
+}
+```
+
 #### Parameters
 
 The following parameters are available in the `zabbix::agent` class:
@@ -1427,6 +1441,7 @@ The following parameters are available in the `zabbix::agent` class:
 * [`userparameter`](#-zabbix--agent--userparameter)
 * [`loadmodulepath`](#-zabbix--agent--loadmodulepath)
 * [`loadmodule`](#-zabbix--agent--loadmodule)
+* [`binary_location`](#-zabbix--agent--binary_location)
 * [`manage_startup_script`](#-zabbix--agent--manage_startup_script)
 
 ##### <a name="-zabbix--agent--zabbix_version"></a>`zabbix_version`
@@ -2099,6 +2114,14 @@ Module to load at agent startup.
 
 Default value: `$zabbix::params::agent_loadmodule`
 
+##### <a name="-zabbix--agent--binary_location"></a>`binary_location`
+
+Data type: `Optional[Stdlib::Absolutepath]`
+
+Location of th binary file, this feature is available only for systemd startup script
+
+Default value: `$zabbix::params::agent_binary_location`
+
 ##### <a name="-zabbix--agent--manage_startup_script"></a>`manage_startup_script`
 
 Data type: `Boolean`
@@ -5719,6 +5742,7 @@ The following parameters are available in the `zabbix::startup` defined type:
 * [`service_type`](#-zabbix--startup--service_type)
 * [`manage_database`](#-zabbix--startup--manage_database)
 * [`service_name`](#-zabbix--startup--service_name)
+* [`binary_location`](#-zabbix--startup--binary_location)
 
 ##### <a name="-zabbix--startup--pidfile"></a>`pidfile`
 
@@ -5794,6 +5818,14 @@ Name of the service. Defaults to the resource name
 
 Default value: `$name`
 
+##### <a name="-zabbix--startup--binary_location"></a>`binary_location`
+
+Data type: `Optional[Stdlib::Absolutepath]`
+
+This params is use for define a specific binary location. This is actually only available for zabbix agent and systemd
+
+Default value: `undef`
+
 ### <a name="zabbix--template"></a>`zabbix::template`
 
 This will upload an Zabbix Template (XML format)

diff --git a/manifests/agent.pp b/manifests/agent.pp
@@ -118,6 +118,7 @@
 # @param userparameter User-defined parameter to monitor.
 # @param loadmodulepath Full path to location of agent modules.
 # @param loadmodule Module to load at agent startup.
+# @param binary_location Location of th binary file, this feature is available only for systemd startup script
 # @param manage_startup_script
 #  If the init script should be managed by this module. Attention: This might
 #  cause problems with some config options of this module (e.g
@@ -134,6 +135,18 @@
 #    monitored_by_proxy => 'my_proxy_host',
 #    server             => '192.168.1.1',
 #  }
+#
+# @example Using Zabbix Agent 2
+#   class { 'zabbix::agent':
+#     package_name          => 'zabbix-agent2',
+#     agent_configfile_path => '/etc/zabbix/zabbix_agent2.conf',
+#     agent_include         => '/etc/zabbix/zabbix_agent2.d',
+#     pidfile               => '/var/run/zabbix/zabbix_agentd2.pid',
+#     servicename           => 'zabbix-agent2',
+#     zabbix_package_agent  => 'zabbix-agent2',
+#     binary_location       => '/usr/sbin/zabbix_agent2'
+#   }
+#
 # @author Werner Dijkerman [email protected]
 class zabbix::agent (
   $zabbix_version                                      = $zabbix::params::zabbix_version,
@@ -218,7 +231,10 @@
   String $additional_service_params                    = $zabbix::params::additional_service_params,
   String $service_type                                 = $zabbix::params::service_type,
   Boolean $manage_startup_script                       = $zabbix::params::manage_startup_script,
+  Optional[Stdlib::Absolutepath] $binary_location      = $zabbix::params::agent_binary_location,
 ) inherits zabbix::params {
+  $agent2 = $zabbix_package_agent == 'zabbix-agent2'
+
   # Find if listenip is set. If not, we can set to specific ip or
   # to network name. If more than 1 interfaces are available, we
   # can find the ipaddress of this specific interface if listenip
@@ -305,6 +321,7 @@
       additional_service_params => $additional_service_params,
       service_type              => $service_type,
       service_name              => 'zabbix-agent',
+      binary_location           => $binary_location,
       require                   => Package[$zabbix_package_agent],
     }
   }

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -200,18 +200,21 @@
 # @param saml_sp_cert The location of the SAML Service Provider Certificate.
 # @param saml_idp_cert The location of the SAML Identity Provider Certificate.
 # @param saml_settings A hash of additional SAML SSO settings.
+#
 # @example Single host setup:
 #   class { 'zabbix':
 #     zabbix_url => 'zabbix.dj-wasabi.nl',
 #   }
 #
+#
 # @example This assumes that you want to use the postgresql database. If not and  you want to supply your own database crendentials:
 #   class { 'zabbix':
 #     zabbix_url        => 'zabbix.dj-wasabi.nl',
 #     database_type     => 'mysql',
 #     database_user     => 'zabbix',
 #     database_password => 'ThisIsVeryDifficult.nl',
 #   }
+#
 # @author Werner Dijkerman [email protected]
 class zabbix (
   $zabbix_url                                                                 = '',

diff --git a/manifests/params.pp b/manifests/params.pp
@@ -296,6 +296,10 @@
   $server_nodeaddress                       = undef
 
   # Agent specific params
+  $agent_binary_location                    = $facts['kernel'] ? {
+    'Linux' => '/usr/sbin/zabbix_agentd',
+    default => undef,
+  }
   $agent_allowroot                          = '0'
   $agent_buffersend                         = '5'
   $agent_buffersize                         = '100'

diff --git a/manifests/startup.pp b/manifests/startup.pp
@@ -11,6 +11,7 @@
 # @param service_type Systemd service type
 # @param manage_database When true, it will configure the database and execute the sql scripts.
 # @param service_name Name of the service. Defaults to the resource name
+# @param binary_location This params is use for define a specific binary location. This is actually only available for zabbix agent and systemd
 # @example
 #   zabbix::startup { 'agent': }
 #
@@ -27,6 +28,7 @@
   String $service_type                                   = 'simple',
   Optional[Boolean] $manage_database                     = undef,
   Optional[String] $service_name                         = $name,
+  Optional[Stdlib::Absolutepath] $binary_location        = undef,
 ) {
   case $title.downcase {
     /agent/: {
@@ -41,8 +43,10 @@
       fail('we currently only support a title that contains agent or server')
     }
   }
-  # provided by camp2camp/systemd
   if $facts['systemd'] {
+    if $name =~ /^zabbix-agent2?$/ {
+      assert_type(Stdlib::Absolutepath, $binary_location)
+    }
     contain systemd
     systemd::unit_file { "${name}.service":
       content => template("zabbix/${service_name}-systemd.init.erb"),

diff --git a/spec/acceptance/agent_spec.rb b/spec/acceptance/agent_spec.rb
@@ -87,4 +87,120 @@ class { 'zabbix::agent':
       end
     end
   end
+
+  describe "zabbix::agent class with agent2 and zabbix_version #{version}" do
+    # <6.0 agent2 packages are not available for ubuntu 22.04
+    next if zabbix_version < '6.0' && default[:platform] =~ %r{ubuntu-22}
+
+    it 'works idempotently with no errors' do
+      pp = <<-EOS
+      class { 'zabbix::agent':
+        package_name          => 'zabbix-agent2',
+        agent_configfile_path => '/etc/zabbix/zabbix_agent2.conf',
+        agent_include         => '/etc/zabbix/zabbix_agent2.d',
+        pidfile               => '/var/run/zabbix/zabbix_agentd2.pid',
+        servicename           => 'zabbix-agent2',
+        zabbix_package_agent  => 'zabbix-agent2',
+        binary_location       => '/usr/sbin/zabbix_agent2'
+        server                => '192.168.20.11',
+        zabbix_package_state  => 'latest',
+        zabbix_version        => '#{version}',
+      }
+      EOS
+
+      prepare_host
+
+      # Run it twice and test for idempotency
+      apply_manifest(pp, catch_failures: true)
+      apply_manifest(pp, catch_changes: true)
+    end
+
+    # do some basic checks
+    describe package('zabbix-agent2') do
+      it { is_expected.to be_installed }
+    end
+
+    describe service('zabbix-agent2') do
+      it { is_expected.to be_running }
+      it { is_expected.to be_enabled }
+    end
+
+    describe file('/etc/zabbix/zabbix_agentd2.conf') do
+      its(:content) { is_expected.not_to match %r{ListenIP=} }
+    end
+
+    context 'With ListenIP set to an IP-Address' do
+      it 'works idempotently with no errors' do
+        pp = <<-EOS
+          class { 'zabbix::agent':
+            package_name          => 'zabbix-agent2',
+            agent_configfile_path => '/etc/zabbix/zabbix_agent2.conf',
+            agent_include         => '/etc/zabbix/zabbix_agent2.d',
+            pidfile               => '/var/run/zabbix/zabbix_agentd2.pid',
+            servicename           => 'zabbix-agent2',
+            zabbix_package_agent  => 'zabbix-agent2',
+            binary_location       => '/usr/sbin/zabbix_agent2'
+            server                => '192.168.20.11',
+            zabbix_package_state  => 'latest',
+            listenip              => '127.0.0.1',
+            zabbix_version        => '#{version}',
+          }
+        EOS
+        apply_manifest(pp, catch_failures: true)
+        apply_manifest(pp, catch_changes: true)
+      end
+
+      describe file('/etc/zabbix/zabbix_agent2.conf') do
+        its(:content) { is_expected.to match %r{ListenIP=127.0.0.1} }
+      end
+    end
+
+    context 'With ListenIP set to lo' do
+      it 'works idempotently with no errors' do
+        pp = <<-EOS
+          class { 'zabbix::agent':
+            package_name          => 'zabbix-agent2',
+            agent_configfile_path => '/etc/zabbix/zabbix_agent2.conf',
+            agent_include         => '/etc/zabbix/zabbix_agent2.d',
+            pidfile               => '/var/run/zabbix/zabbix_agentd2.pid',
+            servicename           => 'zabbix-agent2',
+            zabbix_package_agent  => 'zabbix-agent2',
+            binary_location       => '/usr/sbin/zabbix_agent2'
+            server                => '192.168.20.11',
+            zabbix_package_state  => 'latest',
+            listenip              => 'lo',
+            zabbix_version        => '#{version}',
+          }
+        EOS
+        apply_manifest(pp, catch_failures: true)
+        apply_manifest(pp, catch_changes: true)
+      end
+
+      context 'With ListenIP set to an IP-Address' do
+        it 'works idempotently with no errors' do
+          pp = <<-EOS
+            class { 'zabbix::agent':
+              package_name          => 'zabbix-agent2',
+              agent_configfile_path => '/etc/zabbix/zabbix_agent2.conf',
+              agent_include         => '/etc/zabbix/zabbix_agent2.d',
+              pidfile               => '/var/run/zabbix/zabbix_agentd2.pid',
+              servicename           => 'zabbix-agent2',
+              zabbix_package_agent  => 'zabbix-agent2',
+              binary_location       => '/usr/sbin/zabbix_agent2'
+              server                => '192.168.20.11',
+              zabbix_package_state  => 'latest',
+              listenip              => '127.0.0.1',
+              zabbix_version        => '#{version}',
+            }
+          EOS
+          apply_manifest(pp, catch_failures: true)
+          apply_manifest(pp, catch_changes: true)
+        end
+
+        describe file('/etc/zabbix/zabbix_agent2.conf') do
+          its(:content) { is_expected.to match %r{ListenIP=127.0.0.1} }
+        end
+      end
+    end
+  end
 end
diff --git a/spec/classes/agent_spec.rb b/spec/classes/agent_spec.rb
@@ -445,6 +445,36 @@
           it { is_expected.to contain_systemd__unit_file('zabbix-agent.service') }
         end
       end
+
+      context 'when binary_location is define', if: facts[:kernel] == 'Linux' do
+        it do
+          is_expected.to contain_zabbix__startup(service_name).with(
+            binary_location: '/usr/sbin/zabbix_agentd'
+          )
+        end
+      end
+
+      context 'when zabbix_package_agent is zabbix-agent2' do
+        let :params do
+          {
+            zabbix_package_agent: 'zabbix-agent2', startagents: 1,
+            maxlinespersecond: 1, allowroot: 1, zabbix_user: 'root',
+            loadmodulepath: '/tmp', allowkey: 'system.run[*]',
+            denykey: 'system.run[*]', enableremotecommands: 1,
+            logremotecommands: 1
+          }
+        end
+
+        it { is_expected.to contain_package('zabbix-agent2') }
+
+        it do
+          is_expected.not_to contain_file(config_path).with_content(
+            %r{^(LogRemoteCommands|StartAgents|MaxLinesPerSecond
+                 |AllowRoot|User|LoadModulePath|AllowKey|DenyKey|
+                 EnableRemoteCommands|LogRemoteCommands)}
+          )
+        end
+      end
     end
   end
 end
diff --git a/spec/classes/database_spec.rb b/spec/classes/database_spec.rb
@@ -11,9 +11,7 @@
     next if facts[:os]['name'] == 'windows'
 
     context "on #{os}" do
-      let :facts do
-        facts
-      end
+      let(:facts) { facts }
 
       let :pre_condition do
         <<-EOS

diff --git a/spec/defines/startup_spec.rb b/spec/defines/startup_spec.rb
@@ -65,7 +65,8 @@
               {
                 agent_configfile_path: '/something',
                 pidfile: '/somethingelse',
-                additional_service_params: '--foreground'
+                additional_service_params: '--foreground',
+                binary_location: '/usr/sbin/zabbix_agentd'
               }
             end
 

diff --git a/templates/zabbix-agent-systemd.init.erb b/templates/zabbix-agent-systemd.init.erb
@@ -8,7 +8,7 @@ After=network.target
 Restart=on-failure
 <% if @pidfile %>PIDFile=<%= @pidfile %><% end %>
 KillMode=control-group
-ExecStart=/usr/sbin/zabbix_agentd <%= @additional_service_params %> -c <%= @agent_configfile_path %>
+ExecStart=<%= @binary_location %> <%= @additional_service_params %> -c <%= @agent_configfile_path %>
 <% if @zabbix_user %>User=<%= @zabbix_user %><% end %>
 RestartSec=10s