update README to fix the bits about $fqdn being used, also create an

Upgrading section so that people can follow along more easily when
they upgrade.

1 files changed, 25 insertions, 1 deletions

diff --git a/README b/README
index cdcb5d3..2acf88d 100644
--- a/README
+++ b/README
@@ -28,7 +28,10 @@ Hosts
 -----
 
 On a node which shall be monitored with nagios, include the "nagios::target".
-This just creates a host declaration for this hosts "$fqdn".
+This just creates a host declaration for this host's "$ipaddress" fact. If
+the $ipaddress of your target is not the one you wish to modify, you can use
+"nagios::target::fqdn" instead, which will use the $fqdn fact of the host instead.
+
 Set the $nagios_parent variable in the node scope for enabling the reachability
 features of nagios. If a node needs more customisation, use the
 native "@@nagios_host" type directly (the double-ampersand declares the object
@@ -60,6 +63,25 @@ Obviously, the check command must either be defined using nagios_command objects
 files directly.
 
 
+Upgrade Notes
+=============
+
+The nagios::target bits have been reworked, the notable changes that
+may affect an upgrade are:
+
+. previous versions had nagios::target::nat which used the $fqdn for
+the address part of nagios::target, this has been renamed to
+nagios::target::fqdn to be more clear. if you were using
+nagios::target::nat then you will need to change those references to
+::fqdn
+
+. previous versions of this module used $fqdn for the nagios::target
+address, now it is using $ipaddress. If you need $fqdn, use
+nagios::target::fqdn instead of nagios::target
+
+. previous versions of nagios_host used the parameter named 'ip', that
+has been changed to 'address'
+
 Caveats
 =======
 
@@ -167,3 +189,5 @@ License
 Copyright (C) 2007 David Schmitt <david@schmitt.edv-bus.at>
 See the file LICENSE in the top directory for the full license.
 
+Copyright (C) 2010 Riseup Networks <micah@riseup.net>
+