contents for OPNFV composite docs

Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
Change-Id: I557819f8a67b8882de87c94bbca8177a89b55d6d

diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst
new file mode 100644 (file)
index 0000000..c357290
--- /dev/null
+++ b/docs/configguide/configguide.rst
@@ -0,0 +1,46 @@
+Configuring Doctor features
+===========================
+
+..
+    This section will be compiled into OPNFV composite document.
+
+Doctor Inspector
+----------------
+
+Doctor Inspector is suggested to be placed in one of the controller nodes,
+but it can be put on any host where Doctor Monitor can reach and accessible
+to the OpenStack Controller (Nova).
+
+Make sure OpenStack env parameters are set properly, so that Doctor Inspector
+can issue admin actions such as compute host force-down and state update of VM.
+
+Then, you can configure Doctor Inspector as follows:
+
+.. code-block:: bash
+
+    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
+    cd doctor/tests
+    INSPECTOR_PORT=12345
+    python inspector.py $INSPECTOR_PORT > inspector.log 2>&1 &
+
+Doctor Monitor
+--------------
+
+Doctor Monitors are suggested to be placed in one of the controller nodes,
+but those can be put on any host which is reachable to target compute host and
+accessible to the Doctor Inspector.
+You need to configure Monitors for all compute hosts one by one.
+
+Make sure OpenStack env parameters are set properly, so that Doctor Inspector
+can issue admin actions such as compute host force-down and state update of VM.
+
+Then, you can configure Doctor Monitor as follows:
+
+.. code-block:: bash
+
+    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
+    cd doctor/tests
+    INSPECTOR_PORT=12345
+    COMPUTE_HOST='overcloud-novacompute-0'
+    sudo python monitor.py "$COMPUTE_HOST" \
+        "http://127.0.0.1:$INSPECTOR_PORT/events" > monitor.log 2>&1 &

diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
deleted file mode 100644 (file)
index cee06eb..0000000
--- a/docs/platformoverview/index.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-***************************
-Overview of Doctor Platform
-***************************
-
-.. toctree::
-   :numbered:
-   :maxdepth: 2
-
-   doctor.rst

diff --git a/docs/platformoverview/doctor.rst b/docs/platformoverview/platformoverview.rst
similarity index 83%
rename from docs/platformoverview/doctor.rst
rename to docs/platformoverview/platformoverview.rst
index 6ee59a9..e6ef885 100644 (file)
--- a/docs/platformoverview/doctor.rst
+++ b/docs/platformoverview/platformoverview.rst
@@ -1,16 +1,18 @@
-===============
-Doctor Platform
-===============
+Doctor platform components and features
+=======================================
+
+..
+    This section will be compiled into OPNFV composite document.

 
 https://wiki.opnfv.org/doctor
 
 Features
 
 https://wiki.opnfv.org/doctor
 
 Features

-========
+--------

 
 Doctor platform, as of Brahmaputra release, provides the two features:
 
 * Immediate Notification
 
 Doctor platform, as of Brahmaputra release, provides the two features:
 
 * Immediate Notification

-* Consistent resource state awareness (Compute)
+* Consistent resource state awareness (Compute/host-down)

 
 These features enable high availability of Network Services on top of
 the virtualized infrastructure. Immediate notification allows VNF managers
 
 These features enable high availability of Network Services on top of
 the virtualized infrastructure. Immediate notification allows VNF managers


@@ -19,7 +21,7 @@ Consistency of resource state is necessary to properly execute recovery
 actions properly in the VIM.
 
 Components
 actions properly in the VIM.
 
 Components

-==========
+----------

 
 Doctor platform, as of Brahmaputra release, consists of the following
 components:
 
 Doctor platform, as of Brahmaputra release, consists of the following
 components:

diff --git a/docs/test4composite/index.rst b/docs/test4composite/index.rst
new file mode 100644 (file)
index 0000000..103481b
--- /dev/null
+++ b/docs/test4composite/index.rst
@@ -0,0 +1,15 @@
+*********************************
+Doctor contents in composite docs
+*********************************
+
+.. note::
+    This document is just for test to validate doctor contents which would
+    be included into the OPNFV composite docs.
+
+.. toctree::
+    :maxdepth: 2
+    :numbered:
+
+    ../platformoverview/platformoverview.rst
+    ../configguide/configguide.rst
+    ../userguide/userguide.rst

diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst
index 7f3e4f9..d869b0b 100644 (file)
--- 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.