icinga2_api Cookbook

• icinga2_api Cookbook
  • Description
  • Requirements
    • Cookbooks
    • Chef
    • Platforms
  • Recipes
  • Usage
    • icinga2_api_host
    • icinga2_api_service
  • License & Authors

Created by gh-md-toc

Description

Chef cookbook with LWRPs used to interact with icinga2 API.

Requirements

Cookbooks

• build-essential

Chef

• Chef 12 or higher

Platforms

• Debian => 6
• Ubuntu => 14.04
• RHEL => 6

Notes: This cookbook has been tested on the listed platforms. It may work on other platforms with or without modification.

Recipes

• default - installing icinga2 gem for LWRPs.

Usage

The main use case is to create icinga2 objects on the node bootstrap time. Thus you don't need to create any autodiscovery tools that will describe all nodes in icinga2 setup.
Please refer to integration cookbook for examples.

icinga2_api_host

LWRP host creates an icinga Host object.

LWRP Environment Host example

  icinga2_api_host 'host1' do
    attributes address: '127.0.0.1',
               templates: ['check-host-tmpl-30s'],
               display_name: 'host1'
    icinga_api_pass 'mysecret'
  end

LWRP Options

• name (name_attribute, String) - chef resource name and icinga2 host name.
• attributes (optional, Hash) - icinga2 host object attributes.
• icinga_api_host (optional, String) - icinga2 API host, default: 'localhost'.
• icinga_api_port (optional, Integer) - icinga2 API port, default: 5665.
• icinga_api_user (optional, String) - icinga2 API username, default: 'admin'.
• icinga_api_pass (required, String) - icinga2 API password.
• icinga_api_pki_path (optional, String) - icinga2 API path to pki for cert auth, default: '/etc/icinga2'.
• icinga_api_node_name (optional, String) - icinga2 API node endpoint.
• icinga_cluster (optional, Boolean) - icinga2 cluster mode enabled, default: false.
• icinga_satellite (optional, String) - icinga2 satellite name.
• action (optional) - options: [:create, :delete], default :create.

icinga2_api_service

LWRP service creates an icinga Service object.

LWRP Environment Service example

  icinga2_api_service 'host1_ping1' do
    host_name 'host1'
    attributes templates: ['check-service-tmpl-30s'],
               display_name: 'PING1',
               check_command: 'hostalive'
    icinga_api_pass 'mysecret'
  end

LWRP Options

• name (name_attribute, String) - chef resource name and icinga2 service name. Should be unique in icinga2 setup.
• host_name (required, Hash) - icinga2 host name object attributes.
• attributes (optional, Hash) - icinga2 service object attributes.
• icinga_api_host (optional, String) - icinga2 API host, default: 'localhost'.
• icinga_api_port (optional, Integer) - icinga2 API port, default: 5665.
• icinga_api_user (optional, String) - icinga2 API username, default: 'admin'.
• icinga_api_pass (required, String) - icinga2 API password.
• icinga_api_pki_path (optional, String) - icinga2 API path to pki for cert auth, default: '/etc/icinga2'.
• icinga_api_node_name (optional, String) - icinga2 API node endpoint.
• icinga_cluster (optional, Boolean) - icinga2 cluster mode enabled, default: false.
• icinga_satellite (optional, String) - icinga2 satellite name.
• action (optional) - options: [:create, :delete], default :create.

License & Authors

• Author:: Andrei Skopenko andrei@skopenko.net

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.