summaryrefslogtreecommitdiffstats
path: root/docs/userguide/feature.userguide.rst
diff options
context:
space:
mode:
authorBertrand Souville <souville@docomolab-euro.com>2016-08-22 10:49:44 +0200
committerBertrand Souville <souville@docomolab-euro.com>2016-08-22 14:03:59 +0200
commit2a8991b88b5f168b48b97e630f6ba158c9d747f0 (patch)
treee9c1c30120f8be997d833afba092fd8f20a9cbab /docs/userguide/feature.userguide.rst
parenta60aa0abf92a6658b2af446a02617e6832fc8412 (diff)
Updated Doctor user/config guides using opnfvdocs templates
https://gerrit.opnfv.org/gerrit/#/c/18311 https://gerrit.opnfv.org/gerrit/#/c/18967 Change-Id: Ia1a08415f316665dcd8ee5d0e99601ec3f3b753c Signed-off-by: Bertrand Souville <souville@docomolab-euro.com>
Diffstat (limited to 'docs/userguide/feature.userguide.rst')
-rw-r--r--docs/userguide/feature.userguide.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst
new file mode 100644
index 00000000..d24c1acb
--- /dev/null
+++ b/docs/userguide/feature.userguide.rst
@@ -0,0 +1,48 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Doctor capabilities and usage
+=============================
+
+..
+ 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
+
+An example of a consumer of this notification can be found in the 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
+-----------------------------------
+
+Resource state of compute host can be changed/updated according to a trigger
+from a monitor running outside 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.
+
+Valid compute host status given to VM owner
+-------------------------------------------
+
+The resource state of a compute host can be retrieved by a user with the
+OpenStack Compute (Nova) servers API.
+
+See
+http://artifacts.opnfv.org/doctor/docs/manuals/get-valid-server-state.html
+for more detail.