From e036d0f69b14dcbe0711c1e46448f380912d794f Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Thu, 28 Jan 2016 17:51:39 +0900 Subject: contents for OPNFV composite docs Signed-off-by: Ryota MIBU Change-Id: I557819f8a67b8882de87c94bbca8177a89b55d6d (cherry picked from commit 1e95ffeaac59aee8decf3ccf6721330de19f491e) --- docs/configguide/configguide.rst | 46 ++++++++++++++++++++++++++++ docs/platformoverview/doctor.rst | 47 ---------------------------- docs/platformoverview/index.rst | 9 ------ docs/platformoverview/platformoverview.rst | 49 ++++++++++++++++++++++++++++++ docs/test4composite/index.rst | 15 +++++++++ docs/userguide/userguide.rst | 39 ++++++++++++++++++++---- 6 files changed, 143 insertions(+), 62 deletions(-) create mode 100644 docs/configguide/configguide.rst delete mode 100644 docs/platformoverview/doctor.rst delete mode 100644 docs/platformoverview/index.rst create mode 100644 docs/platformoverview/platformoverview.rst create mode 100644 docs/test4composite/index.rst diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst new file mode 100644 index 00000000..c3572901 --- /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/doctor.rst b/docs/platformoverview/doctor.rst deleted file mode 100644 index 6ee59a9f..00000000 --- a/docs/platformoverview/doctor.rst +++ /dev/null @@ -1,47 +0,0 @@ -=============== -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/index.rst b/docs/platformoverview/index.rst deleted file mode 100644 index cee06eb3..00000000 --- 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/platformoverview.rst b/docs/platformoverview/platformoverview.rst new file mode 100644 index 00000000..e6ef8859 --- /dev/null +++ b/docs/platformoverview/platformoverview.rst @@ -0,0 +1,49 @@ +Doctor platform components and features +======================================= + +.. + This section will be compiled into OPNFV composite document. + +https://wiki.opnfv.org/doctor + +Features +-------- + +Doctor platform, as of Brahmaputra release, provides the two features: + +* Immediate Notification +* 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 +(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/test4composite/index.rst b/docs/test4composite/index.rst new file mode 100644 index 00000000..103481b7 --- /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 7f3e4f90..d869b0b3 100644 --- a/docs/userguide/userguide.rst +++ b/docs/userguide/userguide.rst @@ -1,7 +1,34 @@ - capabilities and usage -================================ -Describe the specific capabilities and usage for feature. +Doctor capabilities and usage +============================= - ------------------------------------------------ -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. -- cgit 1.2.3-korg