patvdv/kudos.check_health

Ansible role for the Health Checker tool

kudos.check_health

Deployment and configuration of the KUDOS Health Checker framework (http://www.kudos.be/Projects/Health_checker.html)

Requirements

Ansible v2.8+

Role Variables

Core configuration

hc_core:
  time_out: <seconds>
  log_healthy: <yes|no>
  will_fix: <yes|no>
  report_last_cache: <yes|no>
  report_today_cache: <yes|no>
  count_archives: <yes|no>

Default values (non-null):

• time_out: 60
• log_healthy: no
• will_fix: no
• report_last_cache no
• report_today_cache no
• count_archives yes

Scheduling (cron) configuration

hc_scheduling:
  cron:
    when: <time_date_definition>
    user: <text>
    action: <text>
    no_lock: <yes|no>
    timeout: <number_seconds>
    options: <text>

Default values (non-null):

• enabled: yes
• scheduled: no
• cron/when: 00 * * * *
• cron/user: root
• cron/action: --run
• cron/no_lock: no

Above settings can be overridden by specific values in individual plugins.

Note: the scheduling (cron) settings are not supported for the HP-UX plugins. For scheduling on HP-UX, cron packages should be used instead.

Plugin configuration (checks)

States

Plugins can have 3 different levels of state settings:

• installed: the plugin must be present/installed on the target host.
• enabled: the plugin must be enabled (allowed to run) on the target host.
• scheduled: the plugin must be scheduled to run on the target host. Currently only schedeling via cron is supported.

Note: setting the installed will determine whether the corresponding package will be installed or not. Plugins that are bundled together in a package will have their package installed when at least one plugin of that package is set to be installable. In that case there will not be a 1-1 relationship between the installed flag and the presence of the plugin on the target host.

Platform AIX

• check_aix_errpt
• check_aix_fs_mounts
• check_aix_lppchk
• check_aix_file_age
• check_aix_file_change
• check_aix_paths
• check_aix_root_crontab
• check_aix_subsystems
• check_aix_sysbackup
• check_aix_topasrec
• check_aix_uptime

Platform Clusterware

• check_clusterware_resource_config
• check_clusterware_resource_status

Platform Exadata

• check_exadata_cell_alerts
• check_exadata_cell_celldisks
• check_exadata_cell_flash
• check_exadata_cell_griddisks
• check_exadata_cell_luns
• check_exadata_cell_megaraid
• check_exadata_cell_physicaldisks
• check_exadata_megaraid
• check_exadata_zfs_cluster
• check_exadata_zfs_logs
• check_exadata_zfs_pool_usage
• check_exadata_zfs_services
• check_exadata_zfs_share_replication
• check_exadata_zfs_share_usage

Platform HP-UX

• check_hpux_autofs
• check_hpux_autopath
• check_hpux_cdsf_cluster
• check_hpux_cron_status
• check_hpux_drd_status
• check_hpux_file_age
• check_hpux_file_change
• check_hpux_fs_mounts
• check_hpux_fs_mounts_options
• check_hpux_fs_usage
• check_hpux_guid_status
• check_hpux_httpd_status
• check_hpux_ignite_backup
• check_hpux_ioscan
• check_hpux_hpvm_vpar_status
• check_hpux_kernel_params
• check_hpux_kernel_usage
• check_hpux_lunpaths
• check_hpux_named_status
• check_hpux_ntp_status
• check_hpux_ovpa_status
• check_hpux_patch_version
• check_hpux_postfix_status
• check_hpux_root_crontab
• check_hpux_sfm_status
• check_hpux_sshd_status
• check_hpux_syslog
• check_hpux_syslogd_status
• check_hpux_uptime
• check_hpux_vg_minor_number

Platform Linux

• check_linux_autofs
• check_linux_burp_backup
• check_linux_burp_status
• check_linux_dovecot_status
• check_linux_es_status
• check_linux_fail2ban_status
• check_linux_fetchmail_status
• check_linux_file_age
• check_linux_file_change
• check_linux_fs_mounts
• check_linux_fs_usage
• check_linux_hpacucli
• check_linux_hpasmcli
• check_linux_hplog
• check_linux_hpssacli
• check_linux_httpd_status
• check_linux_mysqld_status
• check_linux_named_status
• check_linux_ntp_status
• check_linux_postfix_status
• check_linux_process_limits
• check_linux_root_crontab
• check_linux_samba_status
• check_linux_shorewall_status
• check_linux_sshd_status
• check_linux_uptime
• check_linux_vz_ct_counters
• check_linux_vz_ct_status
• check_linux_winbind_status

Platform Serviceguard

• check_serviceguard_cluster_config
• check_serviceguard_cluster_status
• check_serviceguard_package_config
• check_serviceguard_package_status
• check_serviceguard_qs_status

Plugin configuration (display)

• hc_display_csv
• hc_display_init
• hc_display_json
• hc_display_terse
• hc_display_zenoss

Plugin configuration (notify)

• hc_notify_eif
• hc_notify_sms
• hc_notify_slack

Static definitions

Following variables must be available in the role vars:

• hc_display_plugins: list of display plugins
• hc_notify_plugins: list of notify plugins
• hc_configs: list of plugins that require a configuration file
• hc_packages: map plugin -> package
• hc_cron_packages: map plugin -> cron package (only for HP-UX)

Note: do not change these definitions unless you know what you are doing!

Additionally, following static vars may be defined to configure custom plugins:

• hc_extra_configs: list of plugins that require a configuration file
• hc_extra_packages: map plugin -> package
• hc_extra_cron_packages: map plugin -> cron package (only for HP-UX)

Dependencies

No dependencies

Example Playbook

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

    - hosts: all:!windows
      remote_user: root
      become: yes
      roles:
        - kudos.check_health

License

GPL v3

Author Information

Patrick Van der Veken - KUDOS BV (http://www.kudos.be)