ESCALATOR-31 Adjusting documentation

[escalator.git] / docs / requirements / 101-Scope.rst

diff --git a/docs/01-Scope.rst b/docs/requirements/101-Scope.rst
similarity index 68%
rename from docs/01-Scope.rst
rename to docs/requirements/101-Scope.rst
index 5247e40..42da7b9 100644 (file)
--- a/docs/01-Scope.rst
+++ b/docs/requirements/101-Scope.rst
@@ -1,5 +1,6 @@
+=====
 Scope
------
+=====
 
 This document describes the user requirements on the smooth upgrade
 function of the NFVI and VIM with respect to the upgrades of the OPNFV
@@ -9,12 +10,12 @@ that the process of the upgrade is automatically carried out by a tool
 (code name: Escalator) with pre-configured data. The upgrade process
 includes preparation, validation, execution, monitoring and
 conclusion.
-  
+
 .. <MT> While it is good to have a tool for the entire upgrade process,
    but it is a challenging task, so maybe we shouldn't require automation
    for the entire process right away. Automation is essential at
    execution.
-  
+
 .. <hujie> Maybe we can analysis information flows of the upgrade tool,
    abstract the basic / essential actions from the tool (or tools), and
    map them to a command set of NFVI / VIM's interfaces.
@@ -25,4 +26,20 @@ NFVI.
 
 The requirements may apply to different NFV functions (NFVI, or VIM, or
 both of them). They will be classified in the Appendix of this
-document.
\ No newline at end of file
+document.
+
+The objects being upgraded described in this document are software modules covered by
+red box in the picture below which includes: VIM and NFVI.
+
+The target of the upgrade is to reduce the impact on the applications in the
+blue box below as much as possible.
+
+Please keep in mind that the upgrade tool does not take Vi-Vnfm and Or-Vi into
+consideration.  In other words, these two interfaces may not provided service normally
+during upgrade procedure.
+
+
+.. figure:: images/figure1.png
+   :name: figure1
+   :width: 100%
+