From: Ryota MIBU <r-mibu@cq.jp.nec.com>
Date: Thu, 7 Jan 2016 07:47:20 +0000 (+0900)
Subject: docs: add platform overview
X-Git-Tag: colorado.1.0~92^2
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F31%2F5731%2F2;p=doctor.git

docs: add platform overview

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

diff --git a/docs/platformoverview/doctor.rst b/docs/platformoverview/doctor.rst
new file mode 100644
index 00000000..6ee59a9f
--- /dev/null
+++ b/docs/platformoverview/doctor.rst
@@ -0,0 +1,47 @@
+===============
+Doctor Platform
+===============
+
+https://wiki.opnfv.org/doctor
+
+Features
+========
+
+Doctor platform, as of Brahmaputra release, provides the two features:
+
+* Immediate Notification
+* Consistent resource state awareness (Compute)
+
+These features enable high availability of Network Services on top of
+the virtualized infrastructure. Immediate notification allows VNF managers
+(VNFM) to process recovery actions promptly once a failure has occurred.
+Consistency of resource state is necessary to properly execute recovery
+actions properly in the VIM.
+
+Components
+==========
+
+Doctor platform, as of Brahmaputra release, consists of the following
+components:
+
+* OpenStack Compute (Nova)
+* OpenStack Telemetry (Ceilometer)
+* OpenStack Alarming (Aodh)
+* Doctor Inspector
+* Doctor Monitor
+
+.. note::
+    Doctor Inspector and Monitor are sample implementation for reference.
+
+You can see an overview of the Doctor platform and how components interact in
+:numref:`figure-p1`.
+
+.. figure:: images/figure-p1.png
+    :name: figure-p1
+    :width: 100%
+
+    Doctor platform and typical sequence (Brahmaputra)
+
+Detailed information on the Doctor architecture can be found in the Doctor
+requirements documentation:
+http://artifacts.opnfv.org/doctor/docs/requirements/05-implementation.html
diff --git a/docs/platformoverview/images/figure-p1.png b/docs/platformoverview/images/figure-p1.png
new file mode 100755
index 00000000..e963d8bd
Binary files /dev/null and b/docs/platformoverview/images/figure-p1.png differ
diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
new file mode 100644
index 00000000..cee06eb3
--- /dev/null
+++ b/docs/platformoverview/index.rst
@@ -0,0 +1,9 @@
+***************************
+Overview of Doctor Platform
+***************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   doctor.rst