Chef Cookbook - zabbix-agent


This cookbook installs and configures the zabbix-agent with sane defaults and very minimal dependancies.

Supported OS Distributions

• RHEL/CentOS 6, 7
• Ubuntu 10.04 12.04 14.04
• Debian 6.0.10 7.8
• (soon) fedora
• (soon) opensuse
• (planned) freebsd
• Windows 2012R2, 2016

Other similar versions will likely work as well but are not regularly tested.

USAGE

If you have a supported OS, internet access, and a searchable DNS alias for "zabbix" that will resolve to your zabbix server this cookbook will work with no additional changes. Just include recipe[zabbix-agent] in your run_list.

Otherwise you will need to modify this to point to your zabbix server:

node['zabbix']['agent']['servers'] = 'zabbix-server.yourdomain.com'

and

default['zabbix']['agent']['package']['repo_uri'] = 'http://private-repo.yourdomain.com'
default['zabbix']['agent']['package']['repo_key'] = 'http://private-repo.yourdomain.com/path-to-repo.key'

or try one of the other install methods

Other recomended cookbooks

• libzabbix - in development LWRPs to auto regester and setup monitoring for hosts
• zabbix-server - install configure Zabbix server - planned
• zabbix-web - install configure Zabbix web frontend - planned

zabbix_agentd.conf file

All attributes in the zabbix_agentd.conf file can be controlled from the:

node['zabbix']['agent']['conf']

attribute. This will require a change in attribute naming for upgrades from 0.9.0.

default['zabbix']['agent']['conf']['Timeout'] = '10'

or

---
{
  "default_attributes": {
    "zabbix": {
      "agent": {
        "conf": {
          "Server": ["zabbix.example.com"],
          "Timeout": "10"
        }
      }
    }
  }
}

Default Install, Configure and run zabbix agent

Install packages from repo.zabbix.com and run the Agent:

{
  "run_list": [
    "recipe[zabbix-agent]"
  ]
}

Selective Install or Install and Configure (don't start zabbix-agent)

Alternatively you can just install, or install and configure:

{
  "run_list": [
    "recipe[zabbix-agent::install]"
  ]
}

or

{
  "run_list": [
    "recipe[zabbix-agent::configure]"
  ]
}

ATTRIBUTES

Install Method options are:

node['zabbix']['agent']['install_method'] = 'package' # Default
node['zabbix']['agent']['install_method'] = 'source'
node['zabbix']['agent']['install_method'] = 'prebuild'
node['zabbix']['agent']['install_method'] = 'cookbook_file' # not yet implemented
node['zabbix']['agent']['install_method'] = 'chocolatey' # Default for Windows

# skip is preferred if no internet access when provisioning
# zabbix agent was already installed via chef during image bake process
node['zabbix']['agent']['install_method'] = 'skip'

Version

node['zabbix']['agent']['version'] # Default 3.0.9

Servers

node['zabbix']['agent']['conf']['Server'] = ["Your_zabbix_server.com","secondaryserver.com"]
    # defaults to zabbix
node['zabbix']['agent']['conf']['ServerActive'] = ["Your_zabbix_active_server.com"]

Package install

If you do not set any attributes you will get an install of zabbix agent version 3.0.9 with what should be a working configuration if your DNS has aliases for zabbix.yourdomain.com and your hosts search yourdomain.com.

Source install

If you do not specify source_url attributes for agent it will be set to download the specified branch and version from the official Zabbix source repository. If you want to upgrade later, you need to either nil out the source_url attributes or set them to the URL you wish to download from.

node['zabbix']['agent']['version']
node['zabbix']['agent']['configure_options']

to install an alternative branch or tar file you can specify it here

node['zabbix']['agent']['source_url'] = "http://domain.com/path/to/source.tar.gz"

Prebuild install

The current latest prebuild is behind the source and packaged versions. You will need to set

node['zabbix']['agent']['version']

to the version you wish to be installed.

Cookbook file install

This will install a provided package that can be included in the ./files directory of the cookbook itself and stored on the chef server.

Chocolatey install

Currently untested. Pull requests and kitchen tests desired.

Note :

A Zabbix agent running on the Zabbix server will need to :

• use a different account than the one the server uses or it will be able to spy on private data.
• specify the local Zabbix server using the localhost (127.0.0.1, ::1) address.

RECIPES

default

The default recipe installs, configures and starts the zabbix_agentd.

You can control the agent install with the following attributes:

node['zabbix']['agent']['install_method'] = 'package' # Default

or node['zabbix']['agent']['install_method'] = 'source' or node['zabbix']['agent']['install_method'] = 'prebuild' or node['zabbix']['agent']['install_method'] = 'cookbook_file' # not yet implemented

service

Controls the service start/stop/restart

configure

applies the provided attributes to the configurable items

install

Installs the cookbook based on the 'install_method'. Includes one of the following recipes

install_source

Downloads and installs the Zabbix agent from source

install_package

Sets up the Zabbix default repository and installs the agent from there

install_prebuild

Downloads the Zabbix prebuilt tar.gz file and installs it

install_chocolatey

Needs testing

LWRPs

The LWRPs have been moved to the libzabbix cookbook. https://github.com/TD-4242/cookbook-libzabbix

Testing

To run the tests, insure you meet the below dependancies, then just run rake in the root of the cookbook

• Linux, MacOS X
  • Chef-DK - https://downloads.chef.io/chef-dk/ - 0.4.0
  • VirtualBox - https://www.virtualbox.org/wiki/Downloads - 4.3.24
  • Vagrant - https://www.vagrantup.com/downloads - 1.7.2
    • vagrant plugins:
      • vagrant-berkshelf
      • vagrant-omnibus
      • vagrant-chef-zero
      • vagrant-share
      • vagrant-login
• Windows
  • run rake windows to test Windows 2012R2 and 2016

TODO

• Verify and test on freebsd
• Add cookbook_file install method

CHANGELOG

0.14.0

• upgrade to default client version 3.0.9
• move kitchen to docker so it can be run in travisci

0.13.0

0.12.0

• include kitchen tests for all supported OS types
• upgrade to default client version 2.4.4
• cleanup source compile dependancies
• added debian as supported
• added more distributions and versions to kitchen testing
• many bug fixes for diffrent distribution versions

0.11.0

• Move LWRPs to their own cookbook to clean up zabbix-agent
• Clean up linting and unit tests

0.10.0

• Upgrading from 0.9.0 may require some slight changes to attribute names that control the configuration file.
• Migrate zabbix_agentd.conf to a fully dynamically generated template
• Include many more tests
• General clean-up of code

0.9.0

• Major refactor of all code.
• Rename cookbook to zabbix-agent, strip out all server, web, java-gateway dependencies.
• Add default code path chefspec tests
• Update kitchen tests
• Added package install from repo.zabbix.com
• Rename many cookbooks to follow a Install->Configure->Service design pattern.

0.8.0 forked from https://github.com/laradji/zabbix see this page for historical change log