svn commit: r1128031 - in /activemq/activemq-apollo/trunk: apollo-cli/src/main/resources/META-INF/services/org.apache.activemq.apollo/ apollo-cli/src/main/scala/org/apache/activemq/apollo/cli/commands/ apollo-website/src/documentation/

[ch...@apache.org]

Author: chirino
Date: Thu May 26 18:55:14 2011
New Revision: 1128031

URL: http://svn.apache.org/viewvc?rev=1128031&view=rev
Log:
Remove the apollo stop command, and document how to use the broker-service scripts to manage a background broker process.

Removed:
    activemq/activemq-apollo/trunk/apollo-cli/src/main/scala/org/apache/activemq/apollo/cli/commands/Stop.scala
Modified:
    activemq/activemq-apollo/trunk/apollo-cli/src/main/resources/META-INF/services/org.apache.activemq.apollo/apollo-broker-commands.index
    activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md

Modified: activemq/activemq-apollo/trunk/apollo-cli/src/main/resources/META-INF/services/org.apache.activemq.apollo/apollo-broker-commands.index
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-cli/src/main/resources/META-INF/services/org.apache.activemq.apollo/apollo-broker-commands.index?rev=1128031&r1=1128030&r2=1128031&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-cli/src/main/resources/META-INF/services/org.apache.activemq.apollo/apollo-broker-commands.index (original)
+++ activemq/activemq-apollo/trunk/apollo-cli/src/main/resources/META-INF/services/org.apache.activemq.apollo/apollo-broker-commands.index Thu May 26 18:55:14 2011
@@ -16,7 +16,6 @@
 ## ---------------------------------------------------------------------------
 org.apache.activemq.apollo.cli.commands.Exit
 org.apache.activemq.apollo.cli.commands.Help
-org.apache.activemq.apollo.cli.commands.Stop
 org.apache.activemq.apollo.cli.commands.Run
 org.apache.activemq.apollo.cli.commands.Encrypt
 org.apache.activemq.apollo.cli.commands.Decrypt

Modified: activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md
URL: http://svn.apache.org/viewvc/activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md?rev=1128031&r1=1128030&r2=1128031&view=diff
==============================================================================
--- activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md (original)
+++ activemq/activemq-apollo/trunk/apollo-website/src/documentation/user-manual.md Thu May 26 18:55:14 2011
@@ -762,23 +762,40 @@ A `web_admin` element may be configured 
 
 ## Managing Brokers
 
-### Starting a Broker Instance
+The rest of this section's example assume that you have created a broker 
+instance under the `/var/lib/mybroker` directory.
 
-Assuming you created the broker instance under `/var/lib/mybroker` all you
-need to do start running the broker instance in the foreground is execute:
+### Running a Broker Instance in the Foreground
+
+To start the broker instance in the foreground is execute 
+`bin/apollo-broker run`. Example:
 
     /var/lib/mybroker/bin/apollo-broker run
 
-### Stopping a Broker Instance
+To stop it, press `Ctrl-C` to send the termination signal
+to the process.
+
+### Managing a Background Broker Instance
+
+If you are on Unix, you can use `bin/apollo-broker-service` script
+to start the broker in the background.  Example:
 
-You can stop a running broker by executing: 
+    /var/lib/mybroker/bin/apollo-broker-service start
+
+You can use the same script to check to see  if the broker is still 
+running.  Example:
+
+    /var/lib/mybroker/bin/apollo-broker-service status
+    
+You can stop the background broker by running:
 
-    /var/lib/mybroker/bin/apollo-broker stop --user admin --password password
+    /var/lib/mybroker/bin/apollo-broker-service stop
 
-This command uses the web administration interface to signal the broker
-to shutdown.  If the that interface has been disabled you should just kill
-the the broker process by killing it's process id using your operating
-system's tools.
+When the broker is started in the background, it creates
+a `data/apollo.pid` file which contains the process id of
+the process executing the broker.  This file is typically 
+used to integrated with external watch dog process
+such as [Monit](http://mmonit.com/monit/).
 
 ### Viewing Broker State