From 181485489220d142b43a893fc14ec66a2083e7ed Mon Sep 17 00:00:00 2001
From: Simon Michnowicz <simon.michnowicz@monash.edu>
Date: Wed, 26 Sep 2018 18:01:50 +1000
Subject: [PATCH] first addition of a 'how-to'

---
 roles/nhc/README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 roles/nhc/README.md

diff --git a/roles/nhc/README.md b/roles/nhc/README.md
new file mode 100644
index 00000000..4f7ecf61
--- /dev/null
+++ b/roles/nhc/README.md
@@ -0,0 +1,18 @@
+Creates Node Health Check on a compute node
+see ://github.com/mej/nhc  
+
+It needs some variable to be defined before calling
+
+i.e.
+nhc_version: 1.4.2
+nhc_dir: /opt/nhc-{{ nhc_version }}
+nhc_config_file: nhc.conf
+nhc_log_level: 0
+nhc_emails: nobody@nowhere.nowhere
+nhc_email_subject: "Node Health Check" 
+
+In addition the NAT check needs two variables to be defined to be enabled  (See example)
+
+Example:
+  roles:
+  - { role: nhc, EXTERNAL_IP_ADDRESS: "118.138.246.208", ADD_NHC_NAT_CHECK: 1  }
-- 
GitLab