DESCRIPTION


This cookbook installs zabbix-agent and zabbix-server.

By defaut the cookbook installs zabbix-agent. Check the attribute for enable/disable zabbix-server/web or disable zabbix-agent installation.

Default login password for zabbix frontend is admin/zabbix. Change it!

USAGE

Be careful when you update your server version. You need to run the sql patch in /opt/zabbix-$VERSION.

If you do not specify source_url attributes for agent or server they will be set to download the specified brance 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']['source_url'] = nil
node['zabbix']['server']['source_url'] = nil

Please include the default recipe before using any other recipe.

Installing basic agent:

"recipe[zabbix]"

Installing basic server:

"recipe[zabbix]",  
"recipe[zabbix::server]"

Installing the database :

"recipe[zabbix]",
"recipe[zabbix::database]"

Installing database and server (database must come before server):

"recipe[zabbix]",
"recipe[zabbix::database]",
"recipe[zabbix::server]"

Installing web frontend (server must be already installed):

"recipe[zabbix::web]"

NOTE:

If you are running on Redhat, Centos, Scientific or Amazon, you will need packages from EPEL. Include "recipe[yum::epel]" in your runlist or satisfy these requirements some other way.

"recipe[yum::epel]"

ATTRIBUTES

The values shown below are just examples.

Important to set on agent:

node['zabbix']['agent']['hostname'] = "<my_hostname>"
node['zabbix']['agent']['server'] = "127.0.0.1"
node['zabbix']['agent']['listen_ip'] = "<my_ip>"
node['zabbix']['web']['fqdn'] = "<fqdn_of_server>"

Other agent's attributes that may be important are:

node['zabbix']['agent']['registration'] = true # It is set to false by default
node['zabbix']['agent']['groups'] = ["Mconf"]
node['zabbix']['agent']['templates'] = ["Template Mconf"]

NOTE:

Agent does not register to server by default. It is necessary to set 'registration' to true.

Important to set on server:

node['fqdn'] = "<my_fqdn>"
node['zabbix']['agent']['server'] = "<my_ip>"
node['zabbix']['server']['install'] = true # It is set to false by default
node['zabbix']['web']['install'] = true # It is set to false by default
node['zabbix']['web']['fqdn'] = "<my_fqdn>"

Other server's attributes that may be important are:

node['zabbix']['server']['import_templates'] = true # It is set to false by default
node['zabbix']['server']['template_files'] = ["template-mconf"]
node['zabbix']['server']['import_mediatypes'] = true # It is set to false by default
node['zabbix']['server']['mediatype_files'] = ["Amazon SES"]
node['zabbix']['database']['dbpassword'] = "<my_password>"
node['zabbix']['web']['ssl']['enable'] = true # It is set to false by default

If SSL is enabled on server's web frontend (connection via HTTPS protocol), then it's necessary to set certificate attributes:

node['zabbix']['web']['ssl']['certificate_file'] = "<path to Certificate (.crt) file>"
node['zabbix']['web']['ssl']['certificate_key_file'] = "<path to private key file>"

NOTE:

Templates are not imported into server by default. It is necessary to set 'import_templates' to true and specify the templates filenames (without extension) in 'template_files' attribute. The templates files must be located at 'files/default/' as .xml.

NOTE:

If certbot cookbook is used to generate certificate, then node['zabbix']['web']['ssl']['certificate_file'] and node['certbot']['cert_path'] muste be the same. The same applies to node['zabbix']['web']['ssl']['certificate_key_file'] and node['certbot']['key_path'].

NOTE:

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

• Use a different account than that 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 (or another server interface).

Examples of installation methods:

Server

  node.set['zabbix']['server']['branch'] = "ZABBIX%20Latest%20Stable"
  node.set['zabbix']['server']['version'] = "3.0.0"
  node.set['zabbix']['server']['source_url'] = nil
  node.set['zabbix']['server']['install_method'] = "source"

Agent

  node.set['zabbix']['agent']['branch'] = "ZABBIX%20Latest%20Stable"
  node.set['zabbix']['agent']['version'] = "3.0.0"
  node.set['zabbix']['agent']['source_url'] = nil
  node.set['zabbix']['agent']['install_method'] = "prebuild"

Database

node.set['zabbix']['database']['dbname'] = "zabbix"
node.set['zabbix']['database']['dbuser'] = "zabbix"
node.set['zabbix']['database']['dbhost'] = "localhost"
node.set['zabbix']['database']['dbpassword'] = "password"
node.set['zabbix']['database']['dbport'] = "3306"
node.set['zabbix']['database']['dbsocket'] = "/var/run/mysql-default/mysqld.sock"

If you are using AWS RDS

node.set['zabbix']['database']['install_method'] = "rds_mysql"
node.set['zabbix']['database']['rds_master_user'] = "username"
node.set['zabbix']['database']['rds_master_password'] = "password"

Configuration attributes

It is possible to set any of parameters supported by Zabbix agent and server in version 3.0.0. These configuration parameters will be placed at the configuration files /etc/zabbix/zabbix_agentd.conf and /etc/zabbix/zabbix_server.conf respectively.

A complete list of parameters for agent and server can be found here for agent and here for server.

For instance, if you want to set CacheSize to 10M for Zabbix server, you can set

node['zabbix']['server']['cache_size'] = "10M"

RECIPES

default

The default recipe creates the Zabbix user and directories used by all Zabbix components.

Optionally, it installs the Zabbix agent.

You can control the agent install with the following attributes:

node['zabbix']['agent']['install'] = true
node['zabbix']['agent']['install_method'] = 'source'

agent_prebuild

Downloads and installs the Zabbix agent from a pre built package

If you are on a machine in the RHEL family of platforms, then you must have your package manager setup to allow installation of:

package "redhat-lsb"

You can control the agent version with:

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

agent_source

Downloads and installs the Zabbix agent from source

If you are on a machine in the RHEL family of platforms, then you will need to install packages from the EPEL repository. The easiest way to do this is to add the following recipe to your runlist before zabbix::agent_source

recipe "yum::epel"

You can control the agent install with:

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

database

WARNING: This recipe persists your database credentials back to the Chef server as plaintext node attributes. To prevent this, consume the zabbix_database LWRP in your own wrapper cookbook.

Creates and initializes the Zabbix database. It currently uses mconf-db to install MySQL.

Currently it only supports MySQL and RDS MySQL databases.

If they are not already set, this recipe will generate the following attributes:

node['zabbix']['database']['dbpassword']
node['mysql']['server_root_password'] # Not generated if you are using RDS

You can control the database version with:

node['zabbix']['server']['branch']
node['zabbix']['server']['version']

The database setup uses the following attributes:

node['zabbix']['database']['dbhost']
node['zabbix']['database']['dbname']
node['zabbix']['database']['dbuser']
node['zabbix']['database']['dbpassword']
node['zabbix']['database']['dbsocket']

node['zabbix']['database']['install_method']

If install_method is 'mysql' you also need:

node['mysql']['server_root_password']

If install_method is 'rds_mysql' you also need:

node['zabbix']['database']['rds_master_username']
node['zabbix']['database']['rds_master_password']

firewall

Opens firewall rules to allow Zabbix nodes to communicate with each other.

server

Delegates to other recipes to install the Zabbix server and web frontend components.

You can control the server and web installs with the following attributes:

node['zabbix']['server']['install'] = true
node['zabbix']['server']['install_method'] = 'source'
node['zabbix']['web']['install'] = true

You can also enable template importing to server with:

node['zabbix']['server']['import_templates'] = true

server_source

Downloads and installs the Zabbix server component from source.

If you are on a machine in the RHEL family of platforms, then you will need to install packages from the EPEL repository. The easiest way to do this is to add the following recipe to your runlist before zabbix::server_source:

recipe "yum::epel"

You can control the server install with:

node['zabbix']['server']['branch']
node['zabbix']['server']['version']
node['zabbix']['server']['configure_options']

The server also needs to know about:

node['zabbix']['database']['dbhost']
node['zabbix']['database']['dbname']
node['zabbix']['database']['dbuser']
node['zabbix']['database']['dbpassword']
node['zabbix']['database']['dbport']
node['zabbix']['database']['dbsocket']

web

Creates an Apache site for the Zabbix web frontend component.

It is included by server recipe by default. If you do not want the web frontend to be installed, set:

node['zabbix']['web']['install'] = false

LWRPs

database

resources/database

Installs the Zabbix database.

The default provider is Chef::Provider::ZabbixDatabaseMySql in "providers/database_my_sql". If you want a different provider, make sure you set the following in your resource call.

provider Chef::Provider::SomeProviderClass

Actions

• create (Default Action) - Creates the Zabbix Database

Attributes

• dbname (Name Attribute) - Name of the Zabbix database to create
• host - Host to create the database on
• port - Port to connect to the database over
• socket - Socket to connect to the database with
• username - Name of the Zabbix database user
• password - Password for the Zabbix database user
• root_username - Name of the root user for the database server
• root_password - Password for the database root user
• allowed_user_hosts (Default: '') - Where users can connect to the database from
• server_branch - Which branch of server code you are using
• server_version - Which version of server code you are using
• source_dir - Where Zabbix source code should be stored on the host
• install_dir - Where Zabbix should be installed to

providers/database_my_sql

Installs a MySQL or RDS MySQL Zabbix database.

This is the default provider for resources/database.

If you are using MySQL make sure you set:

root_username "root"
root_password "<your_root_password>"

If you are using RDS MySql make sure you set:

root_username "<your_rds_master_username>"
root_password "<your_rds_master_password>"

providers/database_postgres

Installs a Postgres Zabbix database.

Call the zabbix_database resource with:

provider Chef::Provider::ZabbixDatabasePostgres

Make sure you set:

root_username 'postgres'
root_pasword  '<your_postgres_admin_password>'

The allowed_user_hosts attribute is ignored

resources/source

Fetchs the Zabbix source tar and does something with it.

Actions

• extract_only (Default Action) - Just fetch and extract the tar
• install_server - Fetch the tar then compile the source as a Server
• install_agent - Fetch the tar then compile the source as an Agent

Attributes

• name (Name Attribute) - An arbitrary name for the resource
• branch - The branch of Zabbix to grab code for
• version - The version of Zabbix to grab code for
• code_dir - Where Zabbix source code should be stored on the host
• target_dir - A sub directory under code_dir where you want the source extracted
• install_dir (Optional) - Where Zabbix should be installed to
• configure_options (Optional) - Flags to use when compiling Zabbix

providers/source:

Default implementation of how to fetch and handle the Zabbix source code.

resources/configuration

Allows template importing into zabbix server.

Actions

• import (Default action) - Import templates files located at 'files/default/' into server

Attributes

• name (Name attribute) - An arbitrary name for the resource
• server_connection - Server's information to connect to
• format (Default: 'xml') - Format of template source
• source - Template serialized string

providers/configuration

Default implementation of how to import templates into Zabbix server. It is done via Zabbix API.

TODO

• Support more platform on agent side windows ?
• LWRP Magic ?

CHANGELOG

0.8.0

• This version is a big change with a lot of bugfix and change. Please be careful if you are updated from previous version

0.0.42

• Adds Berkshelf/Vagrant 1.1 compatibility (andrewGarson)
  • Moves recipe[yum::epel] to a documented runlist dependency instead of forcing you to use it via include_recipe

0.0.41

• Format metadata and add support for Oracle linux (Thanks to tas50 and his love for oracle Linux)
• Fix about redhat LSB in agent-prebuild recipe (Thanks nutznboltz)
• Fix Add missing shabang for init file. (Thanks justinabrahms)
  • Fix FC045 foodcritic
  • new dependencies version on database and mysql cookbook
• Add support for custom config file location to zabbix_agentd.init-rh.erb (Thanks charlesjohnson)

0.0.40

• Refactoring for passing foodcritic with help from dkarpenko
• Added new attribute for server service : log_level
• Added new attribute for server service : max_housekeeper_delete & housekeeping_frequency
• Modified firewall recipe to accept connection to localhost zabbix_server

0.0.39

• Added zabbix bin patch in init script (deprecate change made in 0.0.38)
  • Changed default zabbix version to 2.0.3

0.0.38

• Added zabbix_agent bin dir into PATH for Debian/Ubuntu (Some script need zabbix_sender)

0.0.37

• Having run dir in /tmp is not so good (Guilhem Lettron)

0.0.36

• added restart option to zabbix_agentd service definitions (Paul Rossman Patch)

0.0.35

• Fix from Amiando about server_alias how should be a Array.
• Fix from Guilhem about default run_dir be /tmp,it can be a big problem.

0.0.34

• remove the protocol filter on firewall.

0.0.33

• Added ServerActive configuration option for Zabbix agents (Paul Rossman Patch)

0.0.32

• Fix a issue about order in the declaration of service and the template for recipes agent_*

0.0.31

• Readme typo

0.0.30

• Thanks to Paul Rossman for this release
• Zabbix default install version is now 2.0.0
• Option to install Zabbix database on RDS node (default remains localhost MySQL)
  • MySQL client now installed with Zabbix server
  • Added missing node['zabbix']['server']['dbport'] to templates/default/zabbix_web.conf.php.erb
  • Fixed recipe name typo in recipes/web.rb

0.0.29

• Thanks to Steffen Gebert for this release
• WARNING! this can break stuff : typo error on attribute file default['zabbix']['agent']['server'] -> default['zabbix']['agent']['servers']
• Evaluate node.zabbix.agent.install as boolean, not as string
• Respect src_dir in mysql_setup

0.0.28

• Thanks to Steffen Gebert for this release
• Use generic sourceforge download URLs
• Fix warning string literal in condition
• Deploy zabbix.conf.php file for web frontend
• Add "status" option to zabbix_server init script
• Make MySQL populate scripts compatible with zabbix 2.0
• Add example for Chef Solo usage to Vagrantfile

0.0.27

• Configuration error about include_dir in zabbix_agentd.conf.erb

0.0.26

• zabbix agent and zabbix server don't want the same include_dir, be careful if you use include_dir
• noob error on zabbix::server

0.0.25

• Don't try to use String as Interger !

0.0.24

• Markdown Format for Readme.md

0.0.23

• Some Foodcritic

0.0.22

• Bug in metadata dependencies
• Firewall does not fix the protocol anymore

0.0.21

• Added Patch from Harlan Barnes [email protected] his patch include centos/redhat zabbix_server support.
• Added Patch from Harlan Barnes [email protected] his patch include directory has attribute.
• Force a minimum version for apache2 cookbook

0.0.20

• Added Patch from Harlan Barnes [email protected] his patch include centos/redhat zabbix_agent support.

0.0.19

• Fix README

0.0.18

• Fix sysconfdir to point to /etc/zabbix on recipe server_source
• Fix right for folder frontends/php on recipe web
• Hardcode the PATH of conf file in initscript
• Agent source need to build on a other folder
• Add --prefix option to default attributes when using *-source recipe

0.0.17

• Don't mess with te PID, PID are now in /tmp

0.0.16

• Add depencies for recipe agent_source
• Add AlertScriptsPath folder and option for server.

0.0.15

• Add firewall magic for communication between client and server

0.0.14

• Correction on documentation

0.0.13

• Fix some issue on web receipe.

0.0.12

• Change default value of zabbix.server.dbpassword to nil

0.0.11

• Remove mikoomo
• Still refactoring

0.0.10

• Preparation for multiple type installation and some refactoring
• Support the installation of a beta version when using the install_method == source and changing the attribute branch

0.0.9

• Tune of mikoomi for running on agent side.

0.0.8

• Fix some major issu

0.0.7

• Add some love to php value
• Now recipe mysql_setup populate the database
• Minor fix

0.0.6

• Change the name of the web_app to fit the fqdn