summaryrefslogtreecommitdiffstats
path: root/docs/userguide
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2016-01-28 17:51:39 +0900
committerRyota MIBU <r-mibu@cq.jp.nec.com>2016-01-30 00:59:31 +0900
commit1e95ffeaac59aee8decf3ccf6721330de19f491e (patch)
tree27a49b43d2e1b85035e5f655e3e615fb7ad1273b /docs/userguide
parentc643a5ad3d608aa8abad8c1e4442ad98310fc43b (diff)
contents for OPNFV composite docs
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> Change-Id: I557819f8a67b8882de87c94bbca8177a89b55d6d
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/userguide.rst39
1 files changed, 33 insertions, 6 deletions
diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst
index 7f3e4f90..d869b0b3 100644
--- a/docs/userguide/userguide.rst
+++ b/docs/userguide/userguide.rst
@@ -1,7 +1,34 @@
-<Feature> capabilities and usage
-================================
-Describe the specific capabilities and usage for <XYZ> feature.
+Doctor capabilities and usage
+=============================
-<Feature and API usage guidelines and example>
------------------------------------------------
-Describe with examples how to use specfic features.
+..
+ This section will be compiled into OPNFV composite document.
+
+Immediate Notification
+----------------------
+
+Immediate notification can be used by creating 'event' type alarm via
+OpenStack Alarming (Aodh) API with relevant internal components support.
+
+See, upstream spec document:
+http://specs.openstack.org/openstack/ceilometer-specs/specs/liberty/event-alarm-evaluator.html
+
+You can find an example of consumer of this notification in doctor repository.
+It can be executed as follows:
+
+.. code-block:: bash
+
+ git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
+ cd doctor/tests
+ CONSUMER_PORT=12346
+ python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 &
+
+Consistent resource state awareness (Compute/host-down)
+-------------------------------------------------------
+
+Resource state of compute host can be fixed according to an input from a monitor
+sitting out side of OpenStack Compute (Nova) by using force-down API.
+
+See
+http://artifacts.opnfv.org/doctor/brahmaputra/docs/manuals/mark-host-down_manual.html
+for more detail.