From 157f709cb921302442090c7664e6e3a34b6c2998 Mon Sep 17 00:00:00 2001 From: Julien-zte Date: Wed, 17 Aug 2016 16:08:18 +0800 Subject: Adjust the structure of doctor/userguide dir Change-Id: Ie526d921dabbfa3b7a9c95f1705390c2eef53998 Signed-off-by: Julien Signed-off-by: Yuanzhen Li (cherry picked from commit 9064b1fc9960f5a808a8e71158e492f4c31edf05) --- docs/index.rst | 24 +++++ docs/platformoverview/images/LICENSE | 14 --- docs/platformoverview/images/figure-p1.png | Bin 60756 -> 0 bytes docs/platformoverview/index.rst | 12 --- docs/platformoverview/platformoverview.rst | 60 ----------- .../functest/doctor-scenario-in-functest.rst | 118 ++++++++++++++++++++ docs/scenarios/functest/images/LICENSE | 14 +++ docs/scenarios/functest/images/figure-p1.png | Bin 0 -> 60756 bytes docs/scenarios/index.rst | 12 +++ docs/userguide/doctor_scenario_in_functest.rst | 120 --------------------- 10 files changed, 168 insertions(+), 206 deletions(-) create mode 100755 docs/index.rst delete mode 100644 docs/platformoverview/images/LICENSE delete mode 100755 docs/platformoverview/images/figure-p1.png delete mode 100644 docs/platformoverview/index.rst delete mode 100644 docs/platformoverview/platformoverview.rst create mode 100644 docs/scenarios/functest/doctor-scenario-in-functest.rst create mode 100644 docs/scenarios/functest/images/LICENSE create mode 100755 docs/scenarios/functest/images/figure-p1.png create mode 100644 docs/scenarios/index.rst delete mode 100644 docs/userguide/doctor_scenario_in_functest.rst (limited to 'docs') 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/images/LICENSE b/docs/platformoverview/images/LICENSE deleted file mode 100644 index f2b47d20..00000000 --- a/docs/platformoverview/images/LICENSE +++ /dev/null @@ -1,14 +0,0 @@ -Copyright 2015 Open Platform for NFV Project, Inc. and its contributors - -Open Platform for NFV Project Documentation License -=================================================== -Any documentation developed by the "Open Platform for NFV Project" -is licensed under a Creative Commons Attribution 4.0 International License. -You should have received a copy of the license along with this. If not, -see . - -Unless required by applicable law or agreed to in writing, documentation -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/docs/platformoverview/images/figure-p1.png b/docs/platformoverview/images/figure-p1.png deleted file mode 100755 index e963d8bd..00000000 Binary files a/docs/platformoverview/images/figure-p1.png and /dev/null differ diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst deleted file mode 100644 index 23d61cd4..00000000 --- a/docs/platformoverview/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -************************ -Doctor Platform Overview -************************ - -.. toctree:: - :maxdepth: 2 - :numbered: - -.. include:: platformoverview.rst 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 `_: - -* 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/scenarios/functest/doctor-scenario-in-functest.rst b/docs/scenarios/functest/doctor-scenario-in-functest.rst new file mode 100644 index 00000000..29af7390 --- /dev/null +++ b/docs/scenarios/functest/doctor-scenario-in-functest.rst @@ -0,0 +1,118 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + + +Platform overview +""""""""""""""""" + +Doctor platform provides these features in `Colorado Release `_: + +* 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 execute recovery actions +properly in the VIM. + +Ability to query host status gives VM owner the possibility to get +consistent state information through an API in case of a compute host +fault. + +The Doctor platform 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 implementations 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/colorado/requirements/05-implementation.html + +Use case +"""""""" + +* A consumer of the NFVI wants to receive immediate notifications about faults + in the NFVI affecting the proper functioning of the virtual resources. + Therefore, such faults have to be detected as quickly as possible, and, when + a critical error is observed, the affected consumer is immediately informed + about the fault and can switch over to the STBY configuration. + +The faults to be monitored (and at which detection rate) will be configured by +the consumer. Once a fault is detected, the Inspector in the Doctor +architecture will check the resource map maintained by the Controller, to find +out which virtual resources are affected and then update the resources state. +The Notifier will receive the failure event requests sent from the Controller, +and notify the consumer(s) of the affected resources according to the alarm +configuration. + +Detailed workflow information is as follows: + +* Consumer(VNFM): (step 0) creates resources (network, server/instance) and an + event alarm on state down notification of that server/instance + +* Monitor: (step 1) periodically checks nodes, such as ping from/to each + dplane nic to/from gw of node, (step 2) once it fails to send out event + with "raw" fault event information to Inspector + +* Inspector: when it receives an event, it will (step 3) mark the host down + ("mark-host-down"), (step 4) map the PM to VM, and change the VM status to + down + +* Controller: (step 5) sends out instance update event to Ceilometer + +* Notifier: (step 6) Ceilometer transforms and passes the event to Aodh, + (step 7) Aodh will evaluate event with the registered alarm definitions, + then (step 8) it will fire the alarm to the "consumer" who owns the + instance + +* Consumer(VNFM): (step 9) receives the event and (step 10) recreates a new + instance + +Test case +""""""""" + +Functest will call the "run.sh" script in Doctor to run the test job. + +Currently, only 'Apex' and 'local' installer are supported. + +The "run.sh" script will execute the following steps. + +Firstly, prepare image for booting VM, then create a test project and test +user (both default to doctor) for the Doctor tests. + +Secondly, boot a VM under the doctor project and check the VM status to verify +that the VM is launched completely. Then get the compute host info where the VM +is launched to verify connectivity to the target compute host. Get the consumer +ip according to the route to compute ip and create an alarm event in Ceilometer +using the consumer ip. + +Thirdly, the Doctor components are started, and, based on the above preparation, +a failure is injected to the system, i.e. the network of compute host is +disabled for 3 minutes. To ensure the host is down, the status of the host +will be checked. + +Finally, the notification time, i.e. the time between the execution of step 2 +(Monitor detects failure) and step 9 (Consumer receives failure notification) +is calculated. + +According to the Doctor requirements, the Doctor test is successful if the +notification time is below 1 second. diff --git a/docs/scenarios/functest/images/LICENSE b/docs/scenarios/functest/images/LICENSE new file mode 100644 index 00000000..f2b47d20 --- /dev/null +++ b/docs/scenarios/functest/images/LICENSE @@ -0,0 +1,14 @@ +Copyright 2015 Open Platform for NFV Project, Inc. and its contributors + +Open Platform for NFV Project Documentation License +=================================================== +Any documentation developed by the "Open Platform for NFV Project" +is licensed under a Creative Commons Attribution 4.0 International License. +You should have received a copy of the license along with this. If not, +see . + +Unless required by applicable law or agreed to in writing, documentation +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/docs/scenarios/functest/images/figure-p1.png b/docs/scenarios/functest/images/figure-p1.png new file mode 100755 index 00000000..e963d8bd Binary files /dev/null and b/docs/scenarios/functest/images/figure-p1.png differ diff --git a/docs/scenarios/index.rst b/docs/scenarios/index.rst new file mode 100644 index 00000000..3732e027 --- /dev/null +++ b/docs/scenarios/index.rst @@ -0,0 +1,12 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +=============== +Doctor scenario +=============== + +.. toctree:: + :maxdepth: 2 + :numbered: + + ./functest/doctor-scenario-in-functest.rst diff --git a/docs/userguide/doctor_scenario_in_functest.rst b/docs/userguide/doctor_scenario_in_functest.rst deleted file mode 100644 index b36937e7..00000000 --- a/docs/userguide/doctor_scenario_in_functest.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Doctor -^^^^^^ - -Platform overview -""""""""""""""""" - -Doctor platform provides these features in `Colorado Release `_: - -* 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 execute recovery actions -properly in the VIM. - -Ability to query host status gives VM owner the possibility to get -consistent state information through an API in case of a compute host -fault. - -The Doctor platform 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 implementations for reference. - -You can see an overview of the Doctor platform and how components interact in -:numref:`figure-p1`. - -.. figure:: /platformoverview/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 - - -Use case -"""""""" - -* A consumer of the NFVI wants to receive immediate notifications about faults - in the NFVI affecting the proper functioning of the virtual resources. - Therefore, such faults have to be detected as quickly as possible, and, when - a critical error is observed, the affected consumer is immediately informed - about the fault and can switch over to the STBY configuration. - -The faults to be monitored (and at which detection rate) will be configured by -the consumer. Once a fault is detected, the Inspector in the Doctor -architecture will check the resource map maintained by the Controller, to find -out which virtual resources are affected and then update the resources state. -The Notifier will receive the failure event requests sent from the Controller, -and notify the consumer(s) of the affected resources according to the alarm -configuration. - -Detailed workflow information is as follows: - -* Consumer(VNFM): (step 0) creates resources (network, server/instance) and an - event alarm on state down notification of that server/instance - -* Monitor: (step 1) periodically checks nodes, such as ping from/to each - dplane nic to/from gw of node, (step 2) once it fails to send out event - with "raw" fault event information to Inspector - -* Inspector: when it receives an event, it will (step 3) mark the host down - ("mark-host-down"), (step 4) map the PM to VM, and change the VM status to - down - -* Controller: (step 5) sends out instance update event to Ceilometer - -* Notifier: (step 6) Ceilometer transforms and passes the event to Aodh, - (step 7) Aodh will evaluate event with the registered alarm definitions, - then (step 8) it will fire the alarm to the "consumer" who owns the - instance - -* Consumer(VNFM): (step 9) receives the event and (step 10) recreates a new - instance - -Test case -""""""""" - -Functest will call the "run.sh" script in Doctor to run the test job. - -Currently, only 'Apex' and 'local' installer are supported. - -The "run.sh" script will execute the following steps. - -Firstly, prepare image for booting VM, then create a test project and test -user (both default to doctor) for the Doctor tests. - -Secondly, boot a VM under the doctor project and check the VM status to verify -that the VM is launched completely. Then get the compute host info where the VM -is launched to verify connectivity to the target compute host. Get the consumer -ip according to the route to compute ip and create an alarm event in Ceilometer -using the consumer ip. - -Thirdly, the Doctor components are started, and, based on the above preparation, -a failure is injected to the system, i.e. the network of compute host is -disabled for 3 minutes. To ensure the host is down, the status of the host -will be checked. - -Finally, the notification time, i.e. the time between the execution of step 2 -(Monitor detects failure) and step 9 (Consumer receives failure notification) -is calculated. - -According to the Doctor requirements, the Doctor test is successful if the -notification time is below 1 second. -- cgit 1.2.3-korg