Merge pull request #16 from Metaswitch/monit_docs

[Reviewer: Matt] Update monit restart docs
Metaswitch · Mar 13, 2015 · 7c1bdd9 · 7c1bdd9
2 parents 34de766 + 0b6fcc1
commit 7c1bdd9
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/docs/CDF_Integration.md b/docs/CDF_Integration.md
@@ -39,7 +39,7 @@ To point Ralf at the billing DIAMETER realm, add the following line to `/etc/cle
 
 Then restart Ralf to pick up the change:
 
-    sudo monit restart ralf
+    sudo service ralf stop (allowing monit to restart Ralf)
 
 ### Selecting a specific CDF in the realm
 
@@ -51,7 +51,7 @@ If you have a CDF set up to receive Rf billing messages from your deployment, yo
 
 Once you have done this, run the following command to cause Bono to pick up the changes.
 
-    sudo monit restart bono
+    sudo service bono stop (allowing monit to restart Bono)
 
 ## Restrictions
 

diff --git a/docs/Clearwater_Configuration_Options_Reference.md b/docs/Clearwater_Configuration_Options_Reference.md
@@ -4,7 +4,7 @@ To change one of these settings:
 
 * Modify the configuration file
 * Run `sudo service clearwater-infrastructure restart` to regenerate any dependent configuration files
-* Restart the relevant Clearwater service (e.g. `sudo monit restart bono`)
+* Restart the relevant Clearwater service (e.g. run `sudo service bono stop` and allow monit to restart Bono)
 
 ## Core options
 

diff --git a/docs/External_HSS_Integration.md b/docs/External_HSS_Integration.md
@@ -67,7 +67,7 @@ To enable external HSS support, for each of your Homestead nodes,
 
 5.  save the file and exit the editor.
 
-6.  run `sudo service clearwater-infrastructure restart; sudo monit restart homestead` to reload the config and restart Homestead.
+6.  To reload the configuration, run `sudo service clearwater-infrastructure restart; sudo service homestead stop`, and then allow monit to automatically restart Homestead
 
 ### Configuring your external HSS
 

diff --git a/docs/IBCF.md b/docs/IBCF.md
@@ -20,7 +20,7 @@ Install and configure an IBCF node with the following steps.
 
 - Restart the Bono daemon.
 
-        monit restart bono
+        service stop bono (allow monit to restart Bono)
 
 ## ENUM Configuration
 

diff --git a/docs/Modifying_Clearwater_settings.md b/docs/Modifying_Clearwater_settings.md
@@ -58,7 +58,7 @@ hss_port
 To change one of these settings:
 * Edit `/etc/clearwater/config` on each affected node, and change to the new value
 * Run `sudo service clearwater-infrastructure restart` to ensure that the configuration changes are applied consistently across the node
-* Restart the individual component with `sudo monit restart sprout`, `sudo monit restart bono`, `sudo monit restart homer`, `sudo monit restart homestead` or `sudo monit restart ellis` depending on your node. This picks up the new configuration.
+* Restart the individual component by running `sudo service <sprout,bono,homestead,homer,ralf,ellis> stop` and allowing monit to restart the service. This picks up the new configuration.
 
 ## Starting from scratch
 

diff --git a/docs/Troubleshooting_and_Recovery.md b/docs/Troubleshooting_and_Recovery.md
@@ -4,7 +4,7 @@ This document describes how to troubleshoot some common problems, and associated
 
 ## General
 
-*   Clearwater components are monitored by [monit](http://mmonit.com/monit/) and should be restarted by it if the component fails or hangs.  You can check that components are running by issuing `monit status`.  If components are not running as expected, run `monit start <component>` to start a component or `monit stop <component>` to stop it.
+*   Clearwater components are monitored by [monit](http://mmonit.com/monit/) and should be restarted by it if the component fails or hangs.  You can check that components are running by issuing `monit status`.  If components are not running as expected, run `monit start <component>` to start a component or `monit stop <component>` to stop it. To restart a component, we recommend using `service <component> stop` to stop the component, and allowing monit to automatically start the component again. 
 
 *  The [Clearwater diagnostics monitor](https://github.com/Metaswitch/clearwater-infrastructure/blob/master/clearwater-diags-monitor.md) detects crashes in native clearwater processes (bono, sprout and homestead) and captures a diagnostics bundle containing a core file (among other useful information).  A diagnostics bundle can also be created by running a command line script. 
 
@@ -44,7 +44,7 @@ If this doesn't help, sprout logs to `/var/log/sprout/sprout*.txt`.  By default,
 
 Sprout maintains registration state in a memcached cluster.  It's a little clunky to examine this data but you can get some basic information out by running `. /etc/clearwater/config ; telnet $local_ip 11211` to connect to memcached, issuing `stats items`.  This returns a list of entries of the form `STAT items:<slab ID>:...`.  You can then query the keys in each of the slabs with `stats cachedump <slab ID> 0`.
 
-Memcached logs to `/var/log/memcached.log`. It logs very little by default, but it is possible to make it more verbose by editing `/etc/memcached_11211.conf`, uncommenting the `-vv` line, and running `sudo monit restart memcached`.
+Memcached logs to `/var/log/memcached.log`. It logs very little by default, but it is possible to make it more verbose by editing `/etc/memcached_11211.conf`, uncommenting the `-vv` line, and then restarting memcached. 
 
 If you see sprout dying/restarting with no apparent cause in `/var/log/sprout/sprout*.txt`, check `/var/log/monit.log` and `/var/log/syslog` around that time - these can sometimes give clues as to the cause.