summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorCarlos Goncalves <carlos.goncalves@neclab.eu>2016-08-31 09:30:23 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-08-31 09:30:23 +0000
commit6cf036177753359bdbb65464fb0abe3abe3db153 (patch)
tree403ff4d49d2b6c6b6ad8129a7a87c1f945ac2f41 /docs
parentd921539ad550fb4222aaa8d9fc742239150838af (diff)
parent9064b1fc9960f5a808a8e71158e492f4c31edf05 (diff)
Merge "Adjust the structure of doctor/userguide dir"
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/index.rst24
-rw-r--r--docs/platformoverview/platformoverview.rst60
-rw-r--r--docs/scenarios/functest/doctor-scenario-in-functest.rst (renamed from docs/userguide/doctor_scenario_in_functest.rst)8
-rw-r--r--docs/scenarios/functest/images/LICENSE (renamed from docs/platformoverview/images/LICENSE)0
-rwxr-xr-xdocs/scenarios/functest/images/figure-p1.png (renamed from docs/platformoverview/images/figure-p1.png)bin60756 -> 60756 bytes
-rw-r--r--docs/scenarios/index.rst (renamed from docs/platformoverview/index.rst)8
6 files changed, 31 insertions, 69 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100755
index 00000000..a8349970
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2016 OPNFV.
+
+
+======
+Doctor
+======
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+ ./installationprocedure/index.rst
+ ./design/index.rst
+ ./manuals/index.rst
+ ./requirements/index.rst
+ ./scenarios/index.rst
+ ./userguide/index.rst
+
+Indices
+=======
+* :ref:`search`
+
diff --git a/docs/platformoverview/platformoverview.rst b/docs/platformoverview/platformoverview.rst
deleted file mode 100644
index 8a151236..00000000
--- a/docs/platformoverview/platformoverview.rst
+++ /dev/null
@@ -1,60 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Doctor platform components and features
-=======================================
-
-..
- This section will be compiled into OPNFV composite document.
-
-https://wiki.opnfv.org/doctor
-
-Features
---------
-
-Doctor platform provides these features in `Colorado Release <https://wiki.opnfv.org/display/SWREL/Colorado>`_:
-
-* Immediate Notification
-* Consistent resource state awareness for compute host down
-* Valid compute host status given to VM owner
-
-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.
-
-Ability to query host status gives VM owner (VNFM) the possibility to get
-consistent state information through an API in case of a compute host
-fault.
-
-Components
-----------
-
-Doctor platform, as of Colorado 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 (Colorado)
-
-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/userguide/doctor_scenario_in_functest.rst b/docs/scenarios/functest/doctor-scenario-in-functest.rst
index b36937e7..29af7390 100644
--- a/docs/userguide/doctor_scenario_in_functest.rst
+++ b/docs/scenarios/functest/doctor-scenario-in-functest.rst
@@ -1,8 +1,7 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-Doctor
-^^^^^^
+
Platform overview
"""""""""""""""""
@@ -38,7 +37,7 @@ The Doctor platform consists of the following components:
You can see an overview of the Doctor platform and how components interact in
:numref:`figure-p1`.
-.. figure:: /platformoverview/images/figure-p1.png
+.. figure:: ./images/figure-p1.png
:name: figure-p1
:width: 100%
@@ -46,8 +45,7 @@ You can see an overview of the Doctor platform and how components interact in
Detailed information on the Doctor architecture can be found in the Doctor
requirements documentation:
-http://artifacts.opnfv.org/doctor/docs/requirements/05-implementation.html
-
+http://artifacts.opnfv.org/doctor/colorado/requirements/05-implementation.html
Use case
""""""""
diff --git a/docs/platformoverview/images/LICENSE b/docs/scenarios/functest/images/LICENSE
index f2b47d20..f2b47d20 100644
--- a/docs/platformoverview/images/LICENSE
+++ b/docs/scenarios/functest/images/LICENSE
diff --git a/docs/platformoverview/images/figure-p1.png b/docs/scenarios/functest/images/figure-p1.png
index e963d8bd..e963d8bd 100755
--- a/docs/platformoverview/images/figure-p1.png
+++ b/docs/scenarios/functest/images/figure-p1.png
Binary files differ
diff --git a/docs/platformoverview/index.rst b/docs/scenarios/index.rst
index 23d61cd4..3732e027 100644
--- a/docs/platformoverview/index.rst
+++ b/docs/scenarios/index.rst
@@ -1,12 +1,12 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-************************
-Doctor Platform Overview
-************************
+===============
+Doctor scenario
+===============
.. toctree::
:maxdepth: 2
:numbered:
-.. include:: platformoverview.rst
+ ./functest/doctor-scenario-in-functest.rst