heat docs : Add heat-watch manpage

fixes bug 1153689

Change-Id: I7a4566cb850cf94761c1948fa7ad976e7d4f5446

diff --git a/doc/source/conf.py b/doc/source/conf.py
index beaf220587ee6beecb892c4bf8b1948dc262cd26..0577c31bb307e43cc27dd8cd7f5267a30805fc6e 100644 (file)
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -225,6 +225,9 @@ man_pages = [
     ('man/heat-cfn', 'heat-cfn',
     u'Command line utility to run heat actions over the CloudFormation API',
     [u'Heat Developers'], 1),
+    ('man/heat-watch', 'heat-watch',
+    u'Command line utility to run heat watch actions over the CloudWatch API',
+    [u'Heat Developers'], 1),
     ('man/heat-api', 'heat-api',
     u'REST API service to the heat project.',
     [u'Heat Developers'], 1),

diff --git a/doc/source/man/heat-watch.rst b/doc/source/man/heat-watch.rst
new file mode 100644 (file)
index 0000000..6288532
--- /dev/null
+++ b/doc/source/man/heat-watch.rst
@@ -0,0 +1,95 @@
+========
+heat-watch
+========
+
+.. program:: heat-watch
+
+
+SYNOPSIS
+========
+
+``heat-watch [OPTIONS] COMMAND [COMMAND_OPTIONS]``
+
+
+DESCRIPTION
+===========
+heat-watch is a command-line utility for heat-api-cloudwatch.
+It allows manipulation of the watch alarms and metric data via the heat
+cloudwatch API, so this service must be running and accessibe on the host
+specified in your boto config (cloudwatch_region_endpoint)
+
+
+CONFIGURATION
+=============
+
+heat-watch uses the boto client library, and expects some configuration files
+to exist in your environment, see our wiki for an example configuration file:
+
+https://wiki.openstack.org/wiki/Heat/Using-Boto
+
+
+COMMANDS
+========
+
+``describe``
+
+  Provide detailed information about the specified watch rule, or if no arguments are given all watch rules
+
+``set-state``
+
+  Temporarily set the state of a watch rule
+
+``metric-list``
+
+  List data-points for a specified metric
+
+``metric-put-data``
+
+  Publish data-point for specified  metric
+
+  Note the metric must be associated with a CloudWatch Alarm (specified in a heat stack template), publishing arbitrary metric data is not supported.
+
+``help``
+
+  Provide help/usage information on each command
+
+
+OPTIONS
+=======
+
+.. cmdoption:: --version
+
+  show program version number and exit
+
+.. cmdoption:: -h, --help
+
+  show this help message and exit
+
+.. cmdoption:: -v, --verbose
+
+  Print more verbose output
+
+.. cmdoption:: -d, --debug
+
+  Print debug output
+
+.. cmdoption:: -p, --port
+
+  Specify port the heat CW API host listens on. Default: 8003
+
+
+EXAMPLES
+========
+
+  heat-watch describe
+
+  heat-watch metric-list
+
+  heat-watch metric-put-data HttpFailureAlarm system/linux ServiceFailure Count 1
+
+  heat-watch set-state HttpFailureAlarm ALARM
+
+
+BUGS
+====
+Heat bugs are managed through Launchpad <https://launchpad.net/heat>