summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGabriel Filion <gabster@lelutin.ca>2015-08-14 05:01:32 -0400
committerGabriel Filion <gabster@lelutin.ca>2015-08-14 05:01:32 -0400
commit633b8083d23011668735823dff4c5af2d491aa0c (patch)
tree182c131c54330b9374c02e109a93a96e5cf70761
parentca6462c6dc48dcb1af64cefe35c2cf8902f8cc30 (diff)
Add an upgrade notice about using the main class
The module's behaviour was changed from needing to include two different classes to using only the main class (class munin) directly. However, this change was not documented and it could lead to weird errors related to variables being undefined.
-rw-r--r--README.md8
-rw-r--r--manifests/client.pp1
-rw-r--r--manifests/host.pp1
3 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index db6af95..68c3c55 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,14 @@ a very easy plugin interface. The munin homepage is http://munin.projects.linpro
Your modules directory will need all the files included in this repository placed under a directory called `munin`.
+### Upgrade notices
+
+Users of the module who are upgrading from a older version of the module might be interested in these important changes:
+
+ * The `munin::client` and `munin::host` classes should not be included
+ directly anymore. Instead, the main class should be used for both client and
+ server (server should have the `$is_server` parameter set to true).
+
### Master configuration
To install a master (or server) you need to flip one argument to true in the main class:
diff --git a/manifests/client.pp b/manifests/client.pp
index f71d946..afab5f1 100644
--- a/manifests/client.pp
+++ b/manifests/client.pp
@@ -3,6 +3,7 @@
# Adapted and improved by admin(at)immerda.ch
# configure a munin node
+# WARNING: this class should not be included directly. See the 'munin' class.
class munin::client {
case $::operatingsystem {
diff --git a/manifests/host.pp b/manifests/host.pp
index 9831052..ffe7883 100644
--- a/manifests/host.pp
+++ b/manifests/host.pp
@@ -2,6 +2,7 @@
# Copyright (C) 2007 David Schmitt <david@schmitt.edv-bus.at>
# See LICENSE for the full license granted to you.
+# WARNING: this class should not be included directly. See the 'munin' class.
class munin::host {
package {'munin': ensure => installed, }