cookbook 'icinga2', '= 2.3.1'
icinga2
(32) Versions
2.3.1
-
Follow19
Installs/Configures Icinga2
cookbook 'icinga2', '= 2.3.1', :supermarket
knife supermarket install icinga2
knife supermarket download icinga2
icinga2 Cookbook
This is a Chef cookbook to manage Icinga2 using Chef LWRP.
More features and attributes will be added over time, feel free to contribute
what you find missing!
Repository
https://github.com/icinga/chef-icinga2
Chef Super Market
https://supermarket.chef.io/cookbooks/icinga2
Issue Tracking
For issue reporting or any discussion regarding this cookbook, open an issue at Dev Icinga. New users need to Register first.
Contributing
- Open Bug / Feature issue at Dev Icinga
- Fork the repository on Github
- Create a named feature branch (like
add_component_x
) - Write your change
- Write tests for your change (if applicable)
- Run the tests (
rake
), ensuring they all pass - Write new resource/attribute description to
README.md
- Write description about changes to PR along with Dev Icinga issue #
- Submit a Pull Request using Github
TODO
- classic ui setup is incomplete for ubuntu/debian platform
- add chef node zone/endpoint objects for icinga2 agent setup
- add lwrp envendpoint / envzone lwrp for environment resource
Major Changes
v2.0.1
icinga web2 uri updated to
/icingaweb2
epel repository is by default enabled for rhel platform family except amazon platform
v0.10.1
- Deprecated node features attribute and recipe
icinga2::server_features
in favour of LWRPfeature
v0.7.0
- LWRP
environment
now generates different conf file with zone name if resource attributezone
is defined
file name:
file name without zone: host_#{environment}.conf
file name with zone: host_#{environment}_#{zone}.conf
Note: Cookbook version prior to v0.7.0 users must delete
configuration filehost_#{environment}.conf
manually if
zone
attribute is defined.
Cookbook Dependencies
-
ulimit
cookbook -
apache2
cookbook -
yum
cookbook -
yum-epel
cookbook -
apt
cookbook -
pnp4nagios
cookbook
Recipes
icinga2::default
- does not do anything, used for LWRP usageicinga2::server
- install & configure icinga2 server with default icinga Objectsicinga2::server_apache
- manages apache and icinga2 classic ui / web / web2 vhost usingapache2
cookbookicinga2::server_os_packages
- install os packages for icinga2icinga2::server_install
- install icinga2 core/ido server packagesicinga2::server_core
- configures icinga2 core configuration files & directoriesicinga2::server_ido_schema
- load icinga2 ido db schemaicinga2::server_classic_ui
- configures icinga2 classic uiicinga2::server_web2
- configures icingaweb2icinga2::server_pnp
- configures pnp4nagios for icinga2icinga2::server_objects
- manages icinga2 default objects/templates objects ifnode['icinga2']['disable_conf_d']
is set in which caseconf.d
objects config is not included inicinga2.conf
and objects are created using LWRPicinga2::server_object_host
- creates icinga2generic-host
Host
templateicinga2::server_object_notificationcommand
- creates icinga2 defaultNotificationCommand
objectsicinga2::server_object_service
- creates icinga2 defaultgeneric-service
Service
templatesicinga2::server_object_timeperiod
- creates icinga2 defaultTimePeriod
objectsicinga2::server_object_user
- creates icinga2generic-user
User
template andicingaadmin
User
objecticinga2::server_object_usergroup
- creates icinga2icingaadmins
UserGroup
object
Attributes
icinga2::default
- icinga2 server default attributes fileicinga2::repo
- icinga2 yum/apt repositories file for packages installicinga2::server_classic_ui
- icinga2 server classic ui default attributes fileicinga2::server_constants
- icinga2 server constants parameters fileicinga2::server_objects
- icinga2 objects default attributes fileicinga2::server_ido
- icinga2 ido db default attributes fileicinga2::server_web2
- icinga2 web2 ui default attributes file
Supported Icinga Version
This cookbook is being developed for Icinga2 - v2.2.x primarily on Amazon Platform (EPEL Release 6 Package).
Supported Icinga2 Install Types
Currently Icinga2 installation is supported ONLY via Repository Packages, as it is a recommended best practice.
Icinga2 Server Setup
To setup icinga2 server on a node, add recipe icinga2::server
which will install necessary packages and configuration files.
Icing2 with PNP4Nagios
Recipe icinga2::server_pnp
setup and configures PNP4Nagios
along with rrdtool
.
Simply add recipe icinga2::server_pnp
to icinga2 server run_list
to setup PNP4Nagios
along with rrdcached
.
For PNP4Nagios cookbook pnp4nagios
is used and for RRDTool cookbook rrdtool
is used.
Icinga2 Agent Client
NRPE Client recipe was removed from this cookbook in favour of nrpe
cookbook.
Icinga2 Agent setup will be added soon.
Icinga2 Web / Classic UI engine
Currently this cookbook only supports Apache
as Web engine and configuration is managed by cookbook apache2
.
Web engine is configurable by node attribute node['icinga2']['web_engine']
, defaults to apache
.
Icinga2 Classic UI
Icinga2 Classic UI is enabled by default and set as default UI.
However, Classic UI can be disabled by attribute node['icinga2']['classic_ui']['enable']
.
How to add users for icinga2 Classic UI
Icinga2 Classic UI users is controlled by node Hash attribute node['icinga2']['classic_ui']['users']
. This attribute accepts a Hash
of username => htpasswd(passwd)
, so that password is not available in plain text.
By default icingaadmin
user is added with password icingaadmin
:
default['icinga2']['classic_ui']['users'] = {
'icingaadmin' => '$apr1$MZtKRLAy$AV9OiJ.V/mI9g30bHn9ol1'
}
Override it if required in wrapper cookbook or role or environment.
To add more users for icinga2 Classic UI auth, add new users to Hash attribute in the same way icingaadmin
user is added
default['icinga2']['classic_ui']['users']['user_name'] = '$apr1$MZtKRLAy$AV9OiJ.V/mI9g30bHn9ol1'
Icinga2 Classic UI Authorization
Icinga2 Classic UI User authorization is managed by below node Array attributes:
node['icinga2']['classic_ui']['authorized_for_system_information']
node['icinga2']['classic_ui']['authorized_for_configuration_information']
node['icinga2']['classic_ui']['authorized_for_full_command_resolution']
node['icinga2']['classic_ui']['authorized_for_system_commands']
node['icinga2']['classic_ui']['authorized_for_all_services']
node['icinga2']['classic_ui']['authorized_for_all_hosts']
node['icinga2']['classic_ui']['authorized_for_all_service_commands']
node['icinga2']['classic_ui']['authorized_for_all_host_commands']
By simply adding users to above attributes will provide necessary access to the UI.
How to add a guest user
To add a guest user without any admin privileges, first add a guest
user (with password guest
)
default['icinga2']['classic_ui']['users']['guest'] = '$apr1$cA/eVUgT$aIoWUPwV5uONJoYslb7lg0'
Then authorise guest
user to view Host/Service
status
node['icinga2']['classic_ui']['authorized_for_all_services'] = %w(icingaadmin guest)
node['icinga2']['classic_ui']['authorized_for_all_hosts'] = %w(icingaadmin guest)
How to add an admin user
To make a user admin
, add the user to below node attributes:
node['icinga2']['classic_ui']['authorized_for_system_information']
node['icinga2']['classic_ui']['authorized_for_configuration_information']
node['icinga2']['classic_ui']['authorized_for_full_command_resolution']
node['icinga2']['classic_ui']['authorized_for_system_commands']
node['icinga2']['classic_ui']['authorized_for_all_services']
node['icinga2']['classic_ui']['authorized_for_all_hosts']
node['icinga2']['classic_ui']['authorized_for_all_service_commands']
node['icinga2']['classic_ui']['authorized_for_all_host_commands']
Icinga2 Server IDO Schema Load
Icinga2 IDO setup & feature is disabled by default. It can be enabled by configuring node attribute node['icinga2']['ido']['load_schema']
.
Recipe icinga::server_ido_schema
only create DB schema, it does not create database or user or grants etc.
IDO schema files are stored by default under directory /usr/share/icinga2-ido-mysql
and /usr/share/icinga2-ido-pgsql
.
Icinga2 IDO type is configurable by node attribute node['icinga2']['ido']['type']
, which can be configured to mysql
or pgsql
.
ido pgsql schema upload is not fully tested, please open an issue if encounter any problem.
Icinga Web2 Setup
Icingaweb2 is not enabled by default. It can be enabled by configuring node attribute node['icinga2']['web2']['enable']
.
Icingaweb2 can also be enabled by including recipe icinga2::server_web2
to node run_list
.
Recipe icinga::server_web2
configures below items.
- create config directory
/etc/icingaweb2
- create token file
/etc/icingaweb2/setup.token
- create log directory
/var/log/icingaweb2
Rest of the configuration can be completed by browsing icingaweb2 Web UI http://server/icingaweb
.
Icinga2 Cluster Deployment
Icinga2 Distributed / HA cluster setup examples will be added soon.
Icinga2 Monitor a Chef Environment Nodes
This cookbook does not only provide management of Icinga2 server & objects, it also provides
automation around Chef environment.
Using LWRP environment
a whole environment nodes can be added to Host
objects with environment wide Host
object parameters.
There are certain functionalities added to LWRP environment
, like:
define icinga2
Host
parameters for an entire environmentauto create
HostGroup
object for an entire chef environmentauto create
HostGroup
object for node'sapplication
attribute to group nodes for an entire chef environmentapplication
typeauto create
HostGroup
object for node'scluster
attribute to group nodes for a chef environmentcluster
auto add chef node Cloud attributes as
Host
customvars
, currently only AWS EC2 attributes are supported, but is easy to extend the support to other cloud providersauto create
HostGroup
list for a chef environment nodelimit a chef environment spreaded across multiple regions to icinga2 server region, e.g. in multi region ec2 production environment, one would want to setup an icinga2 server in region
us-east-1
just to monitorus-east-1
nodes, but not the production nodes of other regions, likeap-southeast-1
allow chef node to determine
host.address
fromnode['fqdn']
DNS resolution instead ofnode['ipaddress']
and either ignore chef node if failed to resolve DNS or fallback to usenode['ipaddress']
ashost.address
exclude a node by
run_list
role, not yet testedexclude a node by
run_list
role, not yet testedfilter chef node if match certain node attributes
override an environment and use an entire different
search_pattern
, this feature extends LWRPenvironment
functionality to select nodes by a user given search patternHost
object attributedisplay_name
is set to chef node hostname
Simply create a LWRP resource for a chef environment, to start monitoring all nodes in that environment. More details can be found in examples.
Icinga2 Monitor an User Defined Chef Environment Nodes/HostGroups
Last section explains the benefits of using LWRP environment
using in built library search function to determine chef_environment
nodes / icinga2 Host and auto create icinga2 HostGroup.
This section explains how a user can provide a custom inventory list of nodes, host groups etc.
To find all the valid chef nodes for a chef environment, this cookbook uses default library icinga2::search
. There are lots of custom & cloud specific attributes embedded in it which may or may not work for every scenarios.
To overcome and make it less enforcing, LWRP environment
has a Hash attribute env_resources
which can be used by an user from a wrapper cookbook recipe to pass chef environment nodes & hostgroups. If this attribute is set, cookbook will not use default library to search chef_environment nodes and will create Host objects for user defined values.
env_resources
Hash attributes has below valid key names:
- nodes - Hash of {:Hostfqdn => {icinga2 Host attributes}, :Hostfqdn => {icinga2 Host attributes}, …}
- clusters - Array of cluster HostGroups […] if any
- applications - Array of application HostGroups […] if any
- roles - Array of roles HostGroups […] if any
e.g.
icinga2_environment 'UserDefinedEnvironment' do
import node['icinga2']['server']['object']['host']['import']
environment 'production'
check_interval '1m'
retry_interval '10s'
max_check_attempts 3
action_url '/pnp4nagios/graph?host=$HOSTNAME$&srv=_HOST_'
env_resources :nodes => {:fqdn => {attrs}, :fqdn => {attrs}}
end
For more details about nodes attributes, check LWRP environment
object tempalte.
Like
env_resources
, user can also define custom template for LWRPenvironment
using attributecookbook
andtemplate
.
Icinga2 Host Custom Vars
environment LWRP Host Vars
LWRP environment
resources sets Host custom vars for each node via node Hash
attribute -
node['icinga2']['client']['custom_vars']
. All defined vars
will be added to Host
object.
host LWRP Host Vars
When using icinga2_host
LWRP, node custom vars will not be added automatically. There will be no search performed as the Host
object could be different than a chef Node
.
To add Host
custom vars, use Hash attribute custom_vars
.
A resource attribute will be added to icinga2_host
LWRP to perform a search to fetch custom vars defined for a node, so that manual addition is not required.
icinga2 User Defined Objects / Configuration
A configuration directory is created under /etc/icinga2
for user to put configuration not default to icinga2
or LWRP.
Directory name is configurable using node attribute node['icinga2']['user_defined_objects_d']
.
This is just to keep user custom defined configuration, it is included in icinga2.conf
.
LWRP Examples
Different LWRP usage examples are added to examples
directory.
To configure icinga2 server, check examples/icinga2_server
directory. More examples will be added as we go.
LWRP 'assign where' and 'ignore where' statements
assign where (icinga) == assign_where (LWRP)
ignore where (icinga) == ignore_where (LWRP)
assign where
statements are defined as a LWRP resource Array
attribute -assign_where
. Each array element is treated as a different assign where
statement and LWRP creates a separate statement.
e.g.
assign_where ['host.address',
'host.vars.nrpe && host.vars.enable_check',
'host.vars.application == "redis"'
]
Above LWRP resource will be applied to an Object
as shown below:
assign where host.address
assign where host.vars.nrpe && host.vars.enable_check
assign where host.vars.application == "redis"
Similarly, ignore where
statements are created using LWRP resource Array
attribute ignore_where
.
icinga2 LWRP Resources
Currently icinga2 cookbook supports below Objects LWRP Resources:
- icinga2_apilistener
- icinga2_applynotification
- icinga2_applyservice
- icinga2_checkcommand
- icinga2_endpoint
- icinga2_envhostgroup
- icinga2_environment
- icinga2_eventcommand
- icinga2_externalcommandlistener
- icinga2_feature
- icinga2_gelfwriter
- icinga2_graphitewriter
- icinga2_host
- icinga2_hostgroup
- icinga2_idomysqlconnection
- icinga2_idopgsqlconnection
- icinga2_notification
- icinga2_notificationcommand
- icinga2_scheduleddowntime
- icinga2_service
- icinga2_servicegroup
- icinga2_sysloglogger
- icinga2_timeperiod
- icinga2_user
- icinga2_usergroup
- icinga2_zone
- icinga2_livestatuslistener
- icinga2_statusdatawriter
- icinga2_compatlogger
- icinga2_checkresultreader
- icinga2_checkercomponent
- icinga2_notificationcomponent
- icinga2_filelogger
- icinga2_perfdatawriter
Note:
Few of LWRP attributes which are required to create an icinga2 Object are not declared
:required => true
in LWRP in favour of creating icinga2 Object template.Same LWRP resource used to create icinga2
Object
, can also be used to create icinga2Template
as well.Few of LWRP resource attributes which refers to icinga2
constants
or can refer toconstants
are treated as literalString
. It means they will not be transformed into rubyString
by LWRP while creating configuration file.
e.g.
Below attribute definition generate correct syntax for ApiListener
LWRP attribute cert_path
:
cert_path 'SysConf + "/icinga2/pki/" + NodeName + ".crt"'
will transform to:
cert_path SysConf + "/icinga2/pki/" + NodeName + ".crt"
While below attribute definition generate incorrect syntax:
cert_path 'SysConf + /icinga2/pki/ + NodeName + .crt'
will transform to
cert_path SysConf + /icinga2/pki/ + NodeName + .crt
icinga2 LWRP Resources Generated Object/Template File
LWRP Resource Object Config File Location
Icinga2 Object
created by LWRP are stored under a separate directory objects.d
. Directory name is configurable by node attribute node['icinga2']['objects_d']
.
This directory is created under icinga2 config directory node['icinga2']['conf_dir']
.
LWRP Resource Object/Template Config File Name Convention
A LWRP generated icinga2 Object's
are stored into a single file. It means each LWRP has its own conf file.
As few of LWRP can create an Object
and Template
, below conf file name convention is followed through out LWRP resources.
Object conf file : "#{LWRP_NAME}.conf".
Template conf file : "#{LWRP_NAME}_template.conf".
e.g.
LWRP `icinga2_host` object resources will create icinga2
`Host` objects conf file - /etc/icinga2/objects.d/host.conf
LWRP `icinga2_service` object resources will create icinga2
`Service` objects conf file - /etc/icinga2/objects.d/service.conf
LWRP `icinga2_service` template resources will create icinga2
`Service` templates conf file - /etc/icinga2/objects.d/service_template.conf
LWRP `icinga2_applyservice` resources will create icinga2
`apply Service` conf file - /etc/icinga2/objects.d/applyservice.conf
and so on ..
All LWRP generated icinga2 object/template/apply conf files are kept in a single directory and managed separately.
Default icinga2 /etc/icinga2/{conf.d,zones.conf}
As this cookbook supplies almost all necessary LWRP for icinga2 feature, object, template etc. it is a good practice and safe to say to use LWRP instead of managing configuration /etc/icinga2/conf.d
or /etc/icinga2/zones.conf
default configuration files.
Note: Default configuration files managed by cookbook:
- /etc/icinga2/constants.conf
- /etc/icinga2/icinga2.conf
- /etc/icinga2/init.conf
icinga2.conf
no longer includes zones.conf
in favour of LWRP.
LWRP icinga2_environment
As mentioned in a section above, instead of creating Host
objects for each chef node, using LWRP environment
Host
objects can easily be created for all chef nodes for a chef environment.
LWRP resource attributes are common for all the Host
. It may be required to define or override attribute for few specific Host
objects, but it is not yet incorporated or foreseen any usage at this point which might change over time.
LWRP generated config file
There are two files generated by LWRP environment
:
if zone is not defined -
host_#{*environment*}.conf
if zone is defined:
host_#{environment*}_#{*zone*}.conf
Note: Cookbook version prior to v0.7.0 might require to manually delete configuration file
host_#{*environment*}.conf
if zone is defined.
LWRP example
icinga2_environment 'SingaporeDevelopment' do
import node['icinga2']['server']['object']['host']['import']
environment 'development'
limit_region true
ignore_resolv_error true
enable_cluster_hostgroup true
enable_application_hostgroup true
cluster_attribute 'flock'
application_attribute 'application'
check_interval '1m'
retry_interval '10s'
max_check_attempts 3
action_url '/pnp4nagios/graph?host=$HOSTNAME$&srv=_HOST_'
end
Above LWRP resource will create Host
objects for a chef environment nodes for a given search_pattern
and other filter.
LWRP Options
- action (optional) - default :create, options: :create, :delete, :reload
- environment (required, String) - chef environment name
- cookbook (optional, String) - default icinga2, chef cookbook name for template
- template (optional, String) - default object.environment.conf.erb, chef template name
- search_pattern (optional, String) - chef search pattern for given environment
- env_resources (optional, Hash) - user provided Hash for environment nodes and host groups etc., overrides default chef search nodes inventory
-
cluster_attribute (optional, String) - chef node cluster attribute to create hostgroup and
Host
vars -
application_attribute (optional, String) - chef node application attribute to create hostgroup and
Host
vars -
enable_cluster_hostgroup (optional, TrueClass/FalseClass) - whether to create
HostGroup
objects for chef node cluster's -
enable_application_hostgroup (optional, TrueClass/FalseClass) - whether to create
HostGroup
objects for chef node application's -
enable_role_hostgroup (optional, TrueClass/FalseClass) - whether to create
HostGroup
objects for chef node run_list role -
use_fqdn_resolv (optional, TrueClass/FalseClass) - whether to use DNS FQDN resolved address for
Host
object attributeaddress
-
failover_fqdn_address (optional, TrueClass/FalseClass) - whether to use chef node attribute
node['ipaddress']
if failed to resolve node FQDN - ignore_resolv_error (optional, TrueClass/FalseClass) - whether to ignore node FQDN resolve error
-
ignore_node_error (optional, TrueClass/FalseClass) - whether to ignore node if failed to determine
node[]'chef_environment']
ornode['fqdn']
ornode['hostname']
- <del> exclude_recipes (optional, Array) - exclude chef node if
run_list
matches recipe, not yet tested </del> - <del> exclude_roles (optional, Array) - exclude chef node if
run_list
matches role, not yet tested </del> -
env_custom_vars (optional, Hash) - add
Host
object custom vars to all chef node -
limit_region (optional, TrueClass/FalseClass) - whether to limit chef node to chef server region, currently tested for Amazon EC2, e.g. a icinga2 server located in region
us-east-1
will only collect nodes located inus-east-
` region - server_region (optional, String) - icinga2 server region can be overridden if cloud provider is not supported by the cookbook using this attribute
- add_cloud_custom_vars (optional, TrueClass/FalseClass) - whether to add cloud attributes, currently supports amazon ec2, e.g. instance id, vpc subnet etc.
-
env_filter_node_vars (optional, Hash) - filter or match chef nodes for a given
Hash
attribute values -
import (optional, String) - icinga
Host
object import template attribute -
check_command (optional, String) - icinga
Host
object attributecheck_command
-
max_check_attempts (optional, Integer) - icinga
Host
object attributemax_check_attempts
-
check_period (optional, String) - icinga
Host
object attributecheck_period
-
check_interval (optional, String/Integer) - icinga
Host
object attributecheck_interval
-
retry_interval (optional, Integer) - icinga
Host
object attributeretry_interval
-
enable_notifications (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_notifications
-
enable_active_checks (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_active_checks
-
enable_passive_checks (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_passive_checks
-
enable_passive_checks (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_passive_checks
-
enable_event_handler (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_event_handler
-
enable_flapping (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_flapping
-
enable_perfdata (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_perfdata
-
event_command (optional, String) - icinga
Host
object attributeevent_command
-
flapping_threshold (optional, String) - icinga
Host
object attributeflapping_threshold
-
volatile (optional, , TrueClass/FalseClass) - icinga
Host
object attributevolatile
-
zone (optional, String) - icinga
Host
object attributezone
-
command_endpoint (optional, String) - icinga
Host
object attributecommand_endpoint
-
notes (optional, String) - icinga
Host
object attributenotes
-
notes_url (optional, String) - icinga
Host
object attributenotes_url
-
action_url (optional, String) - icinga
Host
object attributeaction_url
-
icon_image (optional, String) - icinga
Host
object attributeicon_image
-
icon_image_alt (optional, String) - icinga
Host
object attributeicon_image_alt
Note: Few of LWRP resource attributes has default value, please check LWRP resource until information is added here.
LWRP icinga2_envhostgroup
LWRP envhostgroup
creates an icinga Hostgroup
object for LWRP environment
host groups.
An environment
host groups are evaluated at compile time, hence it conflicts with LWRP hostgroup
resources. To avoid the conflict, LWRP envhostgroup
resources are created in a separate object file for an environment.
LWRP Environment HostGroup example
icinga2_envhostgroup 'envhostgroup' do
environment environment_name
groups %w(group)
end
Above LWRP resource will create HostGroup
for a chef environment.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
- environment (name_attribute, String) - chef environment name
- groups (optional, Array) - host group names
Note: This LWRP resource is only meant for LWRP environment
and not to be used for custom resources.
LWRP icinga2_host
Unlike LWRP environment
, LWRP host
creates an icinga Host
object or template.
LWRP host
can be useful for servers not managed by Chef or to monitor Cloud Services like Amazon Elastic Cache or Amazon RDS etc.
LWRP Host Object example
icinga2_host 'redis-ec.abcdef.0001.apse1.cache.amazonaws.com' do
display_name 'Production Redis Server'
address 'redis-ec.abcdef.0001.apse1.cache.amazonaws.com'
custom_vars :check_tcp_ports => %w(6379), :application => 'redis', :environment => 'production', :cluster_name => 'prodredis0001'
end
Above LWRP resource will create an icinga Host
object.
LWRP Host Template example
icinga2_host 'generic-host' do
template true
max_check_attempts 5
check_interval '1m'
retry_interval '30s'
check_command 'hostalive'
end
Above LWRP resource will create an icinga Host
template - generic-host
.
LWRP Options
- action (optional) - default :create, options: :create, :delete, :reload
-
display_name (optional, String) - icinga
Host
object import template attribute -
import (optional, String) - icinga
Host
object import template attribute -
address (optional, String) - icinga
Host
object import template attribute -
address6 (optional, String) - icinga
Host
object import template attribute -
groups (optional, Array) - icinga
Host
object import template attribute -
check_command (optional, String) - icinga
Host
object attributecheck_command
-
max_check_attempts (optional, Integer) - icinga
Host
object attributemax_check_attempts
-
check_period (optional, String) - icinga
Host
object attributecheck_period
-
check_interval (optional, String/Integer) - icinga
Host
object attributecheck_interval
-
retry_interval (optional, String/Integer) - icinga
Host
object attributeretry_interval
-
enable_notifications (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_notifications
-
enable_active_checks (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_active_checks
-
enable_passive_checks (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_passive_checks
-
enable_passive_checks (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_passive_checks
-
enable_event_handler (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_event_handler
-
enable_flapping (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_flapping
-
enable_perfdata (optional, TrueClass/FalseClass) - icinga
Host
object attributeenable_perfdata
-
event_command (optional, String) - icinga
Host
object attributeevent_command
-
flapping_threshold (optional, String) - icinga
Host
object attributeflapping_threshold
-
volatile (optional, , TrueClass/FalseClass) - icinga
Host
object attributevolatile
-
zone (optional, String) - icinga
Host
object attributezone
-
command_endpoint (optional, String) - icinga
Host
object attributecommand_endpoint
-
notes (optional, String) - icinga
Host
object attributenotes
-
notes_url (optional, String) - icinga
Host
object attributenotes_url
-
action_url (optional, String) - icinga
Host
object attributeaction_url
-
icon_image (optional, String) - icinga
Host
object attributeicon_image
-
icon_image_alt (optional, String) - icinga
Host
object attributeicon_image_alt
-
custom_vars (optional, String) - icinga
Host
object attributevars
-
tempalte (optional, String) - whether to create a
Host
template
LWRP icinga2_hostgroup
LWRP hostgroup
creates an icinga HostGroup
object.
LWRP HostGroup example
icinga2_hostgroup 'hostgroup_name' do
disaply_name 'Host Group'
groups ['othergroup']
assign_where ['"hostgroup_name" in host.vars.hostgroups']
ignore_where ['"hostgroup_name" in host.vars.hostgroups']
end
Above LWRP resource will create an icinga HostGroup
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
display_name (optional, String) - icinga
HostGroup
attributedisplay_name
-
groups (optional, Array) - icinga
HostGroup
attributegroups
-
assign_where (optional, Array) - an array of
assign where
statements -
ignore_where (optional, Array) - an array of
ignore where
statements
LWRP icinga2_service
LWRP service
creates an icinga Service
object or template.
LWRP Service Object example
icinga2_service 'redis-ec.abcdef.0001.apse1.cache.amazonaws.com_service_check' do
display_name 'Production Redis Service Check'
host_name 'redis-ec.abcdef.0001.apse1.cache.amazonaws.com'
check_command 'tcp'
custom_vars :tcp_port => 6379
end
Above LWRP resource will create an icinga Service
object for a host tcp port check.
LWRP Service Template example
icinga2_service 'generic-service' do
template true
max_check_attempts 5
check_interval '1m'
retry_interval '30s'
end
Above LWRP resource will create an icinga Service
template object for a generic-service
Service
.
LWRP Options
- action (optional) - default :create, options: :create, :delete, :reload
-
display_name (optional) - icinga
Service
object attributedisplay_name
-
import (optional) - icinga
Service
object attributeimport
-
host_name (optional) - icinga
Service
object attributehost_name
-
groups (optional) - icinga
Service
object attributegroups
-
check_command (optional) - icinga
Service
object attributecheck_command
-
max_check_attempts (optional) - icinga
Service
object attributemax_check_attempts
-
check_period (optional) - icinga
Service
object attributecheck_period
-
check_interval (optional) - icinga
Service
object attributecheck_interval
-
retry_interval (optional) - icinga
Service
object attributeretry_interval
-
enable_notifications (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_notifications
-
enable_active_checks (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_active_checks
-
enable_passive_checks (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_passive_checks
-
enable_passive_checks (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_passive_checks
-
enable_event_handler (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_event_handler
-
enable_flapping (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_flapping
-
enable_perfdata (optional) - icinga
Service
object attributeenable_perfdata
-
event_command (optional, TrueClass/FalseClass) - icinga
Service
object attributeevent_command
-
flapping_threshold (optional, String) - icinga
Service
object attributeflapping_threshold
-
volatile (optional, TrueClass/FalseClass) - icinga
Service
object attributevolatile
-
zone (optional, String) - icinga
Service
object attributezone
-
command_endpoint (optional, String) - icinga
Service
object attributecommand_endpoint
-
notes (optional, String) - icinga
Service
object attributenotes
-
notes_url (optional, String) - icinga
Service
object attributenotes_url
-
action_url (optional, String) - icinga
Service
object attributeaction_url
-
icon_image (optional, String) - icinga
Service
object attributeicon_image
-
icon_image_alt (optional, String) - icinga
Service
object attributeicon_image_alt
-
custom_vars (optional, Hash) - icinga
Service
object attributevars
-
tempalte (optional, TrueClass/FalseClass) - whether to create a
Service
template
LWRP icinga2_applyservice
LWRP service
creates an icinga Service
object or template.
LWRP Apply Service Object example
icinga2_applyservice 'nrpe_check_load' do
display_name 'CPU Average Load'
import 'generic-service'
check_command 'nrpe'
custom_vars :nrpe_command => 'check_load'
assign_where ['host.vars.nrpe']
check_interval '1m'
retry_interval '15s'
max_check_attempts 3
action_url '/pnp4nagios/graph?host=$HOSTNAME$&srv=$SERVICEDESC$'
end
Above LWRP resource will apply an icinga Service
object to all Hosts
with custom vars host.vars.nrpe
.
LWRP Options
- action (optional) - default :create, options: :create, :delete, :reload
-
display_name (optional, String) - icinga
Service
object attributedisplay_name
-
import (optional, String) - icinga
Service
object attributeimport
-
host_name (optional, String) - icinga
Service
object attributehost_name
-
groups (optional, Array) - icinga
Service
object attributegroups
-
check_command (optional, String) - icinga
Service
object attributecheck_command
-
max_check_attempts (optional, Integer) - icinga
Service
object attributemax_check_attempts
-
check_period (optional, String) - icinga
Service
object attributecheck_period
-
check_interval (optional, String/Integer) - icinga
Service
object attributecheck_interval
-
retry_interval (optional, String/Integer) - icinga
Service
object attributeretry_interval
-
enable_notifications (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_notifications
-
enable_active_checks (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_active_checks
-
enable_passive_checks (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_passive_checks
-
enable_passive_checks (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_passive_checks
-
enable_event_handler (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_event_handler
-
enable_flapping (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_flapping
-
enable_perfdata (optional, TrueClass/FalseClass) - icinga
Service
object attributeenable_perfdata
-
event_command (optional, TrueClass/FalseClass) - icinga
Service
object attributeevent_command
-
flapping_threshold (optional, TrueClass/FalseClass) - icinga
Service
object attributeflapping_threshold
-
volatile (optional, TrueClass/FalseClass) - icinga
Service
object attributevolatile
-
zone (optional, String) - icinga
Service
object attributezone
-
command_endpoint (optional, String) - icinga
Service
object attributecommand_endpoint
-
notes (optional, String) - icinga
Service
object attributenotes
-
notes_url (optional, String) - icinga
Service
object attributenotes_url
-
action_url (optional, String) - icinga
Service
object attributeaction_url
-
icon_image (optional, String) - icinga
Service
object attributeicon_image
-
icon_image_alt (optional, String) - icinga
Service
object attributeicon_image_alt
-
custom_vars (optional, Hash) - icinga
Service
object attributevars
-
assign_where (optional, Array) - an array of
assign where
statements -
ignore_where (optional, Array) - an array of
ignore where
statements
LWRP icinga2_servicegroup
LWRP servicegroup
creates an icinga ServiceGroup
object.
LWRP ServiceGroup example
icinga2_servicegroup 'servicegroup_name' do
disaply_name 'Service Group'
groups ['othergroup']
assign_where ['"servicegroup_name" in host.vars.servicegroups']
ignore_where ['"servicegroup_name" in host.vars.servicegroups']
end
Above LWRP resource will create an icinga ServiceGroup
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
display_name (optional, String) - icinga
ServiceGroup
attributedisplay_name
-
groups (optional, Array) - icinga
ServiceGroup
attributegroups
-
assign_where (optional, Array) - an array of
assign where
statements -
ignore_where (optional, Array) - an array of
ignore where
statements
LWRP icinga2_feature
LWRP feature
enable or disable an icinga Feature
.
LWRP Feature enable example
icinga2_feature 'feature'
Above LWRP resource will enable an icinga Feature
.
LWRP Feature disable example
icinga2_feature 'feature' do
action :disable
end
Above LWRP resource will disable an icinga Feature
.
LWRP Options
- name(name_attribute) - icinga2 feature name
- action (optional) - default :enable, options: :enable, :disable
LWRP icinga2_user
LWRP user
creates an icinga User
object.
LWRP User Object example
icinga2_user 'user_name' do
import 'generic-user'
enable_notifications true
states %w(OK Warning Critical Unknown Up Down)
types %w(DowntimeStart DowntimeEnd DowntimeRemoved Custom Acknowledgement Problem Recovery FlappingStart FlappingEnd)
display_name 'User Info'
groups %w(usergroup)
email 'user@domain'
end
Above LWRP resource will create an icinga User
object.
LWRP User Template example
icinga2_user 'generic-user' do
template true
end
Above LWRP resource will create an icinga User
template.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
display_name (optional, String) - icinga
User
attributedisplay_name
-
import (optional, String) - icinga
User
attributeimport
-
groups (optional, Array) - icinga
User
attributegroups
-
email (optional, String) - icinga
User
attributeemail
-
pager (optional, String) - icinga
User
attributepager
-
period (optional, String) - icinga
User
attributeperiod
-
states (optional, Array) - icinga
User
attributestates
-
types (optional, Array) - icinga
User
attributetypes
-
zone (optional, String) - icinga
User
attributezone
-
custom_vars (optional, Hash) - icinga
User
attributevars
-
enable_notifications (optional, TrueClass/FalseClass) - icinga
User
attributeenable_notifications
-
template (optional, TrueClass/FalseClass) - whether to create a
User
template
LWRP icinga2_usergroup
LWRP usergroup
creates an icinga UserGroup
object.
LWRP UserGroup example
icinga2_usergroup 'usergroup_name' do
disaply_name 'User Group'
groups ['usergroup']
zone 'zone_name'
end
Above LWRP resource will create an icinga UserGroup
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
display_name (optional, String) - icinga
UserGroup
attributedisplay_name
-
groups (optional, Array) - icinga
UserGroup
attributegroups
-
zone (optional, String) - icinga
UserGroup
attributezone
LWRP icinga2_zone
LWRP zone
creates an icinga Zone
object.
LWRP Zone example
icinga2_zone 'zone' do
endpoints %w(endpoint)
parent 'parent zone'
end
Above LWRP resource will create an icinga Zone
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
endpoints (optional, String) - icinga
Zone
attributeendpoints
-
parent (optional, String) - icinga
Zone
attributeparent
-
global (optional, TrueClass/FalseClass) - icinga
Zone
attributeglobal
LWRP icinga2_endpoint
LWRP endpoint
creates an icinga Endpoint
object.
LWRP Endpoint example
icinga2_endpoint 'endpoint' do
host 'host address'
port 'port'
log_duration 'log duration'
end
Above LWRP resource will create an icinga Endpoint
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
host (optional, String) - icinga
Endpoint
attributehost
-
port (optional, Integer) - icinga
Endpoint
attributeport
-
log_duration (optional, String) - icinga
Endpoint
attributelog_duration
LWRP icinga2_timeperiod
LWRP timeperiod
creates an icinga TimePeriod
object.
LWRP TimePeriod example
icinga2_timeperiod '24x7' do
import 'legacy-timeperiod'
display_name 'Icinga 2 24x7 TimePeriod'
ranges 'monday' => '00:00-24:00',
'tuesday' => '00:00-24:00',
'wednesday' => '00:00-24:00',
'thursday' => '00:00-24:00',
'friday' => '00:00-24:00',
'saturday' => '00:00-24:00',
'sunday' => '00:00-24:00'
end
Above LWRP resource will create an icinga TimePeriod
object.
LWRP TimePeriod template
icinga2_timeperiod 'legacy-timeperiod' do
template true
display_name 'legacy-timeperiod'
end
Above LWRP resource will create an icinga TimePeriod
template.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
display_name (optional, String) - icinga
TimePeriod
attributedisplay_name
-
import (optional, String) - icinga
TimePeriod
attributeimport
-
zone (optional, String) - icinga
TimePeriod
attributezone
-
ranges (optional, Hash) - icinga
TimePeriod
attributeranges
-
template (optional, TrueClass/FalseClass) - whether to create an icinga
TimePeriod
template
LWRP icinga2_eventcommand
LWRP eventcommand
creates an icinga EventCommand
object.
LWRP EventCommand example
icinga2_eventcommand 'eventcommand' do
command 'command name'
custom_vars :attribute => 'value'
end
Above LWRP resource will create an icinga EventCommand
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
import (optional, String) - icinga
EventCommand
attributeimport
-
command (optional, String/Array) - icinga
EventCommand
attributecommand
-
env (optional, Hash) - icinga
EventCommand
attributeenv
-
timeout (optional, String/Integer) - icinga
EventCommand
attributetimeout
-
arguments (optional, Hash) - icinga
EventCommand
attributearguments
-
custom_vars (optional, Hash) - icinga
EventCommand
attributecustom_vars
LWRP icinga2_checkcommand
LWRP checkcommand
creates an icinga CheckCommand
object.
LWRP CheckCommand example
icinga2_checkcommand 'checkcommand' do
command 'command name'
env :attribute => 'value'
arguments :attribute => 'value'
custom_vars :attribute => 'value'
zone 'zone name'
end
Above LWRP resource will create an icinga CheckCommand
object.
LWRP Options
- action (optional, String) - default :enable, options: :enable, :disable
-
import (optional, String) - default plugin-check-command, icinga
CheckCommand
attributeimport
-
command (optional, String/Array) - icinga
CheckCommand
attributecommand
-
env (optional, Hash) - icinga
CheckCommand
attributeenv
-
timeout (optional, Integer) - icinga
CheckCommand
attributetimeout
-
zone (optional, String) - icinga
CheckCommand
attributezone
-
arguments (optional, Hash) - icinga
CheckCommand
attributearguments
-
custom_vars (optional, Hash) - icinga
CheckCommand
attributecustom_vars
LWRP icinga2_scheduleddowntime
LWRP scheduleddowntime
creates an icinga ScheduledDowntime
object.
LWRP ScheduledDowntime example
icinga2_scheduleddowntime 'downtime' do
host_name 'host name'
service_name 'service name'
author 'author'
comment 'comment'
duration 'duration'
end
Above LWRP resource will create an icinga ScheduledDowntime
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
host_name (optional, String) - icinga
ScheduledDowntime
attributehost_name
-
service_name (optional, String) - icinga
ScheduledDowntime
attributeservice_name
-
author (optional, String) - icinga
ScheduledDowntime
attributeauthor
-
comment (optional, String) - icinga
ScheduledDowntime
attributecomment
-
fixed (optional, TrueClass/FalseClass) - icinga
ScheduledDowntime
attributefixed
-
duration (optional, String) - icinga
ScheduledDowntime
attributeduration
-
zone (optional, String) - icinga
ScheduledDowntime
attributezone
-
ranges (optional, Hash) - icinga
ScheduledDowntime
attributeranges
-
template (optional, TrueClass/FalseClass) - whether to create an icinga
ScheduledDowntime
template
LWRP icinga2_externalcommandlistener
LWRP externalcommandlistener
creates an icinga ExternalCommandListener
object.
LWRP ExternalCommandListener example
icinga2_externalcommandlistener 'externalcommandlistener' do
library 'library'
command_path 'command path'
end
Above LWRP resource will create an icinga ExternalCommandListener
config object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default 'compat', icinga
ExternalCommandListener
attributelibrary
-
command_path (optional, String) - icinga
ExternalCommandListener
attributecommand_path
LWRP icinga2_gelfwriter
LWRP gelfwriter
creates an icinga GelfWriter
object.
LWRP GelfWrite example
icinga2_gelfwriter 'gelfwriter' do
library 'library'
host 'host address'
port 'port'
source 'source'
end
Above LWRP resource will create an icinga GelfWriter
config object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default 'perfdata', icinga
GelfWriter
attributelibrary
-
host (required, String) - icinga
GelfWriter
attributehost
-
port (required, Integer) - icinga
GelfWriter
attributeport
-
source (optional, String) - icinga
GelfWriter
attributesource
LWRP icinga2_graphitewriter
LWRP graphitewriter
creates an icinga GraphiteWriter
object.
LWRP GraphiteWriter example
icinga2_graphitewriter 'graphitewriter' do
library 'library'
host 'host address'
port 'port'
end
Above LWRP resource will create an icinga GraphiteWriter
config object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default 'perfdata', icinga
GraphiteWriter
attributelibrary
-
host (optional, String) - icinga
GraphiteWriter
attributehost
-
port (optional, Integer) - icinga
GraphiteWriter
attributeport
-
host_name_template (optional, String) - default icinga.$host.name$, icinga
GraphiteWriter
attributehost_name_template
-
service_name_template (optional, String) - default icinga.$host.name$.$service.name$, icinga
GraphiteWriter
attributeservice_name_template
LWRP icinga2_idomysqlconnection
LWRP idomysqlconnection
creates an icinga IdoMySqlConnection
object.
LWRP IdoMySqlConnection example
icinga2_idomysqlconnection 'idomysqlconnection' do
library 'library'
host 'host address'
port 'port'
user 'user name'
password 'password'
database 'database name'
end
Above LWRP resource will create an icinga IdoMySqlConnection
config object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default 'db_ido_mysql', icinga
IdoMySqlConnection
attributelibrary
-
host (optional, String) - icinga
IdoMySqlConnection
attributehost
-
port (optional, Integer) - icinga
IdoMySqlConnection
attributeport
-
user (optional, String) - icinga
IdoMySqlConnection
attributeuser
-
password (optional, String) - icinga
IdoMySqlConnection
attributepassword
-
database (optional, String) - icinga
IdoMySqlConnection
attributedatabase
-
table_prefix (optional, String) - default icinga_, icinga
IdoMySqlConnection
attributetable_prefix
-
instance_name (optional, String) - icinga
IdoMySqlConnection
attributeinstance_name
-
instance_description (optional, String) - icinga
IdoMySqlConnection
attributeinstance_description
-
enable_ha (optional, TrueClass/FalseClass) - icinga
IdoMySqlConnection
attributeenable_ha
-
failover_timeout (optional, String/Integer) - icinga
IdoMySqlConnection
attributefailover_timeout
-
cleanup (optional, Hash) - icinga
IdoMySqlConnection
attributecleanup
-
categories (optional, Array) - icinga
IdoMySqlConnection
attributecategories
LWRP icinga2_idopgsqlconnection
LWRP idopgsqlconnection
creates an icinga IdoPgSqlConnection
object.
LWRP IdoPgSqlConnection example
icinga2_idopgsqlconnection 'idopgsqlconnection' do
library 'library'
host 'host address'
port 'port'
user 'user name'
password 'password'
database 'database name'
end
Above LWRP resource will create an icinga IdoPgSqlConnection
config object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default 'db_ido_mysql', icinga
IdoPgSqlConnection
attributelibrary
-
host (optional, String) - icinga
IdoPgSqlConnection
attributehost
-
port (optional, Integer) - icinga
IdoPgSqlConnection
attributeport
-
user (optional, String) - icinga
IdoPgSqlConnection
attributeuser
-
password (optional, String) - icinga
IdoPgSqlConnection
attributepassword
-
database (optional, String) - icinga
IdoPgSqlConnection
attributedatabase
-
table_prefix (optional, String) - icinga
IdoPgSqlConnection
attributetable_prefix
-
instance_name (optional, String) - icinga
IdoPgSqlConnection
attributeinstance_name
-
instance_description (optional, String) - icinga
IdoPgSqlConnection
attributeinstance_description
-
enable_ha (optional, TrueClass/FalseClass) - icinga
IdoPgSqlConnection
attributeenable_ha
-
failover_timeout (optional, String/Integer) - icinga
IdoPgSqlConnection
attributefailover_timeout
-
cleanup (optional, Hash) - icinga
IdoPgSqlConnection
attributecleanup
-
categories (optional, Array) - icinga
IdoPgSqlConnection
attributecategories
LWRP icinga2_sysloglogger
LWRP sysloglogger
creates an icinga SyslogLogger
object.
LWRP SyslogLogger example
icinga2_sysloglogger 'sysloglogger' do
severity 'critical'
end
Above LWRP resource will create an icinga SyslogLogger
object.
LWRP Options
-
name(name_attribute) - icinga
SyslogLogger
name -
severity (optional, String) - icinga
SyslogLogger
attributeport
LWRP icinga2_notification
LWRP notification
creates an icinga Notification
object.
LWRP Notification Object example
icinga2_notification 'notification' do
import 'notification template'
host_name 'host'
service_name 'service'
users %w(user)
user_groups %w(usergroup)
interval 'interval'
period 'period'
states %w(OK Warning Critical Unknown Up Down)
types %w(Custom Acknowledgement Problem Recovery)
end
Above LWRP resource will create an icinga Notification
object.
LWRP Notification Template example
icinga2_notification 'notification' do
template true
period '24x7'
end
Above LWRP resource will create an icinga Notification
template.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
import (optional, String) - icinga
Notification
attributeimport
-
host_name (optional, String) - icinga
Notification
attributehost_name
-
service_name (optional, String) - icinga
Notification
attributeservice_name
-
users (optional, Array) - icinga
Notification
attributeusers
-
user_groups (optional, Array) - icinga
Notification
attributeuser_groups
-
times (optional, Hash) - icinga
Notification
attributetimes
-
command (optional, String) - icinga
Notification
attributecommand
-
interval (optional, String/Integer) - icinga
Notification
attributeinterval
-
period (optional, String) - icinga
Notification
attributeperiod
-
zone (optional, String) - icinga
Notification
attributezone
-
types (optional, Array) - icinga
Notification
attributetypes
-
states (optional, Array) - icinga
Notification
attributestates
-
custom_vars (optional, Hash) - icinga
Notification
attributevars
-
template (optional, TrueClass/FalseClass) - whether to create a
Notification
template
LWRP icinga2_applynotification
LWRP applynotification
creates an icinga apply Notification
object for Host
and Service
.
LWRP apply Notification Service Object example
icinga2_applynotification 'servicenotification' do
object_type 'Service'
command 'mail-service-notification'
users %w(user)
interval '1h'
assign_where ['host.address && host.vars.environment == "development"']
ignore_where ['host.vars.monitoring_disabled == true']
end
Above LWRP resource will apply Notification
to all Service
objects for provided assign where
statements and ignore for specified ignore where
statements.
LWRP apply Notification Host Object example
icinga2_applynotification 'hostnotification' do
object_type 'Host'
command 'mail-host-notification'
users %w(user)
interval '1h'
assign_where ['host.address && host.vars.environment == "development"']
ignore_where ['host.vars.monitoring_disabled == true']
end
Above LWRP resource will apply Notification
to all Host
objects for provided assign_where
statements and ignore for specified ignore_where
statements.
LWRP Options
-
object_type (required, String) - apply Notification to
Host
orService
, valid values are: Host Service - action (optional, String) - default :enable, options: :enable, :disable
-
import (optional, String) - icinga
Notification
attributeimport
-
users (optional, Array) - icinga
Notification
attributeusers
-
user_groups (optional, Array) - icinga
Notification
attributeuser_groups
-
times (optional, Hash) - icinga
Notification
attributetimes
-
command (optional, String) - icinga
Notification
attributecommand
-
interval (optional, String/Integer) - icinga
Notification
attributeinterval
-
period (optional, String) - icinga
Notification
attributeperiod
-
types (optional, Array) - icinga
Notification
attributetypes
-
states (optional, Array) - icinga
Notification
attributestates
-
assign_where (optional, Array) - icinga
assign where
statements -
ignore_where (optional, Array) - icinga
ignore where
statements
LWRP icinga2_notificationcommand
LWRP notificationcommand
creates an icinga NotificationCommand
object.
LWRP NotificationCommand example
icinga2_notificationcommand 'mail-service-notification' do
command ['SysconfDir + "/icinga2/scripts/mail-service-notification.sh"']
env 'NOTIFICATIONTYPE' => '$notification.type$', \
'SERVICEDESC' => '$service.name$',\
'HOSTALIAS' => '$host.display_name$',\
'HOSTADDRESS' => '$address$',\
'SERVICESTATE' => '$service.state$',\
'LONGDATETIME' => '$icinga.long_date_time$',\
'SERVICEOUTPUT' => '$service.output$',\
'NOTIFICATIONAUTHORNAME' => '$notification.author$',\
'NOTIFICATIONCOMMENT' => '$notification.comment$',\
'HOSTDISPLAYNAME' => '$host.display_name$',\
'SERVICEDISPLAYNAME' => '$service.display_name$',\
'USEREMAIL' => '$user.email$'
end
Above LWRP resource will create an icinga NotificationCommand
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
import (optional, String) - default plugin-notification-command, icinga
NotificationCommand
attributecert_path
-
command (optional, String/Array) - icinga
NotificationCommand
attributecommand
-
env (optional, Hash) - icinga
NotificationCommand
attributeenv
-
timeout (optional, Integer) - icinga
NotificationCommand
attributetimeout
-
zone (optional, String) - icinga
NotificationCommand
attributezone
-
arguments (optional, Hash) - icinga
NotificationCommand
attributearguments
-
custom_vars (optional, Hash) - icinga
NotificationCommand
attributevars
LWRP icinga2_apilistener
LWRP apilistener
creates an icinga ApiListener
object.
LWRP ApiListener example
icinga2_apilistener 'master' do
cert_path 'SysconfDir + "/icinga2/pki/" + NodeName + ".crt"'
key_path 'SysconfDir + "/icinga2/pki/" + NodeName + ".key"'
ca_path 'SysconfDir + "/icinga2/pki/ca.crt"'
bind_host 'host address'
bind_port '5665'
ticket_salt 'TicketSalt'
end
Above LWRP resource will create an icinga ApiListener
object.
LWRP Options
- action (optional, String) - default :enable, options: :enable, :disable
-
cert_path (required, String) - icinga
ApiListener
attributecert_path
-
key_path (required, String) - icinga
ApiListener
attributekey_path
-
ca_path (required, String) - icinga
ApiListener
attributeca_path
-
crl_path (optional, String) - icinga
ApiListener
attributecrl_path
-
bind_host (optional, String) - icinga
ApiListener
attributebind_host
-
bind_port (optional, String) - icinga
ApiListener
attributebind_port
-
ticket_salt (optional, String) - icinga
ApiListener
attributeticket_salt
-
accept_config (optional, TrueClass/FalseClass) - icinga
ApiListener
attributeaccept_config
-
accept_commands (optional, TrueClass/FalseClass) - icinga
ApiListener
attributeaccept_commands
LWRP icinga2_livestatuslistener
LWRP livestatuslistener
creates an icinga LiveStatusListener
object.
LWRP LiveStatusListener example
icinga2_livestatuslistener 'livestatuslistener' do
socket_type 'socket type'
socket_path 'socket path'
bind_host 'host address'
bind_port 'host port'
compat_log_path 'log path'
end
Above LWRP resource will create an icinga LiveStatusListener
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
socket_type (optional, String) - icinga
LiveStatusListener
attributesocket_type
-
socket_path (optional, String) - icinga
LiveStatusListener
attributesocket_path
-
bind_host (optional, String) - icinga
LiveStatusListener
attributebind_host
-
bind_port (optional, Integer) - icinga
LiveStatusListener
attributebind_port
-
compat_log_path (optional, String) - icinga
LiveStatusListener
attributecompat_log_path
LWRP icinga2_statusdatawriter
LWRP statusdatawriter
creates an icinga StatusDataWriter
object.
LWRP StatusDataWriter example
icinga2_statusdatawriter 'statusdatawriter' do
status_path 'status path'
objects_path 'objects path'
update_interval 'update interval'
end
Above LWRP resource will create an icinga StatusDataWriter
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default compat, icinga
StatusDataWriter
Objectlibrary
-
status_path (optional, String) - icinga
StatusDataWriter
attributestatus_path
-
objects_path (optional, String) - icinga
StatusDataWriter
attributeobjects_path
-
update_interval (optional, String/Integer) - icinga
StatusDataWriter
attributeupdate_interval
LWRP icinga2_compatlogger
LWRP compatlogger
creates an icinga CompatLogger
object.
LWRP CompatLogger example
icinga2_compatlogger 'compatlogger' do
log_dir 'log dir'
rotation_method 'rotation method'
end
Above LWRP resource will create an icinga CompatLogger
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default compat, icinga
CompatLogger
Objectlibrary
-
log_dir (optional, String) - icinga
CompatLogger
attributelog_dir
-
rotation_method (optional, String) - icinga
CompatLogger
attributerotation_method
LWRP icinga2_checkresultreader
LWRP checkresultreader
creates an icinga CheckResultReader
object.
LWRP CheckResultReader example
icinga2_checkresultreader 'checkresultreader' do
spool_dir 'spool dir'
end
Above LWRP resource will create an icinga CheckResultReader
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default compat, icinga
CheckResultReader
Objectlibrary
-
spool_dir (optional, String) - icinga
CheckResultReader
attributespool_dir
LWRP icinga2_checkercomponent
LWRP checkercomponent
creates an icinga CheckerComponent
object.
LWRP CheckerComponent example
icinga2_checkercomponent 'checkercomponent'
Above LWRP resource will create an icinga CheckerComponent
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default checker, icinga
CheckerComponent
Objectlibrary
LWRP icinga2_notificationcomponent
LWRP notificationcomponent
creates an icinga NotificationComponent
object.
LWRP CheckerComponent example
icinga2_notificationcomponent 'notificationcomponent' do
end
Above LWRP resource will create an icinga NotificationComponent
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default notification, icinga
NotificationComponent
Objectlibrary
-
enable_ha (optional, String) - default checker, icinga
NotificationComponent
attributeenable_ha
LWRP icinga2_filelogger
LWRP filelogger
creates an icinga FileLogger
object.
LWRP CheckerComponent example
icinga2_filelogger 'filelogger' do
end
Above LWRP resource will create an icinga FileLogger
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
path (optional, String) - default checker, icinga
FileLogger
attributepath
-
severity (optional, String) - icinga
FileLogger
attributeseverity
LWRP icinga2_perfdatawriter
LWRP perfdatawriter
creates an icinga PerfdataWriter
object.
LWRP PerfdataWriter example
icinga2_perfdatawriter 'perfdatawriter' do
host_perfdata_path 'host perfdata path'
service_perfdata_path 'service perfdata path'
host_format_template 'host perfdata format'
service_format_template 'service perfdata format'
rotation_interval 'rotation interval'
end
Above LWRP resource will create an icinga PerfdataWriter
object.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
library (optional, String) - default perfdata, icinga
PerfdataWriter
Objectlibrary
-
host_perfdata_path (optional, String) - default checker, icinga
PerfdataWriter
attributehost_perfdata_path
-
service_perfdata_path (optional, String) - default checker, icinga
PerfdataWriter
attributeservice_perfdata_path
-
host_temp_path (optional, String) - icinga
PerfdataWriter
attributehost_temp_path
-
service_temp_path (optional, String) - icinga
PerfdataWriter
attributeservice_temp_path
-
host_format_template (optional, String) - icinga
PerfdataWriter
attributehost_format_template
-
service_format_template (optional, String) - icinga
PerfdataWriter
attributeservice_format_template
-
rotation_interval (optional, String/Integer) - icinga
PerfdataWriter
attributerotation_interval
LWRP icinga2_applydependency
LWRP applydependency
creates an icinga apply Dependency
object for Host
and Service
.
LWRP apply Dependency Service Object example
icinga2_applydependency 'applyservicedependency' do
object_type 'Service'
parent_service_name 'check_nrpe'
states %w(OK Critical Unknown Warning)
period '24x7'
assign_where ['service.check_command == "nrpe"']
ignore_where ['service.name == "check_nrpe"']
end
Above LWRP resource will apply Dependency
to all Service
objects for provided assign where
statements and ignore for specified ignore where
statements.
LWRP apply Dependency Host Object example
icinga2_applydependency 'applyhostdependency' do
object_type 'Host'
parent_host_name 'gateway host'
states %w(Down Unknown)
period '24x7'
assign_where %w(host.address)
ignore_where ['!host.address']
end
Above LWRP resource will apply Dependency
to all Host
objects for provided assign_where
statements and ignore for specified ignore_where
statements.
LWRP Options
- action (optional) - default :enable, options: :enable, :disable
-
object_relation (optional, String) - default
to
, applyDependency
relation -
object_type (required, String) - apply Notification to
Host
orService
, valid values are: Host Service -
parent_host_name (optional, String) - icinga apply
Dependency
attributeparent_host_name
-
child_host_name (optional, String) - icinga apply
Dependency
attributechild_host_name
-
parent_service_name (optional, String) - icinga apply
Dependency
attributeparent_service_name
-
child_service_name (optional, String) - icinga apply
Dependency
attributechild_service_name
-
disable_checks (optional, TrueClass/FalseClass) - icinga apply
Dependency
attributedisable_checks
-
disable_notifications (optional, TrueClass/FalseClass) - icinga apply
Dependency
attributedisable_notifications
-
period (optional, String) - icinga apply
Dependency
attributeperiod
-
states (optional, Array) - icinga apply
Dependency
attributestates
-
assign_where (optional, Array) - icinga
assign where
statements -
ignore_where (optional, Array) - icinga
ignore where
statements
Cookbook Advanced Attributes
default['icinga2']['disable_conf_d']
(default:false
): disable icinga2conf.d
default configuration directory inicinga2.conf
and use LWRP to manage icinga2 objects / templatesdefault['icinga2']['build_type']
(default:release
): icinga2 repository build type, options: release snapshotdefault['icinga2']['disable_repository_d']
(default:false
): disable icinga2repository.d
directory inicinga2.conf
default['icinga2']['include_itl']
(default:itl, plugins
):icinga2.conf
includeitl
array attributedefault['icinga2']['add_cloud_custom_vars']
(default:true
): add cloud node attributes, limited cloud provider support is availabledefault['icinga2']['features_enabled_dir']
(default:/etc/icinga2/features-enabled
): icinga2 enabled features locationdefault['icinga2']['features_available_dir']
(default:/etc/icinga2/features-available
): icinga2 available features locationdefault['icinga2']['cluster_attribute']
(default:nil
): icinga2 node cluster attribute name to add node cluster attribute and value to node varsdefault['icinga2']['application_attribute']
(default:nil
): icinga2 node application attribute name to add node application attribute and value to node varsdefault['icinga2']['enable_cluster_hostgroup']
(default:true
): creates icinga2 HostGroup Objects for environment clustersdefault['icinga2']['enable_application_hostgroup']
(default:true
): creates icinga2 HostGroup Objects for environment application typesdefault['icinga2']['enable_role_hostgroup']
(default:false
): creates icinga2 HostGroup Objects for environment rolesdefault['icinga2']['limit_region']
(default:true
): whether to limit monitoring to icinga2 server region, e.g. for ec2 collect nodes belongs to same regiondefault['icinga2']['use_fqdn_resolv']
(default:false
): whether to determine nodeaddress
from fqdndefault['icinga2']['failover_fqdn_address']
(default:true
): whether to use ohai attributenode['ipaddress']
if node fqdn does not existsdefault['icinga2']['ignore_node_error']
(default:false
): whether to ignore node errors if node fqdn, hostname and chef_environment is missing while collecting for a chef environmentdefault['icinga2']['ignore_resolv_error']
(default:true
): whether to ignore node fqdn resolve errors while collecting for a chef environmentdefault['icinga2']['web_engine']
(default: `'apache'): icinga2 web server, currently supports only apachedefault['icinga2']['install_nagios_plugins']
(default:true
): install nagios plugins to icinga2 server and clients
Cookbook Core Attributes
default['icinga2']['version']
(default:2.3.3-1
): icinga2 versiondefault['icinga2']['conf_dir']
(default:/etc/icinga2
): icinga2 configuration locationdefault['icinga2']['conf_d_dir']
(default:/etc/icinga2/conf.d
): icinga2 conf.d directory locationdefault['icinga2']['pki_dir']
(default:/etc/icinga2/pki
): icinga2 pki directory locationdefault['icinga2']['scripts_dir']
(default:/etc/icinga2/scripts
): icinga2 script directory locationdefault['icinga2']['zones_dir']
(default:/etc/icinga2/zones.d
): icinga2 zones.d directory locationdefault['icinga2']['databag']
(default: `'icinga2'): icinga2 databag name, currently not useddefault['icinga2']['objects_d']
(default:'objects.d
): cookbook created icinga2 Object/Templates resources directory namedefault['icinga2']['objects_dir']
(default:/etc/icinga2/objects.d
): cookbook created icinga2 Object/Templates resources directory locationdefault['icinga2']['run_dir']
(default:/var/run/icinga2
): icinga2 run directorydefault['icinga2']['run_cmd_dir']
(default:/var/run/icinga2/cmd
): icinga2 location for processicinga2.cmd
default['icinga2']['cache_dir']
(default:/var/cache/icinga2
): icinga2 cache directory locationdefault['icinga2']['spool_dir']
(default:/var/spool/icinga2
): icinga2 spool directory locationdefault['icinga2']['lib_dir']
(default:/var/lib/icinga2
): icinga2 lib directory locationdefault['icinga2']['log_dir']
(default:/var/log/icinga2
): icinga2 core process log directory locationdefault['icinga2']['cache_dir']
(default:/var/cache/icinga2
): icinga2 cache directory locationdefault['icinga2']['perfdata_dir']
(default:/var/spool/icinga2/perfdata
): icinga2 perfdata directory locationdefault['icinga2']['service_name']
(default:icinga2'
): icinga2 process name*default['icinga2']['service_config_file']
(default:/etc/default/icinga2
): icinga2 * process configuration filedefault['icinga2']['plugins_dir']
(default:/usr/lib/nagios/plugins
): icinga2 plugins directory locationdefault['icinga2']['custom_plugins_dir']
(default:/opt/icinga2_custom_plugins
): icinga2 custom plugins directorydefault['icinga2']['admin_user']
(default:icingaadmin
): icinga2 admin userdefault['icinga2']['user']
(default:icinga
): icinga2 userdefault['icinga2']['group']
(default:icinga
): icinga2 user groupdefault['icinga2']['cmdgroup']
(default:icingacmd
): icinga2 cmd user groupdefault['icinga2']['user_defined_objects_d']
(default:user_defined_objects
): icinga2 conf directory name for user defined objectsdefault['icinga2']['user_defined_objects_dir']
(default:/etc/icinga2/user_defined_objects
): icinga2 conf directory for user defined objectsdefault['icinga2']['cmdgroup']
(default:icingacmd
): icinga2 cmd user groupdefault['icinga2']['apache_modules']
(default:calculated
): apache modules / apache2 cookbook recipe to enable
Cookbook Icinga2 Constants Attributes
default['icinga2']['server']['constants']['NodeName']
(default:node['fqdn']
): icinga2 NodeName constantdefault['icinga2']['server']['constants']['PluginDir']
(default:node['icinga2']['plugins_dir']
): icinga2 plugins directory locationdefault['icinga2']['server']['constants']['ManubulonPluginDir']
(default:node['icinga2']['plugins_dir']
): icinga2 plugins directory locationdefault['icinga2']['server']['constants']['TicketSalt']
(default:ed25aed394c4bf7d236b347bb67df466
): icinga2 default TicketSalt key
Cookbook Icinga2 Host Object default Attributes
default['icinga2']['server']['object']['host']['import']
(default:'generic-host
)default['icinga2']['server']['object']['host']['max_check_attempts']
(default:3
)default['icinga2']['server']['object']['host']['check_period']
(default:nil
)default['icinga2']['server']['object']['host']['check_interval']
(default:1800
)default['icinga2']['server']['object']['host']['retry_interval']
(default:60
)default['icinga2']['server']['object']['host']['enable_notifications']
(default:true
)default['icinga2']['server']['object']['host']['enable_active_checks']
(default:true
)default['icinga2']['server']['object']['host']['enable_passive_checks']
(default:false
)default['icinga2']['server']['object']['host']['enable_event_handler']
(default:true
)default['icinga2']['server']['object']['host']['enable_flapping']
(default:true
)default['icinga2']['server']['object']['host']['enable_perfdata']
(default:true
)default['icinga2']['server']['object']['host']['event_command']
(default:nil
)default['icinga2']['server']['object']['host']['flapping_threshold']
(default:nil
)default['icinga2']['server']['object']['host']['volatile']
(default:nil
)default['icinga2']['server']['object']['host']['check_command']
(default:hostalive
)default['icinga2']['server']['object']['host']['zone']
(default:nil
)default['icinga2']['server']['object']['host']['command_endpoint']
(default:nil
)
Cookbook Icinga2 IDO Attributes
default[:icinga2][:ido][:type]
(default:mysql
): icinga2 ido type, valid aremysql pgsql
default[:icinga2][:ido][:load_schema]
(default:false
): whether to load db schemadefault[:icinga2][:ido][:db_host]
(default:localhost
): Icinga2 ido db hostdefault[:icinga2][:ido][:db_name]
(default:icinga
): Icinga2 ido db namedefault[:icinga2][:ido][:db_user]
(default:icinga
): Icinga2 ido db userdefault[:icinga2][:ido][:db_password]
(default:icinga
): Icinga2 ido db password
Cookbook Icingaweb2 Attributes
default[:icinga2][:web2][:enable]
(default:false
): whether to setup icingaweb2default[:icinga2][:web2][:source_url]
(default:git://git.icinga.org/icingaweb2.git
):default[:icinga2][:web2][:version]
(default:v2.0.0-beta3
): icingaweb2 git checkout version / branch / tag etc.default[:icinga2][:web2][:web_root]
(default:/usr/share/icingaweb2
): icingaweb2 web root locationdefault[:icinga2][:web2][:web_uri]
(default:/icingaweb2
): icingweb2 web uridefault[:icinga2][:web2][:conf_dir]
(default:/etc/icingaweb2
): icingaweb2 config directorydefault[:icinga2][:web2][:log_dir]
(default:/var/log/icingaweb2
): icingaweb2 log directory
Cookbook Ulimit Attributes
default[:icinga2][:limits][:memlock]
(default:unlimited
): Icinga2 service user memory limitdefault[:icinga2][:limits][:nofile]
(default:48000
): Icinga2 service user file limitdefault[:icinga2][:limits][:nproc]
(default:unlimited
): Icinga2 service user process limit
Cookbook Repository Attributes
default['icinga2']['yum']['description']
(default: `ICINGA Release'):default['icinga2']['yum']['mirrorlist']
(default:nil
):default['icinga2']['yum']['gpgcheck']
(default:true
):default['icinga2']['yum']['enabled']
(default:true
):default['icinga2']['yum']['gpgkey']
(default:http://packages.icinga.org/icinga.key
):default['icinga2']['yum']['action']
(default::create
):default['icinga2']['yum']['baseurl']
(default:calculated
):default['icinga2']['apt']['repo']
(default:ICINGA Release
):default['icinga2']['apt']['uri']
(default:calculated
):default['icinga2']['apt']['distribution']
(default:node['lsb']['codename']
):default['icinga2']['apt']['keyserver']
(default:keyserver.ubuntu.com
):default['icinga2']['apt']['components']
(default:[main]
):default['icinga2']['apt']['deb_src']
(default:true
):default['icinga2']['apt']['repo_key']
(default:http://packages.icinga.org/icinga.key
):default['icinga2']['apt']['action']
(default::add
):
Cookbook Classic UI CGI Core Attributes
default['icinga2']['classic_ui']['version']
(default:2.3.3-1
): icinga2 classic-ui package versiondefault['icinga2']['classic_ui']['gui_version']
(default:1.12.2-0
): icinga2 gui package versiondefault['icinga2']['classic_ui']['web_root']
(default:/usr/share/icinga
): icinga2 web doc root directory locationdefault['icinga2']['classic_ui']['home_dir']
(default:/etc/icinga
): icinga2 classic ui configuration home directory locationdefault['icinga2']['classic_ui']['conf_dir']
(default:/etc/icinga
): icinga2 classic ui configuration directory locationdefault['icinga2']['classic_ui']['log_dir']
(default:/var/log/icinga
): icinga2 classic ui log directory locationdefault['icinga2']['classic_ui']['cgi_log_dir']
(default:/var/log/icinga/gui
): icinga2 gui log directory location
Cookbook Classic UI CGI User Access Attributes
default['icinga2']['classic_ui']['users']
(default:{ 'icingaadmin' => 'icingaadmin' }
): Hash List of user => password (md5) for class ui accessdefault['icinga2']['classic_ui']['authorized_for_system_information']
(default:[node['icinga2']['admin_user']]
): Array list of users authorized for system informationdefault['icinga2']['classic_ui']['authorized_for_configuration_information']
(default:[node['icinga2']['admin_user']]
): Array list of users authorized for configuration informationdefault['icinga2']['classic_ui']['authorized_for_full_command_resolution']
(default:[node['icinga2']['admin_user']]
): Array list of users authorized for full command resolutiondefault['icinga2']['classic_ui']['authorized_for_system_commands']
(default:[node['icinga2']['admin_user']]
): Array list of users authorized for system commandsdefault['icinga2']['classic_ui']['authorized_for_all_services']
(default:[node['icinga2']['admin_user']]
): Array list of users authorized for all servicesdefault['icinga2']['classic_ui']['authorized_for_all_hosts']
(default:[node['icinga2']['admin_user']]
): Array list of users authorized for all hostsdefault['icinga2']['classic_ui']['authorized_for_all_service_commands']
(default:[node['icinga2']['admin_user']]
): Array list of users authorized for all service commandsdefault['icinga2']['classic_ui']['authorized_for_all_host_commands']
(default:[node['icinga2']['admin_user']]
): Array list of users authorized for all host commands
Cookbook Classic UI CGI Configuration Attributes
default['icinga2']['classic_ui']['cgi']['standalone_installation']
(default:1
)default['icinga2']['classic_ui']['cgi']['physical_html_path']
(default:/usr/share/icinga
)default['icinga2']['classic_ui']['cgi']['url_html_path']
(default:/icinga
)default['icinga2']['classic_ui']['cgi']['url_stylesheets_path']
(default:/icinga/stylesheets
)default['icinga2']['classic_ui']['cgi']['http_charset']
(default:utf-8
)default['icinga2']['classic_ui']['cgi']['refresh_rate']
(default:60
)default['icinga2']['classic_ui']['cgi']['refresh_type']
(default:1
)default['icinga2']['classic_ui']['cgi']['escape_html_tags']
(default:1
)default['icinga2']['classic_ui']['cgi']['result_limit']
(default:50
)default['icinga2']['classic_ui']['cgi']['show_tac_header']
(default:1
)default['icinga2']['classic_ui']['cgi']['use_pending_states']
(default:1
)default['icinga2']['classic_ui']['cgi']['first_day_of_week']
(default:0
)default['icinga2']['classic_ui']['cgi']['suppress_maintenance_downtime']
(default:0
)default['icinga2']['classic_ui']['cgi']['action_url_target']
(default:main
)default['icinga2']['classic_ui']['cgi']['notes_url_target']
(default:main
)default['icinga2']['classic_ui']['cgi']['use_authentication']
(default:1
)default['icinga2']['classic_ui']['cgi']['use_ssl_authentication']
(default:0
)default['icinga2']['classic_ui']['cgi']['lowercase_user_name']
(default:0
)default['icinga2']['classic_ui']['cgi']['authorized_for_system_information']
(default:node['icinga2']['classic_ui']['authorized_for_system_information'].join(',')
)default['icinga2']['classic_ui']['cgi']['authorized_for_configuration_information']
(default:node['icinga2']['classic_ui']* ['authorized_for_configuration_information'].join(',')
)default['icinga2']['classic_ui']['cgi']['authorized_for_full_command_resolution']
(default:node['icinga2']['classic_ui']['authorized_for_full_command_resolution'].join(',')
)default['icinga2']['classic_ui']['cgi']['authorized_for_system_commands']
(default:node['icinga2']['classic_ui']['authorized_for_system_commands'].join(',')
)default['icinga2']['classic_ui']['cgi']['authorized_for_all_services']
(default:node['icinga2']['classic_ui']['authorized_for_all_services'].join(',')
)default['icinga2']['classic_ui']['cgi']['authorized_for_all_hosts']
(default:node['icinga2']['classic_ui']['authorized_for_all_hosts'].join(',')
)default['icinga2']['classic_ui']['cgi']['authorized_for_all_service_commands']
(default:node['icinga2']['classic_ui']['authorized_for_all_service_commands'].join(',')
)default['icinga2']['classic_ui']['cgi']['authorized_for_all_host_commands']
(default:node['icinga2']['classic_ui']['authorized_for_all_host_commands'].join(',')
)default['icinga2']['classic_ui']['cgi']['show_all_services_host_is_authorized_for']
(default:1
)default['icinga2']['classic_ui']['cgi']['show_partial_hostgroups']
(default:0
)default['icinga2']['classic_ui']['cgi']['show_partial_servicegroups']
(default:0
)default['icinga2']['classic_ui']['cgi']['default_statusmap_layout']
(default:5
)default['icinga2']['classic_ui']['cgi']['status_show_long_plugin_output']
(default:0
)default['icinga2']['classic_ui']['cgi']['display_status_totals']
(default:0
)default['icinga2']['classic_ui']['cgi']['highlight_table_rows']
(default:1
)default['icinga2']['classic_ui']['cgi']['add_notif_num_hard']
(default:28
)default['icinga2']['classic_ui']['cgi']['add_notif_num_soft']
(default:0
)default['icinga2']['classic_ui']['cgi']['use_logging']
(default:0
)default['icinga2']['classic_ui']['cgi']['cgi_log_file']
(default:node['icinga2']['classic_ui']['cgi_log_dir']/icinga-cgi.log
)default['icinga2']['classic_ui']['cgi']['cgi_log_rotation_method']
(default:d
)default['icinga2']['classic_ui']['cgi']['cgi_log_archive_path']
(default:node['icinga2']['classic_ui']['cgi_log_dir']
)default['icinga2']['classic_ui']['cgi']['enforce_comments_on_actions']
(default:0
)default['icinga2']['classic_ui']['cgi']['send_ack_notifications']
(default:1
)default['icinga2']['classic_ui']['cgi']['persistent_ack_comments']
(default:0
)default['icinga2']['classic_ui']['cgi']['lock_author_names']
(default:1
)default['icinga2']['classic_ui']['cgi']['default_downtime_duration']
(default:7200
)default['icinga2']['classic_ui']['cgi']['set_expire_ack_by_default']
(default:0
)default['icinga2']['classic_ui']['cgi']['default_expiring_acknowledgement_duration']
(default:86_400
)default['icinga2']['classic_ui']['cgi']['default_expiring_disabled_notifications_duration']
(default:86_400
)default['icinga2']['classic_ui']['cgi']['tac_show_only_hard_state']
(default:0
)default['icinga2']['classic_ui']['cgi']['show_tac_header_pending']
(default:1
)default['icinga2']['classic_ui']['cgi']['exclude_customvar_name']
(default:PASSWORD,COMMUNITY
)default['icinga2']['classic_ui']['cgi']['exclude_customvar_value']
(default:secret
)default['icinga2']['classic_ui']['cgi']['extinfo_show_child_hosts']
(default: `)default['icinga2']['classic_ui']['cgi']['tab_friendly_titles']
(default:1
)default['icinga2']['classic_ui']['cgi']['object_cache_file']
(default:/var/cache/icinga2/objects.cache
)default['icinga2']['classic_ui']['cgi']['status_file']
(default:node['icinga2']['cache_dir']/status.dat
)default['icinga2']['classic_ui']['cgi']['resource_file']
(default:node['icinga2']['classic_ui']['conf_dir']/resource.cfg
)default['icinga2']['classic_ui']['cgi']['command_file']
(default:node['icinga2']['run_dir']/cmd/icinga2.cmd
)default['icinga2']['classic_ui']['cgi']['check_external_commands']
(default:1
)default['icinga2']['classic_ui']['cgi']['interval_length']
(default:60
)default['icinga2']['classic_ui']['cgi']['status_update_interval']
(default:10
)default['icinga2']['classic_ui']['cgi']['log_file']
(default:node['icinga2']['log_dir']/compat/icinga.log
)default['icinga2']['classic_ui']['cgi']['log_rotation_method']
(default:h
)default['icinga2']['classic_ui']['cgi']['log_archive_path']
(default:node['icinga2']['log_dir']/compat/archives
)default['icinga2']['classic_ui']['cgi']['date_format']
(default:us
)
Copyright & License
Authors:: Check AUTHORS file
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
</pre>
Dependent cookbooks
apt >= 0.0.0 |
yum ~> 3.0 |
yum-epel >= 0.0.0 |
apache2 >= 0.0.0 |
ulimit >= 0.0.0 |
pnp4nagios >= 0.0.0 |
Contingent cookbooks
icinga2 CHANGELOG
This file is used to list changes made in each version of the icinga2 cookbook.
2.3.1
Virender Khatri - Bug #9037, added Hash support for host / service custom vars
Virender Khatri - Bug #9019, fixed host.vars.disks attribute for lwrp environment
Virender Khatri - Bug #9038, added suffix centos for epel repo releasever 7
Marcel Beck - Bug #9038, rhel version check for centos suffix
Marcel Beck - Bug #9039, allow web_uri /
Virender Khatri - Bug #9066, allow arguments Hash key value to be String, Integer and Float for checkcommand lwrp
Virender Khatri - Bug #8788, possible fix for debian platform classic_ui cgi resource_file nil string
Virender Khatri - Bug #9126, manage classic ui cgi log directory
Virender Khatri - Bug #9125, update repo attribute to support debian platform
Virender Khatri - Bug #9128, fix user group ownership for node[icinga2][classic_ui][log_dir]
Virender Khatri - Bug #9129, classic ui unable to access icinga2 objects.cache on ubuntu platform
Jörg Herzinger - Bug #9132,Fix version contraint for centos 7 apache modules
Virender Khatri - Bug #9151, bump icinga2 version to v2.3.4-1, classic_ui version to v1.13.2
2.1.8
- Virender Khatri - Bug #9001, added attribute to ignore default icinga2 package version
2.1.7
- Virender Khatri - Feature #8997, bump update icinga2 version to v2.3.3
2.1.6
Virender Khatri - Feature #8630, adding default Host vars remote_client
Virender Khatri - Feature #8631, add default endpoint port
Virender Khatri - Bug #8635, re-org recipes in favour of client agent recipe
Virender Khatri - Bug #8837, restart icinga2 service on package upgrade / install
Virender Khatri - Bug #8838, bump icinga2 version to v2.3.2
Virender Khatri - Bug #8838, bump icingaweb2 ref to beta3
2.1.0
Virender Khatri - iBug #8449 update default icingaweb2 version to use tag release
Virender Khatri - iBug #8409 bump icinga2 version
Virender Khatri - iFeature #8454, enable snapshot yum repository
Andrei Scopenco - allow to disable user_defined_objects_dir
Virender Khatri - iBug #8479 use packages.icinga.org for apt/yum snapshots repository
Virender Khatri - iBug #8481 use native htpasswd file location for icinga2 classicui
Virender Khatri - iBug #8469 mod_python deprecated for centos7/rhel7
Jannik Zinkl - iBug #8469, fixed platform_version condition
Virender Khatri - iBug #8494 package php5-intl added for ubuntu
Virender Khatri - iBug #8495 fix for libjpeg62-dev conflict with libgd2-xpm-dev
2.0.1
Jannik Zinkl - fixed pgqsl schema setup for extra line char
Andrei Scopenco - iBug #8384 fix for LWRP endpoint
Virender Khatri - iBug #8384 fix for lwrp apilistener
Virender Khatri - iBug #8384 fix for lwrp applydependency
Virender Khatri - iBug #8384 fix for lwrp applynotification
Virender Khatri - iBug #8384 fix for lwrp applyservice
Virender Khatri - iBug #8384 fix for lwrp checkcommand
Virender Khatri - iBug #8384 fix for lwrp eventcommand
Virender Khatri - iBug #8384 fix for lwrp hostgroup
Virender Khatri - iBug #8384 fix for lwrp notificationcommand
Virender Khatri - iBug #8384 fix for lwrp servicegroup
Virender Khatri - iBug #8384 fix for lwrp usergroup
Virender Khatri - iBug #8384 fix for lwrp zone
Jannik Zinkl - iBug #8377 fixing package php-pecl-imagick install for imagick
Virender Khatri - iBug #8377 added yum-epel repository for package php-pecl-imagick
Andrei Scopenco - added include_itl attribute for adding itl to icinga2.conf
Virender Khatri - iBug #8419 updated icinga web2 default uri to /icingaweb2
Virender Khatri - iBug #8377 added icingaweb2 packages dependency for debian platform family
Andrei Scopenco - iBug #8427 added attribute for disabling repository.d
Andrei Scopenco - iBug #8428 added lwrp zone resource attribute - global
0.10.1
Gerhard Sulzberger - corrected platform_family case statement in recipe
server_os_packages
&server_install
Virender Khatri - bump icinga2 version to 2.2.3-1
Virender Khatri - corrected LWRP applydependency resource attribute Class type
Virender Khatri - removed object_name LWRP applyservice resource attribute
Virender Khatri - fixed LWRP for resource attribute
port
Virender Khatri - added LWRP resource Class to README
Virender Khatri - fixed server isntall attributes & recipes
Gerhard Sulzberger - added recipe
apt
for deb packages upgrade dependencyGerhard Sulzberger - added icinga user & group for debian platform family
Virender Khatri - added icinga cmdgroup for debian platform family
Virender Khatri - fixed typo for apache node attribute reference
Virender Khatri - updated apache vhost template
Virender Khatri - added attribute for optional configuration of icinga2 classic ui & web2
Virender Khatri - fixed classic ui template & attributes for ubuntu / deb paltform family
Virender Khatri - allow LWRP environment chef resources override with custom template
added LWRP attributes for custom resources attributes for icinga2 Host/HostGroup templateAndrei Scopenco - fixed package version suffix for release repo
Andrei Scopenco - fixed typos in LWRP idomysqlconnection
Andrei Scopenco - fixed typos and template in LWRP externalcommandlistener
Virender Khatri - fixed missing library template attribute for LWRP compatlogger
Virender Khatri - corrected icinga2 object name for LWRP idomysqlconnection
Virender Khatri - corrected icinga2 object name for LWRP idopgsqlconnection
Virender Khatri - corrected icinga2 object name for LWRP livestatuslistener
Virender Khatri - deprecated features mgmt via node attr in favor of LWRP
Virender Khatri - fixed interval / timeout object attribute in resource templates
Jannik Zinkl - fixed typo in recipe server_ido_schema.rb
0.7.6
Virender Khatri - LWRP resource custom vars are not sorted
Virender Khatri - updated generic-host template to use node attributes
Virender Khatri - cleaned up LWRP for unused attributes
Virender Khatri - added LWRP applydependency
Virender Khatri - fixed error for missing node attribute in library
Virender Khatri - fixed LWRP applyservice template for True/False Class attributes
Virender Khatri - updated README
0.7.0
- Virender Khatri - added multiple zone support for LWRP environment
0.6.8
Virender Khatri - fixed ido schema upload recipe
Virender Khatri - added icingaweb2 apache nginx vhost
Virender Khatri - created different recipe for os packages install
Virender Khatri - added icingaweb2 setup and configuration
Virender Khatri - added icingaweb2 setup token attribute
Virender Khatri - fixed LWRP apilistener
0.6.1
Virender Khatri - added travis
Virender Khatri - added user_defined_objects conf directory
Virender Khatri - added LWRP resource regex check for interval attributes
Virender Khatri - fixed LWRP template for gelfwriter graphitewriter idomysqlconnection
idopgsqlconnection sysloglogger syslogloggerVirender Khatri - added LWRP compatlogger livestatuslistener perfdatawriter
statusdatawriter checkercomponent checkresultreader filelogger
notificationcomponentVirender Khatri - updated README doc
0.5.4
Virender Khatri - added pnp4nagios ssi symlink for node graph preview
Virender Khatri - fixed library for mount disks host custom vars
Virender Khatri - fixed LWRP sysloglogger
Virender Khatri - added LWRP doc
0.5.0
Virender Khatri - added lwrp for icinga2 feature
Virender Khatri - removed default features
Virender Khatri - added default
NodeName
constantVirender Khatri - removed zones.conf in favor of LWRP
zone
Virender Khatri - delaying icinga2 service start in favor of LWRP resources objects
Virender Khatri - added missing zone Object to various environment / host LWRPs
Virender Khatri - corrected LWRP endpoint
Virender Khatri - added support for pnp4nagios
Virender Khatri - updated README documentation
0.4.2
Virender Khatri - removed nrpe client recipe
Virender Khatri - replaced icingaweb recipe from cookbook with icingaweb2
Virender Khatri - refactored recipes for packages
Virender Khatri - prepping for pnp4nagios support, added recipe
icinga2::server_pnp
Virender Khatri - disabled icingaweb2 by default
Virender Khatri - enable icinga2 classic ui by default
Virender Khatri - disabled pnp integration by defatul
Virender Khatri - renamed
conf.d
disable attribute todisable_conf_d
Virender Khatri - added
icinga2_features
recipe to manage icinga2 featuresVirender Khatri - removed
environment
lwrp attributeenv_notification_user_groups
Virender Khatri - bump icinga2 version to v2.2.2-1
Virender Khatri - preparing for
ubuntu
platform testing
0.3.0
Virender Khatri - allowing node custom_vars hostgroups Array declaration
Virender Khatri - corrected check_interval chec_period resource attribute type
Virender Khatri - renamed downtime lwrp to scheduleddowntime
Virender Khatri - added applistener lwrp
Virender Khatri - added endpoint lwrp
Virender Khatri - added gelfwrite lwrp
Virender Khatri - corrected lwrp attributes types
Virender Khatri - corrected icinga2 objects boolean attribute, nil value attribute will be ignored
Virender Khatri - fixed mail notification scripts permissions
0.2.1
- Virender Khatri - removed files under development for chef supermarket
0.2.0
Virender Khatri - added node cpu and memory to custom vars by default
Virender Khatri - fixed permission issue on /var/run/icinga2
Virender Khatri - fixed nrpe config for ubuntu
Virender Khatri - added templates for mail notification scripts
Virender Khatri - added externalcommandlistener lwrp
Virender Khatri - added graphitewriter lwrp
Virender Khatri - added idomysqlconnection lwrp
Virender Khatri - added idopgsqlconnection lwrp
Virender Khatri - added sysloglogger lwrp
Virender Khatri - renamed client recipe to client_nrpe in favor of icinga2 agent
0.1.5
- Virender Khatri - initial release of icinga2
Check the Markdown Syntax Guide for help with Markdown.
The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.
Foodcritic Metric
2.3.1 passed this metric
2.3.1 passed this metric