README: fixed example playbook

README.md

@@ -0,0 +1,59 @@
+monitored
+=========
+
+Prepare remote machine for monitoring with Naemon/Nagios/Icinga via NRPE and/or SSH
+
+Requirements
+------------
+
+- Role "epel" for RedHat-like systems
+
+Role Variables
+--------------
+
+Defaults (config/overwrite required):
+- `monitored_by_nrpe` (defaults: `False`): install/configure NRPE
+- `monitored_by_ssh` (defaults: `False`): install/configure SSH incl. wrapper
+  script
+- `monitored_server_ips` (defaults: `[127.0.0.1,]`: list(!) of monitoring server
+  ips
+
+Required for SSH:
+- `monitored_ssh_key_files` (defaults: `[]`): list(!) of SSH key strings(!)
+
+Common variables:
+- `monitored_packages_install` (defaults: `True`): install plugings
+- `monitored_sudo_file` (defaults: `/etc/sudoers.d/monitored`): sudoers file
+- `monitored_sudo_commands`: list of `sudoers` config lines
+- `monitored_packages_additional(_nrpe|_ssh)`: additional packages to install
+- `monitored_plugins_custom`: additional plugin scripts to copy
+- `monitored_plugins_custom_path` (defaults: `/usr/local/plugins/`): path for
+  additional plugins
+
+NRPE:
+- `monitored_nrpe_*`: NRPE config variables
+
+SSH:
+- `monitored_ssh_key_wrapper`: local path/filename of wrapper
+- `monitored_ssh_key_wrapper_src`: remote path and filename of wrapper
+- `monitored_ssh_key_wrapper_*`: file attributes of wrapper
+
+Example Playbook
+----------------
+
+    - hosts: all
+      roles:
+        - role: monitored
+          when: monitored_dont|default(False) != True
+
+License
+-------
+
+GPL-2.0-or-later
+
+Author Information
+------------------
+
+Sven Velt - <sven-ansiblerole@velt.biz>
+https://git.velt.biz/velt.biz/
+

defaults/main.yml

@@ -6,6 +6,7 @@ monitored_user: nagios
 monitored_group: nagios
 monitored_homedir: /var/lib/nagios
 monitored_shell: /bin/bash
+monitored_password: null
 
 monitored_sudo_file: /etc/sudoers.d/monitored
 monitored_sudo_commands: []

meta/main.yml

@@ -0,0 +1,5 @@
+---
+dependencies:
+  - role: epel
+    when: ansible_os_family == "RedHat" and ansible_distribution != "Fedora"
+

monitored.yml

@@ -2,9 +2,10 @@
 - hosts: all
   roles:
 
-          - role: epel
+# "epel" is already a dependency (meta/main.yml)
-            when: ansible_os_family == "RedHat" and ansible_distribution != "Fedora"
+#  - role: epel
+#    when: ansible_os_family == "RedHat" and ansible_distribution != "Fedora"
 
-          - role: monitored
+  - role: monitored
-            when: monitored_dont|default(False) != True
+    when: monitored_dont|default(False) != True
 

tasks/main.yml

@@ -4,6 +4,7 @@
     that:
       - monitored_dont|default(False) != True
       - monitored_by_nrpe == True or monitored_by_ssh == True
+    fail_msg: "Neither monitored_by_nrpe nor monitored_by_ssh set to True"
 
 - name: Gather OS Specific Variables
   include_vars: "{{ item }}"

tasks/nrpe.yml

@@ -23,7 +23,7 @@
   loop: "{{ monitored_nrpe_include_dirs }}"
 
 - name: "INCLUDE: Migrate custom NRPE files"
-  include: nrpe_migrate.yml
+  import_tasks: nrpe_migrate.yml
 
 - name: Enable NRPE
   service:
@@ -35,7 +35,7 @@
     name: "{{ monitored_nrpe_servicename }}"
     state: restarted
 
-- name: Instal additional packages for NRPE monitoring
+- name: Install additional packages for NRPE monitoring
   package:
     name: "{{ monitored_packages_additional_nrpe }}"
     state: latest

tasks/ssh.yml

@@ -1,4 +1,10 @@
 ---
+- name: Sanity check
+  assert:
+    that:
+      - monitored_ssh_key_files|length > 0
+    fail_msg: "List of SSH keys ('monitored_ssh_key_files') is empty!"
+
 - name: Copy SSH authorized_keys for monitoring user
   authorized_key:
     user: "{{ monitored_user }}"
@@ -17,7 +23,7 @@
     backup: yes
   when: monitored_ssh_key_wrapper_src|default(False) and monitored_ssh_key_wrapper|default(False)
 
-- name: Instal additional packages for SSH monitoring
+- name: Install additional packages for SSH monitoring
   package:
     name: "{{ monitored_packages_additional_ssh }}"
     state: latest

tasks/user.yml

@@ -13,6 +13,7 @@
     home: "{{ monitored_homedir }}"
     move_home: yes
     shell: "{{ monitored_shell }}"
+    password: "{{ monitored_password }}"
     state: present
 
 - name: "Install sudo (if required)"

templates/nrpe.cfg.j2

@@ -1,7 +1,9 @@
 ### {{ ansible_managed }}
 
 log_facility=daemon
-pid_file={{ monitored_nrpe_pidfile }}
+{% if monitored_nrpe_pidfile %}pid_file={{ monitored_nrpe_pidfile }}
+{% else %}# pid_file=
+{% endif %}
 debug=0
 
 {% if monitored_nrpe_server_address %}server_address={{ monitored_nrpe_server_address }}

templates/ssh-key-options.j2

@@ -1 +1 @@
-no-agent-forwarding,no-port-forwarding,no-X11-forwarding,no-pty{% if monitored_ssh_key_wrapper %},command="{{ monitored_ssh_key_wrapper }}"{% endif %}
+no-agent-forwarding,no-port-forwarding,no-X11-forwarding,no-pty,from="{{ monitored_server_ips|join(",") }}"{% if monitored_ssh_key_wrapper %},command="{{ monitored_ssh_key_wrapper }}"{% endif %}

vars/alpine.yml

@@ -1,4 +1,7 @@
 ---
+monitored_shell: /bin/ash
+monitored_password: '*'
+
 monitored_packages_mp:
   - monitoring-plugins
 monitored_packages_np:
@@ -19,5 +22,5 @@ monitored_packages_nrpe:
   - nrpe
 
 monitored_nrpe_basedir: /etc
-monitored_nrpe_pidfile: /var/run/nrpe.pid
+monitored_nrpe_pidfile: False